StandardBridgeAdapter | @constellation-labs/sdk

Bridge adapter for any token bridge that uses the standard token bridge interface.

Hierarchy

StandardBridgeAdapter
- ETHBridgeAdapter
- DAIBridgeAdapter

Implements

IBridgeAdapter

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new StandardBridgeAdapter(opts: { l1Bridge: AddressLike; l2Bridge: AddressLike; messenger: ICrossChainMessenger }): StandardBridgeAdapter

- Defined in packages/sdk/src/adapters/standard-bridge.ts:45
Creates a StandardBridgeAdapter instance.

Parameters
- opts: { l1Bridge: AddressLike; l2Bridge: AddressLike; messenger: ICrossChainMessenger }
  
  Options for the adapter.
  - l1Bridge: AddressLike
    
    L1 bridge contract.
  - l2Bridge: AddressLike
    
    L2 bridge contract.
  - messenger: ICrossChainMessenger
    
    Provider used to make queries related to cross-chain interactions.
Returns StandardBridgeAdapter

Properties

estimateGas

estimateGas: { approve: (l1Token: AddressLike, l2Token: AddressLike, amount: NumberLike, opts?: { overrides?: CallOverrides }) => Promise<BigNumber>; deposit: (l1Token: AddressLike, l2Token: AddressLike, amount: NumberLike, opts?: { l2GasLimit?: NumberLike; overrides?: CallOverrides; recipient?: AddressLike }) => Promise<BigNumber>; withdraw: (l1Token: AddressLike, l2Token: AddressLike, amount: NumberLike, opts?: { overrides?: CallOverrides; recipient?: AddressLike }) => Promise<BigNumber> } = ...

Object that holds the functions that estimates the gas required for a given transaction. Follows the pattern used by ethers.js.

Type declaration

approve: (l1Token: AddressLike, l2Token: AddressLike, amount: NumberLike, opts?: { overrides?: CallOverrides }) => Promise<BigNumber>
- - (l1Token: AddressLike, l2Token: AddressLike, amount: NumberLike, opts?: { overrides?: CallOverrides }): Promise<BigNumber>
  - Parameters
    - l1Token: AddressLike
    - l2Token: AddressLike
    - amount: NumberLike
    - Optional opts: { overrides?: CallOverrides }
      - Optional overrides?: CallOverrides
    Returns Promise<BigNumber>
deposit: (l1Token: AddressLike, l2Token: AddressLike, amount: NumberLike, opts?: { l2GasLimit?: NumberLike; overrides?: CallOverrides; recipient?: AddressLike }) => Promise<BigNumber>
- - (l1Token: AddressLike, l2Token: AddressLike, amount: NumberLike, opts?: { l2GasLimit?: NumberLike; overrides?: CallOverrides; recipient?: AddressLike }): Promise<BigNumber>
  - Parameters
    - l1Token: AddressLike
    - l2Token: AddressLike
    - amount: NumberLike
    - Optional opts: { l2GasLimit?: NumberLike; overrides?: CallOverrides; recipient?: AddressLike }
      - Optional l2GasLimit?: NumberLike
      - Optional overrides?: CallOverrides
      - Optional recipient?: AddressLike
    Returns Promise<BigNumber>
withdraw: (l1Token: AddressLike, l2Token: AddressLike, amount: NumberLike, opts?: { overrides?: CallOverrides; recipient?: AddressLike }) => Promise<BigNumber>
- - (l1Token: AddressLike, l2Token: AddressLike, amount: NumberLike, opts?: { overrides?: CallOverrides; recipient?: AddressLike }): Promise<BigNumber>
  - Parameters
    - l1Token: AddressLike
    - l2Token: AddressLike
    - amount: NumberLike
    - Optional opts: { overrides?: CallOverrides; recipient?: AddressLike }
      - Optional overrides?: CallOverrides
      - Optional recipient?: AddressLike
    Returns Promise<BigNumber>

l1Bridge

l1Bridge: Contract

L1 bridge contract.

l2Bridge

l2Bridge: Contract

L2 bridge contract.

messenger

messenger: ICrossChainMessenger

Provider used to make queries related to cross-chain interactions.

populateTransaction

populateTransaction: { approve: (l1Token: AddressLike, l2Token: AddressLike, amount: NumberLike, opts?: { overrides?: Overrides }) => Promise<TransactionRequest>; deposit: (l1Token: AddressLike, l2Token: AddressLike, amount: NumberLike, opts?: { l2GasLimit?: NumberLike; overrides?: Overrides; recipient?: AddressLike }) => Promise<TransactionRequest>; withdraw: (l1Token: AddressLike, l2Token: AddressLike, amount: NumberLike, opts?: { overrides?: Overrides; recipient?: AddressLike }) => Promise<TransactionRequest> } = ...

Object that holds the functions that generate transactions to be signed by the user. Follows the pattern used by ethers.js.

Type declaration

