Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Channel

Hierarchy

  • Channel

Index

Constructors

Properties

Constructors

constructor

Properties

Optional balance

balance: undefined | number

should be an integer of the amount of the token_address token we have available for payments.

Optional channelIdentifier

channelIdentifier: undefined | string

should be an integer containing the identifier of the channel

Optional networkIdentifier

networkIdentifier: undefined | string

should be a string containing the EIP55-encoded address of the token network the channel is part of

Optional partnerAddress

partnerAddress: undefined | string

should be a string containing the EIP55-encoded address of the partner with whom we have opened a channel

Optional revealTimeout

revealTimeout: undefined | number

The maximum number of blocks allowed between the setting of a hashlock and the revealing of the related secret

Optional settleTimeout

settleTimeout: undefined | number

The number of blocks that are required to be mined from the time that close() is called until the channel can be settled with a call to settle()

Optional state

state: ChannelState

should be the current state of the channel represented by a string. Possible value are:

  • 'opened': The channel is open and tokens are tradeable
  • 'closed': The channel has been closed by a participant
  • 'settled': The channel has been closed by a participant and also settled

Optional tokenAddress

tokenAddress: undefined | string

should be a string containing the EIP55-encoded address of the token we are trading in the channel

Optional totalDeposit

totalDeposit: undefined | number

should be an integer of the amount of the token_address token we have deposited into the contract for this channel

Generated using TypeDoc