Skip to main content

erc20Bridger

Classes

AdminErc20Bridger

Admin functionality for the token bridge

Extends

Constructors

new AdminErc20Bridger()
new AdminErc20Bridger(childNetwork: ArbitrumNetwork): AdminErc20Bridger

Bridger for moving ERC20 tokens back and forth between parent-to-child

Parameters
ParameterType
childNetworkArbitrumNetwork
Returns

AdminErc20Bridger

Inherited from

Erc20Bridger . constructor

Source

assetBridger/erc20Bridger.ts:205

Properties

PropertyModifierTypeDescriptionInherited from
nativeToken?readonlystringIn 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 network as its native/gas token, this is the address of said token on the parent network
Erc20Bridger.nativeToken

Accessors

nativeTokenIsEth
get protected nativeTokenIsEth(): boolean

Whether the chain uses ETH as its native/gas token

Returns

boolean

Source

assetBridger/assetBridger.ts:72

Methods

approveGasToken()
approveGasToken(params: ApproveParamsOrTxRequest): Promise<ContractTransaction>

Approves the custom gas token to be spent by the relevant gateway on the parent network

Parameters
ParameterTypeDescription
paramsApproveParamsOrTxRequest
Returns

Promise<ContractTransaction>

Inherited from

Erc20Bridger . approveGasToken

Source

assetBridger/erc20Bridger.ts:276

approveToken()
approveToken(params: ApproveParamsOrTxRequest): Promise<ContractTransaction>

Approve tokens for deposit to the bridge. The tokens will be approved for the relevant gateway.

Parameters
ParameterTypeDescription
paramsApproveParamsOrTxRequest
Returns

Promise<ContractTransaction>

Inherited from

Erc20Bridger . approveToken

Source

assetBridger/erc20Bridger.ts:339

checkChildNetwork()
protected checkChildNetwork(sop: SignerOrProvider): Promise<void>

Check the signer/provider matches the child network, throws if not

Parameters
ParameterTypeDescription
sopSignerOrProvider
Returns

Promise<void>

Inherited from

Erc20Bridger . checkChildNetwork

Source

assetBridger/assetBridger.ts:61

checkParentNetwork()
protected checkParentNetwork(sop: SignerOrProvider): Promise<void>

Check the signer/provider matches the parent network, throws if not

Parameters
ParameterTypeDescription
sopSignerOrProvider
Returns

Promise<void>

Inherited from

Erc20Bridger . checkParentNetwork

Source

assetBridger/assetBridger.ts:50

deposit()
deposit(params: Erc20DepositParams | ParentToChildTxReqAndSignerProvider): Promise<ParentContractCallTransaction>

Execute a token deposit from parent to child network

Parameters
ParameterTypeDescription
paramsErc20DepositParams | ParentToChildTxReqAndSignerProvider
Returns

Promise<ParentContractCallTransaction>

Inherited from

Erc20Bridger . deposit

Source

assetBridger/erc20Bridger.ts:769

getApproveGasTokenRequest()
getApproveGasTokenRequest(params: ProviderTokenApproveParams): Promise<Required<Pick<TransactionRequest, "data" | "value" | "to">>>

Creates a transaction request for approving the custom gas token to be spent by the relevant gateway on the parent network

Parameters
ParameterTypeDescription
paramsProviderTokenApproveParams
Returns

Promise<Required<Pick<TransactionRequest, "data" | "value" | "to">>>

Inherited from

Erc20Bridger . getApproveGasTokenRequest

Source

assetBridger/erc20Bridger.ts:260

getApproveTokenRequest()
getApproveTokenRequest(params: ProviderTokenApproveParams): Promise<Required<Pick<TransactionRequest, "data" | "value" | "to">>>

Get a tx request to approve tokens for deposit to the bridge. The tokens will be approved for the relevant gateway.

Parameters
ParameterTypeDescription
paramsProviderTokenApproveParams
Returns

Promise<Required<Pick<TransactionRequest, "data" | "value" | "to">>>

Inherited from