approve: (l1Token: AddressLike, l2Token: AddressLike, amount: NumberLike, opts?: { overrides?: Overrides }) => Promise<TransactionRequest>
- - (l1Token: AddressLike, l2Token: AddressLike, amount: NumberLike, opts?: { overrides?: Overrides }): Promise<TransactionRequest>
  - Parameters
    - l1Token: AddressLike
    - l2Token: AddressLike
    - amount: NumberLike
    - Optional opts: { overrides?: Overrides }
      - Optional overrides?: Overrides
    Returns Promise<TransactionRequest>
deposit: (l1Token: AddressLike, l2Token: AddressLike, amount: NumberLike, opts?: { l2GasLimit?: NumberLike; overrides?: Overrides; recipient?: AddressLike }) => Promise<TransactionRequest>
- - (l1Token: AddressLike, l2Token: AddressLike, amount: NumberLike, opts?: { l2GasLimit?: NumberLike; overrides?: Overrides; recipient?: AddressLike }): Promise<TransactionRequest>
  - Parameters
    - l1Token: AddressLike
    - l2Token: AddressLike
    - amount: NumberLike
    - Optional opts: { l2GasLimit?: NumberLike; overrides?: Overrides; recipient?: AddressLike }
      - Optional l2GasLimit?: NumberLike
      - Optional overrides?: Overrides
      - Optional recipient?: AddressLike
    Returns Promise<TransactionRequest>
withdraw: (l1Token: AddressLike, l2Token: AddressLike, amount: NumberLike, opts?: { overrides?: Overrides; recipient?: AddressLike }) => Promise<TransactionRequest>
- - (l1Token: AddressLike, l2Token: AddressLike, amount: NumberLike, opts?: { overrides?: Overrides; recipient?: AddressLike }): Promise<TransactionRequest>
  - Parameters
    - l1Token: AddressLike
    - l2Token: AddressLike
    - amount: NumberLike
    - Optional opts: { overrides?: Overrides; recipient?: AddressLike }
      - Optional overrides?: Overrides
      - Optional recipient?: AddressLike
    Returns Promise<TransactionRequest>

Methods

approval

approval(l1Token: AddressLike, l2Token: AddressLike, signer: Signer): Promise<BigNumber>

Implementation of IBridgeAdapter.approval
- Defined in packages/sdk/src/adapters/standard-bridge.ts:198
Logics for bridges of various token standards are different, on a high level: ERC20, native: each token contract maintains a mapping of address -> amount ERC721: each token contract maintains a mapping of tokenId -> owner ERC1155: each token contract maintains a mapping of owner -> tokenId -> amount

Checkout contracts(ERC20, ERC721, ERC1155) for more details.

Parameters
- l1Token: AddressLike
- l2Token: AddressLike
- signer: Signer
Returns Promise<BigNumber>

approve

approve(l1Token: AddressLike, l2Token: AddressLike, signer: Signer, amount: NumberLike, opts?: { overrides?: Overrides }): Promise<TransactionResponse>

Implementation of IBridgeAdapter.approve
- Defined in packages/sdk/src/adapters/standard-bridge.ts:216
Parameters
- l1Token: AddressLike
- l2Token: AddressLike
- signer: Signer
- amount: NumberLike
- Optional opts: { overrides?: Overrides }
  - Optional overrides?: Overrides
Returns Promise<TransactionResponse>

deposit

deposit(l1Token: AddressLike, l2Token: AddressLike, signer: Signer, amount: NumberLike, opts?: { l2GasLimit?: NumberLike; overrides?: Overrides; recipient?: AddressLike }): Promise<TransactionResponse>

Implementation of IBridgeAdapter.deposit
- Defined in packages/sdk/src/adapters/standard-bridge.ts:230
Parameters
- l1Token: AddressLike
- l2Token: AddressLike
- signer: Signer
- amount: NumberLike
- Optional opts: { l2GasLimit?: NumberLike; overrides?: Overrides; recipient?: AddressLike }
  - Optional l2GasLimit?: NumberLike
  - Optional overrides?: Overrides
  - Optional recipient?: AddressLike
Returns Promise<TransactionResponse>

getDepositsByAddress

getDepositsByAddress(address: AddressLike, opts?: { fromBlock?: BlockTag; toBlock?: BlockTag }): Promise<TokenBridgeMessage[]>

Implementation of IBridgeAdapter.getDepositsByAddress
- Defined in packages/sdk/src/adapters/standard-bridge.ts:63
Gets all deposits for a given address.

Parameters
- address: AddressLike
- Optional opts: { fromBlock?: BlockTag; toBlock?: BlockTag }
  - Optional fromBlock?: BlockTag
  - Optional toBlock?: BlockTag
Returns Promise<TokenBridgeMessage[]>
All deposit token bridge messages sent by the given address.

getWithdrawalsByAddress

getWithdrawalsByAddress(address: AddressLike, opts?: { fromBlock?: BlockTag; toBlock?: BlockTag }): Promise<TokenBridgeMessage[]>

