Crate xand_api_client

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

• AddAuthorityKey
• Address
• AllowlistCidrBlock
• BankAccountId
• Blockstamp
• CashConfirmation
• CidrBlock
  IPv4 CIDR Block, with first four indices the ip address and last being the suffix
• CidrBlockParseErr
• 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
• PublicKey
• ReconnectingXandApiClient
• RedeemCancellation
• RedeemFulfillment
• RegisterAccountAsMember
• RegisterSessionKeys
• RemoveAllowlistCidrBlock
• RemoveAuthorityKey
• RemoveMember
• Resurrectable
  A wrapper around something async that will re-attempt initialization automatically
• RootAllowlistCidrBlock
• RootRemoveAllowlistCidrBlock
• RuntimeUpgrade
• Send
• SetLimitedAgentId
• SetMemberEncKey
• SetPendingCreateRequestExpire
• SetTrustEncKey
• SetTrustNodeId
• SetValidatorEmissionRate
• SubmitProposal
• TonicStatus
  A gRPC status describing the result of an RPC call.
• TotalIssuance
• Transaction
• TransactionFilter
• TransactionId
• TransactionStatusStream
  Wraps a stream of TransactionStatus updates to simplify common operations
• ValidatorEmissionProgress
• ValidatorEmissionRate
• VoteProposal
• WithTimeout
  Wrapper type for any type implementing XandAPIClientTrait that adds a timeout to all requests.
• WithdrawFromNetwork
• XandApiClient
  Default implementation of the XandApiClientTrait

Enums

• AddressError
• 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
• EncryptionError
• 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
• TonicCode
  gRPC status codes used by Status.
• 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.

Traits

• XandApiClientTrait
  Trait that exposes all of the functionality provided by the xand-api as a simple client interface

Functions

• convert_type

Type Definitions

• TransactionHistoryPage