Erc20Bridger . getApproveTokenRequest

Source

assetBridger/erc20Bridger.ts:306

getChildErc20Address()
getChildErc20Address(erc20ParentAddress: string, parentProvider: Provider): Promise<string>

Get the corresponding child network token address for the provided parent network token

Parameters
ParameterTypeDescription
erc20ParentAddressstring
parentProviderProvider
Returns

Promise<string>

Inherited from

Erc20Bridger . getChildErc20Address

Source

assetBridger/erc20Bridger.ts:491

getChildGatewayAddress()
getChildGatewayAddress(erc20ParentAddress: string, childProvider: Provider): Promise<string>

Get the address of the child gateway for this token

Parameters
ParameterTypeDescription
erc20ParentAddressstring
childProviderProvider
Returns

Promise<string>

Inherited from

Erc20Bridger . getChildGatewayAddress

Source

assetBridger/erc20Bridger.ts:244

getChildGatewaySetEvents()
getChildGatewaySetEvents(
childProvider: Provider,
filter: object,
customNetworkChildGatewayRouter?: string): Promise<object[]>

Get all the gateway set events on the child gateway router

Parameters
ParameterTypeDescription
childProviderProviderThe provider for the child network
filterobjectAn object containing fromBlock and toBlock to filter events
filter.fromBlockBlockTag-
filter.toBlock?BlockTag-
customNetworkChildGatewayRouter?stringOptional address of the custom network child gateway router
Returns

Promise<object[]>

An array of GatewaySetEvent event arguments

Throws

If the network is custom and customNetworkChildGatewayRouter is not provided

Source

assetBridger/erc20Bridger.ts:1233

getChildTokenContract()
getChildTokenContract(childProvider: Provider, childTokenAddr: string): L2GatewayToken

Get the child network token contract at the provided address Note: This function just returns a typed ethers object for the provided address, it doesn't check the underlying form of the contract bytecode to see if it's an erc20, and doesn't ensure the validity of any of the underlying functions on that contract.

Parameters
ParameterTypeDescription
childProviderProvider
childTokenAddrstring
Returns

L2GatewayToken

Inherited from

Erc20Bridger . getChildTokenContract

Source

assetBridger/erc20Bridger.ts:462

getDepositRequest()
getDepositRequest(params: DepositRequest): Promise<ParentToChildTransactionRequest>

Get the arguments for calling the deposit function

Parameters
ParameterTypeDescription
paramsDepositRequest
Returns

Promise <ParentToChildTransactionRequest>

Inherited from

Erc20Bridger . getDepositRequest

Source

assetBridger/erc20Bridger.ts:655

getParentErc20Address()
getParentErc20Address(erc20ChildChainAddress: string, childProvider: Provider): Promise<string>

Get the corresponding parent network address for the provided child network token Validates the returned address against the child network router to ensure it is correctly mapped to the provided erc20ChildChainAddress

Parameters
ParameterTypeDescription
erc20ChildChainAddressstring
childProviderProvider
Returns

Promise<string>

Inherited from

Erc20Bridger . getParentErc20Address

Source

assetBridger/erc20Bridger.ts:514

getParentGatewayAddress()
getParentGatewayAddress(erc20ParentAddress: string, parentProvider: Provider): Promise<string>

Get the address of the parent gateway for this token

Parameters
ParameterTypeDescription
erc20ParentAddressstring
parentProviderProvider
Returns

Promise<string>

Inherited from

Erc20Bridger . getParentGatewayAddress

Source

assetBridger/erc20Bridger.ts:226

getParentGatewaySetEvents()
getParentGatewaySetEvents(parentProvider: Provider, filter: object): Promise<object[]>

Get all the gateway set events on the Parent gateway router

Parameters
ParameterTypeDescription
parentProviderProviderThe provider for the parent network
filterobjectAn object containing fromBlock and toBlock to filter events
filter.fromBlockBlockTag-
filter.toBlockBlockTag-
Returns

Promise<object[]>

An array of GatewaySetEvent event arguments

Source

