Class Hop

Hierarchy

Base
- Hop

Index

Constructors

Constructors

constructor

new Hop(options?): Hop
Parameters
- Optional options: HopConstructorInput
Returns Hop
Overrides Base.constructor

Properties

batchBlocks

batchBlocks: number

contractAddresses

contractAddresses: Addresses

gasPriceMultiplier

gasPriceMultiplier: number

hubChainId

hubChainId: string

`Readonly` hubConnector

hubConnector: HubConnector

l1ChainId

l1ChainId: number

network

network: string

`Readonly` railsGateways

railsGateways: Record<string, RailsGateway> = {}

signersOrProviders

signersOrProviders: SignersOrProviders

`Static` EventName

EventName: typeof EventName = EventName

Accessors

populateTransaction

get populateTransaction(): {
    approveSendTokens: ((__namedParameters, txOverrides?) => Promise<TransactionRequest>);
    sendTokens: ((__namedParameters, txOverrides?) => Promise<TransactionRequest>);
    sendTokensMultiHop: ((__namedParameters, txOverrides?) => Promise<TransactionRequest>);
}
Returns {
    approveSendTokens: ((__namedParameters, txOverrides?) => Promise<TransactionRequest>);
    sendTokens: ((__namedParameters, txOverrides?) => Promise<TransactionRequest>);
    sendTokensMultiHop: ((__namedParameters, txOverrides?) => Promise<TransactionRequest>);
}
- approveSendTokens: ((__namedParameters, txOverrides?) => Promise<TransactionRequest>)
  - - (__namedParameters, txOverrides?): Promise<TransactionRequest>
    - Parameters
      __namedParameters: ApproveSendTokensInput
      txOverrides: TxOverrides = {}
      Returns Promise<TransactionRequest>
- sendTokens: ((__namedParameters, txOverrides?) => Promise<TransactionRequest>)
  - - (__namedParameters, txOverrides?): Promise<TransactionRequest>
    - Parameters
      __namedParameters: SendTokensInput
      txOverrides: TxOverrides = {}
      Returns Promise<TransactionRequest>
- sendTokensMultiHop: ((__namedParameters, txOverrides?) => Promise<TransactionRequest>)
  - - (__namedParameters, txOverrides?): Promise<TransactionRequest>
    - Parameters
      __namedParameters: SendTokensInput
      txOverrides: TxOverrides = {}
      Returns Promise<TransactionRequest>

utils

get utils(): {
    estimateGas: ((provider, tx) => Promise<BigNumber>);
    generateZeroBytes32: (() => string);
    getAddressExplorerUrl: ((address, chainId) => string);
    getBumpedGasPrice: ((provider, percent) => Promise<BigNumber>);
    getChainInfo: ((chainId) => any);
    getChainSlug: ((chainId) => string);
    getConnectedChainId: ((provider) => Promise<BigNumber>);
    getGasPrice: ((signerOrProvider) => Promise<BigNumber>);
    getLogoForChainId: ((chainId) => string);
    getLogoForChainSlug: ((chainSlug) => string);
    getLogoForTokenSymbol: ((tokenSymbol) => string);
    getTokenExplorerUrl: ((address, chainId) => string);
    getTransactionHashExplorerUrl: ((txHash, chainId) => string);
    isContractError: ((err) => boolean);
    isValidAddress: ((address) => boolean);
    isValidBytes: ((bytes) => boolean);
    isValidBytes32: ((hash) => boolean);
    isValidChainId: ((chainId) => boolean);
    isValidFilterBlock: ((blockTag) => boolean);
    isValidNumericValue: ((value) => boolean);
    isValidObject: ((obj) => boolean);
    isValidTxHash: ((txHash) => boolean);
    switchChain: ((chainId, provider) => Promise<void>);
    willTransactionFail: ((provider, tx) => Promise<boolean>);
}
Returns {
    estimateGas: ((provider, tx) => Promise<BigNumber>);
    generateZeroBytes32: (() => string);
    getAddressExplorerUrl: ((address, chainId) => string);
    getBumpedGasPrice: ((provider, percent) => Promise<BigNumber>);
    getChainInfo: ((chainId) => any);
    getChainSlug: ((chainId) => string);
    getConnectedChainId: ((provider) => Promise<BigNumber>);
    getGasPrice: ((signerOrProvider) => Promise<BigNumber>);
    getLogoForChainId: ((chainId) => string);
    getLogoForChainSlug: ((chainSlug) => string);
    getLogoForTokenSymbol: ((tokenSymbol) => string);
    getTokenExplorerUrl: ((address, chainId) => string);
    getTransactionHashExplorerUrl: ((txHash, chainId) => string);
    isContractError: ((err) => boolean);
    isValidAddress: ((address) => boolean);
    isValidBytes: ((bytes) => boolean);
    isValidBytes32: ((hash) => boolean);
    isValidChainId: ((chainId) => boolean);
    isValidFilterBlock: ((blockTag) => boolean);
    isValidNumericValue: ((value) => boolean);
    isValidObject: ((obj) => boolean);
    isValidTxHash: ((txHash) => boolean);
    switchChain: ((chainId, provider) => Promise<void>);
    willTransactionFail: ((provider, tx) => Promise<boolean>);
}
- estimateGas: ((provider, tx) => Promise<BigNumber>)
  - - (provider, tx): Promise<BigNumber>
    - Parameters
      provider: Provider
      tx: TransactionRequest
      Returns Promise<BigNumber>
