ethBridger
Classes
EthBridger
Bridger for moving ETH back and forth between L1 to L2
Extends
AssetBridger<EthDepositParams|EthDepositToParams|L1ToL2TxReqAndSigner,EthWithdrawParams|L2ToL1TxReqAndSigner>
Properties
| Property | Modifier | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|---|
l1Network | readonly | L1Network | L2Network | Parent chain for the given Arbitrum chain, can be an L1 or an L2 | AssetBridger.l1Network | assetBridger/assetBridger.ts:41 |
nativeToken? | readonly | string | In case of a chain that uses ETH as its native/gas token, this is either undefined or the zero address In case of a chain that uses an ERC-20 token from the parent chain as its native/gas token, this is the address of said token on the parent chain | AssetBridger.nativeToken | assetBridger/assetBridger.ts:48 |
Accessors
nativeTokenIsEth
get protected nativeTokenIsEth(): boolean
Whether the chain uses ETH as its native/gas token
Returns
boolean
Inherited from
AssetBridger . nativeTokenIsEth
Defined in
assetBridger/assetBridger.ts:75
Methods
approveGasToken()
approveGasToken(params: WithL1Signer<ApproveGasTokenParamsOrTxRequest>): Promise<TransactionResponse>
Approves the custom gas token to be spent by the Inbox on the parent chain.
Parameters
| Parameter | Type | Description |
|---|---|---|
params | WithL1Signer<ApproveGasTokenParamsOrTxRequest> |
Returns
Promise<TransactionResponse>
Defined in
assetBridger/ethBridger.ts:219
checkL1Network()
protected checkL1Network(sop: SignerOrProvider): Promise<void>
Check the signer/provider matches the l1Network, throws if not
Parameters
| Parameter | Type | Description |
|---|---|---|
sop | SignerOrProvider |
Returns
Promise<void>
Inherited from
Defined in
assetBridger/assetBridger.ts:59
checkL2Network()
protected checkL2Network(sop: SignerOrProvider): Promise<void>
Check the signer/provider matches the l2Network, throws if not
Parameters
| Parameter | Type | Description |
|---|---|---|
sop | SignerOrProvider |
Returns
Promise<void>
Inherited from
Defined in
assetBridger/assetBridger.ts:67
deposit()
deposit(params: EthDepositParams | L1ToL2TxReqAndSigner): Promise<L1EthDepositTransaction>
Deposit ETH from L1 onto L2
Parameters
| Parameter | Type | Description |
|---|---|---|
params | EthDepositParams | L1ToL2TxReqAndSigner |
Returns
Promise<L1EthDepositTransaction>
Overrides
Defined in
assetBridger/ethBridger.ts:287
depositTo()
depositTo(params: EthDepositToParams | L1ToL2TransactionRequest & object & object): Promise<L1ContractCallTransaction>
Deposit ETH from L1 onto a different L2 address
Parameters
| Parameter | Type | Description |
|---|---|---|
params | EthDepositToParams | L1ToL2TransactionRequest & object & object |
Returns
Promise<L1ContractCallTransaction>
Defined in
assetBridger/ethBridger.ts:339
getApproveGasTokenRequest()
getApproveGasTokenRequest(params?: ApproveGasTokenParams): Required<Pick<TransactionRequest, "data" | "value" | "to">>
Creates a transaction request for approving the custom gas token to be spent by the inbox on the parent chain
Parameters
| Parameter | Type | Description |
|---|---|---|
params? | ApproveGasTokenParams |
Returns
Required<Pick<TransactionRequest, "data" | "value" | "to">>
Defined in
assetBridger/ethBridger.ts:191
getDepositRequest()
getDepositRequest(params: EthDepositRequestParams): Promise<OmitTyped<L1ToL2TransactionRequest, "retryableData">>
Gets tx request for depositing ETH or custom gas token
Parameters
| Parameter | Type | Description |
|---|---|---|
params | EthDepositRequestParams |
Returns
Promise <OmitTyped <L1ToL2TransactionRequest, "retryableData">>
Defined in
assetBridger/ethBridger.ts:268
getDepositToRequest()
getDepositToRequest(params: EthDepositToRequestParams): Promise<L1ToL2TransactionRequest>
Get a transaction request for an ETH deposit to a different L2 address using Retryables
Parameters
| Parameter | Type | Description |
|---|---|---|
params | EthDepositToRequestParams |
Returns
Promise <L1ToL2TransactionRequest>
Defined in
assetBridger/ethBridger.ts:312
getWithdrawalRequest()
getWithdrawalRequest(params: EthWithdrawParams): Promise<L2ToL1TransactionRequest>
Get a transaction request for an eth withdrawal
Parameters
| Parameter | Type | Description |
|---|---|---|
params | EthWithdrawParams |
Returns
Promise <L2ToL1TransactionRequest>
Defined in
assetBridger/ethBridger.ts:370
withdraw()
withdraw(params: L2ToL1TxReqAndSigner | EthWithdrawParams & object): Promise<L2ContractTransaction>
Withdraw ETH from L2 onto L1
Parameters
| Parameter | Type | Description |
|---|---|---|
params | L2ToL1TxReqAndSigner | EthWithdrawParams & object |
Returns
Promise<L2ContractTransaction>
Overrides
Defined in
assetBridger/ethBridger.ts:406
fromProvider()
static fromProvider(l2Provider: Provider): Promise<EthBridger>
Instantiates a new EthBridger from an L2 Provider
Parameters
| Parameter | Type | Description |
|---|---|---|
l2Provider | Provider |
Returns
Promise <EthBridger>