Module proto_models 

Server-agnostic wire types and business representations for the xand-api-client.

This module does not take any dependencies on any runtime specifics.

If you are a caller of xand-api (IE: Some external service like the trustee or member–api), you should depend exclusively on the xand-api-client package, which re-exports the things you will need from this module.

Re-exports

pub use cidr_block::CidrBlock;

pub use cidr_block::CidrBlockParseErr;

pub use errors::EncryptionError;

pub use public_key::PublicKey;

Modules

cidr_block

errors

public_key

serde_hex

Serialization of a byte sequence to an hexadecimal string

Structs

AddAuthorityKey

AllowlistCidrBlock

BankAccountId

Blockstamp

CashConfirmation

ConversionFailure

CorrelationId

An id for correlating a create/redeem request. Exactly 16 bytes.

CreateCancellation

EncryptionKey

A Encryption key representing the public portion of some private key, and hence a (potential) sender or receiver of encrypted messages.

ExitMember

GetValidatorEmissionProgress

HealthResponse

PendingCreateRequest

PendingRedeemRequest

Proposal

RedeemCancellation

RedeemFulfillment

RegisterAccountAsMember

RegisterSessionKeys

RemoveAllowlistCidrBlock

RemoveAuthorityKey

RemoveMember

RootAllowlistCidrBlock

RootRemoveAllowlistCidrBlock

RuntimeUpgrade

Send

SetLimitedAgentId

SetMemberEncKey

SetPendingCreateRequestExpire

SetTrustEncKey

SetTrustNodeId

SetValidatorEmissionRate

SubmitProposal

TotalIssuance

Transaction

TransactionFilter

TransactionId

ValidatorEmissionProgress

ValidatorEmissionRate

VoteProposal

WithdrawFromNetwork

Enums

AdministrativeTransaction

BankAccountConversionErr

BankAccountInfo

Some bank account information associated with create and redeem requests. Depending on where in their lifecycle they are, the information may or may not be encrypted yet.

CorrelationIdError

CreateCancellationReason

CreateRequestCompletion

EncryptionKeyError

HealthStatus

ProposalStage

Represents the stage of a proposal. Proposals can only ever change stage once, from Proposed to another stage. All other stages are final, and any subsequent changes should be considered a bug.

RedeemCancellationReason

RedeemRequestCompletion

TransactionIdError

TransactionStatus

A chain-implementation agnostic representation of the status of a transaction/extrinsic/whatever that a client has submitted (or tried to submit) to the network.

TransactionType

Auto-generated discriminant enum variants

XandTransaction

Chain-agnostic versions of all of our transaction types wrapped up in an enum

Constants

DEFAULT_PAGE_SIZE

Default page size for paginated results.

Functions

convert_type