Skip to content

feat: add usdc bridge docs #422

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Aug 12, 2025
Merged

feat: add usdc bridge docs #422

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c9c895f
docs: add usdc bridge docs
vasyl-ivanchuk Aug 1, 2025
edb19c9
docs: add usdc bridge docs
vasyl-ivanchuk Aug 7, 2025
142f99d
chore: import usdc bridge examples
sarahschwartz Aug 11, 2025
d862a37
Merge branch 'main' into add-sdk-usdc-bridge-docs
sarahschwartz Aug 11, 2025
cddd5fc
Merge branch 'main' into add-sdk-usdc-bridge-docs
vasyl-ivanchuk Aug 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions content/00.zksync-era/50.sdk/10.js/01.ethers/05.api/10.v5/20.accounts/01.wallet.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,7 @@ the [`allowanceL1`](#getallowancel1) method.
| `transaction.approveERC20?` | `boolean` | Whether or not should the token approval be performed under the hood. Set this flag to `true` if you bridge an ERC20 token and didn't call the `approveERC20` function beforehand. |
| `transaction.approveBaseERC20?` | `boolean` | Whether or not should the base token approval be performed under the hood. Set this flag to `true` if you bridge a base token and didn't call the `approveERC20` function beforehand. |
| `transaction.l2GasLimit?` | `BigNumberish` | Maximum amount of L2 gas that transaction can consume during execution on L2. |
| `transaction.gasPerPubdataByte?` | `BigNumberish` | Whether or not should the token approval be performed under the hood. Set this flag to `true` if you bridge an ERC20 token and didn't call the `approveERC20` function beforehand. |
| `transaction.gasPerPubdataByte?` | `BigNumberish` | The L2 gas price for each published L1 calldata byte. |
| `transaction.refundRecipient?` | `Address` | The address on L2 that will receive the refund for the transaction. If the transaction fails, it will also be the address to receive l2Value. |
| `transaction.overrides?` | `ethers.PayableOverrides` | Transaction's overrides which may be used to pass L1 `gasLimit`, `gasPrice`, `value`, etc. |
| `transaction.approveOverrides?` | `ethers.Overrides` | Transaction's overrides which may be used to pass L1 `gasLimit`, `gasPrice`, `value`, etc. |
Expand Down Expand Up @@ -359,7 +359,7 @@ Gas of approving ERC20 token is not included in estimation.
| `transaction.operatorTip?` | `BigNumberish` | (_currently is not used_) If the ETH value passed with the transaction is not explicitly stated in the overrides, <br/>this field will be equal to the tip the operator will receive on top of the base cost of the transaction. |
| `transaction.bridgeAddress?` | `Address` | The address of the bridge contract to be used. Defaults to the default ZKsync bridge (either `L1EthBridge` or `L1Erc20Bridge`). |
| `transaction.l2GasLimit?` | `BigNumberish` | Maximum amount of L2 gas that transaction can consume during execution on L2. |
| `transaction.gasPerPubdataByte?` | `BigNumberish` | Whether or not should the token approval be performed under the hood. Set this flag to `true` if you bridge an ERC20 token and didn't call the `approveERC20` function beforehand. |
| `transaction.gasPerPubdataByte?` | `BigNumberish` | The L2 gas price for each published L1 calldata byte. |
| `transaction.customBridgeData?` | `BytesLike` | Additional data that can be sent to a bridge. |
| `transaction.refundRecipient?` | `Address` | The address on L2 that will receive the refund for the transaction. If the transaction fails, it will also be the address to receive l2Value. |
| `transaction.overrides?` | `ethers.PayableOverrides` | Transaction's overrides which may be used to pass L1 `gasLimit`, `gasPrice`, `value`, etc. |
Expand Down Expand Up @@ -1038,7 +1038,7 @@ Returns populated deposit transaction.
| `transaction.operatorTip?` | `BigNumberish` | (_currently is not used_) If the ETH value passed with the transaction is not explicitly stated in the overrides, <br/>this field will be equal to the tip the operator will receive on top of the base cost of the transaction. |
| `transaction.bridgeAddress?` | `Address` | The address of the bridge contract to be used. Defaults to the default ZKsync bridge (either `L1EthBridge` or `L1Erc20Bridge`). |
| `transaction.l2GasLimit?` | `BigNumberish` | Maximum amount of L2 gas that transaction can consume during execution on L2. |
| `transaction.gasPerPubdataByte?` | `BigNumberish` | Whether or not should the token approval be performed under the hood. Set this flag to `true` if you bridge an ERC20 token and didn't call the `approveERC20` function beforehand. |
| `transaction.gasPerPubdataByte?` | `BigNumberish` | The L2 gas price for each published L1 calldata byte. |
| `transaction.customBridgeData?` | `BytesLike` | Additional data that can be sent to a bridge. |
| `transaction.refundRecipient?` | `Address` | The address on L2 that will receive the refund for the transaction. If the transaction fails, it will also be the address to receive l2Value. |
| `transaction.overrides?` | `ethers.PayableOverrides` | Transaction's overrides which may be used to pass L1 `gasLimit`, `gasPrice`, `value`, etc. |
Expand Down Expand Up @@ -1089,7 +1089,7 @@ Retrieves the full needed ETH fee for the deposit. Returns the L1 fee and the L2
| `transaction.to?` | `Address` | The address that will receive the deposited tokens on L2. |
| `transaction.bridgeAddress?` | `Address` | The address of the bridge contract to be used. Defaults to the default ZKsync bridge (either `L1EthBridge` or `L1Erc20Bridge`). |
| `transaction.customBridgeData?` | `BytesLike` | Additional data that can be sent to a bridge. |
| `transaction.gasPerPubdataByte?` | `BigNumberish` | Whether or not should the token approval be performed under the hood. Set this flag to `true` if you bridge an ERC20 token and didn't call the `approveERC20` function beforehand. |
| `transaction.gasPerPubdataByte?` | `BigNumberish` | The L2 gas price for each published L1 calldata byte. |
| `transaction.overrides?` | `ethers.PayableOverrides` | Transaction's overrides which may be used to pass L1 `gasLimit`, `gasPrice`, `value`, etc. |

```ts
Expand Down
8 changes: 4 additions & 4 deletions ...nt/00.zksync-era/50.sdk/10.js/01.ethers/05.api/10.v5/20.accounts/03.l1signer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ the [`allowanceL1`](#getallowancel1) method.
| `transaction.approveERC20?` | `boolean` | Whether or not should the token approval be performed under the hood. Set this flag to `true` if you bridge an ERC20 token and didn't call the `approveERC20` function beforehand. |
| `transaction.approveBaseERC20?` | `boolean` | Whether or not should the base token approval be performed under the hood. Set this flag to `true` if you bridge a base token and didn't call the `approveERC20` function beforehand. |
| `transaction.l2GasLimit?` | `BigNumberish` | Maximum amount of L2 gas that transaction can consume during execution on L2. |
| `transaction.gasPerPubdataByte?` | `BigNumberish` | Whether or not should the token approval be performed under the hood. Set this flag to `true` if you bridge an ERC20 token and didn't call the `approveERC20` function beforehand. |
| `transaction.gasPerPubdataByte?` | `BigNumberish` | The L2 gas price for each published L1 calldata byte. |
| `transaction.refundRecipient?` | `Address` | The address on L2 that will receive the refund for the transaction. If the transaction fails, it will also be the address to receive l2Value. |
| `transaction.overrides?` | `ethers.PayableOverrides` | Transaction's overrides which may be used to pass L1 `gasLimit`, `gasPrice`, `value`, etc. |
| `transaction.approveOverrides?` | `ethers.Overrides` | Transaction's overrides which may be used to pass L1 `gasLimit`, `gasPrice`, `value`, etc. |
Expand Down Expand Up @@ -243,7 +243,7 @@ Gas of approving ERC20 token is not included in estimation.
| `transaction.operatorTip?` | `BigNumberish` | (_currently is not used_) If the ETH value passed with the transaction is not explicitly stated in the overrides, <br/>this field will be equal to the tip the operator will receive on top of the base cost of the transaction. |
| `transaction.bridgeAddress?` | `Address` | The address of the bridge contract to be used. Defaults to the default ZKsync bridge (either `L1EthBridge` or `L1Erc20Bridge`). |
| `transaction.l2GasLimit?` | `BigNumberish` | Maximum amount of L2 gas that transaction can consume during execution on L2. |
| `transaction.gasPerPubdataByte?` | `BigNumberish` | Whether or not should the token approval be performed under the hood. Set this flag to `true` if you bridge an ERC20 token and didn't call the `approveERC20` function beforehand. |
| `transaction.gasPerPubdataByte?` | `BigNumberish` | The L2 gas price for each published L1 calldata byte. |
| `transaction.customBridgeData?` | `BytesLike` | Additional data that can be sent to a bridge. |
| `transaction.refundRecipient?` | `Address` | The address on L2 that will receive the refund for the transaction. If the transaction fails, it will also be the address to receive l2Value. |
| `transaction.overrides?` | `ethers.PayableOverrides` | Transaction's overrides which may be used to pass L1 `gasLimit`, `gasPrice`, `value`, etc. |
Expand Down Expand Up @@ -684,7 +684,7 @@ Returns populated deposit transaction.
| `transaction.operatorTip?` | `BigNumberish` | (_currently is not used_) If the ETH value passed with the transaction is not explicitly stated in the overrides, <br/>this field will be equal to the tip the operator will receive on top of the base cost of the transaction. |
| `transaction.bridgeAddress?` | `Address` | The address of the bridge contract to be used. Defaults to the default ZKsync bridge (either `L1EthBridge` or `L1Erc20Bridge`). |
| `transaction.l2GasLimit?` | `BigNumberish` | Maximum amount of L2 gas that transaction can consume during execution on L2. |
| `transaction.gasPerPubdataByte?` | `BigNumberish` | Whether or not should the token approval be performed under the hood. Set this flag to `true` if you bridge an ERC20 token and didn't call the `approveERC20` function beforehand. |
| `transaction.gasPerPubdataByte?` | `BigNumberish` | The L2 gas price for each published L1 calldata byte. |
| `transaction.customBridgeData?` | `BytesLike` | Additional data that can be sent to a bridge. |
| `transaction.refundRecipient?` | `Address` | The address on L2 that will receive the refund for the transaction. If the transaction fails, it will also be the address to receive l2Value. |
| `transaction.overrides?` | `ethers.PayableOverrides` | Transaction's overrides which may be used to pass L1 `gasLimit`, `gasPrice`, `value`, etc. |
Expand Down Expand Up @@ -732,7 +732,7 @@ Retrieves the full needed ETH fee for the deposit. Returns the L1 fee and the L2
| `transaction.to?` | `Address` | The address that will receive the deposited tokens on L2. |
| `transaction.bridgeAddress?` | `Address` | The address of the bridge contract to be used. Defaults to the default ZKsync bridge (either `L1EthBridge` or `L1Erc20Bridge`). |
| `transaction.customBridgeData?` | `BytesLike` | Additional data that can be sent to a bridge. |
| `transaction.gasPerPubdataByte?` | `BigNumberish` | Whether or not should the token approval be performed under the hood. Set this flag to `true` if you bridge an ERC20 token and didn't call the `approveERC20` function beforehand. |
| `transaction.gasPerPubdataByte?` | `BigNumberish` | The L2 gas price for each published L1 calldata byte. |
| `transaction.overrides?` | `ethers.PayableOverrides` | Transaction's overrides which may be used to pass L1 `gasLimit`, `gasPrice`, `value`, etc. |

```ts
Expand Down
Loading
Loading