Class RailsPath

Hierarchy

Base
- RailsPath

Index

Constructors

Constructors

constructor

new RailsPath(__namedParameters): RailsPath
Parameters
- __namedParameters: RailsPathConstructorInput
Returns RailsPath
Overrides Base.constructor

Properties

address

address: string

batchBlocks

batchBlocks: number

chainId

chainId: BigNumberish

contractAddresses

contractAddresses: Addresses

gasPriceMultiplier

gasPriceMultiplier: number

hubChainId

hubChainId: string

l1ChainId

l1ChainId: number

network

network: string

signersOrProviders

signersOrProviders: SignersOrProviders

`Static` EventName

EventName: typeof RailsPathEventName = EventName

Accessors

helpers

get helpers(): {
approveSend: ((input, txOverrides?) => Promise<TransactionResponse>);
}
Returns {
approveSend: ((input, txOverrides?) => Promise<TransactionResponse>);
}
- approveSend: ((input, txOverrides?) => Promise<TransactionResponse>)
  - - (input, txOverrides?): Promise<TransactionResponse>
    - Parameters
      input: RailsPathApproveSendInput
      txOverrides: TxOverrides = {}
      Returns Promise<TransactionResponse>

populateTransaction

get populateTransaction(): {
    approveSend: ((__namedParameters, txOverrides?) => Promise<TransactionRequest>);
    bond: ((__namedParameters, txOverrides?) => Promise<TransactionRequest>);
    confirmClaim: ((__namedParameters, txOverrides?) => Promise<TransactionRequest>);
    pushClaim: ((__namedParameters, txOverrides?) => Promise<TransactionRequest>);
    readdClaim: ((__namedParameters, txOverrides?) => Promise<TransactionRequest>);
    removeClaim: ((__namedParameters, txOverrides?) => Promise<TransactionRequest>);
    send: ((__namedParameters, txOverrides?) => Promise<TransactionRequest>);
    withdrawBonds: ((__namedParameters, txOverrides?) => Promise<TransactionRequest>);
    withdrawClaim: ((__namedParameters, txOverrides?) => Promise<TransactionRequest>);
}
Returns {
    approveSend: ((__namedParameters, txOverrides?) => Promise<TransactionRequest>);
    bond: ((__namedParameters, txOverrides?) => Promise<TransactionRequest>);
    confirmClaim: ((__namedParameters, txOverrides?) => Promise<TransactionRequest>);
    pushClaim: ((__namedParameters, txOverrides?) => Promise<TransactionRequest>);
    readdClaim: ((__namedParameters, txOverrides?) => Promise<TransactionRequest>);
    removeClaim: ((__namedParameters, txOverrides?) => Promise<TransactionRequest>);
    send: ((__namedParameters, txOverrides?) => Promise<TransactionRequest>);
    withdrawBonds: ((__namedParameters, txOverrides?) => Promise<TransactionRequest>);
    withdrawClaim: ((__namedParameters, txOverrides?) => Promise<TransactionRequest>);
}
- approveSend: ((__namedParameters, txOverrides?) => Promise<TransactionRequest>)
  - - (__namedParameters, txOverrides?): Promise<TransactionRequest>
    - Parameters
      __namedParameters: RailsPathApproveSendInput
      txOverrides: TxOverrides = {}
      Returns Promise<TransactionRequest>
- bond: ((__namedParameters, txOverrides?) => Promise<TransactionRequest>)
  - - (__namedParameters, txOverrides?): Promise<TransactionRequest>
    - Parameters
      __namedParameters: RailsPathBondInput
      txOverrides: TxOverrides = {}
      Returns Promise<TransactionRequest>
- confirmClaim: ((__namedParameters, txOverrides?) => Promise<TransactionRequest>)
  - - (__namedParameters, txOverrides?): Promise<TransactionRequest>
    - Parameters
      __namedParameters: RailsPathConfirmClaimInput
      txOverrides: TxOverrides = {}
      Returns Promise<TransactionRequest>
- pushClaim: ((__namedParameters, txOverrides?) => Promise<TransactionRequest>)
  - - (__namedParameters, txOverrides?): Promise<TransactionRequest>
    - Parameters
      __namedParameters: RailsPathPushClaimInput
      txOverrides: TxOverrides = {}
      Returns Promise<TransactionRequest>
