Class Token`Namespace`

Class reprensenting ERC20 Token Token

Hierarchy

Base
- Token

Index

Constructors

Accessors

availableLiqudityJsonUrl chainId configChains coreConfigJsonUrl imageUrl isNativeToken nativeTokenSymbol supportedChains supportedNetworks symbol

Methods

_getBonderAddress _getMessengerWrapperAddress allowance approve balanceOf checkBlocklist connect debugTimeLog eq estimateGas estimateOptimismL1FeeFromData fetchBonderAvailableLiquidityData fetchBonderAvailableLiquidityDataWithIpfsFallback fetchConfigFromS3 fetchCoreConfigData fetchCoreConfigDataWithIpfsFallback fetchIpfsBonderAvailableLiquidityData fetchIpfsCoreConfigData geConfigChains getArbChainAddress getAvailableRoutes getBumpedGasPrice getChainId getChainProvider getChainProviderUrls getChainProviders getConfigAddresses getDebugTimeLogs getDestinationFeeGasPriceMultiplier getErc20 getExplorerUrl getExplorerUrlForAccount getExplorerUrlForTransactionHash getExplorerUrlForTransferId getFeeBps getGasEstimateFromAddress getImageUrl getIpfsBaseConfigUrl getIsBridgeDeprecated getL1AmbBridgeAddress getL1BridgeAddress getL1CanonicalBridgeAddress getL1CanonicalTokenAddress getL1PosErc20PredicateAddress getL1PosRootChainManagerAddress getL2AmbBridgeAddress getL2AmmWrapperAddress getL2BridgeAddress getL2CanonicalBridgeAddress getL2CanonicalTokenAddress getL2HopBridgeTokenAddress getL2SaddleLpTokenAddress getL2SaddleSwapAddress getNativeTokenBalance getProviderRpcUrl getRelayerFee getS3ConfigData getSignerAddress getSignerOrProvider getSupportedAssets getSupportedAssetsForChain getSupportedChains getSupportedTokens getTokenBalancesForAccount getTransferStatus getTransferTimes getWethContract getWrapTokenEstimatedGas getWrappedToken isValidChain isValidNetwork needsApproval overrides populateApproveTx populateUnwrapTokenTx populateWrapTokenTx resolveDnslink sendTransaction setAvailableLiqudityJsonUrl setBaseConfigUrl setChainProvider setChainProviderUrls setChainProviders setConfigAddresses setConfigFileFetchEnabled setCoreConfigJsonUrl setGasPriceMultiplier toChainModel toJSON toTokenModel totalSupply transfer txOverrides unwrapToken wrapToken fromJSON

Constructors

constructor

new Token(networkOrOptionsObject, chain?, address?, decimals?, symbol?, name?, image?, signer?, chainProviders?): Token
Parameters
- networkOrOptionsObject: string | TokenConstructorOptions
  
  L1 network name (e.g. 'mainnet', 'goerli')
- Optional chain: TChain
  
  Chain
- Optional address: string
  
  Token address.
- Optional decimals: number
  
  Token decimals.
- Optional symbol: string
  
  Token symbol.
- Optional name: string
  
  Token name.
- Optional image: string
- Optional signer: Provider | Signer
  
  Ethers signer.
- Optional chainProviders: ChainProviders
Returns Token
Token class instance.

Desc
Instantiates Token class.
Overrides Base.constructor
- Defined in src/Token.ts:45

Properties

_symbol

_symbol: string

`Readonly` address

address: string

addresses

addresses: Record<string, any>

baseConfigUrl

baseConfigUrl: string = defaultBaseConfigUrl

baseExplorerUrl

baseExplorerUrl: string = 'https://explorer.hop.exchange'

blocklist

blocklist: Record<string, boolean> = null

bonders

bonders: Record<string, any>

bridgeDeprecated

bridgeDeprecated: Record<string, boolean>

`Readonly` chain

chain: Chain

chainProviders

chainProviders: ChainProviders = {}

chains

chains: Record<string, any>