assetBridger/erc20Bridger.ts:1207

getParentTokenContract()
getParentTokenContract(parentProvider: Provider, parentTokenAddr: string): ERC20

Get the parent token contract at the provided address Note: This function just returns a typed ethers object for the provided address, it doesnt check the underlying form of the contract bytecode to see if it's an erc20, and doesn't ensure the validity of any of the underlying functions on that contract.

Parameters
ParameterTypeDescription
parentProviderProvider
parentTokenAddrstring
Returns

ERC20

Inherited from

Erc20Bridger . getParentTokenContract

Source

assetBridger/erc20Bridger.ts:478

getWithdrawalEvents()
getWithdrawalEvents(
childProvider: Provider,
gatewayAddress: string,
filter: object,
parentTokenAddress?: string,
fromAddress?: string,
toAddress?: string): Promise<object & object[]>

Get the child network events created by a withdrawal

Parameters
ParameterTypeDescription
childProviderProvider
gatewayAddressstring
filterobject
filter.fromBlockBlockTag-
filter.toBlock?BlockTag-
parentTokenAddress?string
fromAddress?string
toAddress?string-
Returns

Promise<object & object[]>

Inherited from

Erc20Bridger . getWithdrawalEvents

Source

assetBridger/erc20Bridger.ts:367

getWithdrawalRequest()
getWithdrawalRequest(params: Erc20WithdrawParams): Promise<ChildToParentTransactionRequest>

Get the arguments for calling the token withdrawal function

Parameters
ParameterTypeDescription
paramsErc20WithdrawParams
Returns

Promise <ChildToParentTransactionRequest>

Inherited from

Erc20Bridger . getWithdrawalRequest

Source

assetBridger/erc20Bridger.ts:826

isDepositDisabled()
isDepositDisabled(parentTokenAddress: string, parentProvider: Provider): Promise<boolean>

Whether the token has been disabled on the router

Parameters
ParameterTypeDescription
parentTokenAddressstring
parentProviderProvider
Returns

Promise<boolean>

Inherited from

Erc20Bridger . isDepositDisabled

Source

assetBridger/erc20Bridger.ts:560

isRegistered()
isRegistered(params: object): Promise<boolean>

Checks if the token has been properly registered on both gateways. Mostly useful for tokens that use a custom gateway.

Parameters
ParameterTypeDescription
paramsobject
params.childProviderProvider
params.erc20ParentAddressstring
params.parentProviderProvider
Returns

Promise<boolean>

Inherited from

Erc20Bridger . isRegistered

Source

assetBridger/erc20Bridger.ts:924

registerCustomToken()
registerCustomToken(
parentTokenAddress: string,
childTokenAddress: string,
parentSigner: Signer,
childProvider: Provider): Promise<ParentContractTransaction<ParentTransactionReceipt>>

Register a custom token on the Arbitrum bridge See https://developer.offchainlabs.com/docs/bridging_assets#the-arbitrum-generic-custom-gateway for more details

Parameters
ParameterTypeDescription
parentTokenAddressstringAddress of the already deployed parent token. Must inherit from https://developer.offchainlabs.com/docs/sol_contract_docs/md_docs/arb-bridge-peripherals/tokenbridge/ethereum/icustomtoken.
childTokenAddressstringAddress of the already deployed child token. Must inherit from https://developer.offchainlabs.com/docs/sol_contract_docs/md_docs/arb-bridge-peripherals/tokenbridge/arbitrum/iarbtoken.
parentSignerSignerThe signer with the rights to call registerTokenOnL2 on the parent token
childProviderProviderArbitrum rpc provider
Returns

Promise<ParentContractTransaction<ParentTransactionReceipt>>

Source

assetBridger/erc20Bridger.ts:1035

setGateways()
setGateways(
parentSigner: Signer,
childProvider: Provider,
tokenGateways: TokenAndGateway[],
options?: GasOverrides): Promise<ParentContractCallTransaction>

Register the provided token addresses against the provided gateways

