Preparing search index...
The search index is not available
Connect SDK - v0.3.0
Connect SDK
@wormhole-foundation/connect-sdk-evm-tokenbridge
EvmTokenBridge
Class EvmTokenBridge<N, C>
Type Parameters
N
extends
Network
C
extends
EvmChains
Hierarchy
EvmTokenBridge
Implements
TokenBridge
<
N
,
EvmPlatformType
,
C
>
Index
Constructors
constructor
Properties
chain
chain
Id
contracts
network
provider
token
Bridge
token
Bridge
Address
Methods
create
Attestation
create
Unsigned
Tx
get
Original
Asset
get
Wrapped
Asset
get
Wrapped
Native
has
Wrapped
Asset
is
Transfer
Completed
is
Wrapped
Asset
redeem
submit
Attestation
transfer
from
Rpc
Constructors
Private
constructor
new
Evm
Token
Bridge
<
N
,
C
>
(
network
,
chain
,
provider
,
contracts
)
:
EvmTokenBridge
<
N
,
C
>
Type Parameters
N
extends
"Mainnet"
|
"Testnet"
|
"Devnet"
C
extends
"Ethereum"
|
"Bsc"
|
"Polygon"
|
"Avalanche"
|
"Oasis"
|
"Aurora"
|
"Fantom"
|
"Karura"
|
"Acala"
|
"Klaytn"
|
"Celo"
|
"Moonbeam"
|
"Neon"
|
"Arbitrum"
|
"Optimism"
|
"Gnosis"
|
"Base"
|
"Rootstock"
|
"Sepolia"
|
"ArbitrumSepolia"
|
"BaseSepolia"
|
"OptimismSepolia"
|
"Holesky"
Parameters
network
:
N
chain
:
C
provider
:
Provider
contracts
:
Contracts
Returns
EvmTokenBridge
<
N
,
C
>
Properties
Readonly
chain
chain
:
C
Readonly
chain
Id
chain
Id
:
bigint
Readonly
contracts
contracts
:
Contracts
Readonly
network
network
:
N
Readonly
provider
provider
:
Provider
Readonly
token
Bridge
token
Bridge
:
TokenBridgeContract
Readonly
token
Bridge
Address
token
Bridge
Address
:
string
Methods
create
Attestation
create
Attestation
(
token
)
:
AsyncGenerator
<
EvmUnsignedTransaction
<
N
,
C
>
,
any
,
unknown
>
Parameters
token
:
TokenAddress
<
C
>
Returns
AsyncGenerator
<
EvmUnsignedTransaction
<
N
,
C
>
,
any
,
unknown
>
Private
create
Unsigned
Tx
create
Unsigned
Tx
(
txReq
,
description
,
parallelizable
?
)
:
EvmUnsignedTransaction
<
N
,
C
>
Parameters
txReq
:
TransactionRequest
description
:
string
parallelizable
:
boolean
= false
Returns
EvmUnsignedTransaction
<
N
,
C
>
get
Original
Asset
get
Original
Asset
(
token
)
:
Promise
<
TokenId
>
Parameters
token
:
TokenAddress
<
C
>
Returns
Promise
<
TokenId
>
get
Wrapped
Asset
get
Wrapped
Asset
(
token
)
:
Promise
<
NativeAddress
<
C
>
>
Parameters
token
:
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
<
NativeAddress
<
C
>
>
get
Wrapped
Native
get
Wrapped
Native
(
)
:
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
>
>
has
Wrapped
Asset
has
Wrapped
Asset
(
token
)
:
Promise
<
boolean
>
Parameters
token
:
TokenId
Returns
Promise
<
boolean
>
is
Transfer
Completed
is
Transfer
Completed
(
vaa
)
:
Promise
<
boolean
>
Parameters
vaa
:
VAA
<
"TokenBridge:Transfer"
>
|
VAA
<
"TokenBridge:TransferWithPayload"
>
Returns
Promise
<
boolean
>
is
Wrapped
Asset
is
Wrapped
Asset
(
token
)
:
Promise
<
boolean
>
Parameters
token
:
TokenAddress
<
C
>
Returns
Promise
<
boolean
>
redeem
redeem
(
sender
,
vaa
,
unwrapNative
?
)
:
AsyncGenerator
<
EvmUnsignedTransaction
<
N
,
C
>
,
any
,
unknown
>
Parameters
sender
:
AccountAddress
<
C
>
vaa
:
VAA
<
"TokenBridge:Transfer"
>
|
VAA
<
"TokenBridge:TransferWithPayload"
>
unwrapNative
:
boolean
= true
Returns
AsyncGenerator
<
EvmUnsignedTransaction
<
N
,
C
>
,
any
,
unknown
>
submit
Attestation
submit
Attestation
(
vaa
)
:
AsyncGenerator
<
EvmUnsignedTransaction
<
N
,
C
>
,
any
,
unknown
>
Parameters
vaa
:
VAA
<
"TokenBridge:AttestMeta"
>
Returns
AsyncGenerator
<
EvmUnsignedTransaction
<
N
,
C
>
,
any
,
unknown
>
transfer
transfer
(
sender
,
recipient
,
token
,
amount
,
payload
?
)
:
AsyncGenerator
<
EvmUnsignedTransaction
<
N
,
C
>
,
any
,
unknown
>
Parameters
sender
:
AccountAddress
<
C
>
recipient
:
ChainAddress
token
:
TokenAddress
<
C
>
amount
:
bigint
Optional
payload
:
Uint8Array
Returns
AsyncGenerator
<
EvmUnsignedTransaction
<
N
,
C
>
,
any
,
unknown
>
Static
from
Rpc
from
Rpc
<
N
>
(
provider
,
config
)
:
Promise
<
EvmTokenBridge
<
N
,
"Ethereum"
|
"Bsc"
|
"Polygon"
|
"Avalanche"
|
"Oasis"
|
"Aurora"
|
"Fantom"
|
"Karura"
|
"Acala"
|
"Klaytn"
|
"Celo"
|
"Moonbeam"
|
"Neon"
|
"Arbitrum"
|
"Optimism"
|
"Gnosis"
|
"Base"
|
"Rootstock"
|
"Sepolia"
|
"ArbitrumSepolia"
|
"BaseSepolia"
|
"OptimismSepolia"
|
"Holesky"
>
>
Type Parameters
N
extends
"Mainnet"
|
"Testnet"
|
"Devnet"
Parameters
provider
:
Provider
config
:
ChainsConfig
<
N
,
"Solana"
|
"Algorand"
|
"Near"
|
"Sui"
|
"Aptos"
|
"Btc"
|
"Evm"
|
"Cosmwasm"
>
Returns
Promise
<
EvmTokenBridge
<
N
,
"Ethereum"
|
"Bsc"
|
"Polygon"
|
"Avalanche"
|
"Oasis"
|
"Aurora"
|
"Fantom"
|
"Karura"
|
"Acala"
|
"Klaytn"
|
"Celo"
|
"Moonbeam"
|
"Neon"
|
"Arbitrum"
|
"Optimism"
|
"Gnosis"
|
"Base"
|
"Rootstock"
|
"Sepolia"
|
"ArbitrumSepolia"
|
"BaseSepolia"
|
"OptimismSepolia"
|
"Holesky"
>
>
Settings
Member Visibility
Protected
Private
Inherited
Theme
OS
Light
Dark
On This Page
constructor
chain
chain
Id
contracts
network
provider
token
Bridge
token
Bridge
Address
create
Attestation
create
Unsigned
Tx
get
Original
Asset
get
Wrapped
Asset
get
Wrapped
Native
has
Wrapped
Asset
is
Transfer
Completed
is
Wrapped
Asset
redeem
submit
Attestation
transfer
from
Rpc
Connect SDK -
v0.3.0
@wormhole-
foundation/sdk-
base -
v0.3.0
@wormhole-
foundation/sdk-
definitions -
v0.3.0
@wormhole-
foundation/connect-
sdk -
v0.3.0
@wormhole-
foundation/connect-
sdk-
evm -
v0.3.0
@wormhole-
foundation/connect-
sdk-
evm-
core -
v0.3.0
@wormhole-
foundation/connect-
sdk-
evm-
tokenbridge -
v0.3.0
ethers_
contracts
Evm
Automatic
Token
Bridge
Evm
Token
Bridge
@wormhole-
foundation/connect-
sdk-
evm-
cctp -
v0.3.0
@wormhole-
foundation/connect-
sdk-
solana -
v0.3.0
@wormhole-
foundation/connect-
sdk-
solana-
core -
v0.3.0
@wormhole-
foundation/connect-
sdk-
solana-
tokenbridge -
v0.3.0
@wormhole-
foundation/connect-
sdk-
cosmwasm -
v0.3.0
@wormhole-
foundation/connect-
sdk-
cosmwasm-
core -
v0.3.0
@wormhole-
foundation/connect-
sdk-
cosmwasm-
tokenbridge -
v0.3.0
@wormhole-
foundation/connect-
sdk-
cosmwasm-
ibc -
v0.3.0
Generated using
TypeDoc