Preparing search index...
The search index is not available
Connect SDK - v0.3.0
Connect SDK
@wormhole-foundation/connect-sdk-evm-tokenbridge
EvmAutomaticTokenBridge
Class EvmAutomaticTokenBridge<N, C>
Type Parameters
N
extends
Network
C
extends
EvmChains
Hierarchy
EvmAutomaticTokenBridge
Implements
AutomaticTokenBridge
<
N
,
EvmPlatformType
,
C
>
Index
Constructors
constructor
Properties
chain
chain
Id
contracts
network
provider
token
Bridge
token
Bridge
Relayer
Methods
create
Unsigned
Tx
get
Registered
Tokens
get
Relayer
Fee
is
Registered
Token
max
Swap
Amount
native
Token
Amount
redeem
transfer
from
Rpc
Constructors
Private
constructor
new
Evm
Automatic
Token
Bridge
<
N
,
C
>
(
network
,
chain
,
provider
,
contracts
)
:
EvmAutomaticTokenBridge
<
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
EvmAutomaticTokenBridge
<
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
Relayer
token
Bridge
Relayer
:
ethers_contracts
.
TokenBridgeRelayer
Methods
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
Registered
Tokens
get
Registered
Tokens
(
)
:
Promise
<
NativeAddress
<
C
>
[]
>
Returns
Promise
<
NativeAddress
<
C
>
[]
>
get
Relayer
Fee
get
Relayer
Fee
(
sender
,
recipient
,
token
)
:
Promise
<
bigint
>
Parameters
sender
:
AccountAddress
<
C
>
recipient
:
ChainAddress
token
:
TokenAddress
<
C
>
Returns
Promise
<
bigint
>
is
Registered
Token
is
Registered
Token
(
token
)
:
Promise
<
boolean
>
Parameters
token
:
TokenAddress
<
C
>
Returns
Promise
<
boolean
>
max
Swap
Amount
max
Swap
Amount
(
token
)
:
Promise
<
bigint
>
Parameters
token
:
TokenAddress
<
C
>
Returns
Promise
<
bigint
>
native
Token
Amount
native
Token
Amount
(
token
,
amount
)
:
Promise
<
bigint
>
Parameters
token
:
TokenAddress
<
C
>
amount
:
bigint
Returns
Promise
<
bigint
>
redeem
redeem
(
sender
,
vaa
)
:
AsyncGenerator
<
EvmUnsignedTransaction
<
N
,
C
>
,
any
,
unknown
>
Parameters
sender
:
AccountAddress
<
C
>
vaa
:
VAA
<
"AutomaticTokenBridge:TransferWithRelay"
>
Returns
AsyncGenerator
<
EvmUnsignedTransaction
<
N
,
C
>
,
any
,
unknown
>
transfer
transfer
(
sender
,
recipient
,
token
,
amount
,
nativeGas
?
)
:
AsyncGenerator
<
EvmUnsignedTransaction
<
N
,
C
>
,
any
,
unknown
>
Parameters
sender
:
AccountAddress
<
C
>
recipient
:
ChainAddress
token
:
TokenAddress
<
C
>
amount
:
bigint
Optional
nativeGas
:
bigint
Returns
AsyncGenerator
<
EvmUnsignedTransaction
<
N
,
C
>
,
any
,
unknown
>
Static
from
Rpc
from
Rpc
<
N
>
(
provider
,
config
)
:
Promise
<
EvmAutomaticTokenBridge
<
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
,
"Evm"
>
Returns
Promise
<
EvmAutomaticTokenBridge
<
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
Relayer
create
Unsigned
Tx
get
Registered
Tokens
get
Relayer
Fee
is
Registered
Token
max
Swap
Amount
native
Token
Amount
redeem
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