Class Relayer

constructor

• new Relayer(options, properties?): Web.Relayer

• Parameters

  • options: Web.Options.Relayer

  • Optional properties: RelayerProperties

  Returns Web.Relayer

httpClient

url

address

• get address(): string

• Returns string

chainId

• get chainId(): number

• Returns number

miningFeePercent

• get miningFeePercent(): number

• Returns number

prices

• get prices(): Map<string, BigNumber>

• Returns Map<string, BigNumber>

properties

• get properties(): RelayerProperties

• Returns RelayerProperties

serviceFeePercent

• get serviceFeePercent(): number

• Returns number

status

• get status(): string

• Returns string

version

• get version(): string

• Returns string

fetchProperties

• fetchProperties(): Promise<RelayerProperties>

• This function MUST be called to unlock the rest of the Relayer class functionality, as otherwise we don't have the property data necessary for all the logic we want.

  Returns Promise<RelayerProperties>

  Fetched RelayerProperties.

getETHPurchasePrice

• getETHPurchasePrice(token): Promise<BigNumber>

• Parameters

  • token: string

  Returns Promise<BigNumber>

handleWithdrawal

• handleWithdrawal(instanceAddress, proof): Promise<WithdrawalRequestResult>

• Parameters

  • instanceAddress: string

  • proof: string[]

  Returns Promise<WithdrawalRequestResult>

remember

• remember(): Promise<void>

• Cache relayer data into a PouchDB database in your cache folder. This will automatically fetch properties if they are not fetched.

  Returns Promise<void>

Static fromCache

• fromCache(options): Promise<Web.Relayer>

• Construct a new Relayer by reading relayer data from cache.

  Parameters

  • options: Web.Options.Relayer

  Returns Promise<Web.Relayer>