Parameters
ParameterTypeDescription
parentSignerSigner
childProviderProvider
tokenGatewaysTokenAndGateway[]
options?GasOverrides-
Returns

Promise<ParentContractCallTransaction>

Source

assetBridger/erc20Bridger.ts:1266

withdraw()
withdraw(params: ChildToParentTxReqAndSigner | OmitTyped<Erc20WithdrawParams, "from"> & object): Promise<ChildContractTransaction>

Withdraw tokens from child to parent network

Parameters
ParameterTypeDescription
paramsChildToParentTxReqAndSigner | OmitTyped<Erc20WithdrawParams, "from"> & object
Returns

Promise<ChildContractTransaction>

Inherited from

Erc20Bridger . withdraw

Source

assetBridger/erc20Bridger.ts:889

fromProvider()
static fromProvider(childProvider: Provider): Promise<Erc20Bridger>

Instantiates a new Erc20Bridger from a child provider

Parameters
ParameterTypeDescription
childProviderProvider
Returns

Promise <Erc20Bridger>

Inherited from

Erc20Bridger . fromProvider

Source

assetBridger/erc20Bridger.ts:216


Erc20Bridger

Bridger for moving ERC20 tokens back and forth between parent-to-child

Extends

Extended by

Constructors

new Erc20Bridger()
new Erc20Bridger(childNetwork: ArbitrumNetwork): Erc20Bridger

Bridger for moving ERC20 tokens back and forth between parent-to-child

Parameters
ParameterType
childNetworkArbitrumNetwork
Returns

Erc20Bridger

Overrides

AssetBridger< Erc20DepositParams | ParentToChildTxReqAndSignerProvider, OmitTyped<Erc20WithdrawParams, 'from'> | ChildToParentTransactionRequest >.constructor

Source

assetBridger/erc20Bridger.ts:205

Properties

PropertyModifierTypeDescriptionInherited from
nativeToken?readonlystringIn 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 network as its native/gas token, this is the address of said token on the parent network
AssetBridger.nativeToken

Accessors

nativeTokenIsEth
get protected nativeTokenIsEth(): boolean

Whether the chain uses ETH as its native/gas token

Returns

boolean

Source

assetBridger/assetBridger.ts:72

Methods

approveGasToken()
approveGasToken(params: ApproveParamsOrTxRequest): Promise<ContractTransaction>

Approves the custom gas token to be spent by the relevant gateway on the parent network

Parameters
ParameterTypeDescription
paramsApproveParamsOrTxRequest
Returns

Promise<ContractTransaction>

Source

assetBridger/erc20Bridger.ts:276

approveToken()
approveToken(params: ApproveParamsOrTxRequest): Promise<ContractTransaction>

Approve tokens for deposit to the bridge. The tokens will be approved for the relevant gateway.

Parameters
ParameterTypeDescription
paramsApproveParamsOrTxRequest
Returns

Promise<ContractTransaction>

Source

assetBridger/erc20Bridger.ts:339

checkChildNetwork()
protected checkChildNetwork(sop: SignerOrProvider): Promise<void>

Check the signer/provider matches the child network, throws if not

Parameters
ParameterTypeDescription
sopSignerOrProvider
Returns

Promise<void>

Inherited from

AssetBridger . checkChildNetwork

Source

assetBridger/assetBridger.ts:61

checkParentNetwork()
protected checkParentNetwork(sop: SignerOrProvider): Promise<void>

Check the signer/provider matches the parent network, throws if not

Parameters
ParameterTypeDescription
sopSignerOrProvider
Returns

Promise<void>

Inherited from

AssetBridger . checkParentNetwork

Source

assetBridger/assetBridger.ts:50

deposit()
deposit(params: Erc20DepositParams | ParentToChildTxReqAndSignerProvider): Promise<ParentContractCallTransaction>

Execute a token deposit from parent to child network

Parameters
ParameterTypeDescription
paramsErc20DepositParams | ParentToChildTxReqAndSignerProvider
Returns

Promise<ParentContractCallTransaction>

Overrides

AssetBridger . deposit

