Struct cap_sdk_core::TransactionList

pub struct TransactionList { /* private fields */ }

A list contains a series of transactions and appropriate indexers.

This structure exposes a virtual merkle-tree in the following form:

0: event_hashes 1: offset 3: user_indexer 4: contract_indexer 5: token_indexer

      ROOT
     /    \
    /      \
   V        V
  /  \     /  \
 0    1   3    V
              / \
             4   5

Implementations

impl TransactionList

pub fn new(contract: Principal, offset: u64) -> TransactionList

Create a new list with the given global offset.

pub fn contract_id(&self) -> &Principal

Return the principal id of the contract we’re storing transactions for.

pub fn size(&self) -> u64

Return the total number of transactions.

pub fn len(&self) -> usize

Return the total number of items in this list.

pub fn is_empty(&self) -> bool

Returns tru if there are no events in this list.

pub fn insert(&mut self, event: Event) -> u64

Try to insert an event into the list.

pub fn get_transactions_for_user(
    &self,
    principal: &Principal,
    page: u32
) -> Vec<&Event, Global>

Return the transactions associated with a user’s principal id at the given page.

pub fn last_page_for_user(&self, principal: &Principal) -> u32

Return the last page number associated with the given user.

pub fn get_transactions_for_contract(
    &self,
    principal: &Principal,
    page: u32
) -> Vec<&Event, Global>

Return the transactions associated with a token’s principal id at the given page.

pub fn last_page_for_contract(&self, principal: &Principal) -> u32

Return the last page number associated with the given token contract.

pub fn get_transactions_for_token(
    &self,
    token_id: &u64,
    page: u32
) -> Vec<&Event, Global>

Return the transactions for a specific token.

pub fn last_page_for_token(&self, token_id: &u64) -> u32

pub fn witness_transactions_for_user(
    &self,
    principal: &Principal,
    page: u32
) -> HashTree<'_>

Return the witness that can be used to prove the response from get_transactions_for_user.

pub fn witness_transactions_for_contract(
    &self,
    principal: &Principal,
    page: u32
) -> HashTree<'_>

Return the witness that can be used to prove the response from get_transactions_for_token.

pub fn witness_transactions_for_token(
    &self,
    token_id: &u64,
    page: u32
) -> HashTree<'_>

Return the witness that can be used to prove the response from get_transactions_for_token.

pub fn get_transaction(&self, id: u64) -> Option<&Event>

Return a transaction by its global id.

pub fn witness_transaction(&self, id: u64) -> HashTree<'_>

Return a witness which proves the response returned by get_transaction.

Trait Implementations

impl AsHashTree for TransactionList

fn root_hash(&self) -> [u8; 32]

This method should return the root hash of this hash tree. Must be equivalent to as_hash_tree().reconstruct().

fn as_hash_tree(&self) -> HashTree<'_>

Constructs a hash tree corresponding to the data.

impl CandidType for TransactionList

fn _ty() -> Type

fn idl_serialize<S>(
    &self,
    serializer: S
) -> Result<(), <S as Serializer>::Error> where
    S: Serializer, 

fn ty() -> Type

fn id() -> TypeId

impl<'de> Deserialize<'de> for TransactionList

fn deserialize<D>(
    deserializer: D
) -> Result<TransactionList, <D as Deserializer<'de>>::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Drop for TransactionList

fn drop(&mut self)

Executes the destructor for this type.

impl Serialize for TransactionList

fn serialize<S>(
    &self,
    serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.