- readdClaim: ((__namedParameters, txOverrides?) => Promise<TransactionRequest>)
  - - (__namedParameters, txOverrides?): Promise<TransactionRequest>
    - Parameters
      __namedParameters: RailsPathReaddClaimInput
      txOverrides: TxOverrides = {}
      Returns Promise<TransactionRequest>
- removeClaim: ((__namedParameters, txOverrides?) => Promise<TransactionRequest>)
  - - (__namedParameters, txOverrides?): Promise<TransactionRequest>
    - Parameters
      __namedParameters: RailsPathRemoveClaimInput
      txOverrides: TxOverrides = {}
      Returns Promise<TransactionRequest>
- send: ((__namedParameters, txOverrides?) => Promise<TransactionRequest>)
  - - (__namedParameters, txOverrides?): Promise<TransactionRequest>
    - Parameters
      __namedParameters: RailsPathSendInput
      txOverrides: TxOverrides = {}
      Returns Promise<TransactionRequest>
- withdrawBonds: ((__namedParameters, txOverrides?) => Promise<TransactionRequest>)
  - - (__namedParameters, txOverrides?): Promise<TransactionRequest>
    - Parameters
      __namedParameters: RailsPathWithdrawBondsInput
      txOverrides: TxOverrides = {}
      Returns Promise<TransactionRequest>
- withdrawClaim: ((__namedParameters, txOverrides?) => Promise<TransactionRequest>)
  - - (__namedParameters, txOverrides?): Promise<TransactionRequest>
    - Parameters
      __namedParameters: RailsPathWithdrawClaimInput
      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

Methods

addDecodedTypesToEvent

addDecodedTypesToEvent(event): EthersEventWithDecodedTypesAndBaseContext<TransferSent | TransferBonded | ClaimPushed | ClaimReadded | ClaimRemoved | ClaimWithdrawn>
Parameters
- event: any
Returns EthersEventWithDecodedTypesAndBaseContext<TransferSent | TransferBonded | ClaimPushed | ClaimReadded | ClaimRemoved | ClaimWithdrawn>

addDecodedTypesToEvents

addDecodedTypesToEvents(events): EthersEventWithDecodedTypesAndBaseContext<TransferSent | TransferBonded | ClaimPushed | ClaimReadded | ClaimRemoved | ClaimWithdrawn>[]
Parameters
- events: any[]
Returns EthersEventWithDecodedTypesAndBaseContext<TransferSent | TransferBonded | ClaimPushed | ClaimReadded | ClaimRemoved | ClaimWithdrawn>[]

bond

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

claimChain

claimChain(__namedParameters): Promise<string>
Parameters
- __namedParameters: ClaimChainInput
Returns Promise<string>

confirmClaim

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

counterpartChainId

counterpartChainId(): Promise<BigNumber>
Returns Promise<BigNumber>

counterpartToken

counterpartToken(): Promise<string>
Returns Promise<string>

gateway

gateway(): Promise<string>
Returns Promise<string>

getAmountOut

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

getBucket

getBucket(__namedParameters): Promise<RailsPathBucket>
Parameters
- __namedParameters: RailsPathGetBucketInput
Returns Promise<RailsPathBucket>

getBucketIndex

getBucketIndex(__namedParameters): Promise<number>
Parameters
- __namedParameters: RailsPathGetBucketIndexInput
Returns Promise<number>

getChainIdsSupportedByTokenSymbol

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

getClaim

getClaim(__namedParameters): Promise<RailsPathClaim>
Parameters
- __namedParameters: RailsPathGetClaimInput
Returns Promise<RailsPathClaim>

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

getDefaultProvider

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

getDefaultProviders

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

getEthersWeb3Signer

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

getEventFetcher

getEventFetcher(eventName): any
Parameters
- eventName: string
Returns any

getEventFilter

getEventFilter(eventName, input?): any
Parameters
- eventName: RailsPathEventName
- input: RailsPathGetEventFilterInput = {}
Returns any

getEventFromTransactionHash

getEventFromTransactionHash<T>(__namedParameters): Promise<null | EthersEventWithDecodedTypes<T>>
Type Parameters
- T
Parameters
- __namedParameters: GetEventFromTransactionHashInput
Returns Promise<null | EthersEventWithDecodedTypes<T>>

getEventFromTransactionReceipt

