Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "raidenclient/types"

Index

Type aliases

Channel

Channel: OpenChannelPayload & object

A raiden payment channel.

OpenChannelPayload

OpenChannelPayload: object

The payload for the openChannel call.

Type declaration

  • partner_address: string
  • settle_timeout: number
  • token_address: string
  • total_deposit: number

PaymentEvent

PaymentEvent: object

Type declaration

  • Optional amount?: undefined | number
  • event: string
  • identifier: number
  • Optional initiator?: undefined | string
  • log_time: string
  • payment_network_address: string
  • Optional reason?: undefined | string
  • Optional route?: string[]
  • Optional secret?: undefined | string
  • Optional target?: undefined | string
  • token_network_address: string

RaidenChannelCount

RaidenChannelCount: object

Type declaration

  • active: number
  • closed: number
  • settled: number

RaidenClientConfig

RaidenClientConfig: object

The configurable options for the raiden client.

Type declaration

  • disable: boolean
  • host: string
  • keystorepath: string
  • port: number

RaidenInfo

RaidenInfo: object

General information about the state of this raiden client.

Type declaration

  • Optional address?: undefined | string
  • Optional chain?: undefined | string
  • Optional channels?: RaidenChannelCount
  • Optional error?: undefined | string
  • status: string
  • Optional version?: undefined | string

RaidenResolveRequest

RaidenResolveRequest: object

Type declaration

  • amount: number

    The amount of the incoming payment pending resolution, in the smallest units supported by the token.

  • chain_height: number

    The current height of the chain

  • expiration: number

    The lock expiration for the incoming payment (absolute block number).

  • secrethash: string

    The payment hash in hex with 0x prefix.

  • token: string

    The token address for the resolve request in hex.

RaidenResolveResponse

RaidenResolveResponse: object

Type declaration

  • secret: string

    The preimage in hex format.

RaidenVersion

RaidenVersion: object

The raiden version.

Type declaration

  • version: string

TokenPaymentRequest

TokenPaymentRequest: object

The payload for tokenPayment call.

Type declaration

  • amount: number

    The amount of the payment request denominated in the smallest units supported by the token.

  • Optional identifier?: undefined | number
  • Optional lock_timeout?: undefined | number
  • secret_hash: string
  • target_address: string
  • token_address: string

TokenPaymentResponse

TokenPaymentResponse: TokenPaymentRequest & object

The response for tokenPayment call.

Generated using TypeDoc