Struct polymesh_api::polymesh::api::identity::CallApi

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

Implementations

impl<'api> CallApi<'api>

pub fn cdd_register_did(
    &self,
    target_account: AccountId,
    secondary_keys: Vec<SecondaryKey<AccountId>>
) -> Result<WrappedCall<'api>>

Register target_account with a new Identity.

Failure

• origin has to be a active CDD provider. Inactive CDD providers cannot add new claims.
• target_account (primary key of the new Identity) can be linked to just one and only one identity.
• External secondary keys can be linked to just one identity.

Weight

7_000_000_000 + 600_000 * secondary_keys.len()

pub fn invalidate_cdd_claims(
    &self,
    cdd: IdentityId,
    disable_from: u64,
    expiry: Option<u64>
) -> Result<WrappedCall<'api>>

Invalidates any claim generated by cdd from disable_from timestamps.

You can also define an expiration time, which will invalidate all claims generated by that cdd and remove it as CDD member group.

pub fn remove_secondary_keys_old(
    &self,
    keys_to_remove: Vec<Signatory<AccountId>>
) -> Result<WrappedCall<'api>>

Deprecated. Use remove_secondary_keys instead.

pub fn accept_primary_key(
    &self,
    rotation_auth_id: u64,
    optional_cdd_auth_id: Option<u64>
) -> Result<WrappedCall<'api>>

Call this with the new primary key. By invoking this method, caller accepts authorization to become the new primary key of the issuing identity. If a CDD service provider approved this change (or this is not required), primary key of the DID is updated.

The caller (new primary key) must be either a secondary key of the issuing identity, or unlinked to any identity.

Differs from rotate_primary_key_to_secondary in that it will unlink the old primary key instead of leaving it as a secondary key.

Arguments

• owner_auth_id Authorization from the owner who initiated the change
• cdd_auth_id Authorization from a CDD service provider

pub fn change_cdd_requirement_for_mk_rotation(
    &self,
    auth_required: bool
) -> Result<WrappedCall<'api>>

Set if CDD authorization is required for updating primary key of an identity. Callable via root (governance)

Arguments

• auth_required CDD Authorization required or not

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

Join an identity as a secondary key.

pub fn leave_identity_as_key(&self) -> Result<WrappedCall<'api>>

Leave the secondary key’s identity.

pub fn add_claim(
    &self,
    target: IdentityId,
    claim: Claim,
    expiry: Option<u64>
) -> Result<WrappedCall<'api>>

Adds a new claim record or edits an existing one.

Only called by did_issuer’s secondary key.

pub fn revoke_claim(
    &self,
    target: IdentityId,
    claim: Claim
) -> Result<WrappedCall<'api>>

Marks the specified claim as revoked.

pub fn set_permission_to_signer(
    &self,
    key: Signatory<AccountId>,
    perms: Permissions
) -> Result<WrappedCall<'api>>

Deprecated. Use set_secondary_key_permissions instead.

pub fn placeholder_legacy_set_permission_to_signer(
    &self
) -> Result<WrappedCall<'api>>

Placeholder for removed legacy_set_permission_to_signer.

pub fn freeze_secondary_keys(&self) -> Result<WrappedCall<'api>>

It disables all secondary keys at did identity.

Errors

pub fn unfreeze_secondary_keys(&self) -> Result<WrappedCall<'api>>

Re-enables all secondary keys of the caller’s identity.

pub fn add_authorization(
    &self,
    target: Signatory<AccountId>,
    data: AuthorizationData<AccountId>,
    expiry: Option<u64>
) -> Result<WrappedCall<'api>>

Adds an authorization.

pub fn remove_authorization(
    &self,
    target: Signatory<AccountId>,
    auth_id: u64,
    _auth_issuer_pays: bool
) -> Result<WrappedCall<'api>>

Removes an authorization. _auth_issuer_pays determines whether the issuer of the authorisation pays the transaction fee

pub fn add_secondary_keys_with_authorization_old(
    &self,
    additional_keys: Vec<SecondaryKeyWithAuthV1<AccountId>>,
    expires_at: u64
) -> Result<WrappedCall<'api>>

Deprecated. Use add_secondary_keys_with_authorization instead.