configFileFetchEnabled

configFileFetchEnabled: boolean = true

`Readonly` contract

contract: Contract

customAvailableLiquidityJsonUrl

customAvailableLiquidityJsonUrl: string = ''

customCoreConfigJsonUrl

customCoreConfigJsonUrl: string = ''

debugTimeLogsCache

debugTimeLogsCache: any[] = []

debugTimeLogsCacheEnabled

debugTimeLogsCacheEnabled: boolean = false

debugTimeLogsEnabled

debugTimeLogsEnabled: boolean = false

`Readonly` decimals

decimals: number

destinationFeeGasPriceMultiplier

destinationFeeGasPriceMultiplier: number = 1

fees

fees: {
[token: string]: Record<string, number>;
}

Type declaration

[token: string]: Record<string, number>

gasPriceMultiplier

gasPriceMultiplier: number = 0

getContract

getContract: ((factory, address, provider) => Promise<any>) = getContract

Type declaration

- (factory, address, provider): Promise<any>
- Parameters
  - factory: Factory
  - address: string
  - provider: TProvider
  Returns Promise<any>

getGasPrice

getGasPrice: ((...args) => Promise<BigNumber>) = ...

Type declaration

- (...args): Promise<BigNumber>
- Parameters
  - Rest ...args: [signerOrProvider: TProvider]
  Returns Promise<BigNumber>

`Readonly` image

image: string

`Readonly` name

name: string

network

network: string

Network name

relayerFeeEnabled

relayerFeeEnabled: Record<string, boolean>

relayerFeeWei

relayerFeeWei: Record<string, string>

signer

signer: TProvider

Ethers signer or provider

Accessors

availableLiqudityJsonUrl

get availableLiqudityJsonUrl(): string
Returns string
Inherited from Base.availableLiqudityJsonUrl
- Defined in src/Base.ts:876

chainId

get chainId(): number
Returns number
- Defined in src/Token.ts:254

configChains

get configChains(): string[]
Returns string[]
Inherited from Base.configChains
- Defined in src/Base.ts:366

coreConfigJsonUrl

get coreConfigJsonUrl(): string
Returns string
Inherited from Base.coreConfigJsonUrl
- Defined in src/Base.ts:827

imageUrl

get imageUrl(): string
Returns string
- Defined in src/Token.ts:409

isNativeToken

get isNativeToken(): boolean
Returns boolean
- Defined in src/Token.ts:266

nativeTokenSymbol

get nativeTokenSymbol(): string
Returns string
- Defined in src/Token.ts:278

supportedChains

get supportedChains(): string[]
Returns string[]
Inherited from Base.supportedChains
- Defined in src/Base.ts:361

supportedNetworks

get supportedNetworks(): string[]
Returns string[]
Inherited from Base.supportedNetworks
- Defined in src/Base.ts:351

symbol

get symbol(): string
Returns string
- Defined in src/Token.ts:87

Methods

`Protected` _getBonderAddress

_getBonderAddress(token, sourceChain, destinationChain): Promise<string>
Parameters
- token: TToken
- sourceChain: TChain
- destinationChain: TChain
Returns Promise<string>
Inherited from Base._getBonderAddress
- Defined in src/Base.ts:689

`Protected` _getMessengerWrapperAddress

_getMessengerWrapperAddress(token, destinationChain): Promise<string>
Parameters
- token: TToken
- destinationChain: TChain
Returns Promise<string>
Inherited from Base._getMessengerWrapperAddress
- Defined in src/Base.ts:703

allowance

allowance(spender, address?): Promise<BigNumber>

Parameters

spender: string

spender address.
Optional address: string

Returns Promise<BigNumber>

Ethers Transaction object.

Desc

Returns token allowance.

Example

import { Hop, Chain } from '@hop-protocol/sdk'

const hop = new Hop('mainnet')
const bridge = hop.bridge('USDC')
const token = bridge.getCanonicalToken(Chain.Polygon)
const spender = await bridge.getSendApprovalAddress(Chain.Polygon)
const account = '0x90F8bf6A479f320ead074411a4B0e7944Ea8c9C1'
const allowance = await token.allowance(spender, account)
console.log(allowance)

