Module: assetBridger/assetBridger
AssetBridger
Base for bridging assets from parent-to-child and back
Extended By
Type parameters
| Parameter |
|---|
DepositParams |
WithdrawParams |
Properties
| Property | Type | Description |
|---|---|---|
nativeToken? | string | In case of a chain that uses ETH as its native/gas token, this is either undefined or the zero addressIn 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
protected get nativeTokenIsEth(): boolean
Source
arbitrum-sdk/src/lib/assetBridger/assetBridger.ts:68
Methods
checkChildChain()
protected checkChildChain(sop): Promise< void >
Check the signer/provider matches the childChain, throws if not
Parameters
| Parameter | Type | Description |
|---|---|---|
sop | SignerOrProvider |
Returns
Promise< void >
Source
arbitrum-sdk/src/lib/assetBridger/assetBridger.ts:60
checkParentChain()
protected checkParentChain(sop): Promise< void >
Check the signer/provider matches the parentChain, throws if not
Parameters
| Parameter | Type | Description |
|---|---|---|
sop | SignerOrProvider |
Returns
Promise< void >
Source
arbitrum-sdk/src/lib/assetBridger/assetBridger.ts:49
deposit()
abstract deposit(params): Promise< ParentContractTransaction< ParentTransactionReceipt > >
Transfer assets from parent-to-child
Parameters
| Parameter | Type | Description |
|---|---|---|
params | DepositParams |
Returns
Promise< ParentContractTransaction< ParentTransactionReceipt > >
Source
arbitrum-sdk/src/lib/assetBridger/assetBridger.ts:76
withdraw()
abstract withdraw(params): Promise< ChildContractTransaction >
Transfer assets from child-to-parent
Parameters
| Parameter | Type | Description |
|---|---|---|
params | WithdrawParams |
Returns
Promise< ChildContractTransaction >