Struct polymesh_api::polymesh::api::relayer::CallApi

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

Implementations

impl<'api> CallApi<'api>

pub fn set_paying_key(
    &self,
    user_key: AccountId,
    polyx_limit: u128
) -> Result<WrappedCall<'api>>

Creates an authorization to allow user_key to accept the caller (origin == paying_key) as their subsidiser.

Arguments

• user_key the user key to subsidise.
• polyx_limit the initial POLYX limit for this subsidy.

Errors

• UnauthorizedCaller if origin is not authorized to call this extrinsic.

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

Accepts a paying_key authorization.

Arguments

• auth_id the authorization id to accept a paying_key.

Errors

• AuthorizationError::Invalid if auth_id does not exist for the given caller.
• AuthorizationError::Expired if auth_id the authorization has expired.
• AuthorizationError::BadType if auth_id was not a AddRelayerPayingKey authorization.
• NotAuthorizedForUserKey if origin is not authorized to accept the authorization for the user_key.
• NotAuthorizedForPayingKey if the authorization was created an identity different from the paying_key’s identity.
• UserKeyCddMissing if the user_key is not attached to a CDD’d identity.
• PayingKeyCddMissing if the paying_key is not attached to a CDD’d identity.
• UnauthorizedCaller if origin is not authorized to call this extrinsic.

pub fn remove_paying_key(
    &self,
    user_key: AccountId,
    paying_key: AccountId
) -> Result<WrappedCall<'api>>

Removes the paying_key from a user_key.

Arguments

• user_key the user key to remove the subsidy from.
• paying_key the paying key that was subsidising the user_key.

Errors

• NotAuthorizedForUserKey if origin is not authorized to remove the subsidy for the user_key.
• NoPayingKey if the user_key doesn’t have a paying_key.
• NotPayingKey if the paying_key doesn’t match the current paying_key.
• UnauthorizedCaller if origin is not authorized to call this extrinsic.

pub fn update_polyx_limit(
    &self,
    user_key: AccountId,
    polyx_limit: u128
) -> Result<WrappedCall<'api>>

Updates the available POLYX for a user_key.

Arguments

• user_key the user key of the subsidy to update the available POLYX.
• polyx_limit the amount of POLYX available for subsidising the user_key.

Errors

• NoPayingKey if the user_key doesn’t have a paying_key.
• NotPayingKey if origin doesn’t match the current paying_key.
• UnauthorizedCaller if origin is not authorized to call this extrinsic.

pub fn increase_polyx_limit(
    &self,
    user_key: AccountId,
    amount: u128
) -> Result<WrappedCall<'api>>

Increase the available POLYX for a user_key.

Arguments

• user_key the user key of the subsidy to update the available POLYX.
• amount the amount of POLYX to add to the subsidy of user_key.

Errors

• NoPayingKey if the user_key doesn’t have a paying_key.
• NotPayingKey if origin doesn’t match the current paying_key.
• UnauthorizedCaller if origin is not authorized to call this extrinsic.
• Overlow if the subsidy’s remaining POLYX would have overflowed u128::MAX.

pub fn decrease_polyx_limit(
    &self,
    user_key: AccountId,
    amount: u128
) -> Result<WrappedCall<'api>>

Decrease the available POLYX for a user_key.

Arguments

• user_key the user key of the subsidy to update the available POLYX.
• amount the amount of POLYX to remove from the subsidy of user_key.

Errors

• NoPayingKey if the user_key doesn’t have a paying_key.
• NotPayingKey if origin doesn’t match the current paying_key.
• UnauthorizedCaller if origin is not authorized to call this extrinsic.
• Overlow if the subsidy has less then amount POLYX remaining.

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.