Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RaidenChannel

Public exposed channels interface (Raiden.channels$)

This should be only used as a public view of the internal channel state It contains some details about channel's current state, and some balances. Most relevant are:

  • state: one of 'open', 'closing', 'closed', 'settleable' or 'settling'
  • id: channel identifier
  • token: ERC20 token contract address
  • tokenNetwork: TokenNetwork contract address
  • settleTimeout: number of blocks after close when channel becomes settleable
  • openBlock: block number in which channel was opened
  • closeBlock: block in which channel got closed
  • partner: partner's address
  • balance: how much was sent (negative) plus received on this channel from partner
  • capacity: how much still can be transferred through this channel; increases with deposit
  • Balances [for each property, prefixed with either 'own' or 'partner']:
    • Deposit: on-chain totalDeposit
    • Withdraw: on-chain totalWithdraw
    • Unlocked: how much was received and unlocked on this channel's end
    • Locked: how much is still locked off-chain on this channel's end
    • Balance: received minus sent off-chain
    • Capacity: channel end's liquidity
    • Withdrawable: amount which can still be withdrawn

Hierarchy

  • ChannelBalances
    • RaidenChannel

Index

Properties

balance

balance: BigNumber

capacity

capacity: BigNumber

Optional closeBlock

closeBlock: number

id

id: number

openBlock

openBlock: number

ownBalance

ownBalance: Int<32>

ownCapacity

ownCapacity: UInt<32>

ownDeposit

ownDeposit: UInt<32>

ownLocked

ownLocked: UInt<32>

ownOnchainUnlocked

ownOnchainUnlocked: UInt<32>

ownTotalWithdrawable

ownTotalWithdrawable: UInt<32>

ownTransferred

ownTransferred: UInt<32>

ownUnlocked

ownUnlocked: UInt<32>

ownWithdraw

ownWithdraw: UInt<32>

ownWithdrawable

ownWithdrawable: UInt<32>

partner

partner: Address

partnerBalance

partnerBalance: Int<32>

partnerCapacity

partnerCapacity: UInt<32>

partnerDeposit

partnerDeposit: UInt<32>

partnerLocked

partnerLocked: UInt<32>

partnerOnchainUnlocked

partnerOnchainUnlocked: UInt<32>

partnerTotalWithdrawable

partnerTotalWithdrawable: UInt<32>

partnerTransferred

partnerTransferred: UInt<32>

partnerUnlocked

partnerUnlocked: UInt<32>

partnerWithdraw

partnerWithdraw: UInt<32>

partnerWithdrawable

partnerWithdrawable: UInt<32>

settleTimeout

settleTimeout: number

state

token

token: Address

tokenNetwork

tokenNetwork: Address

totalCapacity

totalCapacity: UInt<32>

Generated using TypeDoc