approve

approve(spender, amount?): Promise<any>

Parameters

spender: string

spender address.
amount: BigNumberish = ethers.constants.MaxUint256

amount allowed to spend.

Returns Promise<any>

Ethers Transaction object.

Desc

Approve address to spend tokens if not enough allowance .

Example

import { Hop, Chain } from '@hop-protocol/sdk'

const bridge = hop.bridge('USDC').connect(signer)
const spender = '0x90F8bf6A479f320ead074411a4B0e7944Ea8c9C1'
const amount = '1000000000000000000'
const tx = await bridge.approve(Chain.Gnosis, spender, amount)

balanceOf

balanceOf(address?): Promise<BigNumber>

Parameters

Optional address: string

account address.

Returns Promise<BigNumber>

Ethers Transaction object.

Desc

Returns token balance of signer.

Example

import { Hop, Chain } from '@hop-protocol/sdk'

const bridge = hop.bridge('USDC').connect(signer)
const spender = '0x90F8bf6A479f320ead074411a4B0e7944Ea8c9C1'
const allowance = bridge.allowance(Chain.Gnosis, spender)

checkBlocklist

checkBlocklist(): Promise<void>
Returns Promise<void>
Inherited from Base.checkBlocklist
- Defined in src/Base.ts:293

connect

connect(signer): Token
Parameters
- signer: Provider | Signer
  
  Ethers Signer for signing transactions.
Returns Token
New Token SDK instance with connected signer.

Desc
Returns a token instance with signer connected. Used for adding or changing signer.
- Defined in src/Token.ts:99

debugTimeLog

debugTimeLog(label, timeStart): void
Parameters
- label: string
- timeStart: number
Returns void
Inherited from Base.debugTimeLog
- Defined in src/Base.ts:1076

eq

eq(token): boolean
Parameters
- token: Token
Returns boolean
- Defined in src/Token.ts:258

estimateGas

estimateGas(signerOrProvider, tx): Promise<BigNumber>
Parameters
- signerOrProvider: TProvider
- tx: any
Returns Promise<BigNumber>
Inherited from Base.estimateGas
- Defined in src/Base.ts:1069

estimateOptimismL1FeeFromData

estimateOptimismL1FeeFromData(gasLimit, data?, to?, destChain?): Promise<any>
Parameters
- gasLimit: BigNumberish
- data: string = '0x'
- to: string = constants.AddressZero
- destChain: string | Chain = Chain.Optimism
Returns Promise<any>
Inherited from Base.estimateOptimismL1FeeFromData
- Defined in src/Base.ts:942

fetchBonderAvailableLiquidityData

fetchBonderAvailableLiquidityData(): Promise<any>
Returns Promise<any>
Inherited from Base.fetchBonderAvailableLiquidityData
- Defined in src/Base.ts:835

fetchBonderAvailableLiquidityDataWithIpfsFallback

fetchBonderAvailableLiquidityDataWithIpfsFallback(): Promise<any>
Returns Promise<any>
Inherited from Base.fetchBonderAvailableLiquidityDataWithIpfsFallback
- Defined in src/Base.ts:853

fetchConfigFromS3

fetchConfigFromS3(): Promise<any>
Returns Promise<any>
Inherited from Base.fetchConfigFromS3
- Defined in src/Base.ts:243

fetchCoreConfigData

fetchCoreConfigData(): Promise<any>
Returns Promise<any>
Inherited from Base.fetchCoreConfigData
- Defined in src/Base.ts:789

fetchCoreConfigDataWithIpfsFallback

fetchCoreConfigDataWithIpfsFallback(): Promise<any>
Returns Promise<any>
Inherited from Base.fetchCoreConfigDataWithIpfsFallback
- Defined in src/Base.ts:799

fetchIpfsBonderAvailableLiquidityData

