Crate xand_api_proto

Source

Re-exports§

pub use xand_models_adapters::*;

Modules§

admin_txn
Nested message and enum types in AdministrativeTransaction.
administrative_transaction
Nested message and enum types in AdministrativeTransaction.
any_transaction
Nested message and enum types in AnyTransaction.
bank_account
Nested message and enum types in BankAccount.
create_request_completion
Nested message and enum types in CreateRequestCompletion.
encryption_error
Nested message and enum types in EncryptionError.
error
proposal
Nested message and enum types in Proposal.
proto_models
Server-agnostic wire types and business representations for the xand-api-client.
redeem_request_completion
Nested message and enum types in RedeemRequestCompletion.
transaction_status
Nested message and enum types in TransactionStatus.
user_transaction
Nested message and enum types in UserTransaction.
user_txn
Nested message and enum types in UserTransaction.
xand_api_client
Generated client implementations.
xand_api_server
Generated server implementations.
xand_models_adapters

Structs§

AddAuthorityKey
Issued by root to add a new keypair for a validator which may participate in consensus
AddressBalance
AddressBalanceRequest
AddressTransactionHistoryRequest
This must be separate from TransactionHistoryRequest so that we can enforce we are only talking about one address.
AdministrativeTransaction
Transactions which can only be issued by root (network)
Allowlist
AllowlistCidrBlock
Issued to add a CIDR block to the allowlist
AllowlistEntry
Allowlist entry returned by GetAllowlist
AllowlistRequest
AnyTransaction
All submitted transactions on the network are represented here
AuthorityKeys
List of authority keys (validators)
AuthorityKeysRequest
Query the list of authority keys (validators)
BankAccount
Bank account details
Blockstamp
CashConfirmation
Issued by the trust when fulfilling a CreateRequest
Create
A create request that has been submitted and may not have been confirmed or cancelled yet.
CreateCancellation
Issued by the trust to cancel pending create requests
CreateRequest
A request to confirm cash as claims on the network
CreateRequestCompletion
The reason / identifier a create request was completed
EncryptedBankAccount
Encrypted bank account details
EncryptionError
Encryption errors
EncryptionKey
EncryptionKeyRequest
Fetch the encryption key registered to a given account
ExitMember
Issued by root to immediately exit Members
FetchedTransaction
GetAllProposalsReq
Query for the state of all Proposals
GetCurrentBlockReq
GetLimitedAgentReq
Query the information on the Limited Agent
GetPendingCreateRequestExpireTimeReq
GetProposalReq
Query for the state of a specific Proposal
GetTrusteeReq
Query the information on the Trustee Node
GetValidatorEmissionProgressReq
GetValidatorEmissionRateReq
HealthCheckRequest
HealthCheckResponse
Issuer
KeyNotFound
LimitedAgentData
Limited Agent information
MaybeBalance
Members
List of members
MembersRequest
Query the list of members
MessageMalformed
OptionalAddress
A dummy message containing a string. Due to protobuf’s optional-messages-by-default behavior, this message will be optional in a containing message.
PendingCreateRequest
PendingCreateRequestExpireTime
PendingCreateRequests
PendingCreateRequestsPagination
PendingRedeemRequest
PendingRedeemRequests
PendingRedeemRequestsPagination
Proposal
Proposals
Redeem
A redeem request that has been submitted and may not have been fulfilled or cancelled yet.
RedeemCancellation
Issued by the trust to cancel pending redeem requests
RedeemFulfillment
Issued by the trust when a RedeemRequest has been fulfilled
RedeemRequest
A request to redeem on-chain funds
RedeemRequestCompletion
The reason / identifier a redeem request was completed
RegisterAccountAsMember
Issued by root to register members
RegisterSessionKeys
Issued by a validator to register their session keys
RemoveAllowlistCidrBlock
Issued to remove a CIDR block from the allowlist
RemoveAuthorityKey
Issued by root to remove a keypair for an existing validator
RemoveMember
Issued by root to mark Members for removal
RootAllowlistCidrBlock
Issued by root to add a CIDR block to the allowlist
RootRemoveAllowlistCidrBlock
Issued by root to remove a CIDR block from the allowlist
RuntimeUpgrade
Send
A request to send claims on-chain from one party to another
SetLimitedAgent
Issued by root to set the identity of the Limited Agent
SetMemberEncryptionKey
Issued by members to set the pubkey that should be used for encrypting data to be shared with them
SetPendingCreateRequestExpire
SetTrust
Issued by root to set the identity of the trust
SetTrustEncryptionKey
Issued by trust to set the pubkey that should be used for encrypting data only to be shared with the trust.
SetValidatorEmissionRate
Issued by root to select the amount and frequency of payments to Validators
SubmitProposal
Timestamp
Unix timestamp in milliseconds
TotalIssuanceRequest
TotalIssuanceResponse
TransactionAccepted
TransactionBroadcast
TransactionCommitted
TransactionDetailsRequest
TransactionDropped
TransactionFinalized
TransactionHistory
TransactionHistoryRequest
The pagination technique follows Google’s advice for grpc: https://cloud.google.com/apis/design/design_patterns#list_pagination
TransactionInvalid
TransactionReceived
TransactionStatus
Represents the status of an individual transaction
TransactionUpdate
TrusteeData
Trustee Node information
UnencryptedBankAccount
Unencrypted bank account details
UserTransaction
Transactions which any user may issue. These represent the most common transactions on the network and require no special privileges.
ValidatorEmissionProgress
ValidatorEmissionRate
VoteProposal
Issued by network voter to add vote for Proposal with specified id
VotingTransaction
WithdrawFromNetwork
Define withdrawal

Enums§

HealthStatus
TransactionType