cfxdb.xbrmm.channel

Attributes

ChannelState
ChannelType

Classes

Channel	XBR off-chain payment or paying channel.
ChannelBalance	XBR payment channel current (off-chain) balance. The sum of Balance.remaining and Balance.inflight equals Channel.amount.
IndexPayingChannelByDelegate	Index: (delegate_adr, created_timestamp) -> channel_oid
IndexPayingChannelByRecipient	Index: (recipient_adr, created_timestamp) -> channel_oid
IndexPaymentChannelByActor	Index: (actor_adr, created_timestamp) -> channel_oid
IndexPaymentChannelByDelegate	Index: (delegate_adr, created_timestamp) -> channel_oid
PayingChannelBalances	XBR paying channels current balances by channel_oid.
PayingChannels	XBR paying channels by channel_oid.
PaymentChannelBalances	XBR payment channels current balances by channel_oid.
PaymentChannels	XBR payment channels by channel_oid.
_ChannelBalanceGen	Expand methods on the class code generated by flatc.
_ChannelGen	Expand methods on the class code generated by flatc.

Module Contents

class Channel(from_fbs=None)

Bases: object

XBR off-chain payment or paying channel.

__str__()

_actor = None

_amount = None

_channel_oid = None

_channel_type = None

_close_balance = None

_close_channel_seq = None

_close_del_sig = None

_close_is_final = None

_close_mm_sig = None

_closed_at = None

_closed_tx = None

_closing_at = None

_delegate = None

_from_fbs = None

_market_oid = None

_marketmaker = None

_member_oid = None

_open_at = None

_recipient = None

_seq = None

_state = None

_timeout = None

_timestamp = None

property actor: bytes

Ethereum address of the sender (either XBR Consumer or XBR Market).

property amount: int

Amount of XBR tokens initially deposited into the payment channel.

build(builder)

static cast(buf)

property channel_oid: uuid.UUID

The unique OID of the channel.

property channel_type: int

payment channel (from XBR consumer to XBR market maker) or paying channel (from XBR market maker to XBR provider).

Type:

Channel type

property close_balance: int

Remaining (closing) channel balance (XBR).

property close_channel_seq: int

channel transaction sequence number.

Type:

Last off-chain, closing transaction

property close_del_sig: bytes

Closing signature by (seller or buyer) delegate.

property close_is_final: bool

Flag indication if close is final (happens immediately without a channel timeout).

property close_mm_sig: int

Closing signature by market maker.

property closed_at: int

Block number (on the blockchain) when the payment channel was finally closed.

property closed_tx: bytes

When channel was finally closed on-chain, the Ethereum transaction ID.

property closing_at: int

Block number (on the blockchain) when the payment channel will close (at the latest).

property delegate: bytes

Ethereum address of the sender delegate (either XBR Consumer delegate or XBR Market delegate == market maker)

property market_oid: uuid.UUID

The unique OID of the market.

property marketmaker: bytes

ID of the payment channel.

marshal() → dict

property member_oid: uuid.UUID

The unique OID of the member.

property open_at: int

Block number (on the blockchain) when the actor (originally) joined the market.

property recipient: bytes

Ethereum address of the recipient (either XBR Market or XBR Provider)

property seq: int

Global channel sequence number.

property state: int

Current state of payment channel.

property timeout: int

Payment channel (non-cooperative) closed timeout in blocks (on the blockchain).

property timestamp: numpy.datetime64

Database transaction time (epoch time in ns) of insert or last update.

class ChannelBalance(from_fbs=None)

Bases: object

XBR payment channel current (off-chain) balance. The sum of Balance.remaining and Balance.inflight equals Channel.amount.

__str__()

_from_fbs = None

_inflight = None

_remaining = None

_seq = None

build(builder)

static cast(buf)

property inflight: int

Amount of XBR tokens reserved to in-flight purchase transactions.

marshal() → dict

static parse(data: dict)

property remaining: int

Amount of XBR tokens currently remaining in the payment channel.

property seq: int

Sequence number of transactions on this balance starting from 0 when the payment channel is created.

ChannelState

ChannelType

class IndexPayingChannelByDelegate(slot=None, compress=None)

Bases: zlmdb.MapBytes20TimestampUuid

Index: (delegate_adr, created_timestamp) -> channel_oid

class IndexPayingChannelByRecipient(slot=None, compress=None)

Bases: zlmdb.MapBytes20TimestampUuid

Index: (recipient_adr, created_timestamp) -> channel_oid

class IndexPaymentChannelByActor(slot=None, compress=None)

Bases: zlmdb.MapBytes20TimestampUuid

Index: (actor_adr, created_timestamp) -> channel_oid

class IndexPaymentChannelByDelegate(slot=None, compress=None)

Bases: zlmdb.MapBytes20TimestampUuid

Index: (delegate_adr, created_timestamp) -> channel_oid

class PayingChannelBalances(slot=None, compress=None, build=None, cast=None)

Bases: zlmdb.MapUuidFlatBuffers

XBR paying channels current balances by channel_oid.

Map zlmdb.MapBytes20FlatBuffers from channel_oid to cfxdb.xbr.Balance

class PayingChannels(slot=None, compress=None, build=None, cast=None)

Bases: zlmdb.MapUuidFlatBuffers

XBR paying channels by channel_oid.

Map zlmdb.MapUuidFlatBuffers from channel_oid to cfxdb.xbr.Channel

class PaymentChannelBalances(slot=None, compress=None, build=None, cast=None)

Bases: zlmdb.MapUuidFlatBuffers

XBR payment channels current balances by channel_oid.

Map zlmdb.MapBytes20FlatBuffers from channel_oid to cfxdb.xbr.Balance

class PaymentChannels(slot=None, compress=None, build=None, cast=None)

Bases: zlmdb.MapUuidFlatBuffers

XBR payment channels by channel_oid.

Map zlmdb.MapUuidFlatBuffers from channel_oid to cfxdb.xbr.Channel

class _ChannelBalanceGen

Bases: cfxdb.gen.xbrmm.ChannelBalance.ChannelBalance

Expand methods on the class code generated by flatc.

FIXME: come up with a PR for flatc to generated this stuff automatically.

classmethod GetRootAsChannelBalance(buf, offset)

This method is deprecated. Please switch to GetRootAs.

InflightAsBytes()

RemainingAsBytes()

class _ChannelGen

Bases: cfxdb.gen.xbrmm.Channel.Channel

Expand methods on the class code generated by flatc.

FIXME: come up with a PR for flatc to generated this stuff automatically.

ActorAsBytes()

AmountAsBytes()

ChannelOidAsBytes()

CloseBalanceAsBytes()

CloseDelSigAsBytes()

CloseMmSigAsBytes()

ClosedAtAsBytes()

ClosedTxAsBytes()

ClosingAtAsBytes()

DelegateAsBytes()

classmethod GetRootAsChannel(buf, offset)

This method is deprecated. Please switch to GetRootAs.

MarketOidAsBytes()

MarketmakerAsBytes()

MemberOidAsBytes()

OpenAtAsBytes()

RecipientAsBytes()