githubEdit

gearConfiguration

Configuration options and settings for @tetherto/wdk-protocol-bridge-usdt0-evm

Bridge Protocol Configuration

The Usdt0ProtocolEvm accepts a configuration object that defines how the bridge protocol works:

import Usdt0ProtocolEvm from '@tetherto/wdk-protocol-bridge-usdt0-evm'
import { WalletAccountEvm } from '@tetherto/wdk-wallet-evm'

// Create wallet account first
const account = new WalletAccountEvm(seedPhrase, "0'/0/0", {
  provider: 'https://eth.drpc.org'
})

// Create bridge protocol with configuration
const bridgeProtocol = new Usdt0ProtocolEvm(account, {
  bridgeMaxFee: 1000000000000000n // Optional: Maximum bridge fee in wei
})

Account Configuration

The bridge protocol uses the wallet account's configuration for blockchain access:

import { WalletAccountEvm, WalletAccountReadOnlyEvm } from '@tetherto/wdk-wallet-evm'

// Full access account
const account = new WalletAccountEvm(
  seedPhrase,
  "0'/0/0", // BIP-44 derivation path
  {
    provider: 'https://eth.drpc.org',
    transferMaxFee: 100000000000000
  }
)

// Read-only account
const readOnlyAccount = new WalletAccountReadOnlyEvm(
  '0x...', // Ethereum address
  {
    provider: 'https://eth.drpc.org'
  }
)

// Create bridge protocol
const bridgeProtocol = new Usdt0ProtocolEvm(account, {
  bridgeMaxFee: 1000000000000000n
})

Configuration Options

Bridge Max Fee

The bridgeMaxFee option sets a maximum limit for total bridge costs to prevent unexpectedly high fees.

Type: number | bigint (optional) Unit: Wei (1 ETH = 1000000000000000000 Wei)

Examples:

Provider

The provider option comes from the wallet account configuration and specifies how to connect to the blockchain.

Type: string | Eip1193Provider

Examples:

ERC-4337 Configuration

When using ERC-4337 accounts, you can override configuration options during bridge operations:

Paymaster Token

The paymasterToken option specifies which token to use for paying gas fees in ERC-4337 accounts.

Type: { address: string } (optional) Format: Object with token contract address

Example:

Network Support

The bridge protocol uses EVM wallet providers as source chains and supports both EVM and non-EVM destinations. Change the provider URL in the wallet account configuration:

Bridge Options

When calling the bridge method, you need to provide bridge options:

Target Chain

The targetChain option specifies which blockchain to bridge tokens to.

Type: string Supported values: 'ethereum', 'arbitrum', 'optimism', 'polygon', 'berachain', 'ink', 'plasma', 'conflux', 'corn', 'avalanche', 'celo', 'flare', 'hyperevm', 'mantle', 'megaeth', 'monad', 'morph', 'rootstock', 'sei', 'stable', 'unichain', 'xlayer', 'solana', 'ton', 'tron'

Recipient

The recipient option specifies the address that will receive the bridged tokens.

Type: string Format: Valid address for the target chain

Token

The token option specifies which token contract to bridge.

Type: string Format: Token contract address on the source chain

Amount

The amount option specifies how many tokens to bridge.

Type: number | bigint Unit: Base units of the token (e.g., for USD₮: 1 USD₮ = 1000000n)

OFT Contract Address

The optional oftContractAddress option lets you override auto-discovery and force a specific OFT contract.

Type: string (optional) Format: Valid EVM contract address on the source chain

Destination EID Override

The optional dstEid option lets you override the default LayerZero destination endpoint ID for the selected target chain.

Type: number (optional)

Error Handling

The bridge protocol will throw errors for invalid configurations:


Need Help?