getEventFromTransactionReceipt<T>(__namedParameters): Promise<null | EthersEventWithDecodedTypes<T>>
Type Parameters
- T
Parameters
- __namedParameters: GetEventFromTransactionReceiptInput
Returns Promise<null | EthersEventWithDecodedTypes<T>>

getEventFromTransferId

getEventFromTransferId<T>(__namedParameters): Promise<EthersEventWithDecodedTypes<T>>
Type Parameters
- T
Parameters
- __namedParameters: GetEventFromTransferIdInput
Returns Promise<EthersEventWithDecodedTypes<T>>

getEventNames

getEventNames(): string[]
EVENT HANDLERS

Returns string[]

getEventsInBatches

getEventsInBatches(__namedParameters): AsyncGenerator<any, void, unknown>
Parameters
- __namedParameters: GetEventsInBatchesInput
Returns AsyncGenerator<any, void, unknown>

getExplorerApiBaseUrl

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

getHeadClaimId

getHeadClaimId(): Promise<string>
Returns Promise<string>

getHeadTransferId

getHeadTransferId(): Promise<string>
Returns Promise<string>

getHubChainId

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

getInitialId

getInitialId(): Promise<string>
Returns Promise<string>

getNextHopsHash

getNextHopsHash(__namedParameters): Promise<string>
Parameters
- __namedParameters: RailsPathGetNextHopsHashInput
Returns Promise<string>

getNextHopsHashFromHops

getNextHopsHashFromHops(__namedParameters): Promise<string>
Parameters
- __namedParameters: GetNextHopsHashFromHopsInput
Returns Promise<string>

getPathInfo

getPathInfo(): Promise<RailsPathPath>
Returns Promise<RailsPathPath>

getProvider

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

getRailsPathContract

getRailsPathContract(): Promise<Contract>
Returns Promise<Contract>

getRailsPathContractAddress

getRailsPathContractAddress(): string
Returns string

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

getSourcePool

getSourcePool(__namedParameters): Promise<BigNumber>
Parameters
- __namedParameters: GetSourcePoolInput
Returns Promise<BigNumber>

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

getTokenSymbolByTokenAddress

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

getTotalClaimsAtClaimId

getTotalClaimsAtClaimId(__namedParameters): Promise<BigNumber>
Parameters
- __namedParameters: GetTotalClaimsAtClaimIdInput
Returns Promise<BigNumber>

getTotalConfirmed

getTotalConfirmed(): Promise<BigNumber>
Returns Promise<BigNumber>

getTransfer

getTransfer(__namedParameters): Promise<Transfer>
Parameters
- __namedParameters: GetTransferInput
Returns Promise<Transfer>

getTxOverrides

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

getWithdrawableBalance

getWithdrawableBalance(__namedParameters): Promise<BigNumber>
Parameters
- __namedParameters: RailsPathGetWithdrawableBalanceInput
Returns Promise<BigNumber>

hardConfirmedBucketIndex

hardConfirmedBucketIndex(): Promise<BigNumber>
Returns Promise<BigNumber>

hardConfirmedClaimId

hardConfirmedClaimId(): Promise<string>
Returns Promise<string>

initialReserve

initialReserve(): Promise<BigNumber>
Returns Promise<BigNumber>

isValidClaim

isValidClaim(__namedParameters): Promise<boolean>
Parameters
- __namedParameters: RailsPathIsValidClaimInput
Returns Promise<boolean>

isValidTransfer

isValidTransfer(__namedParameters): Promise<boolean>
Parameters
- __namedParameters: RailsPathIsValidTransferInput
Returns Promise<boolean>

lastBondedClaimIdForBonder

lastBondedClaimIdForBonder(__namedParameters): Promise<string>
Parameters
- __namedParameters: LastBondedClaimIdForBonderInput
Returns Promise<string>

pathId

pathId(): Promise<BigNumber>
Returns Promise<BigNumber>

pushClaim

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

readdClaim

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

removeClaim

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

removedBalance

removedBalance(__namedParameters): Promise<Transfer>
Parameters
- __namedParameters: GetRemovedBalanceInput
Returns Promise<Transfer>

send

send(input, txOverrides?): Promise<TransactionResponse>
Parameters
- input: RailsPathSendInput
- 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(signersOrProvidersUrls): void
Parameters
- signersOrProvidersUrls: Record<string, string | string[]>
Returns void
Inherited from Base.setProviderUrls

