cfxdb.xbr.api

Classes

Api	XBRNetwork.Api database object.
Apis	Apis table, mapping from oid|UUID to cfxdb.xbr.Api
IndexApiByCatalog	Api-by-FbsRepository, index with (catalog_oid|bytes[16], created|int) -> api_oid|UUID mapping.
_ApiGen

Module Contents

class Api(from_fbs=None)

Bases: object

XBRNetwork.Api database object.

__str__()

_catalog_oid = None

_from_fbs = None

_meta = None

_oid = None

_published = None

_schema = None

_signature = None

_tid = None

_timestamp = None

build(builder)

static cast(buf)

property catalog_oid: uuid.UUID

The unique ID of the catalog.

marshal() → dict

property meta: str

The XBR market metadata published by the market owner. IPFS Multihash pointing to a RDF/Turtle file with market metadata.

property oid: uuid.UUID

The unique ID of the api.

property published: int

Global market sequence number.

property schema: str

The XBR market terms set by the market owner. IPFS Multihash pointing to a ZIP archive file with market documents.

property signature: bytes

When signed off-chain and submitted via XBRMarket.createMarketFor.

property tid: bytes

Transaction hash of the transaction this change was committed to the blockchain under.

property timestamp: numpy.datetime64

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

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

Bases: zlmdb.MapUuidFlatBuffers

Apis table, mapping from oid|UUID to cfxdb.xbr.Api

class IndexApiByCatalog(slot=None, compress=None)

Bases: zlmdb.MapBytes16TimestampUuid

Api-by-FbsRepository, index with (catalog_oid|bytes[16], created|int) -> api_oid|UUID mapping.

class _ApiGen

Bases: cfxdb.gen.xbr.Api.Api

CatalogOidAsBytes()

classmethod GetRootAsApi(buf, offset)

This method is deprecated. Please switch to GetRootAs.

OidAsBytes()

PublishedAsBytes()

SignatureAsBytes()

TidAsBytes()