- generateZeroBytes32: (() => string)
  - - (): string
    - Returns string
- getAddressExplorerUrl: ((address, chainId) => string)
  - - (address, chainId): string
    - Parameters
      address: string
      chainId: BigNumberish
      Returns string
- getBumpedGasPrice: ((provider, percent) => Promise<BigNumber>)
  - - (provider, percent): Promise<BigNumber>
    - Parameters
      provider: Provider
      percent: number
      Returns Promise<BigNumber>
- getChainInfo: ((chainId) => any)
  - - (chainId): any
    - Parameters
      chainId: BigNumberish
      Returns any
- getChainSlug: ((chainId) => string)
  - - (chainId): string
    - Parameters
      chainId: BigNumberish
      Returns string
- getConnectedChainId: ((provider) => Promise<BigNumber>)
  - - (provider): Promise<BigNumber>
    - Parameters
      provider: Provider
      Returns Promise<BigNumber>
- getGasPrice: ((signerOrProvider) => Promise<BigNumber>)
  - - (signerOrProvider): Promise<BigNumber>
    - Parameters
      signerOrProvider: Provider | Signer
      Returns Promise<BigNumber>
- getLogoForChainId: ((chainId) => string)
  - - (chainId): string
    - Parameters
      chainId: BigNumberish
      Returns string
- getLogoForChainSlug: ((chainSlug) => string)
  - - (chainSlug): string
    - Parameters
      chainSlug: string
      Returns string
- getLogoForTokenSymbol: ((tokenSymbol) => string)
  - - (tokenSymbol): string
    - Parameters
      tokenSymbol: string
      Returns string
- getTokenExplorerUrl: ((address, chainId) => string)
  - - (address, chainId): string
    - Parameters
      address: string
      chainId: BigNumberish
      Returns string
- getTransactionHashExplorerUrl: ((txHash, chainId) => string)
  - - (txHash, chainId): string
    - Parameters
      txHash: string
      chainId: BigNumberish
      Returns string
- isContractError: ((err) => boolean)
  - - (err): boolean
    - Parameters
      err: unknown
      Returns boolean
- isValidAddress: ((address) => boolean)
  - - (address): boolean
    - Parameters
      address: string
      Returns boolean
- isValidBytes: ((bytes) => boolean)
  - - (bytes): boolean
    - Parameters
      bytes: string
      Returns boolean
- isValidBytes32: ((hash) => boolean)
  - - (hash): boolean
    - Parameters
      hash: string
      Returns boolean