Source

assetBridger/erc20Bridger.ts:769

getApproveGasTokenRequest()
getApproveGasTokenRequest(params: ProviderTokenApproveParams): Promise<Required<Pick<TransactionRequest, "data" | "value" | "to">>>

Creates a transaction request for approving the custom gas token to be spent by the relevant gateway on the parent network

Parameters
ParameterTypeDescription
paramsProviderTokenApproveParams
Returns

Promise<Required<Pick<TransactionRequest, "data" | "value" | "to">>>

Source

assetBridger/erc20Bridger.ts:260

getApproveTokenRequest()
getApproveTokenRequest(params: ProviderTokenApproveParams): Promise<Required<Pick<TransactionRequest, "data" | "value" | "to">>>

Get a tx request to approve tokens for deposit to the bridge. The tokens will be approved for the relevant gateway.

Parameters
ParameterTypeDescription
paramsProviderTokenApproveParams
Returns

Promise<Required<Pick<TransactionRequest, "data" | "value" | "to">>>

Source

assetBridger/erc20Bridger.ts:306

getChildErc20Address()
getChildErc20Address(erc20ParentAddress: string, parentProvider: Provider): Promise<string>

Get the corresponding child network token address for the provided parent network token

Parameters
ParameterTypeDescription
erc20ParentAddressstring
parentProviderProvider
Returns

Promise<string>

Source

assetBridger/erc20Bridger.ts:491

getChildGatewayAddress()
getChildGatewayAddress(erc20ParentAddress: string, childProvider: Provider): Promise<string>

Get the address of the child gateway for this token

Parameters
ParameterTypeDescription
erc20ParentAddressstring
childProviderProvider
Returns

Promise<string>

Source

assetBridger/erc20Bridger.ts:244

getChildTokenContract()
getChildTokenContract(childProvider: Provider, childTokenAddr: string): L2GatewayToken

Get the child network token contract at the provided address Note: This function just returns a typed ethers object for the provided address, it doesn't check the underlying form of the contract bytecode to see if it's an erc20, and doesn't ensure the validity of any of the underlying functions on that contract.

Parameters
ParameterTypeDescription
childProviderProvider
childTokenAddrstring
Returns

L2GatewayToken

Source

assetBridger/erc20Bridger.ts:462

getDepositRequest()
getDepositRequest(params: DepositRequest): Promise<ParentToChildTransactionRequest>

Get the arguments for calling the deposit function

Parameters
ParameterTypeDescription
paramsDepositRequest
Returns

Promise <ParentToChildTransactionRequest>

Source

assetBridger/erc20Bridger.ts:655

getDepositRequestCallValue()
private getDepositRequestCallValue(depositParams: OmitTyped<ParentToChildMessageGasParams, "deposit">): BigNumber | BigNumber

Get the call value for the deposit transaction request

Parameters
ParameterTypeDescription
depositParamsOmitTyped<ParentToChildMessageGasParams, "deposit">
Returns

BigNumber | BigNumber

Source

assetBridger/erc20Bridger.ts:593

getDepositRequestOutboundTransferInnerData()
private getDepositRequestOutboundTransferInnerData(depositParams: OmitTyped<ParentToChildMessageGasParams, "deposit">, decimals: number): string

Get the data param for call to outboundTransfer

Parameters
ParameterTypeDescription
depositParamsOmitTyped<ParentToChildMessageGasParams, "deposit">
decimalsnumber-
Returns

string

Source

assetBridger/erc20Bridger.ts:616

getParentErc20Address()
getParentErc20Address(erc20ChildChainAddress: string, childProvider: Provider): Promise<string>

Get the corresponding parent network address for the provided child network token Validates the returned address against the child network router to ensure it is correctly mapped to the provided erc20ChildChainAddress

Parameters
ParameterTypeDescription
erc20ChildChainAddressstring
childProviderProvider
Returns

Promise<string>

Source

assetBridger/erc20Bridger.ts:514

getParentGatewayAddress()
getParentGatewayAddress(erc20ParentAddress: string, parentProvider: Provider): Promise<string>

