Struct polymesh_api::polymesh::api::external_agents::CallApi

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

Implementations

impl<'api> CallApi<'api>

pub fn create_group(
    &self,
    ticker: Ticker,
    perms: SubsetRestriction<PalletPermissions>
) -> Result<WrappedCall<'api>>

Creates a custom agent group (AG) for the given ticker.

The AG will have the permissions as given by perms. This new AG is then assigned id = AGIdSequence::get() + 1 as its AGId, which you can use as AgentGroup::Custom(id) when adding agents for ticker.

Arguments

• ticker to add the custom group for.
• perms that the new AG will have.

Errors

• UnauthorizedAgent if origin was not authorized as an agent to call this.
• TooLong if perms had some string or list length that was too long.
• CounterOverflow if AGIdSequence::get() + 1 would exceed u32::MAX.

Permissions

• Asset
• Agent

pub fn set_group_permissions(
    &self,
    ticker: Ticker,
    id: AGId,
    perms: SubsetRestriction<PalletPermissions>
) -> Result<WrappedCall<'api>>

Updates the permissions of the custom AG identified by id, for the given ticker.

Arguments

• ticker the custom AG belongs to.
• id for the custom AG within ticker.
• perms to update the custom AG to.

Errors

• UnauthorizedAgent if origin was not authorized as an agent to call this.
• TooLong if perms had some string or list length that was too long.
• NoSuchAG if id does not identify a custom AG.

Permissions

• Asset
• Agent

pub fn remove_agent(
    &self,
    ticker: Ticker,
    agent: IdentityId
) -> Result<WrappedCall<'api>>

Remove the given agent from ticker.

Arguments

• ticker that has the agent to remove.
• agent of ticker to remove.

Errors

• UnauthorizedAgent if origin was not authorized as an agent to call this.
• NotAnAgent if agent is not an agent of ticker.
• RemovingLastFullAgent if agent is the last full one.

Permissions

• Asset
• Agent

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

Abdicate agentship for ticker.

Arguments

• ticker of which the caller is an agent.

Errors

• NotAnAgent if the caller is not an agent of ticker.
• RemovingLastFullAgent if the caller is the last full agent.

Permissions

• Asset

pub fn change_group(
    &self,
    ticker: Ticker,
    agent: IdentityId,
    group: AgentGroup
) -> Result<WrappedCall<'api>>

Change the agent group that agent belongs to in ticker.

Arguments

• ticker that has the agent.
• agent of ticker to change the group for.
• group that agent will belong to in ticker.

Errors

• UnauthorizedAgent if origin was not authorized as an agent to call this.
• NoSuchAG if id does not identify a custom AG.
• NotAnAgent if agent is not an agent of ticker.
• RemovingLastFullAgent if agent was a Full one and is being demoted.

Permissions

• Asset
• Agent

pub fn accept_become_agent(&self, auth_id: u64) -> Result<WrappedCall<'api>>

Accept an authorization by an agent “Alice” who issued auth_id to also become an agent of the ticker Alice specified.

Arguments

• auth_id identifying the authorization to accept.

Errors

• AuthorizationError::Invalid if auth_id does not exist for the given caller.
• AuthorizationError::Expired if auth_id is for an auth that has expired.
• AuthorizationError::BadType if auth_id was not for a BecomeAgent auth type.
• UnauthorizedAgent if “Alice” is not permissioned to provide the auth.
• NoSuchAG if the group referred to a custom that does not exist.
• AlreadyAnAgent if the caller is already an agent of the ticker.

Permissions

• Agent

pub fn create_group_and_add_auth(
    &self,
    ticker: Ticker,
    perms: SubsetRestriction<PalletPermissions>,
    target: IdentityId,
    expiry: Option<u64>
) -> Result<WrappedCall<'api>>

Utility extrinsic to batch create_group and add_auth.

Permissions

• Asset
• Agent

pub fn create_and_change_custom_group(
    &self,
    ticker: Ticker,
    perms: SubsetRestriction<PalletPermissions>,
    agent: IdentityId
) -> Result<WrappedCall<'api>>

Utility extrinsic to batch create_group and change_group for custom groups only.

Permissions

• Asset
• Agent

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.