- isValidChainId: ((chainId) => boolean)
  - - (chainId): boolean
    - Parameters
      chainId: BigNumberish
      Returns boolean
- isValidFilterBlock: ((blockTag) => boolean)
  - - (blockTag): boolean
    - Parameters
      blockTag: string | number
      Returns boolean
- isValidNumericValue: ((value) => boolean)
  - - (value): boolean
    - Parameters
      value: null | object | BigNumberish
      Returns boolean
- isValidObject: ((obj) => boolean)
  - - (obj): boolean
    - Parameters
      obj: any
      Returns boolean
- isValidTxHash: ((txHash) => boolean)
  - - (txHash): boolean
    - Parameters
      txHash: string
      Returns boolean
- switchChain: ((chainId, provider) => Promise<void>)
  - - (chainId, provider): Promise<void>
    - Parameters
      chainId: BigNumberish
      provider: Provider
      Returns Promise<void>
- willTransactionFail: ((provider, tx) => Promise<boolean>)
  - - (provider, tx): Promise<boolean>
    - Parameters
      provider: Provider
      tx: TransactionRequest
      Returns Promise<boolean>
Inherited from Base.utils

version

get version(): string
Returns string

Methods

approveSendTokens

approveSendTokens(input, txOverrides?): Promise<TransactionResponse>
Parameters
- input: ApproveSendTokensInput
- txOverrides: TxOverrides = {}
Returns Promise<TransactionResponse>

calcAmountOutMin

calcAmountOutMin(__namedParameters): BigNumber
Parameters
- __namedParameters: CalcAmountOutMinInput
Returns BigNumber

connectTargets

connectTargets(input, txOverrides?): Promise<{
connectorAddress: string;
tx: TransactionResponse;
}>
Parameters
- input: ConnectTargetsInput
- txOverrides: TxOverrides = {}
Returns Promise<{
connectorAddress: string;
tx: TransactionResponse;
}>

estimateGasCostForSend

estimateGasCostForSend(__namedParameters): Promise<BigNumber>
Parameters
- __namedParameters: EstimateGasCostForSendInput
Returns Promise<BigNumber>

getAllRailsPathAddresses

getAllRailsPathAddresses(chainId): Promise<string[]>
Parameters
- chainId: BigNumberish
Returns Promise<string[]>

getAmountOut

getAmountOut(__namedParameters): Promise<BigNumber>
Parameters
- __namedParameters: GetAmountOutInput
Returns Promise<BigNumber>

getChainIdsSupportedByTokenSymbol

getChainIdsSupportedByTokenSymbol(tokenSymbol): string[]
Parameters
- tokenSymbol: string
Returns string[]
Inherited from Base.getChainIdsSupportedByTokenSymbol

getColorForChainId

getColorForChainId(chainId): string
Parameters
- chainId: BigNumberish
Returns string
Inherited from Base.getColorForChainId

getConfigAddress

getConfigAddress(chainId, key): string
Parameters
- chainId: BigNumberish
- key: string
Returns string
Inherited from Base.getConfigAddress

getConfigStartBlock

getConfigStartBlock(chainId): number
Parameters
- chainId: BigNumberish
Returns number
Inherited from Base.getConfigStartBlock

getContractAddresses

getContractAddresses(): Addresses
Returns Addresses
Inherited from Base.getContractAddresses

getContractExists

getContractExists(address, provider): Promise<boolean>
Parameters
- address: string
- provider: Provider
Returns Promise<boolean>
Inherited from Base.getContractExists

getCounterpartChainId

getCounterpartChainId(originChainId, pathId): Promise<string>
Parameters
- originChainId: BigNumberish
- pathId: string
Returns Promise<string>

getDefaultProvider

getDefaultProvider(chainId): Provider
Parameters
- chainId: BigNumberish
Returns Provider
Inherited from Base.getDefaultProvider

getDefaultProviders

