Struct polymesh_api::polymesh::api::corporate_action::QueryApi

pub struct QueryApi<'api> { /* private fields */ }

Implementations

impl<'api> QueryApi<'api>

pub async fn max_details_length(&self) -> Result<u32>

Determines the maximum number of bytes that the free-form details of a CA can store.

Note that this is not the number of chars or the number of graphemes. While this may be unnatural in terms of human understanding of a text’s length, it more closely reflects actual storage costs ('a' is cheaper to store than an emoji).

pub async fn default_target_identities(
    &self,
    key_0: Ticker
) -> Result<TargetIdentities>

The identities targeted by default for CAs for this ticker, either to be excluded or included.

(ticker => target identities)

pub async fn default_withholding_tax(&self, key_0: Ticker) -> Result<Permill>

The default amount of tax to withhold (“withholding tax”, WT) for this ticker when distributing dividends.

To understand withholding tax, e.g., let’s assume that you hold ACME shares. ACME now decides to distribute 100 SEK to Alice. Alice lives in Sweden, so Skatteverket (the Swedish tax authority) wants 30% of that. Then those 100 * 30% are withheld from Alice, and ACME will send them to Skatteverket.

(ticker => % to withhold)

pub async fn did_withholding_tax(
    &self,
    key_0: Ticker
) -> Result<Vec<(IdentityId, Permill)>>

The amount of tax to withhold (“withholding tax”, WT) for a certain ticker x DID. If an entry exists for a certain DID, it overrides the default in DefaultWithholdingTax.

(ticker => [(did, % to withhold)]

pub async fn ca_id_sequence(&self, key_0: Ticker) -> Result<LocalCAId>

The next per-Ticker CA ID in the sequence. The full ID is defined as a combination of Ticker and a number in this sequence.

pub async fn corporate_actions(
    &self,
    key_0: Ticker,
    key_1: LocalCAId
) -> Result<Option<CorporateAction>>

All recorded CAs thus far. Only generic information is stored here. Specific CAKinds, e.g., benefits and corporate ballots, may use additional on-chain storage.

(ticker => local ID => the corporate action)

pub async fn ca_doc_link(&self, key_0: CAId) -> Result<Vec<DocumentId>>

Associations from CAs to Documents via their IDs. (CAId => [DocumentId])

The CorporateActions map stores Ticker => LocalId => The CA, so we can infer Ticker => CAId. Therefore, we don’t need a double map.

pub async fn details(&self, key_0: CAId) -> Result<CADetails>

Associates details in free-form text with a CA by its ID. (CAId => CADetails)

pub async fn storage_version(&self) -> Result<Version>

Storage version.

Trait Implementations

impl<'api> Clone for QueryApi<'api>

fn clone(&self) -> QueryApi<'api>

Returns a copy of the value.

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

Performs copy-assignment from source.