setProviders

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

throwError

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

token

token(): Promise<string>
Returns Promise<string>

totalSent

totalSent(): Promise<BigNumber>
Returns Promise<BigNumber>

totalWithdrawableAtClaimId

totalWithdrawableAtClaimId(__namedParameters): Promise<BigNumber>
Parameters
- __namedParameters: GetTotalWithdrawableAtClaimIdInput
Returns Promise<BigNumber>

transferChain

transferChain(__namedParameters): Promise<string>
Parameters
- __namedParameters: TransferChainInput
Returns Promise<string>

withdrawBonds

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

withdrawClaim

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

withdrawn

withdrawn(__namedParameters): Promise<BigNumber>
Parameters
- __namedParameters: WithdrawnInput
Returns Promise<BigNumber>

`Static` addDecodedTypesToEvent

addDecodedTypesToEvent(event, chainId?): EthersEventWithDecodedTypesAndBaseContext<TransferSent | TransferBonded | ClaimPushed | ClaimReadded | ClaimRemoved | ClaimWithdrawn>
Parameters
- event: any
- Optional chainId: BigNumberish
Returns EthersEventWithDecodedTypesAndBaseContext<TransferSent | TransferBonded | ClaimPushed | ClaimReadded | ClaimRemoved | ClaimWithdrawn>

`Static` addDecodedTypesToEvents

addDecodedTypesToEvents(events, chainId?): EthersEventWithDecodedTypesAndBaseContext<TransferSent | TransferBonded | ClaimPushed | ClaimReadded | ClaimRemoved | ClaimWithdrawn>[]
Parameters
- events: any[]
- Optional chainId: BigNumberish
Returns EthersEventWithDecodedTypesAndBaseContext<TransferSent | TransferBonded | ClaimPushed | ClaimReadded | ClaimRemoved | ClaimWithdrawn>[]

`Static` deriveNetwork

deriveNetwork(chainId): string
STATIC METHODS
Parameters
- chainId: BigNumberish
Returns string

`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

`Static` getEventNames

getEventNames(): string[]
Returns string[]

`Static` getEventSignature

getEventSignature(eventName): string
Parameters
- eventName: RailsPathEventName
Returns string

Class RailsPath

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

__namedParameters: RailsPathConstructorInput

Returns RailsPath

Properties

address

batchBlocks

chainId

contractAddresses

gasPriceMultiplier

hubChainId

l1ChainId

network

signersOrProviders

Static EventName

Accessors

helpers

Returns { approveSend: ((input, txOverrides?) => Promise<TransactionResponse>); }

approveSend: ((input, txOverrides?) => Promise<TransactionResponse>)

Parameters

input: RailsPathApproveSendInput

txOverrides: TxOverrides = {}

Returns Promise<TransactionResponse>

populateTransaction

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

Parameters

__namedParameters: RailsPathApproveSendInput

txOverrides: TxOverrides = {}

Returns Promise<TransactionRequest>

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

Parameters

__namedParameters: RailsPathBondInput

txOverrides: TxOverrides = {}

Returns Promise<TransactionRequest>

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

Parameters

__namedParameters: RailsPathConfirmClaimInput

txOverrides: TxOverrides = {}

Returns Promise<TransactionRequest>

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

Parameters

__namedParameters: RailsPathPushClaimInput

txOverrides: TxOverrides = {}

Returns Promise<TransactionRequest>

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

Parameters

__namedParameters: RailsPathReaddClaimInput

txOverrides: TxOverrides = {}

Returns Promise<TransactionRequest>

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

Parameters

__namedParameters: RailsPathRemoveClaimInput

txOverrides: TxOverrides = {}

Returns Promise<TransactionRequest>

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

Parameters

__namedParameters: RailsPathSendInput

txOverrides: TxOverrides = {}

Returns Promise<TransactionRequest>

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

Parameters

__namedParameters: RailsPathWithdrawBondsInput

txOverrides: TxOverrides = {}

Returns Promise<TransactionRequest>

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

Parameters

__namedParameters: RailsPathWithdrawClaimInput

txOverrides: TxOverrides = {}

Returns Promise<TransactionRequest>

utils

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

Parameters

`Static` EventName

Returns {
approveSend: ((input, txOverrides?) => Promise<TransactionResponse>);
}