fetchIpfsBonderAvailableLiquidityData(): Promise<any>
Returns Promise<any>
Inherited from Base.fetchIpfsBonderAvailableLiquidityData
- Defined in src/Base.ts:1045

fetchIpfsCoreConfigData

fetchIpfsCoreConfigData(): Promise<any>
Returns Promise<any>
Inherited from Base.fetchIpfsCoreConfigData
- Defined in src/Base.ts:1034

geConfigChains

geConfigChains(): string[]
Returns string[]
Inherited from Base.geConfigChains
- Defined in src/Base.ts:375

getArbChainAddress

getArbChainAddress(token, chain): string
Parameters
- token: TToken
- chain: TChain
Returns string
Inherited from Base.getArbChainAddress
- Defined in src/Base.ts:611

getAvailableRoutes

getAvailableRoutes(): Promise<any>
Returns Promise<any>
Inherited from Base.getAvailableRoutes
- Defined in src/Base.ts:917

getBumpedGasPrice

getBumpedGasPrice(signer, percent): Promise<BigNumber>
Parameters
- signer: TProvider
  
  Ether's Signer
- percent: number
  
  Percentage to bump by.
Returns Promise<BigNumber>
Bumped as price as BigNumber
Desc
Calculates current gas price plus increased percentage amount.

Example
```
import { Hop } from '@hop-protocol/sdk'

const hop = new Hop()
const bumpedGasPrice = await hop.getBumpedGasPrice(signer, 1.20)
console.log(bumpedGasPrice.toNumber())
```
Inherited from Base.getBumpedGasPrice
- Defined in src/Base.ts:442

getChainId

getChainId(chain): number
Parameters
- chain: Chain
  
  Chain model.
Returns number
- Chain ID.
Desc
Returns Chain ID for specified Chain model.
Inherited from Base.getChainId
- Defined in src/Base.ts:452

getChainProvider

getChainProvider(chain): any
Parameters
- chain: string | Chain
  
  Chain model.
Returns any
Ethers provider.

Desc
Returns Ethers provider for specified Chain model.
Inherited from Base.getChainProvider
- Defined in src/Base.ts:462

getChainProviderUrls

getChainProviderUrls(): any
Returns any
Inherited from Base.getChainProviderUrls
- Defined in src/Base.ts:493

getChainProviders

getChainProviders(): any
Returns any
Inherited from Base.getChainProviders
- Defined in src/Base.ts:483

getConfigAddresses

getConfigAddresses(token, chain): any
Parameters
- token: TToken
- chain: TChain
Returns any
Inherited from Base.getConfigAddresses
- Defined in src/Base.ts:564

getDebugTimeLogs

getDebugTimeLogs(): any[]
Returns any[]
Inherited from Base.getDebugTimeLogs
- Defined in src/Base.ts:1091

getDestinationFeeGasPriceMultiplier

getDestinationFeeGasPriceMultiplier(): number
Returns number
Inherited from Base.getDestinationFeeGasPriceMultiplier
- Defined in src/Base.ts:741

getErc20

getErc20(): Promise<any>
Returns Promise<any>
Ethers contract instance.

Desc
Returns a token Ethers contract instance.
- Defined in src/Token.ts:241

getExplorerUrl

getExplorerUrl(): string
Returns string
Inherited from Base.getExplorerUrl
- Defined in src/Base.ts:966

getExplorerUrlForAccount

getExplorerUrlForAccount(accountAddress): string
Parameters
- accountAddress: string
Returns string
Inherited from Base.getExplorerUrlForAccount
- Defined in src/Base.ts:970

getExplorerUrlForTransactionHash

getExplorerUrlForTransactionHash(transactionHash): string
Parameters
- transactionHash: string
Returns string
Inherited from Base.getExplorerUrlForTransactionHash
- Defined in src/Base.ts:978

getExplorerUrlForTransferId

getExplorerUrlForTransferId(transferId): string
Parameters
- transferId: string
Returns string
Inherited from Base.getExplorerUrlForTransferId
- Defined in src/Base.ts:974

