Expand description
Provides a trait and implementation of that trait for interacting with the xand-api (as
well as a fake version you can use in your tests in the mock module).
If you are talking with xand-api over the wire, this is what you should use.
Modules§
- cidr_
block - errors
- mock
- models
- The types in here represent chain-agnostic versions of the data one might fetch or send with the xand-api client. They are not the actual wire types, but are more usable representations.
- proto_
help - public_
key - serde_
hex - Serialization of a byte sequence to an hexadecimal string
Structs§
- AddAuthority
Key - Address
- Allowlist
Cidr Block - Bank
Account Id - Blockstamp
- Cash
Confirmation - Cidr
Block - IPv4 CIDR Block, with first four indices the ip address and last being the suffix
- Cidr
Block Parse Err - Conversion
Failure - Correlation
Id - An id for correlating a create/redeem request. Exactly 16 bytes.
- Create
Cancellation - Encryption
Key - A Encryption key representing the public portion of some private key, and hence a (potential) sender or receiver of encrypted messages.
- Exit
Member - GetValidator
Emission Progress - Health
Response - Pending
Create Request - Pending
Redeem Request - Proposal
- Public
Key - Reconnecting
Xand ApiClient - Redeem
Cancellation - Redeem
Fulfillment - Register
Account AsMember - Register
Session Keys - Remove
Allowlist Cidr Block - Remove
Authority Key - Remove
Member - Resurrectable
- A wrapper around something async that will re-attempt initialization automatically
- Root
Allowlist Cidr Block - Root
Remove Allowlist Cidr Block - Runtime
Upgrade - Send
- SetLimited
Agent Id - SetMember
EncKey - SetPending
Create Request Expire - SetTrust
EncKey - SetTrust
Node Id - SetValidator
Emission Rate - Submit
Proposal - Tonic
Status - A gRPC status describing the result of an RPC call.
- Total
Issuance - Transaction
- Transaction
Filter - Transaction
Id - Transaction
Status Stream - Wraps a stream of
TransactionStatusupdates to simplify common operations - Validator
Emission Progress - Validator
Emission Rate - Vote
Proposal - With
Timeout - Wrapper type for any type implementing
XandAPIClientTraitthat adds a timeout to all requests. - Withdraw
From Network - Xand
ApiClient - Default implementation of the
XandApiClientTrait
Enums§
- Address
Error - Administrative
Transaction - Bank
Account Conversion Err - Bank
Account Info - 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.
- Correlation
IdError - Create
Cancellation Reason - Create
Request Completion - Encryption
Error - Encryption
KeyError - Health
Status - Proposal
Stage - Represents the stage of a proposal. Proposals can only ever change stage once, from
Proposedto another stage. All other stages are final, and any subsequent changes should be considered a bug. - Redeem
Cancellation Reason - Redeem
Request Completion - Tonic
Code - gRPC status codes used by
Status. - Transaction
IdError - Transaction
Status - 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.
- Transaction
Type - Auto-generated discriminant enum variants
- Xand
Transaction - Chain-agnostic versions of all of our transaction types wrapped up in an enum
Constants§
- DEFAULT_
PAGE_ SIZE - Default page size for paginated results.
Traits§
- Xand
ApiClient Trait - Trait that exposes all of the functionality provided by the xand-api as a simple client interface