Class USDCBridgeAdapter

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

Hierarchy (view full)

StandardBridgeAdapter
- USDCBridgeAdapter

Index

Constructors

constructor

new USDCBridgeAdapter(opts): USDCBridgeAdapter
Parameters
- opts: {
      l1Bridge: AddressLike;
      l2Bridge: AddressLike;
      messenger: CrossChainMessenger;
  }
  - l1Bridge: AddressLike
  - l2Bridge: AddressLike
  - messenger: CrossChainMessenger
Returns USDCBridgeAdapter
Overrides StandardBridgeAdapter.constructor
- Defined in packages/tokamak/sdk/src/adapters/usdc-bridge.ts:12

Properties

estimateGas

estimateGas: {
    approve: ((l1Token, l2Token, amount, opts?) => Promise<BigNumber>);
    deposit: ((l1Token, l2Token, amount, opts?) => Promise<BigNumber>);
    withdraw: ((l1Token, l2Token, amount, opts?) => 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, l2Token, amount, opts?) => Promise<BigNumber>)
- - (l1Token, l2Token, amount, opts?): Promise<BigNumber>
  - Parameters
    - l1Token: AddressLike
    - l2Token: AddressLike
    - amount: NumberLike
    - Optional opts: {
      overrides?: CallOverrides;
      }
      Optional overrides?: CallOverrides
    Returns Promise<BigNumber>
deposit: ((l1Token, l2Token, amount, opts?) => Promise<BigNumber>)
- - (l1Token, l2Token, amount, opts?): 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, l2Token, amount, opts?) => Promise<BigNumber>)
- - (l1Token, l2Token, amount, opts?): 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: CrossChainMessenger

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

populateTransaction

populateTransaction: {
    approve: ((l1Token, l2Token, amount, opts?) => Promise<TransactionRequest>);
    deposit: ((l1Token, l2Token, amount, opts?) => Promise<TransactionRequest>);
    withdraw: ((l1Token, l2Token, amount, opts?) => 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, l2Token, amount, opts?) => Promise<TransactionRequest>)
- - (l1Token, l2Token, amount, opts?): Promise<TransactionRequest>
  - Parameters
    - l1Token: AddressLike
    - l2Token: AddressLike
    - amount: NumberLike
    - Optional opts: {
      overrides?: Overrides;
      }
      Optional overrides?: Overrides
    Returns Promise<TransactionRequest>
deposit: ((l1Token, l2Token, amount, opts?) => Promise<TransactionRequest>)
- - (l1Token, l2Token, amount, opts?): 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, l2Token, amount, opts?) => Promise<TransactionRequest>)
- - (l1Token, l2Token, amount, opts?): 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, l2Token, signer): Promise<BigNumber>
Queries the account's approval amount for a given L1 token.
Parameters
- l1Token: AddressLike
  The L1 token address.
- l2Token: AddressLike
  The L2 token address.
- signer: Signer
  Signer to query the approval for.
Returns Promise<BigNumber>
Amount of tokens approved for deposits from the account.
Inherited from StandardBridgeAdapter.approval
- Defined in packages/tokamak/sdk/src/adapters/standard-bridge.ts:195

approve

approve(l1Token, l2Token, amount, signer, opts?): Promise<TransactionResponse>
Approves a deposit into the L2 chain.
Parameters
- l1Token: AddressLike
  The L1 token address.
- l2Token: AddressLike
  The L2 token address.
- amount: NumberLike
  Amount of the token to approve.
- signer: Signer
  Signer used to sign and send the transaction.
- Optional opts: {
  overrides?: Overrides;
  }
  Additional options.
  - Optional overrides?: Overrides
Returns Promise<TransactionResponse>
Transaction response for the approval transaction.
Inherited from StandardBridgeAdapter.approve
- Defined in packages/tokamak/sdk/src/adapters/standard-bridge.ts:213

deposit

deposit(l1Token, l2Token, amount, signer, opts?): Promise<TransactionResponse>
Deposits some tokens into the L2 chain.
Parameters
- l1Token: AddressLike
  The L1 token address.
- l2Token: AddressLike
  The L2 token address.
- amount: NumberLike
  Amount of the token to deposit.
- signer: Signer
  Signer used to sign and send the transaction.
- Optional opts: {
      l2GasLimit?: NumberLike;
      overrides?: Overrides;
      recipient?: AddressLike;
  }
  Additional options.
  - Optional l2GasLimit?: NumberLike
  - Optional overrides?: Overrides
  - Optional recipient?: AddressLike
Returns Promise<TransactionResponse>
Transaction response for the deposit transaction.
Inherited from StandardBridgeAdapter.deposit
- Defined in packages/tokamak/sdk/src/adapters/standard-bridge.ts:227

filterEthDepositsAndWithdrawls

filterEthDepositsAndWithdrawls(l1Token, l2Token): boolean
Parameters
- l1Token: AddressLike
- l2Token: AddressLike
Returns boolean
Inherited from StandardBridgeAdapter.filterEthDepositsAndWithdrawls
- Defined in packages/tokamak/sdk/src/adapters/standard-bridge.ts:258

filterL2NativeTokenDepositsAndWithdrawls