getFeeBps

getFeeBps(token, destinationChain): Promise<number>
Parameters
- token: TToken
- destinationChain: TChain
Returns Promise<number>
Inherited from Base.getFeeBps
- Defined in src/Base.ts:716

`Private` getGasEstimateFromAddress

getGasEstimateFromAddress(): Promise<string>
Returns Promise<string>
- Defined in src/Token.ts:370

getImageUrl

getImageUrl(): string
Returns string
- Defined in src/Token.ts:413

getIpfsBaseConfigUrl

getIpfsBaseConfigUrl(ipfsHash): string
Parameters
- ipfsHash: string
Returns string
Inherited from Base.getIpfsBaseConfigUrl
- Defined in src/Base.ts:1029

getIsBridgeDeprecated

getIsBridgeDeprecated(token): Promise<boolean>
Parameters
- token: TToken
Returns Promise<boolean>
Inherited from Base.getIsBridgeDeprecated
- Defined in src/Base.ts:745

getL1AmbBridgeAddress

getL1AmbBridgeAddress(token, chain): string
Parameters
- token: TToken
- chain: TChain
Returns string
Inherited from Base.getL1AmbBridgeAddress
- Defined in src/Base.ts:616

getL1BridgeAddress

getL1BridgeAddress(token, chain): string
Parameters
- token: TToken
- chain: TChain
Returns string
Inherited from Base.getL1BridgeAddress
- Defined in src/Base.ts:570

getL1CanonicalBridgeAddress

getL1CanonicalBridgeAddress(token, chain): string
Parameters
- token: TToken
- chain: TChain
Returns string
Inherited from Base.getL1CanonicalBridgeAddress
- Defined in src/Base.ts:578

getL1CanonicalTokenAddress

getL1CanonicalTokenAddress(token, chain): string
Parameters
- token: TToken
- chain: TChain
Returns string
Inherited from Base.getL1CanonicalTokenAddress
- Defined in src/Base.ts:586

getL1PosErc20PredicateAddress

getL1PosErc20PredicateAddress(token, chain): string
Parameters
- token: TToken
- chain: TChain
Returns string
Inherited from Base.getL1PosErc20PredicateAddress
- Defined in src/Base.ts:631

getL1PosRootChainManagerAddress

getL1PosRootChainManagerAddress(token, chain): string
Parameters
- token: TToken
- chain: TChain
Returns string
Inherited from Base.getL1PosRootChainManagerAddress
- Defined in src/Base.ts:626

getL2AmbBridgeAddress

getL2AmbBridgeAddress(token, chain): string
Parameters
- token: TToken
- chain: TChain
Returns string
Inherited from Base.getL2AmbBridgeAddress
- Defined in src/Base.ts:621

getL2AmmWrapperAddress

getL2AmmWrapperAddress(token, chain): string
Parameters
- token: TToken
- chain: TChain
Returns string
Inherited from Base.getL2AmmWrapperAddress
- Defined in src/Base.ts:598

getL2BridgeAddress

getL2BridgeAddress(token, chain): string
Parameters
- token: TToken
- chain: TChain
Returns string
Inherited from Base.getL2BridgeAddress
- Defined in src/Base.ts:574

getL2CanonicalBridgeAddress

getL2CanonicalBridgeAddress(token, chain): string
Parameters
- token: TToken
- chain: TChain
Returns string
Inherited from Base.getL2CanonicalBridgeAddress
- Defined in src/Base.ts:582

getL2CanonicalTokenAddress

getL2CanonicalTokenAddress(token, chain): string
Parameters
- token: TToken
- chain: TChain
Returns string
Inherited from Base.getL2CanonicalTokenAddress
- Defined in src/Base.ts:590

getL2HopBridgeTokenAddress

getL2HopBridgeTokenAddress(token, chain): string
Parameters
- token: TToken
- chain: TChain
Returns string
Inherited from Base.getL2HopBridgeTokenAddress
- Defined in src/Base.ts:594

