Struct XandApiClient 

pub struct XandApiClient<T> { /* private fields */ }

Implementations

impl XandApiClient<Channel>

pub async fn connect<D>(dst: D) -> Result<Self, Error>

where D: TryInto<Endpoint>, D::Error: Into<StdError>,

Attempt to create a new client by connecting to a given endpoint.

impl<T> XandApiClient<T>

where T: GrpcService<BoxBody>, T::ResponseBody: Body + Send + 'static, T::Error: Into<StdError>, <T::ResponseBody as Body>::Error: Into<StdError> + Send,

pub fn new(inner: T) -> Self

pub fn with_interceptor<F>( inner: T, interceptor: F, ) -> XandApiClient<InterceptedService<T, F>>

where F: Interceptor, T: Service<Request<BoxBody>, Response = Response<<T as GrpcService<BoxBody>>::ResponseBody>>, <T as Service<Request<BoxBody>>>::Error: Into<StdError> + Send + Sync,

pub fn send_gzip(self) -> Self

Compress requests with gzip.

This requires the server to support it otherwise it might respond with an error.

pub fn accept_gzip(self) -> Self

Enable decompressing responses with gzip.

pub async fn submit_transaction( &mut self, request: impl IntoRequest<UserTransaction>, ) -> Result<Response<Streaming<TransactionUpdate>>, Status>

For submitting transactions to the network. See the UserTransaction type for details about which transactions may be submitted.

pub async fn propose_action( &mut self, request: impl IntoRequest<SubmitProposal>, ) -> Result<Response<Streaming<TransactionUpdate>>, Status>

For proposing administrative transactions to the network. See the AdministrativeTransaction type for details about which transactions may be submitted.

pub async fn vote_on_proposal( &mut self, request: impl IntoRequest<VotingTransaction>, ) -> Result<Response<Streaming<TransactionUpdate>>, Status>

For voting on outstanding proposals. See the VotingTransactions type for details about which transactions may be submitted.

pub async fn get_proposal( &mut self, request: impl IntoRequest<GetProposalReq>, ) -> Result<Response<Proposal>, Status>

For querying data on specific Proposal by id

pub async fn get_all_proposals( &mut self, request: impl IntoRequest<GetAllProposalsReq>, ) -> Result<Response<Proposals>, Status>

For querying a list of all non-expired Proposals

pub async fn get_trustee( &mut self, request: impl IntoRequest<GetTrusteeReq>, ) -> Result<Response<TrusteeData>, Status>

pub async fn get_limited_agent( &mut self, request: impl IntoRequest<GetLimitedAgentReq>, ) -> Result<Response<LimitedAgentData>, Status>

pub async fn get_transaction_details( &mut self, request: impl IntoRequest<TransactionDetailsRequest>, ) -> Result<Response<FetchedTransaction>, Status>

To request the details (including its status) of a transaction by ID

pub async fn get_transaction_history( &mut self, request: impl IntoRequest<TransactionHistoryRequest>, ) -> Result<Response<TransactionHistory>, Status>

For requesting historical transaction data. Only returns transactions which have been finalized on the chain.

TODO – A request with no addresses results in every transaction in the cache being returned, without meaningful order. We need to make changes to the backend.

pub async fn get_address_balance( &mut self, request: impl IntoRequest<AddressBalanceRequest>, ) -> Result<Response<AddressBalance>, Status>

For requesting the balance an address has

pub async fn get_total_issuance( &mut self, request: impl IntoRequest<TotalIssuanceRequest>, ) -> Result<Response<TotalIssuanceResponse>, Status>

For requesting the total amount of claims on the network

pub async fn get_address_transactions( &mut self, request: impl IntoRequest<AddressTransactionHistoryRequest>, ) -> Result<Response<TransactionHistory>, Status>

For requesting transactions that affect a given address

pub async fn get_pending_create_requests( &mut self, request: impl IntoRequest<PendingCreateRequestsPagination>, ) -> Result<Response<PendingCreateRequests>, Status>

For enumerating the currently outstanding create requests

pub async fn get_pending_redeem_requests( &mut self, request: impl IntoRequest<PendingRedeemRequestsPagination>, ) -> Result<Response<PendingRedeemRequests>, Status>

For enumerating the currently outstanding redeem requests

pub async fn get_allowlist( &mut self, request: impl IntoRequest<AllowlistRequest>, ) -> Result<Response<Allowlist>, Status>

For retrieving the list of allowlisted CIDR blocks.

pub async fn get_members( &mut self, request: impl IntoRequest<MembersRequest>, ) -> Result<Response<Members>, Status>

For enumerating the current members

pub async fn get_authority_keys( &mut self, request: impl IntoRequest<AuthorityKeysRequest>, ) -> Result<Response<AuthorityKeys>, Status>

For enumerating the current authority keys (validators)

pub async fn get_encryption_key( &mut self, request: impl IntoRequest<EncryptionKeyRequest>, ) -> Result<Response<EncryptionKey>, Status>

For retrieving the public encryption key of an account on the network

pub async fn get_current_block( &mut self, request: impl IntoRequest<GetCurrentBlockReq>, ) -> Result<Response<Blockstamp>, Status>

Returns the most current block and timestamp in a single blockstamp message with a staleness indicator

pub async fn get_validator_emission_rate( &mut self, request: impl IntoRequest<GetValidatorEmissionRateReq>, ) -> Result<Response<ValidatorEmissionRate>, Status>

pub async fn get_validator_emission_progress( &mut self, request: impl IntoRequest<GetValidatorEmissionProgressReq>, ) -> Result<Response<ValidatorEmissionProgress>, Status>

pub async fn get_pending_create_request_expire_time( &mut self, request: impl IntoRequest<GetPendingCreateRequestExpireTimeReq>, ) -> Result<Response<PendingCreateRequestExpireTime>, Status>

pub async fn check_health( &mut self, request: impl IntoRequest<HealthCheckRequest>, ) -> Result<Response<HealthCheckResponse>, Status>

Trait Implementations

impl<T: Clone> Clone for XandApiClient<T>

fn clone(&self) -> XandApiClient<T>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for XandApiClient<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.