pub fn add_investor_uniqueness_claim(
    &self,
    target: IdentityId,
    claim: Claim,
    proof: [u8; 64],
    expiry: Option<u64>
) -> Result<WrappedCall<'api>>

Add Claim::InvestorUniqueness claim for a given target identity.

Weight of the this extrinsic is depend on the computation that used to validate the proof of claim, which will be a constant independent of user inputs.

Arguments

• origin - Who provides the claim to the user? In this case, it’s the user’s account id as the user provides.
• target - IdentityId to which the claim gets assigned.
• claim - InvestorUniqueness claim details.
• proof - To validate the self attestation.
• expiry - Expiry of claim.

Errors

• DidMustAlreadyExist Target should already been a part of the ecosystem.
• ClaimVariantNotAllowed When origin trying to pass claim variant other than InvestorUniqueness.
• ConfidentialScopeClaimNotAllowed When issuer is different from target or CDD_ID is invalid for given user.
• `InvalidScopeClaim When proof is invalid.
• InvalidCDDId when you are not the owner of that CDD_ID.

pub fn gc_add_cdd_claim(&self, target: IdentityId) -> Result<WrappedCall<'api>>

Assuming this is executed by the GC voting majority, adds a new cdd claim record.

pub fn gc_revoke_cdd_claim(
    &self,
    target: IdentityId
) -> Result<WrappedCall<'api>>

Assuming this is executed by the GC voting majority, removes an existing cdd claim record.

pub fn add_investor_uniqueness_claim_v2(
    &self,
    target: IdentityId,
    scope: Scope,
    claim: Claim,
    proof: ScopeClaimProof,
    expiry: Option<u64>
) -> Result<WrappedCall<'api>>

pub fn revoke_claim_by_index(
    &self,
    target: IdentityId,
    claim_type: ClaimType,
    scope: Option<Scope>
) -> Result<WrappedCall<'api>>

Revokes a specific claim using its Claim Unique Index composed by target, claim_type, and scope.

Please note that origin must be the issuer of the target claim.

Errors

• TargetHasNonZeroBalanceAtScopeId when you try to revoke a InvestorUniqueness* claim, and target identity still have any balance on the given scope.

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

Call this with the new primary key. By invoking this method, caller accepts authorization to become the new primary key of the issuing identity. If a CDD service provider approved this change, (or this is not required), primary key of the DID is updated.

The caller (new primary key) must be either a secondary key of the issuing identity, or unlinked to any identity.

Differs from accept_primary_key in that it will leave the old primary key as a secondary key with the permissions specified in the corresponding RotatePrimaryKeyToSecondary authorization instead of unlinking the old primary key.

Arguments

• owner_auth_id Authorization from the owner who initiated the change
• cdd_auth_id Authorization from a CDD service provider

pub fn add_secondary_keys_with_authorization(
    &self,
    additional_keys: Vec<SecondaryKeyWithAuth<AccountId>>,
    expires_at: u64
) -> Result<WrappedCall<'api>>

Adds secondary keys to target identity id.

Keys are directly added to identity because each of them has an authorization.

Arguments:

- `origin` which must be the primary key of the identity `id`.
- `id` to which new secondary keys will be added.
- `additional_keys` which includes secondary keys,
   coupled with authorization data, to add to target identity.

Errors

- Can only called by primary key owner.
- Keys should be able to linked to any identity.

pub fn set_secondary_key_permissions(
    &self,
    key: AccountId,
    perms: Permissions
) -> Result<WrappedCall<'api>>

Sets permissions for an specific target_key key.

Only the primary key of an identity is able to set secondary key permissions.

pub fn remove_secondary_keys(
    &self,
    keys_to_remove: Vec<AccountId>
) -> Result<WrappedCall<'api>>

Removes specified secondary keys of a DID if present.

Errors

The extrinsic can only called by primary key owner.

pub fn register_custom_claim_type(
    &self,
    ty: Vec<u8>
) -> Result<WrappedCall<'api>>

Register custom claim type.

Errors

• CustomClaimTypeAlreadyExists The type that is being registered already exists.
• CounterOverflow CustomClaimTypeId has overflowed.
• TooLong The type being registered is too lang.

Trait Implementations

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

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

Returns a copy of the value.

const 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.