getL2SaddleLpTokenAddress

getL2SaddleLpTokenAddress(token, chain): string
Parameters
- token: TToken
- chain: TChain
Returns string
Inherited from Base.getL2SaddleLpTokenAddress
- Defined in src/Base.ts:606

getL2SaddleSwapAddress

getL2SaddleSwapAddress(token, chain): string
Parameters
- token: TToken
- chain: TChain
Returns string
Inherited from Base.getL2SaddleSwapAddress
- Defined in src/Base.ts:602

getNativeTokenBalance

getNativeTokenBalance(address?): Promise<BigNumber>
Parameters
- Optional address: string
Returns Promise<BigNumber>
- Defined in src/Token.ts:282

getProviderRpcUrl

getProviderRpcUrl(provider): string
Parameters
- provider: any
Returns string
Inherited from Base.getProviderRpcUrl
- Defined in src/Base.ts:996

getRelayerFee

getRelayerFee(destinationChain, tokenSymbol): Promise<BigNumber>
Parameters
- destinationChain: TChain
- tokenSymbol: string
Returns Promise<BigNumber>
Inherited from Base.getRelayerFee
- Defined in src/Base.ts:755

getS3ConfigData

getS3ConfigData(): Promise<any>
Returns Promise<any>
Inherited from Base.getS3ConfigData
- Defined in src/Base.ts:815

getSignerAddress

getSignerAddress(): Promise<string>
Returns Promise<string>
Ethers signer address.
Desc
Returns the connected signer address.

Example
```
import { Hop } from '@hop-protocol/sdk'

const hop = new Hop()
const address = await hop.getSignerAddress()
console.log(address)
```
Inherited from Base.getSignerAddress
- Defined in src/Base.ts:515

getSignerOrProvider

getSignerOrProvider(chain, signer?): Promise<Provider | Signer>
Parameters
- chain: TChain
  
  Chain name or model
- signer: TProvider = ...
  
  Ethers signer or provider
Returns Promise<Provider | Signer>
Ethers signer or provider

Desc
Returns the connected signer if it's connected to the specified chain id, otherwise it returns a regular provider for the specified chain.
Inherited from Base.getSignerOrProvider
- Defined in src/Base.ts:528

getSupportedAssets

getSupportedAssets(): any
Returns any
Inherited from Base.getSupportedAssets
- Defined in src/Base.ts:897

getSupportedAssetsForChain

getSupportedAssetsForChain(chain): any
Parameters
- chain: TChain
Returns any
Inherited from Base.getSupportedAssetsForChain
- Defined in src/Base.ts:911

getSupportedChains

getSupportedChains(): string[]
Returns string[]
Inherited from Base.getSupportedChains
- Defined in src/Base.ts:371

getSupportedTokens

getSupportedTokens(): string[]
Returns string[]
Inherited from Base.getSupportedTokens
- Defined in src/Base.ts:887

getTokenBalancesForAccount

getTokenBalancesForAccount(accountAddress): Promise<Balance[]>
Parameters
- accountAddress: string
Returns Promise<Balance[]>
Inherited from Base.getTokenBalancesForAccount
- Defined in src/Base.ts:1098

getTransferStatus

getTransferStatus(transferIdOrTxHash): Promise<any>
Parameters
- transferIdOrTxHash: string
Returns Promise<any>
Inherited from Base.getTransferStatus
- Defined in src/Base.ts:982

getTransferTimes

getTransferTimes(sourceChainSlug, destinationChainSlug): Promise<any>
Parameters
- sourceChainSlug: string
- destinationChainSlug: string
Returns Promise<any>
Inherited from Base.getTransferTimes
- Defined in src/Base.ts:989

getWethContract

getWethContract(): Promise<any>
Returns Promise<any>
- Defined in src/Token.ts:290

getWrapTokenEstimatedGas

getWrapTokenEstimatedGas(chain): Promise<any>
Parameters
- chain: TChain
Returns Promise<any>
- Defined in src/Token.ts:345

