assetBridger
Classes
abstract AssetBridger<DepositParams, WithdrawParams>
Base for bridging assets from l1 to l2 and back
Extended by
Type parameters
| Type parameter |
|---|
DepositParams |
WithdrawParams |
Properties
| Property | Modifier | Type | Description |
|---|---|---|---|
l1Network | readonly | L1Network | L2Network | Parent chain for the given Arbitrum chain, can be an L1 or an L2 |
nativeToken? | readonly | string | In case of a chain that uses ETH as its native/gas token, this is either 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 |
Accessors
nativeTokenIsEth
get protected nativeTokenIsEth(): boolean
Whether the chain uses ETH as its native/gas token
Returns
boolean
Source
assetBridger/assetBridger.ts:75
Methods
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>
Source
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>
Source
assetBridger/assetBridger.ts:67
deposit()
abstract deposit(params: DepositParams): Promise<L1ContractTransaction<L1TransactionReceipt>>
Transfer assets from L1 to L2
Parameters
| Parameter | Type | Description |
|---|---|---|
params | DepositParams |
Returns
Promise<L1ContractTransaction<L1TransactionReceipt>>
Source
assetBridger/assetBridger.ts:83
withdraw()
abstract withdraw(params: WithdrawParams): Promise<L2ContractTransaction>
Transfer assets from L2 to L1
Parameters
| Parameter | Type | Description |
|---|---|---|
params | WithdrawParams |
Returns
Promise<L2ContractTransaction>