Get the address of the parent gateway for this token

Parameters
ParameterTypeDescription
erc20ParentAddressstring
parentProviderProvider
Returns

Promise<string>

Source

assetBridger/erc20Bridger.ts:226

getParentTokenContract()
getParentTokenContract(parentProvider: Provider, parentTokenAddr: string): ERC20

Get the parent token contract at the provided address Note: This function just returns a typed ethers object for the provided address, it doesnt check the underlying form of the contract bytecode to see if it's an erc20, and doesn't ensure the validity of any of the underlying functions on that contract.

Parameters
ParameterTypeDescription
parentProviderProvider
parentTokenAddrstring
Returns

ERC20

Source

assetBridger/erc20Bridger.ts:478

getWithdrawalEvents()
getWithdrawalEvents(
childProvider: Provider,
gatewayAddress: string,
filter: object,
parentTokenAddress?: string,
fromAddress?: string,
toAddress?: string): Promise<object & object[]>

Get the child network events created by a withdrawal

Parameters
ParameterTypeDescription
childProviderProvider
gatewayAddressstring
filterobject
filter.fromBlockBlockTag-
filter.toBlock?BlockTag-
parentTokenAddress?string
fromAddress?string
toAddress?string-
Returns

Promise<object & object[]>

Source

assetBridger/erc20Bridger.ts:367

getWithdrawalRequest()
getWithdrawalRequest(params: Erc20WithdrawParams): Promise<ChildToParentTransactionRequest>

Get the arguments for calling the token withdrawal function

Parameters
ParameterTypeDescription
paramsErc20WithdrawParams
Returns

Promise <ChildToParentTransactionRequest>

Source

assetBridger/erc20Bridger.ts:826

isDepositDisabled()
isDepositDisabled(parentTokenAddress: string, parentProvider: Provider): Promise<boolean>

Whether the token has been disabled on the router

Parameters
ParameterTypeDescription
parentTokenAddressstring
parentProviderProvider
Returns

Promise<boolean>

Source

assetBridger/erc20Bridger.ts:560

isRegistered()
isRegistered(params: object): Promise<boolean>

Checks if the token has been properly registered on both gateways. Mostly useful for tokens that use a custom gateway.

Parameters
ParameterTypeDescription
paramsobject
params.childProviderProvider
params.erc20ParentAddressstring
params.parentProviderProvider
Returns

Promise<boolean>

Source

assetBridger/erc20Bridger.ts:924

isWethGateway()
private isWethGateway(gatewayAddress: string, parentProvider: Provider): Promise<boolean>

Is this a known or unknown WETH gateway

Parameters
ParameterTypeDescription
gatewayAddressstring
parentProviderProvider
Returns

Promise<boolean>

Source

assetBridger/erc20Bridger.ts:436

looksLikeWethGateway()
private looksLikeWethGateway(potentialWethGatewayAddress: string, parentProvider: Provider): Promise<boolean>

Does the provided address look like a weth gateway

Parameters
ParameterTypeDescription
potentialWethGatewayAddressstring
parentProviderProvider
Returns

Promise<boolean>

Source

assetBridger/erc20Bridger.ts:406

withdraw()
withdraw(params: ChildToParentTxReqAndSigner | OmitTyped<Erc20WithdrawParams, "from"> & object): Promise<ChildContractTransaction>

Withdraw tokens from child to parent network

Parameters
ParameterTypeDescription
paramsChildToParentTxReqAndSigner | OmitTyped<Erc20WithdrawParams, "from"> & object
Returns

Promise<ChildContractTransaction>

Overrides

AssetBridger . withdraw

Source

assetBridger/erc20Bridger.ts:889

fromProvider()
static fromProvider(childProvider: Provider): Promise<Erc20Bridger>

Instantiates a new Erc20Bridger from a child provider

Parameters
ParameterTypeDescription
childProviderProvider
Returns

Promise <Erc20Bridger>

Source

assetBridger/erc20Bridger.ts:216