getWrappedToken

getWrappedToken(): Token
Returns Token
- Defined in src/Token.ts:295

isValidChain

isValidChain(chain): boolean
Parameters
- chain: string
Returns boolean
Inherited from Base.isValidChain
- Defined in src/Base.ts:379

isValidNetwork

isValidNetwork(network): boolean
Parameters
- network: string
Returns boolean
Inherited from Base.isValidNetwork
- Defined in src/Base.ts:355

needsApproval

needsApproval(spender, amount, address?): Promise<boolean>
Parameters
- spender: string
- amount: BigNumberish
- Optional address: string
Returns Promise<boolean>
- Defined in src/Token.ts:139

overrides

overrides(): Promise<any>
Returns Promise<any>
- Defined in src/Token.ts:249

populateApproveTx

populateApproveTx(spender, amount?): Promise<any>
Parameters
- spender: string
- amount: BigNumberish = ethers.constants.MaxUint256
Returns Promise<any>
- Defined in src/Token.ts:226

populateUnwrapTokenTx

populateUnwrapTokenTx(amount): Promise<any>
Parameters
- amount: BigNumberish
Returns Promise<any>
- Defined in src/Token.ts:335

populateWrapTokenTx

populateWrapTokenTx(amount): Promise<any>
Parameters
- amount: BigNumberish
Returns Promise<any>
- Defined in src/Token.ts:313

resolveDnslink

resolveDnslink(dnslinkDomain): Promise<string>
Parameters
- dnslinkDomain: string
Returns Promise<string>
Inherited from Base.resolveDnslink
- Defined in src/Base.ts:1000

sendTransaction

sendTransaction(transactionRequest, chain): Promise<any>
Parameters
- transactionRequest: TransactionRequest
- chain: TChain
Returns Promise<any>
Inherited from Base.sendTransaction
- Defined in src/Base.ts:287

setAvailableLiqudityJsonUrl

setAvailableLiqudityJsonUrl(url): Promise<void>
Parameters
- url: string
Returns Promise<void>
Inherited from Base.setAvailableLiqudityJsonUrl
- Defined in src/Base.ts:869

setBaseConfigUrl

setBaseConfigUrl(url): Promise<void>
Parameters
- url: string
Returns Promise<void>
Inherited from Base.setBaseConfigUrl
- Defined in src/Base.ts:774

setChainProvider

setChainProvider(chain, provider): void
Parameters
- chain: TChain
- provider: Provider
Returns void
Inherited from Base.setChainProvider
- Defined in src/Base.ts:313

setChainProviderUrls

setChainProviderUrls(chainProviders): void
Parameters
- chainProviders: Record<string, string>
Returns void
Inherited from Base.setChainProviderUrls
- Defined in src/Base.ts:337

setChainProviders

setChainProviders(chainProviders): void
Parameters
- chainProviders: ChainProviders
Returns void
Inherited from Base.setChainProviders
- Defined in src/Base.ts:323

setConfigAddresses

setConfigAddresses(addresses): void
Parameters
- addresses: Addresses
Returns void
Inherited from Base.setConfigAddresses
- Defined in src/Base.ts:304

setConfigFileFetchEnabled

setConfigFileFetchEnabled(enabled): void
Parameters
- enabled: boolean
Returns void
Inherited from Base.setConfigFileFetchEnabled
- Defined in src/Base.ts:785

setCoreConfigJsonUrl

setCoreConfigJsonUrl(url): Promise<any>
Parameters
- url: string
Returns Promise<any>
Inherited from Base.setCoreConfigJsonUrl
- Defined in src/Base.ts:820

setGasPriceMultiplier

setGasPriceMultiplier(gasPriceMultiplier): number
Parameters
- gasPriceMultiplier: number
Returns number
Inherited from Base.setGasPriceMultiplier
- Defined in src/Base.ts:737

toChainModel

toChainModel(chain): Chain
Parameters
- chain: TChain
  
  Chain name or model.
Returns Chain
Chain model with connected provider.