getDefaultProviders(): SignersOrProviders
Returns SignersOrProviders
Inherited from Base.getDefaultProviders

getEstimatedReceived

getEstimatedReceived(__namedParameters): Promise<BigNumber>
Parameters
- __namedParameters: GetEstimatedReceivedInput
Returns Promise<BigNumber>

getEthersWeb3Signer

getEthersWeb3Signer(signer): Signer
Parameters
- signer: any
Returns Signer
Inherited from Base.getEthersWeb3Signer

getEvents

getEvents(__namedParameters): Promise<EthersEventWithDecodedTypesAndContext<AllEventTypes>[]>
Parameters
- __namedParameters: GetGeneralEventsInput
Returns Promise<EthersEventWithDecodedTypesAndContext<AllEventTypes>[]>

getExplorerApiBaseUrl

getExplorerApiBaseUrl(): string
Returns string
Inherited from Base.getExplorerApiBaseUrl

getHubChainId

getHubChainId(): string
Returns string
Inherited from Base.getHubChainId

getHubConnectorContractAddress

getHubConnectorContractAddress(chainId): string
Parameters
- chainId: BigNumberish
Returns string

getMaxBonderFee

getMaxBonderFee(__namedParameters): Promise<BigNumber>
Parameters
- __namedParameters: GetMaxBonderFeeInput
Returns Promise<BigNumber>

getMessenger

getMessenger(chainId): Messenger
Parameters
- chainId: BigNumberish
Returns Messenger

getNeedsApprovalForSendTokens

getNeedsApprovalForSendTokens(input): Promise<boolean>
Parameters
- input: GetNeedsApprovalForSendTokensInput
Returns Promise<boolean>

getPathInfo

getPathInfo(__namedParameters): Promise<Path>
Parameters
- __namedParameters: GetPathInfoInput
Returns Promise<Path>

getProvider

getProvider(chainId): null | Provider
Parameters
- chainId: BigNumberish
Returns null | Provider
Inherited from Base.getProvider

getRailsGateway

getRailsGateway(chainId): RailsGateway
Parameters
- chainId: BigNumberish
Returns RailsGateway

getRailsGatewayContractAddress

getRailsGatewayContractAddress(chainId): string
Parameters
- chainId: BigNumberish
Returns string

getRailsPath

getRailsPath(chainId, pathId?, address?): Promise<RailsPath>
Parameters
- chainId: BigNumberish
- Optional pathId: string
- Optional address: string
Returns Promise<RailsPath>

getSendData

getSendData(__namedParameters): Promise<SendData>
Parameters
- __namedParameters: GetSendDataInput
Returns Promise<SendData>

getSendDataMultiHop

getSendDataMultiHop(__namedParameters): Promise<SendData>
Parameters
- __namedParameters: GetSendDataInput
Returns Promise<SendData>

getSendFee

getSendFee(__namedParameters): Promise<BigNumber>
Parameters
- __namedParameters: GetSendFeeInput
Returns Promise<BigNumber>

getSigner

getSigner(chainId): Promise<null | Signer>
Parameters
- chainId: BigNumberish
Returns Promise<null | Signer>
Inherited from Base.getSigner

getSignerAddress

getSignerAddress(chainId): Promise<null | string>
Parameters
- chainId: BigNumberish
Returns Promise<null | string>
Inherited from Base.getSignerAddress

getSignerOrProvider

getSignerOrProvider(chainId): Promise<Provider | Signer>
Parameters
- chainId: BigNumberish
Returns Promise<Provider | Signer>
Inherited from Base.getSignerOrProvider

getSignerProviderChainId

getSignerProviderChainId(chainId): Promise<BigNumber>
Parameters
- chainId: BigNumberish
Returns Promise<BigNumber>
Inherited from Base.getSignerProviderChainId

getSupportedChainIds

getSupportedChainIds(): string[]
Returns string[]
Inherited from Base.getSupportedChainIds

getSupportedTokenSymbols