Implementation of IBridgeAdapter.getWithdrawalsByAddress
- Defined in packages/sdk/src/adapters/standard-bridge.ts:112
Gets all withdrawals for a given address.

Parameters
- address: AddressLike
- Optional opts: { fromBlock?: BlockTag; toBlock?: BlockTag }
  - Optional fromBlock?: BlockTag
  - Optional toBlock?: BlockTag
Returns Promise<TokenBridgeMessage[]>
All withdrawal token bridge messages sent by the given address.

supportsTokenPair

supportsTokenPair(l1Token: AddressLike, l2Token: AddressLike): Promise<boolean>

Implementation of IBridgeAdapter.supportsTokenPair
- Defined in packages/sdk/src/adapters/standard-bridge.ts:155
Checks whether the given token pair is supported by the bridge.

Parameters
- l1Token: AddressLike
- l2Token: AddressLike
Returns Promise<boolean>
Whether the given token pair is supported by the bridge.

withdraw

withdraw(l1Token: AddressLike, l2Token: AddressLike, signer: Signer, amount: NumberLike, opts?: { overrides?: Overrides; recipient?: AddressLike }): Promise<TransactionResponse>

Implementation of IBridgeAdapter.withdraw
- Defined in packages/sdk/src/adapters/standard-bridge.ts:246
Parameters
- l1Token: AddressLike
- l2Token: AddressLike
- signer: Signer
- amount: NumberLike
- Optional opts: { overrides?: Overrides; recipient?: AddressLike }
  - Optional overrides?: Overrides
  - Optional recipient?: AddressLike
Returns Promise<TransactionResponse>

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

opts: { l1Bridge: AddressLike; l2Bridge: AddressLike; messenger: ICrossChainMessenger }

l1Bridge: AddressLike

l2Bridge: AddressLike

messenger: ICrossChainMessenger

Returns StandardBridgeAdapter

Properties

estimateGas

Type declaration

approve: (l1Token: AddressLike, l2Token: AddressLike, amount: NumberLike, opts?: { overrides?: CallOverrides }) => Promise<BigNumber>

Parameters

l1Token: AddressLike

l2Token: AddressLike

amount: NumberLike

Optional opts: { overrides?: CallOverrides }

Optional overrides?: CallOverrides

Returns Promise<BigNumber>

deposit: (l1Token: AddressLike, l2Token: AddressLike, amount: NumberLike, opts?: { l2GasLimit?: NumberLike; overrides?: CallOverrides; recipient?: AddressLike }) => Promise<BigNumber>

Parameters

l1Token: AddressLike

l2Token: AddressLike

amount: NumberLike

Optional opts: { l2GasLimit?: NumberLike; overrides?: CallOverrides; recipient?: AddressLike }

Optional l2GasLimit?: NumberLike

Optional overrides?: CallOverrides

Optional recipient?: AddressLike

Returns Promise<BigNumber>

withdraw: (l1Token: AddressLike, l2Token: AddressLike, amount: NumberLike, opts?: { overrides?: CallOverrides; recipient?: AddressLike }) => Promise<BigNumber>

Parameters

l1Token: AddressLike

l2Token: AddressLike

amount: NumberLike

Optional opts: { overrides?: CallOverrides; recipient?: AddressLike }

Optional overrides?: CallOverrides

Optional recipient?: AddressLike

Returns Promise<BigNumber>

l1Bridge

l2Bridge

messenger

populateTransaction

Type declaration

approve: (l1Token: AddressLike, l2Token: AddressLike, amount: NumberLike, opts?: { overrides?: Overrides }) => Promise<TransactionRequest>

Parameters

l1Token: AddressLike

l2Token: AddressLike

amount: NumberLike

Optional opts: { overrides?: Overrides }

Optional overrides?: Overrides

Returns Promise<TransactionRequest>

deposit: (l1Token: AddressLike, l2Token: AddressLike, amount: NumberLike, opts?: { l2GasLimit?: NumberLike; overrides?: Overrides; recipient?: AddressLike }) => Promise<TransactionRequest>

Parameters

l1Token: AddressLike

l2Token: AddressLike

amount: NumberLike

Optional opts: { l2GasLimit?: NumberLike; overrides?: Overrides; recipient?: AddressLike }

Optional l2GasLimit?: NumberLike

Optional overrides?: Overrides

Optional recipient?: AddressLike

Returns Promise<TransactionRequest>

withdraw: (l1Token: AddressLike, l2Token: AddressLike, amount: NumberLike, opts?: { overrides?: Overrides; recipient?: AddressLike }) => Promise<TransactionRequest>

Parameters

l1Token: AddressLike

l2Token: AddressLike

amount: NumberLike

Optional opts: { overrides?: Overrides; recipient?: AddressLike }

Optional overrides?: Overrides

Optional recipient?: AddressLike

Returns Promise<TransactionRequest>

Methods

approval

Parameters

l1Token: AddressLike