Struct polymesh_api::polymesh::api::external_agents::ExternalAgentsCallApi

source ·

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

Implementations§

source §

impl<'api> ExternalAgentsCallApi<'api>

source

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

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

source

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

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

source

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

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

source

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

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

source

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

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

source

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

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.