getSupportedTokenSymbols(): string[]
Returns string[]
Inherited from Base.getSupportedTokenSymbols

getSupportedTokenSymbolsByChainId

getSupportedTokenSymbolsByChainId(chainId): string[]
Parameters
- chainId: BigNumberish
Returns string[]
Inherited from Base.getSupportedTokenSymbolsByChainId

getTokenAddressByTokenSymbol

getTokenAddressByTokenSymbol(chainId, tokenSymbol): string
Parameters
- chainId: BigNumberish
- tokenSymbol: string
Returns string
Inherited from Base.getTokenAddressByTokenSymbol

getTokenContract

getTokenContract(__namedParameters): Contract
Parameters
- __namedParameters: GetTokenContractInput
Returns Contract

getTokenSymbolByTokenAddress

getTokenSymbolByTokenAddress(chainId, tokenAddress): string
Parameters
- chainId: BigNumberish
- tokenAddress: string
Returns string
Inherited from Base.getTokenSymbolByTokenAddress

getTransferIdFromTransactionHash

getTransferIdFromTransactionHash(__namedParameters): Promise<string>
Parameters
- __namedParameters: GetTransferIdFromTransactionHashInput
Returns Promise<string>

getTransferStatus

getTransferStatus(__namedParameters): Promise<TransferStatus>
Parameters
- __namedParameters: GetTransferStatusInput
Returns Promise<TransferStatus>

getTransferStatusFromApi

getTransferStatusFromApi(__namedParameters): Promise<TransferStatus>
Parameters
- __namedParameters: GetTransferStatusFromApiInput
Returns Promise<TransferStatus>

getTransferStatusFromEvents

getTransferStatusFromEvents(__namedParameters): Promise<TransferStatus>
Parameters
- __namedParameters: GetTransferStatusFromEventsInput
Returns Promise<TransferStatus>

getTxOverrides

getTxOverrides(fromChainId, toChainId): Promise<TxOverrides>
Parameters
- fromChainId: BigNumberish
- toChainId: BigNumberish
Returns Promise<TxOverrides>
Inherited from Base.getTxOverrides

getWillSendTokensFail

getWillSendTokensFail(__namedParameters): Promise<boolean>
Parameters
- __namedParameters: WillSendTokensFailInput
Returns Promise<boolean>

sendTokens

sendTokens(input, txOverrides?): Promise<TransactionResponse>
Parameters
- input: SendTokensInput
- txOverrides: TxOverrides = {}
Returns Promise<TransactionResponse>

sendTokensMultiHop

sendTokensMultiHop(input, txOverrides?): Promise<TransactionResponse>
Parameters
- input: SendTokensInput
- txOverrides: TxOverrides = {}
Returns Promise<TransactionResponse>

sendTransaction

sendTransaction(transactionRequest, chainId?, customSigner?): Promise<TransactionResponse>
Parameters
- transactionRequest: TransactionRequest
- Optional chainId: BigNumberish
- Optional customSigner: null | Signer
Returns Promise<TransactionResponse>
Inherited from Base.sendTransaction

setContractAddresses

setContractAddresses(contractAddresses): void
Parameters
- contractAddresses: Addresses
Returns void
Inherited from Base.setContractAddresses

setExplorerApiBaseUrl

setExplorerApiBaseUrl(url): void
Parameters
- url: string
Returns void
Inherited from Base.setExplorerApiBaseUrl

setHubChainId

setHubChainId(newChainId): void
Parameters
- newChainId: BigNumberish
Returns void
Inherited from Base.setHubChainId

setProvider

setProvider(chainId, provider): void
Parameters
- chainId: BigNumberish
- provider: Provider | Signer
Returns void
Inherited from Base.setProvider

setProviderUrl

setProviderUrl(chainId, url): void
Parameters
- chainId: BigNumberish
- url: string | string[]
Returns void
Inherited from Base.setProviderUrl

setProviderUrls

setProviderUrls(signersOrProviders): void
Parameters
- signersOrProviders: Record<string, string | string[]>
Returns void
Overrides Base.setProviderUrls

