Struct polymesh_api::polymesh::api::corporate_action::CallApi

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

Implementations

impl<'api> CallApi<'api>

pub fn set_max_details_length(&self, length: u32) -> Result<WrappedCall<'api>>

Set the max length of details in terms of bytes. May only be called via a PIP.

pub fn set_default_targets(
    &self,
    ticker: Ticker,
    targets: TargetIdentities
) -> Result<WrappedCall<'api>>

Set the default CA TargetIdentities to targets.

Arguments

• origin which must be an external agent of ticker with relevant permissions.
• ticker for which the default identities are changing.
• targets the default target identities for a CA.

Errors

• UnauthorizedAgent if origin is not agent-permissioned for ticker.
• TooManyTargetIds if targets.identities.len() > T::MaxTargetIds::get().

Permissions

• Asset

pub fn set_default_withholding_tax(
    &self,
    ticker: Ticker,
    tax: Permill
) -> Result<WrappedCall<'api>>

Set the default withholding tax for all DIDs and CAs relevant to this ticker.

Arguments

• origin which must be an external agent of ticker with relevant permissions.
• ticker that the withholding tax will apply to.
• tax that should be withheld when distributing dividends, etc.

Errors

• UnauthorizedAgent if origin is not agent-permissioned for ticker.

Permissions

• Asset

pub fn set_did_withholding_tax(
    &self,
    ticker: Ticker,
    taxed_did: IdentityId,
    tax: Option<Permill>
) -> Result<WrappedCall<'api>>

Set the withholding tax of ticker for taxed_did to tax. If Some(tax), this overrides the default withholding tax of ticker to tax for taxed_did. Otherwise, if None, the default withholding tax will be used.

Arguments

• origin which must be an external agent of ticker with relevant permissions.
• ticker that the withholding tax will apply to.
• taxed_did that will have its withholding tax updated.
• tax that should be withheld when distributing dividends, etc.

Errors

• UnauthorizedAgent if origin is not agent-permissioned for ticker.
• TooManyDidTaxes if Some(tax) and adding the override would go over the limit MaxDidWhts.

Permissions

• Asset

pub fn initiate_corporate_action(
    &self,
    ticker: Ticker,
    kind: CAKind,
    decl_date: u64,
    record_date: Option<RecordDateSpec>,
    details: CADetails,
    targets: Option<TargetIdentities>,
    default_withholding_tax: Option<Permill>,
    withholding_tax: Option<Vec<(IdentityId, Permill)>>
) -> Result<WrappedCall<'api>>

Initiates a CA for ticker of kind with details and other provided arguments.

Arguments

• origin which must be an external agent of ticker with relevant permissions.
• ticker that the CA is made for.
• kind of CA being initiated.
• decl_date of CA bring initialized.
• record_date, if any, to calculate the impact of this CA. If provided, this results in a scheduled balance snapshot (“checkpoint”) at the date.
• details of the CA in free-text form, up to a certain number of bytes in length.
• targets, if any, which this CA is relevant/irrelevant to. Overrides, if provided, the default at the asset level (set_default_targets).
• default_withholding_tax, if any, is the default withholding tax to use for this CA. Overrides, if provided, the default at the asset level (set_default_withholding_tax).
• withholding_tax, if any, provides per-DID withholding tax overrides. Overrides, if provided, the default at the asset level (set_did_withholding_tax).

Errors

• DetailsTooLong if details.len() goes beyond max_details_length.
• UnauthorizedAgent if origin is not agent-permissioned for ticker.
• CounterOverflow in the unlikely event that so many CAs were created for this ticker, that integer overflow would have occured if instead allowed.
• TooManyDidTaxes if withholding_tax.unwrap().len() would go over the limit MaxDidWhts.
• DuplicateDidTax if a DID is included more than once in wt.
• TooManyTargetIds if targets.unwrap().identities.len() > T::MaxTargetIds::get().
• DeclDateInFuture if the declaration date is not in the past.
• When record_date.is_some(), other errors due to checkpoint scheduling may occur.

Permissions

• Asset

pub fn link_ca_doc(
    &self,
    id: CAId,
    docs: Vec<DocumentId>
) -> Result<WrappedCall<'api>>

Link the given CA id to the given docs. Any previous links for the CA are removed in favor of docs.

The workflow here is to add the documents and initiating the CA in any order desired. Once both exist, they can now be linked together.

Arguments

• origin which must be an external agent of id.ticker with relevant permissions.
• id of the CA to associate with docs.
• docs to associate with the CA with id.

Errors

• UnauthorizedAgent if origin is not agent-permissioned for ticker.
• NoSuchCA if id does not identify an existing CA.
• NoSuchDoc if any of docs does not identify an existing document.

Permissions

• Asset

pub fn remove_ca(&self, ca_id: CAId) -> Result<WrappedCall<'api>>

Removes the CA identified by ca_id.

Associated data, such as document links, ballots, and capital distributions are also removed.

Any schedule associated with the record date will see strong_ref_count(schedule_id) decremented.

Arguments

• origin which must be an external agent of ca_id.ticker with relevant permissions.
• ca_id of the CA to remove.

Errors

• UnauthorizedAgent if origin is not agent-permissioned for ticker.
• NoSuchCA if id does not identify an existing CA.

Permissions

• Asset

pub fn change_record_date(
    &self,
    ca_id: CAId,
    record_date: Option<RecordDateSpec>
) -> Result<WrappedCall<'api>>

Changes the record date of the CA identified by ca_id.

Arguments

• origin which must be an external agent of ca_id.ticker with relevant permissions.
• ca_id of the CA to alter.
• record_date, if any, to calculate the impact of the CA. If provided, this results in a scheduled balance snapshot (“checkpoint”) at the date.

Errors

• UnauthorizedAgent if origin is not agent-permissioned for ticker.
• NoSuchCA if id does not identify an existing CA.
• When record_date.is_some(), other errors due to checkpoint scheduling may occur.

Permissions

• Asset

pub fn initiate_corporate_action_and_distribute(
    &self,
    ca_args: InitiateCorporateActionArgs,
    portfolio: Option<PortfolioNumber>,
    currency: Ticker,
    per_share: u128,
    amount: u128,
    payment_at: u64,
    expires_at: Option<u64>
) -> Result<WrappedCall<'api>>

Utility extrinsic to batch initiate_corporate_action and distribute

Trait Implementations

impl<'api> Clone for CallApi<'api>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'api> From<&'api Api> for CallApi<'api>

fn from(api: &'api Api) -> Self

Converts to this type from the input type.