Interface TokenBridge<N, P, C>
Methods
createAttestation
- createAttestation(token, payer?): AsyncGenerator<UnsignedTransaction<N, C>, any, unknown>
-
Returns AsyncGenerator<UnsignedTransaction<N, C>, any, unknown>
getOriginalAsset
- getOriginalAsset(nativeAddress): Promise<TokenId<"Solana" | "Ethereum" | "Terra" | "Bsc" | "Polygon" | "Avalanche" | "Oasis" | "Algorand" | "Aurora" | "Fantom" | "Karura" | "Acala" | "Klaytn" | "Celo" | "Near" | "Moonbeam" | "Neon" | "Terra2" | "Injective" | "Osmosis" | "Sui" | "Aptos" | "Arbitrum" | "Optimism" | "Gnosis" | "Pythnet" | "Xpla" | "Btc" | "Base" | "Sei" | "Rootstock" | "Wormchain" | "Cosmoshub" | "Evmos" | "Kujira" | "Sepolia" | "ArbitrumSepolia" | "BaseSepolia" | "OptimismSepolia" | "Holesky">>
-
Returns Promise<TokenId<"Solana" | "Ethereum" | "Terra" | "Bsc" | "Polygon" | "Avalanche" | "Oasis" | "Algorand" | "Aurora" | "Fantom" | "Karura" | "Acala" | "Klaytn" | "Celo" | "Near" | "Moonbeam" | "Neon" | "Terra2" | "Injective" | "Osmosis" | "Sui" | "Aptos" | "Arbitrum" | "Optimism" | "Gnosis" | "Pythnet" | "Xpla" | "Btc" | "Base" | "Sei" | "Rootstock" | "Wormchain" | "Cosmoshub" | "Evmos" | "Kujira" | "Sepolia" | "ArbitrumSepolia" | "BaseSepolia" | "OptimismSepolia" | "Holesky">>
getWrappedAsset
- getWrappedAsset(foreignToken): Promise<GetNativeAddress<(C extends bigint
? `bigint(${C})`
: C extends boolean
? `boolean(${C})`
: C) extends "Solana" | "Ethereum" | "Terra" | "Bsc" | "Polygon" | "Avalanche" | "Oasis" | "Algorand" | "Aurora" | "Fantom" | "Karura" | "Acala" | "Klaytn" | "Celo" | "Near" | "Moonbeam" | "Neon" | "Terra2" | "Injective" | "Osmosis" | "Sui" | "Aptos" | "Arbitrum" | "Optimism" | "Gnosis" | "Pythnet" | "Xpla" | "Btc" | "Base" | "Sei" | "Rootstock" | "Wormchain" | "Cosmoshub" | "Evmos" | "Kujira" | "Sepolia" | "ArbitrumSepolia" | "BaseSepolia" | "OptimismSepolia" | "Holesky"
? {
Acala: "Evm";
Algorand: "Algorand";
Aptos: "Aptos";
Arbitrum: "Evm";
ArbitrumSepolia: "Evm";
Aurora: "Evm";
Avalanche: "Evm";
Base: "Evm";
BaseSepolia: "Evm";
Bsc: "Evm";
Btc: "Btc";
Celo: "Evm";
Cosmoshub: "Cosmwasm";
Ethereum: "Evm";
Evmos: "Cosmwasm";
Fantom: "Evm";
Gnosis: "Evm";
Holesky: "Evm";
Injective: "Cosmwasm";
Karura: "Evm";
Klaytn: "Evm";
Kujira: "Cosmwasm";
Moonbeam: "Evm";
Near: "Near";
Neon: "Evm";
Oasis: "Evm";
Optimism: "Evm";
OptimismSepolia: "Evm";
Osmosis: "Cosmwasm";
Polygon: "Evm";
Pythnet: "Solana";
Rootstock: "Evm";
Sei: "Cosmwasm";
Sepolia: "Evm";
Solana: "Solana";
Sui: "Sui";
Terra: "Cosmwasm";
Terra2: "Cosmwasm";
Wormchain: "Cosmwasm";
Xpla: "Cosmwasm";
}[Object] extends {
[key: string]: unknown;
}
? {
Acala: "Evm";
Algorand: "Algorand";
Aptos: "Aptos";
Arbitrum: "Evm";
ArbitrumSepolia: "Evm";
Aurora: "Evm";
Avalanche: "Evm";
Base: "Evm";
BaseSepolia: "Evm";
Bsc: "Evm";
Btc: "Btc";
Celo: "Evm";
Cosmoshub: "Cosmwasm";
Ethereum: "Evm";
Evmos: "Cosmwasm";
Fantom: "Evm";
Gnosis: "Evm";
Holesky: "Evm";
Injective: "Cosmwasm";
Karura: "Evm";
Klaytn: "Evm";
Kujira: "Cosmwasm";
Moonbeam: "Evm";
Near: "Near";
Neon: "Evm";
Oasis: "Evm";
Optimism: "Evm";
OptimismSepolia: "Evm";
Osmosis: "Cosmwasm";
Polygon: "Evm";
Pythnet: "Solana";
Rootstock: "Evm";
Sei: "Cosmwasm";
Sepolia: "Evm";
Solana: "Solana";
Sui: "Sui";
Terra: "Cosmwasm";
Terra2: "Cosmwasm";
Wormchain: "Cosmwasm";
Xpla: "Cosmwasm";
}[Object]
: {
Acala: "Evm";
Algorand: "Algorand";
Aptos: "Aptos";
Arbitrum: "Evm";
ArbitrumSepolia: "Evm";
Aurora: "Evm";
Avalanche: "Evm";
Base: "Evm";
BaseSepolia: "Evm";
Bsc: "Evm";
Btc: "Btc";
Celo: "Evm";
Cosmoshub: "Cosmwasm";
Ethereum: "Evm";
Evmos: "Cosmwasm";
Fantom: "Evm";
Gnosis: "Evm";
Holesky: "Evm";
Injective: "Cosmwasm";
Karura: "Evm";
Klaytn: "Evm";
Kujira: "Cosmwasm";
Moonbeam: "Evm";
Near: "Near";
Neon: "Evm";
Oasis: "Evm";
Optimism: "Evm";
OptimismSepolia: "Evm";
Osmosis: "Cosmwasm";
Polygon: "Evm";
Pythnet: "Solana";
Rootstock: "Evm";
Sei: "Cosmwasm";
Sepolia: "Evm";
Solana: "Solana";
Sui: "Sui";
Terra: "Cosmwasm";
Terra2: "Cosmwasm";
Wormchain: "Cosmwasm";
Xpla: "Cosmwasm";
}[Object]
: never>>
-
Parameters
-
foreignToken: TokenId<"Solana" | "Ethereum" | "Terra" | "Bsc" | "Polygon" | "Avalanche" | "Oasis" | "Algorand" | "Aurora" | "Fantom" | "Karura" | "Acala" | "Klaytn" | "Celo" | "Near" | "Moonbeam" | "Neon" | "Terra2" | "Injective" | "Osmosis" | "Sui" | "Aptos" | "Arbitrum" | "Optimism" | "Gnosis" | "Pythnet" | "Xpla" | "Btc" | "Base" | "Sei" | "Rootstock" | "Wormchain" | "Cosmoshub" | "Evmos" | "Kujira" | "Sepolia" | "ArbitrumSepolia" | "BaseSepolia" | "OptimismSepolia" | "Holesky">
Returns Promise<GetNativeAddress<(C extends bigint
? `bigint(${C})`
: C extends boolean
? `boolean(${C})`
: C) extends "Solana" | "Ethereum" | "Terra" | "Bsc" | "Polygon" | "Avalanche" | "Oasis" | "Algorand" | "Aurora" | "Fantom" | "Karura" | "Acala" | "Klaytn" | "Celo" | "Near" | "Moonbeam" | "Neon" | "Terra2" | "Injective" | "Osmosis" | "Sui" | "Aptos" | "Arbitrum" | "Optimism" | "Gnosis" | "Pythnet" | "Xpla" | "Btc" | "Base" | "Sei" | "Rootstock" | "Wormchain" | "Cosmoshub" | "Evmos" | "Kujira" | "Sepolia" | "ArbitrumSepolia" | "BaseSepolia" | "OptimismSepolia" | "Holesky"
? {
Acala: "Evm";
Algorand: "Algorand";
Aptos: "Aptos";
Arbitrum: "Evm";
ArbitrumSepolia: "Evm";
Aurora: "Evm";
Avalanche: "Evm";
Base: "Evm";
BaseSepolia: "Evm";
Bsc: "Evm";
Btc: "Btc";
Celo: "Evm";
Cosmoshub: "Cosmwasm";
Ethereum: "Evm";
Evmos: "Cosmwasm";
Fantom: "Evm";
Gnosis: "Evm";
Holesky: "Evm";
Injective: "Cosmwasm";
Karura: "Evm";
Klaytn: "Evm";
Kujira: "Cosmwasm";
Moonbeam: "Evm";
Near: "Near";
Neon: "Evm";
Oasis: "Evm";
Optimism: "Evm";
OptimismSepolia: "Evm";
Osmosis: "Cosmwasm";
Polygon: "Evm";
Pythnet: "Solana";
Rootstock: "Evm";
Sei: "Cosmwasm";
Sepolia: "Evm";
Solana: "Solana";
Sui: "Sui";
Terra: "Cosmwasm";
Terra2: "Cosmwasm";
Wormchain: "Cosmwasm";
Xpla: "Cosmwasm";
}[Object] extends {
[key: string]: unknown;
}
? {
Acala: "Evm";
Algorand: "Algorand";
Aptos: "Aptos";
Arbitrum: "Evm";
ArbitrumSepolia: "Evm";
Aurora: "Evm";
Avalanche: "Evm";
Base: "Evm";
BaseSepolia: "Evm";
Bsc: "Evm";
Btc: "Btc";
Celo: "Evm";
Cosmoshub: "Cosmwasm";
Ethereum: "Evm";
Evmos: "Cosmwasm";
Fantom: "Evm";
Gnosis: "Evm";
Holesky: "Evm";
Injective: "Cosmwasm";
Karura: "Evm";
Klaytn: "Evm";
Kujira: "Cosmwasm";
Moonbeam: "Evm";
Near: "Near";
Neon: "Evm";
Oasis: "Evm";
Optimism: "Evm";
OptimismSepolia: "Evm";
Osmosis: "Cosmwasm";
Polygon: "Evm";
Pythnet: "Solana";
Rootstock: "Evm";
Sei: "Cosmwasm";
Sepolia: "Evm";
Solana: "Solana";
Sui: "Sui";
Terra: "Cosmwasm";
Terra2: "Cosmwasm";
Wormchain: "Cosmwasm";
Xpla: "Cosmwasm";
}[Object]
: {
Acala: "Evm";
Algorand: "Algorand";
Aptos: "Aptos";
Arbitrum: "Evm";
ArbitrumSepolia: "Evm";
Aurora: "Evm";
Avalanche: "Evm";
Base: "Evm";
BaseSepolia: "Evm";
Bsc: "Evm";
Btc: "Btc";
Celo: "Evm";
Cosmoshub: "Cosmwasm";
Ethereum: "Evm";
Evmos: "Cosmwasm";
Fantom: "Evm";
Gnosis: "Evm";
Holesky: "Evm";
Injective: "Cosmwasm";
Karura: "Evm";
Klaytn: "Evm";
Kujira: "Cosmwasm";
Moonbeam: "Evm";
Near: "Near";
Neon: "Evm";
Oasis: "Evm";
Optimism: "Evm";
OptimismSepolia: "Evm";
Osmosis: "Cosmwasm";
Polygon: "Evm";
Pythnet: "Solana";
Rootstock: "Evm";
Sei: "Cosmwasm";
Sepolia: "Evm";
Solana: "Solana";
Sui: "Sui";
Terra: "Cosmwasm";
Terra2: "Cosmwasm";
Wormchain: "Cosmwasm";
Xpla: "Cosmwasm";
}[Object]
: never>>
getWrappedNative
- getWrappedNative(): Promise<GetNativeAddress<(C extends bigint
? `bigint(${C})`
: C extends boolean
? `boolean(${C})`
: C) extends "Solana" | "Ethereum" | "Terra" | "Bsc" | "Polygon" | "Avalanche" | "Oasis" | "Algorand" | "Aurora" | "Fantom" | "Karura" | "Acala" | "Klaytn" | "Celo" | "Near" | "Moonbeam" | "Neon" | "Terra2" | "Injective" | "Osmosis" | "Sui" | "Aptos" | "Arbitrum" | "Optimism" | "Gnosis" | "Pythnet" | "Xpla" | "Btc" | "Base" | "Sei" | "Rootstock" | "Wormchain" | "Cosmoshub" | "Evmos" | "Kujira" | "Sepolia" | "ArbitrumSepolia" | "BaseSepolia" | "OptimismSepolia" | "Holesky"
? {
Acala: "Evm";
Algorand: "Algorand";
Aptos: "Aptos";
Arbitrum: "Evm";
ArbitrumSepolia: "Evm";
Aurora: "Evm";
Avalanche: "Evm";
Base: "Evm";
BaseSepolia: "Evm";
Bsc: "Evm";
Btc: "Btc";
Celo: "Evm";
Cosmoshub: "Cosmwasm";
Ethereum: "Evm";
Evmos: "Cosmwasm";
Fantom: "Evm";
Gnosis: "Evm";
Holesky: "Evm";
Injective: "Cosmwasm";
Karura: "Evm";
Klaytn: "Evm";
Kujira: "Cosmwasm";
Moonbeam: "Evm";
Near: "Near";
Neon: "Evm";
Oasis: "Evm";
Optimism: "Evm";
OptimismSepolia: "Evm";
Osmosis: "Cosmwasm";
Polygon: "Evm";
Pythnet: "Solana";
Rootstock: "Evm";
Sei: "Cosmwasm";
Sepolia: "Evm";
Solana: "Solana";
Sui: "Sui";
Terra: "Cosmwasm";
Terra2: "Cosmwasm";
Wormchain: "Cosmwasm";
Xpla: "Cosmwasm";
}[Object] extends {
[key: string]: unknown;
}
? {
Acala: "Evm";
Algorand: "Algorand";
Aptos: "Aptos";
Arbitrum: "Evm";
ArbitrumSepolia: "Evm";
Aurora: "Evm";
Avalanche: "Evm";
Base: "Evm";
BaseSepolia: "Evm";
Bsc: "Evm";
Btc: "Btc";
Celo: "Evm";
Cosmoshub: "Cosmwasm";
Ethereum: "Evm";
Evmos: "Cosmwasm";
Fantom: "Evm";
Gnosis: "Evm";
Holesky: "Evm";
Injective: "Cosmwasm";
Karura: "Evm";
Klaytn: "Evm";
Kujira: "Cosmwasm";
Moonbeam: "Evm";
Near: "Near";
Neon: "Evm";
Oasis: "Evm";
Optimism: "Evm";
OptimismSepolia: "Evm";
Osmosis: "Cosmwasm";
Polygon: "Evm";
Pythnet: "Solana";
Rootstock: "Evm";
Sei: "Cosmwasm";
Sepolia: "Evm";
Solana: "Solana";
Sui: "Sui";
Terra: "Cosmwasm";
Terra2: "Cosmwasm";
Wormchain: "Cosmwasm";
Xpla: "Cosmwasm";
}[Object]
: {
Acala: "Evm";
Algorand: "Algorand";
Aptos: "Aptos";
Arbitrum: "Evm";
ArbitrumSepolia: "Evm";
Aurora: "Evm";
Avalanche: "Evm";
Base: "Evm";
BaseSepolia: "Evm";
Bsc: "Evm";
Btc: "Btc";
Celo: "Evm";
Cosmoshub: "Cosmwasm";
Ethereum: "Evm";
Evmos: "Cosmwasm";
Fantom: "Evm";
Gnosis: "Evm";
Holesky: "Evm";
Injective: "Cosmwasm";
Karura: "Evm";
Klaytn: "Evm";
Kujira: "Cosmwasm";
Moonbeam: "Evm";
Near: "Near";
Neon: "Evm";
Oasis: "Evm";
Optimism: "Evm";
OptimismSepolia: "Evm";
Osmosis: "Cosmwasm";
Polygon: "Evm";
Pythnet: "Solana";
Rootstock: "Evm";
Sei: "Cosmwasm";
Sepolia: "Evm";
Solana: "Solana";
Sui: "Sui";
Terra: "Cosmwasm";
Terra2: "Cosmwasm";
Wormchain: "Cosmwasm";
Xpla: "Cosmwasm";
}[Object]
: never>>
-
Returns Promise<GetNativeAddress<(C extends bigint
? `bigint(${C})`
: C extends boolean
? `boolean(${C})`
: C) extends "Solana" | "Ethereum" | "Terra" | "Bsc" | "Polygon" | "Avalanche" | "Oasis" | "Algorand" | "Aurora" | "Fantom" | "Karura" | "Acala" | "Klaytn" | "Celo" | "Near" | "Moonbeam" | "Neon" | "Terra2" | "Injective" | "Osmosis" | "Sui" | "Aptos" | "Arbitrum" | "Optimism" | "Gnosis" | "Pythnet" | "Xpla" | "Btc" | "Base" | "Sei" | "Rootstock" | "Wormchain" | "Cosmoshub" | "Evmos" | "Kujira" | "Sepolia" | "ArbitrumSepolia" | "BaseSepolia" | "OptimismSepolia" | "Holesky"
? {
Acala: "Evm";
Algorand: "Algorand";
Aptos: "Aptos";
Arbitrum: "Evm";
ArbitrumSepolia: "Evm";
Aurora: "Evm";
Avalanche: "Evm";
Base: "Evm";
BaseSepolia: "Evm";
Bsc: "Evm";
Btc: "Btc";
Celo: "Evm";
Cosmoshub: "Cosmwasm";
Ethereum: "Evm";
Evmos: "Cosmwasm";
Fantom: "Evm";
Gnosis: "Evm";
Holesky: "Evm";
Injective: "Cosmwasm";
Karura: "Evm";
Klaytn: "Evm";
Kujira: "Cosmwasm";
Moonbeam: "Evm";
Near: "Near";
Neon: "Evm";
Oasis: "Evm";
Optimism: "Evm";
OptimismSepolia: "Evm";
Osmosis: "Cosmwasm";
Polygon: "Evm";
Pythnet: "Solana";
Rootstock: "Evm";
Sei: "Cosmwasm";
Sepolia: "Evm";
Solana: "Solana";
Sui: "Sui";
Terra: "Cosmwasm";
Terra2: "Cosmwasm";
Wormchain: "Cosmwasm";
Xpla: "Cosmwasm";
}[Object] extends {
[key: string]: unknown;
}
? {
Acala: "Evm";
Algorand: "Algorand";
Aptos: "Aptos";
Arbitrum: "Evm";
ArbitrumSepolia: "Evm";
Aurora: "Evm";
Avalanche: "Evm";
Base: "Evm";
BaseSepolia: "Evm";
Bsc: "Evm";
Btc: "Btc";
Celo: "Evm";
Cosmoshub: "Cosmwasm";
Ethereum: "Evm";
Evmos: "Cosmwasm";
Fantom: "Evm";
Gnosis: "Evm";
Holesky: "Evm";
Injective: "Cosmwasm";
Karura: "Evm";
Klaytn: "Evm";
Kujira: "Cosmwasm";
Moonbeam: "Evm";
Near: "Near";
Neon: "Evm";
Oasis: "Evm";
Optimism: "Evm";
OptimismSepolia: "Evm";
Osmosis: "Cosmwasm";
Polygon: "Evm";
Pythnet: "Solana";
Rootstock: "Evm";
Sei: "Cosmwasm";
Sepolia: "Evm";
Solana: "Solana";
Sui: "Sui";
Terra: "Cosmwasm";
Terra2: "Cosmwasm";
Wormchain: "Cosmwasm";
Xpla: "Cosmwasm";
}[Object]
: {
Acala: "Evm";
Algorand: "Algorand";
Aptos: "Aptos";
Arbitrum: "Evm";
ArbitrumSepolia: "Evm";
Aurora: "Evm";
Avalanche: "Evm";
Base: "Evm";
BaseSepolia: "Evm";
Bsc: "Evm";
Btc: "Btc";
Celo: "Evm";
Cosmoshub: "Cosmwasm";
Ethereum: "Evm";
Evmos: "Cosmwasm";
Fantom: "Evm";
Gnosis: "Evm";
Holesky: "Evm";
Injective: "Cosmwasm";
Karura: "Evm";
Klaytn: "Evm";
Kujira: "Cosmwasm";
Moonbeam: "Evm";
Near: "Near";
Neon: "Evm";
Oasis: "Evm";
Optimism: "Evm";
OptimismSepolia: "Evm";
Osmosis: "Cosmwasm";
Polygon: "Evm";
Pythnet: "Solana";
Rootstock: "Evm";
Sei: "Cosmwasm";
Sepolia: "Evm";
Solana: "Solana";
Sui: "Sui";
Terra: "Cosmwasm";
Terra2: "Cosmwasm";
Wormchain: "Cosmwasm";
Xpla: "Cosmwasm";
}[Object]
: never>>
hasWrappedAsset
- hasWrappedAsset(foreignToken): Promise<boolean>
-
Parameters
-
foreignToken: TokenId<"Solana" | "Ethereum" | "Terra" | "Bsc" | "Polygon" | "Avalanche" | "Oasis" | "Algorand" | "Aurora" | "Fantom" | "Karura" | "Acala" | "Klaytn" | "Celo" | "Near" | "Moonbeam" | "Neon" | "Terra2" | "Injective" | "Osmosis" | "Sui" | "Aptos" | "Arbitrum" | "Optimism" | "Gnosis" | "Pythnet" | "Xpla" | "Btc" | "Base" | "Sei" | "Rootstock" | "Wormchain" | "Cosmoshub" | "Evmos" | "Kujira" | "Sepolia" | "ArbitrumSepolia" | "BaseSepolia" | "OptimismSepolia" | "Holesky">
Returns Promise<boolean>
isTransferCompleted
- isTransferCompleted(vaa): Promise<boolean>
-
Parameters
-
vaa: VAA<"TokenBridge:Transfer"> | VAA<"TokenBridge:TransferWithPayload">
Returns Promise<boolean>
isWrappedAsset
- isWrappedAsset(nativeAddress): Promise<boolean>
-
Returns Promise<boolean>
redeem
- redeem(sender, vaa, unwrapNative?): AsyncGenerator<UnsignedTransaction<N, C>, any, unknown>
-
Parameters
-
-
vaa: VAA<"TokenBridge:Transfer"> | VAA<"TokenBridge:TransferWithPayload">
-
Optional
unwrapNative: boolean
Returns AsyncGenerator<UnsignedTransaction<N, C>, any, unknown>
submitAttestation
- submitAttestation(vaa, payer?): AsyncGenerator<UnsignedTransaction<N, C>, any, unknown>
-
Parameters
-
vaa: VAA<"TokenBridge:AttestMeta">
-
Returns AsyncGenerator<UnsignedTransaction<N, C>, any, unknown>
transfer
- transfer(sender, recipient, token, amount, payload?): AsyncGenerator<UnsignedTransaction<N, C>, any, unknown>
-
Parameters
-
-
-
-
amount: bigint
-
Optional
payload: Uint8Array
Returns AsyncGenerator<UnsignedTransaction<N, C>, any, unknown>