Struct TransactionHistoryRequest

pub struct TransactionHistoryRequest {
    pub addresses: Vec<String>,
    pub page_size: u32,
    pub page_number: u32,
    pub transaction_types: Vec<i32>,
    pub start_time: Option<Timestamp>,
    pub end_time: Option<Timestamp>,
}

The pagination technique follows Google’s advice for grpc: https://cloud.google.com/apis/design/design_patterns#list_pagination

Fields

addresses: Vec<String>

SS58 public key address(es) whose history we are concerned with. Any transactions affecting these addresses will appear in the history, not just transactions an address has issued. Leaving this field empty, or as an empty list, results in all transactions being returned.

page_size: u32

Clients use this field to specify the maximum number of results to be returned by the server. The server may further constrain the maximum number of results returned in a single page. If the page_size is 0, the server will decide the number of results to be returned.

page_number: u32

Which page number to fetch.

This violates best practices around pagination. We should be using a cursor instead, but there’s not really a point until we’re using an actual database.

transaction_types: Vec<i32>

Types of transactions to return. If empty, transactions of all types are returned.

start_time: Option<Timestamp>

[Optional] Only transactions after the specified time are returned. Unbounded if none.

end_time: Option<Timestamp>

[Optional] Only transactions before the specified time are returned. Unbounded if none.

Implementations

impl TransactionHistoryRequest

pub fn transaction_types( &self, ) -> FilterMap<Cloned<Iter<'_, i32>>, fn(i32) -> Option<TransactionType>>

Returns an iterator which yields the valid enum values contained in transaction_types.

pub fn push_transaction_types(&mut self, value: TransactionType)

Appends the provided enum value to transaction_types.

Trait Implementations

impl Clone for TransactionHistoryRequest

fn clone(&self) -> TransactionHistoryRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TransactionHistoryRequest

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

Formats the value using the given formatter.

impl Default for TransactionHistoryRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for TransactionHistoryRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for TransactionHistoryRequest

fn eq(&self, other: &TransactionHistoryRequest) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for TransactionHistoryRequest