Desc
Returns a Chain model instance with connected provider.
Inherited from Base.toChainModel
- Defined in src/Base.ts:388

toJSON

toJSON(): any
Returns any
- Defined in src/Token.ts:398

toTokenModel

toTokenModel(token): TokenModel
Parameters
- token: TToken
  
  Token name or model.
Returns TokenModel
Token model.

Desc
Returns a Token instance.
Inherited from Base.toTokenModel
- Defined in src/Base.ts:418

totalSupply

totalSupply(): Promise<BigNumber>
Returns Promise<BigNumber>
- Defined in src/Token.ts:378

transfer

transfer(recipient, amount): Promise<any>

Parameters

recipient: string

recipient address.
amount: BigNumberish

Token amount.

Returns Promise<any>

Ethers Transaction object.

Desc

ERC20 token transfer

Example

import { Hop } from '@hop-protocol/sdk'

const bridge = hop.bridge('USDC').connect(signer)
const recipient = '0x90F8bf6A479f320ead074411a4B0e7944Ea8c9C1'
const amount = '1000000000000000000'
const tx = await bridge.erc20Transfer(spender, amount)

txOverrides

txOverrides(sourceChain, destinationChain?): Promise<any>
Parameters
- sourceChain: TChain
- Optional destinationChain: TChain
Returns Promise<any>
Inherited from Base.txOverrides
- Defined in src/Base.ts:636

unwrapToken

unwrapToken(amount): Promise<any>
Parameters
- amount: BigNumberish
Returns Promise<any>
- Defined in src/Token.ts:340

wrapToken

wrapToken(amount, estimateGasOnly?): Promise<any>
Parameters
- amount: BigNumberish
- estimateGasOnly: boolean = false
Returns Promise<any>
- Defined in src/Token.ts:320

`Static` fromJSON

fromJSON(json): Token
Parameters
- json: any
Returns Token
- Defined in src/Token.ts:386

Class TokenNamespace

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

networkOrOptionsObject: string | TokenConstructorOptions

Optional chain: TChain

Optional address: string

Optional decimals: number

Optional symbol: string

Optional name: string

Optional image: string

Optional signer: Provider | Signer

Optional chainProviders: ChainProviders

Returns Token

Desc

Properties

_symbol

Readonly address

addresses

baseConfigUrl

baseExplorerUrl

blocklist

bonders

bridgeDeprecated

Readonly chain

chainProviders

chains

configFileFetchEnabled

Readonly contract

customAvailableLiquidityJsonUrl

customCoreConfigJsonUrl

debugTimeLogsCache

debugTimeLogsCacheEnabled

debugTimeLogsEnabled

Readonly decimals

destinationFeeGasPriceMultiplier

fees

Type declaration

[token: string]: Record<string, number>

gasPriceMultiplier

getContract

Type declaration

Parameters

factory: Factory

address: string

provider: TProvider

Returns Promise<any>

getGasPrice

Type declaration

Parameters

Rest ...args: [signerOrProvider: TProvider]

Returns Promise<BigNumber>

Readonly image

Readonly name

network

relayerFeeEnabled

relayerFeeWei

signer

Accessors

availableLiqudityJsonUrl

Returns string

chainId

Returns number

configChains

Returns string[]

coreConfigJsonUrl

Returns string

imageUrl

Returns string

isNativeToken

Returns boolean

nativeTokenSymbol

Returns string

supportedChains

Class Token`Namespace`

`Optional` chain: TChain

`Optional` address: string

`Optional` decimals: number

`Optional` symbol: string

`Optional` name: string

`Optional` image: string

`Optional` signer: Provider | Signer

`Optional` chainProviders: ChainProviders

`Readonly` address

`Readonly` chain

`Readonly` contract

`Readonly` decimals

`Rest` ...args: [signerOrProvider: TProvider]

`Readonly` image

`Readonly` name

`Protected` _getBonderAddress

`Protected` _getMessengerWrapperAddress

`Optional` address: string

`Optional` address: string