filterL2NativeTokenDepositsAndWithdrawls(l1Token, l2Token): boolean
Parameters
- l1Token: AddressLike
- l2Token: AddressLike
Returns boolean
Inherited from StandardBridgeAdapter.filterL2NativeTokenDepositsAndWithdrawls
- Defined in packages/tokamak/sdk/src/adapters/standard-bridge.ts:268

getDepositsByAddress

getDepositsByAddress(address, opts?): Promise<TokenBridgeMessage[]>
Gets all deposits for a given address.
Parameters
- address: AddressLike
  Address to search for messages from.
- Optional opts: {
  fromBlock?: BlockTag;
  toBlock?: BlockTag;
  }
  Options object.
  - Optional fromBlock?: BlockTag
  - Optional toBlock?: BlockTag
Returns Promise<TokenBridgeMessage[]>
All deposit token bridge messages sent by the given address.
Inherited from StandardBridgeAdapter.getDepositsByAddress
- Defined in packages/tokamak/sdk/src/adapters/standard-bridge.ts:65

getWithdrawalsByAddress

getWithdrawalsByAddress(address, opts?): Promise<TokenBridgeMessage[]>
Gets all withdrawals for a given address.
Parameters
- address: AddressLike
  Address to search for messages from.
- Optional opts: {
  fromBlock?: BlockTag;
  toBlock?: BlockTag;
  }
  Options object.
  - Optional fromBlock?: BlockTag
  - Optional toBlock?: BlockTag
Returns Promise<TokenBridgeMessage[]>
All withdrawal token bridge messages sent by the given address.
Inherited from StandardBridgeAdapter.getWithdrawalsByAddress
- Defined in packages/tokamak/sdk/src/adapters/standard-bridge.ts:106

supportsTokenPair

supportsTokenPair(l1Token, l2Token): Promise<boolean>
Checks whether the given token pair is supported by the bridge.
Parameters
- l1Token: AddressLike
  The L1 token address.
- l2Token: AddressLike
  The L2 token address.
Returns Promise<boolean>
Whether the given token pair is supported by the bridge.
Overrides StandardBridgeAdapter.supportsTokenPair
- Defined in packages/tokamak/sdk/src/adapters/usdc-bridge.ts:30

withdraw

withdraw(l1Token, l2Token, amount, signer, opts?): Promise<TransactionResponse>
Withdraws some tokens back to the L1 chain.
Parameters
- l1Token: AddressLike
  The L1 token address.
- l2Token: AddressLike
  The L2 token address.
- amount: NumberLike
  Amount of the token to withdraw.
- signer: Signer
  Signer used to sign and send the transaction.
- Optional opts: {
  overrides?: Overrides;
  recipient?: AddressLike;
  }
  Additional options.
  - Optional overrides?: Overrides
  - Optional recipient?: AddressLike
Returns Promise<TransactionResponse>
Transaction response for the withdraw transaction.
Inherited from StandardBridgeAdapter.withdraw
- Defined in packages/tokamak/sdk/src/adapters/standard-bridge.ts:243

Class USDCBridgeAdapter

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

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

l1Bridge: AddressLike

l2Bridge: AddressLike

messenger: CrossChainMessenger

Returns USDCBridgeAdapter

Properties

estimateGas

Type declaration

approve: ((l1Token, l2Token, amount, opts?) => Promise<BigNumber>)

Parameters

l1Token: AddressLike

l2Token: AddressLike

amount: NumberLike

Optional opts: { overrides?: CallOverrides; }

Optional overrides?: CallOverrides

Returns Promise<BigNumber>

deposit: ((l1Token, l2Token, amount, opts?) => 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, l2Token, amount, opts?) => 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, l2Token, amount, opts?) => Promise<TransactionRequest>)

Parameters

l1Token: AddressLike

l2Token: AddressLike

amount: NumberLike

Optional opts: { overrides?: Overrides; }

Optional overrides?: Overrides

Returns Promise<TransactionRequest>

deposit: ((l1Token, l2Token, amount, opts?) => 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, l2Token, amount, opts?) => 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

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

`Optional` opts: {
overrides?: CallOverrides;
}

`Optional` overrides?: CallOverrides

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

`Optional` l2GasLimit?: NumberLike

`Optional` overrides?: CallOverrides

`Optional` recipient?: AddressLike

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

`Optional` overrides?: CallOverrides

`Optional` recipient?: AddressLike

`Optional` opts: {
overrides?: Overrides;
}

`Optional` overrides?: Overrides

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

`Optional` l2GasLimit?: NumberLike

`Optional` overrides?: Overrides

`Optional` recipient?: AddressLike

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

`Optional` overrides?: Overrides

`Optional` recipient?: AddressLike

`Optional` opts: {
overrides?: Overrides;
}

`Optional` overrides?: Overrides

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

`Optional` l2GasLimit?: NumberLike

`Optional` overrides?: Overrides

`Optional` recipient?: AddressLike

`Optional` opts: {
fromBlock?: BlockTag;
toBlock?: BlockTag;
}

`Optional` fromBlock?: BlockTag

`Optional` toBlock?: BlockTag

`Optional` opts: {
fromBlock?: BlockTag;
toBlock?: BlockTag;
}

`Optional` fromBlock?: BlockTag

`Optional` toBlock?: BlockTag

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

`Optional` overrides?: Overrides

`Optional` recipient?: AddressLike