setProviders

setProviders(signersOrProviders): void
Parameters
- signersOrProviders: SignersOrProviders
Returns void
Inherited from Base.setProviders

switchChain

switchChain(chainId, currentSignerChainId?): Promise<void>
Parameters
- chainId: BigNumberish
- currentSignerChainId: BigNumberish = chainId
Returns Promise<void>

throwError

throwError(err): unknown
Parameters
- err: unknown
Returns unknown
Inherited from Base.throwError

`Static` calcAmountOutMin

calcAmountOutMin(__namedParameters): BigNumber
Parameters
- __namedParameters: CalcAmountOutMinInput
Returns BigNumber

`Static` getDefaultProvider

getDefaultProvider(chainId): Provider
Parameters
- chainId: BigNumberish
Returns Provider
Inherited from Base.getDefaultProvider

`Static` getDefaultProviders

getDefaultProviders(network): SignersOrProviders
Parameters
- network: string
Returns SignersOrProviders
Inherited from Base.getDefaultProviders

Class Hop

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional options: HopConstructorInput

Returns Hop

Properties

batchBlocks

contractAddresses

gasPriceMultiplier

hubChainId

Readonly hubConnector

l1ChainId

network

Readonly railsGateways

signersOrProviders

Static EventName

Accessors

populateTransaction

Returns { approveSendTokens: ((__namedParameters, txOverrides?) => Promise<TransactionRequest>); sendTokens: ((__namedParameters, txOverrides?) => Promise<TransactionRequest>); sendTokensMultiHop: ((__namedParameters, txOverrides?) => Promise<TransactionRequest>); }

approveSendTokens: ((__namedParameters, txOverrides?) => Promise<TransactionRequest>)

Parameters

__namedParameters: ApproveSendTokensInput

txOverrides: TxOverrides = {}

Returns Promise<TransactionRequest>

sendTokens: ((__namedParameters, txOverrides?) => Promise<TransactionRequest>)

Parameters

__namedParameters: SendTokensInput

txOverrides: TxOverrides = {}

Returns Promise<TransactionRequest>

sendTokensMultiHop: ((__namedParameters, txOverrides?) => Promise<TransactionRequest>)

Parameters

__namedParameters: SendTokensInput

txOverrides: TxOverrides = {}

Returns Promise<TransactionRequest>

utils

estimateGas: ((provider, tx) => Promise<BigNumber>)

Parameters

provider: Provider

tx: TransactionRequest

Returns Promise<BigNumber>

generateZeroBytes32: (() => string)

Returns string

getAddressExplorerUrl: ((address, chainId) => string)

Parameters

address: string

chainId: BigNumberish

Returns string

getBumpedGasPrice: ((provider, percent) => Promise<BigNumber>)

Parameters

provider: Provider

percent: number

Returns Promise<BigNumber>

getChainInfo: ((chainId) => any)

Parameters

chainId: BigNumberish

Returns any

getChainSlug: ((chainId) => string)

Parameters

chainId: BigNumberish

Returns string

getConnectedChainId: ((provider) => Promise<BigNumber>)

Parameters

provider: Provider

Returns Promise<BigNumber>

getGasPrice: ((signerOrProvider) => Promise<BigNumber>)

Parameters

signerOrProvider: Provider | Signer

Returns Promise<BigNumber>

getLogoForChainId: ((chainId) => string)

Parameters

chainId: BigNumberish

Returns string

getLogoForChainSlug: ((chainSlug) => string)

`Optional` options: HopConstructorInput

`Readonly` hubConnector

`Readonly` railsGateways

`Static` EventName

Returns {
approveSendTokens: ((namedParameters, txOverrides?) => Promise<TransactionRequest>);
sendTokens: ((namedParameters, txOverrides?) => Promise<TransactionRequest>);
sendTokensMultiHop: ((__namedParameters, txOverrides?) => Promise<TransactionRequest>);
}