Polymesh SDK API Reference
beta
beta
  • Globals
  • Classes
    • Account
    • AccountManagement
    • Asset
    • AssetHolders
    • AssetPermissions
    • Assets
    • AuthorizationRequest
    • Authorizations
    • Checkpoint
    • CheckpointSchedule
    • Checkpoints
    • Claims
    • Compliance
    • CorporateAction
    • CorporateActionBase
    • CorporateActions
    • Count
    • CustomPermissionGroup
    • DefaultPortfolio
    • DefaultTrustedClaimIssuer
    • Distributions
    • DividendDistribution
    • Documents
    • Entity
    • Identities
    • Identity
    • IdentityAuthorizations
    • Instruction
    • Issuance
    • KnownPermissionGroup
    • Network
    • NumberedPortfolio
    • Offering
    • Offerings
    • Percentage
    • PermissionGroup
    • Permissions
    • Polymesh
    • PolymeshError
    • PolymeshTransaction
    • PolymeshTransactionBase
    • PolymeshTransactionBatch
    • Portfolio
    • Portfolios
    • Requirements
    • Schedules
    • Settlements
    • Subsidy
    • TickerReservation
    • TransactionQueue
    • TransferRestrictionBase
    • TransferRestrictions
    • TrustedClaimIssuers
    • Venue
  • Enums
  • Interfaces
Powered by GitBook
On this page
  • Hierarchy
  • Index
  • Properties
  • Methods
  • Properties
  • assetHolders
  • checkpoints
  • compliance
  • Protected context
  • corporateActions
  • did
  • documents
  • issuance
  • offerings
  • permissions
  • settlements
  • ticker
  • transferRestrictions
  • uuid
  • Methods
  • controllerTransfer
  • createdAt
  • createdAtV2
  • currentFundingRound
  • details
  • exists
  • freeze
  • getIdentifiers
  • getOperationHistory
  • getOperationHistoryV2
  • investorCount
  • isEqual
  • isFrozen
  • modify
  • modifyPrimaryIssuanceAgent
  • redeem
  • removePrimaryIssuanceAgent
  • toHuman
  • transferOwnership
  • unfreeze
  • Static generateUuid
  • Static unserialize

Was this helpful?

  1. Classes

Asset

Class used to manage all Asset functionality

Hierarchy

  • Entity‹UniqueIdentifiers, string›

    ↳ Asset

Index

Properties

  • assetHolders

  • checkpoints

  • compliance

  • context

  • corporateActions

  • did

  • documents

  • issuance

  • offerings

  • permissions

  • settlements

  • ticker

  • transferRestrictions

  • uuid

Methods

  • controllerTransfer

  • createdAt

  • createdAtV2

  • currentFundingRound

  • details

  • exists

  • freeze

  • getIdentifiers

  • getOperationHistory

  • getOperationHistoryV2

  • investorCount

  • isEqual

  • isFrozen

  • modify

  • modifyPrimaryIssuanceAgent

  • redeem

  • removePrimaryIssuanceAgent

  • toHuman

  • transferOwnership

  • unfreeze

  • generateUuid

  • unserialize

Properties

assetHolders

• assetHolders: AssetHolders

Defined in src/api/entities/Asset/index.ts:117


checkpoints

• checkpoints: Checkpoints

Defined in src/api/entities/Asset/index.ts:122


compliance

• compliance: Compliance

Defined in src/api/entities/Asset/index.ts:119


Protected context

• context: Context

Inherited from CheckpointSchedule.context

Defined in src/api/entities/Entity.ts:48


corporateActions

• corporateActions: CorporateActions

Defined in src/api/entities/Asset/index.ts:123


did

• did: string

Defined in src/api/entities/Asset/index.ts:107

Identity ID of the Asset (used for Claims)


documents

• documents: Documents

Defined in src/api/entities/Asset/index.ts:115


issuance

• issuance: Issuance

Defined in src/api/entities/Asset/index.ts:118


offerings

• offerings: Offerings

Defined in src/api/entities/Asset/index.ts:121


permissions

• permissions: Permissions

Defined in src/api/entities/Asset/index.ts:124


settlements

• settlements: Settlements

Defined in src/api/entities/Asset/index.ts:116


ticker

• ticker: string

Defined in src/api/entities/Asset/index.ts:112

ticker of the Asset


transferRestrictions

• transferRestrictions: TransferRestrictions

Defined in src/api/entities/Asset/index.ts:120


uuid

• uuid: string

Inherited from CheckpointSchedule.uuid

Defined in src/api/entities/Entity.ts:46

Methods

controllerTransfer

▸ controllerTransfer(args: ControllerTransferParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››

Defined in src/api/entities/Asset/index.ts:597

Force a transfer from a given Portfolio to the caller’s default Portfolio

note this method is of type ProcedureMethod, which means you can call controllerTransfer.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Parameters:

Name
Type

args

opts?

Returns: Promise‹TransactionQueue‹void››


createdAt

▸ createdAt(): Promise‹EventIdentifier | null›

Defined in src/api/entities/Asset/index.ts:395

Retrieve the identifier data (block number, date and event index) of the event that was emitted when the token was created

note uses the middleware

note there is a possibility that the data is not ready by the time it is requested. In that case, null is returned

Returns: Promise‹EventIdentifier | null›


createdAtV2

▸ createdAtV2(): Promise‹EventIdentifier | null›

Defined in src/api/entities/Asset/index.ts:417

Retrieve the identifier data (block number, date and event index) of the event that was emitted when the token was created

note uses the middlewareV2

note there is a possibility that the data is not ready by the time it is requested. In that case, null is returned

Returns: Promise‹EventIdentifier | null›


currentFundingRound

▸ currentFundingRound(): Promise‹string | null›

Defined in src/api/entities/Asset/index.ts:320

Retrieve the Asset's funding round

note can be subscribed to

Returns: Promise‹string | null›

▸ currentFundingRound(callback: SubCallback‹string | null›): Promise‹UnsubCallback›

Defined in src/api/entities/Asset/index.ts:321

Parameters:

Name
Type

callback

Returns: Promise‹UnsubCallback›


details

▸ details(): Promise‹AssetDetails›

Defined in src/api/entities/Asset/index.ts:219

Retrieve the Asset's data

note can be subscribed to

Returns: Promise‹AssetDetails›

▸ details(callback: SubCallback‹AssetDetails›): Promise‹UnsubCallback›

Defined in src/api/entities/Asset/index.ts:220

Parameters:

Name
Type

callback

Returns: Promise‹UnsubCallback›


exists

▸ exists(): Promise‹boolean›

Overrides Entity.exists

Defined in src/api/entities/Asset/index.ts:720

Determine whether this Asset exists on chain

Returns: Promise‹boolean›


freeze

▸ freeze(opts?: ProcedureOpts): Promise‹TransactionQueue‹Asset››

Defined in src/api/entities/Asset/index.ts:444

Freeze transfers of the Asset

note this method is of type NoArgsProcedureMethod, which means you can call freeze.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Parameters:

Name
Type

opts?

Returns: Promise‹TransactionQueue‹Asset››


getIdentifiers

▸ getIdentifiers(): Promise‹SecurityIdentifier[]›

Defined in src/api/entities/Asset/index.ts:358

Retrieve the Asset's identifiers list

note can be subscribed to

Returns: Promise‹SecurityIdentifier[]›

▸ getIdentifiers(callback?: SubCallback‹SecurityIdentifier[]›): Promise‹UnsubCallback›

Defined in src/api/entities/Asset/index.ts:359

Parameters:

Name
Type

callback?

Returns: Promise‹UnsubCallback›


getOperationHistory

▸ getOperationHistory(): Promise‹HistoricAgentOperation[]›

Defined in src/api/entities/Asset/index.ts:608

Retrieve this Asset's Operation History

note Operations are grouped by the agent Identity who performed them

note uses the middleware

Returns: Promise‹HistoricAgentOperation[]›


getOperationHistoryV2

▸ getOperationHistoryV2(): Promise‹HistoricAgentOperation[]›

Defined in src/api/entities/Asset/index.ts:693

Retrieve this Asset's Operation History

note Operations are grouped by the agent Identity who performed them

note uses the middlewareV2

Returns: Promise‹HistoricAgentOperation[]›


investorCount

▸ investorCount(): Promise‹BigNumber›

Defined in src/api/entities/Asset/index.ts:541

Retrieve the amount of unique investors that hold this Asset

note this takes into account the Scope ID of Investor Uniqueness Claims. If an investor holds balances of this Asset in two or more different Identities, but they all have Investor Uniqueness Claims with the same Scope ID, then they will only be counted once for the purposes of this result

Returns: Promise‹BigNumber›


isEqual

▸ isEqual(entity: Entity‹unknown, unknown›): boolean

Inherited from CheckpointSchedule.isEqual

Defined in src/api/entities/Entity.ts:61

Determine whether this Entity is the same as another one

Parameters:

Name
Type

entity

Returns: boolean


isFrozen

▸ isFrozen(): Promise‹boolean›

Defined in src/api/entities/Asset/index.ts:463

Check whether transfers are frozen for the Asset

note can be subscribed to

Returns: Promise‹boolean›

▸ isFrozen(callback: SubCallback‹boolean›): Promise‹UnsubCallback›

Defined in src/api/entities/Asset/index.ts:464

Parameters:

Name
Type

callback

Returns: Promise‹UnsubCallback›


modify

▸ modify(args: ModifyAssetParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹Asset››

Defined in src/api/entities/Asset/index.ts:210

Modify some properties of the Asset

throws if the passed values result in no changes being made to the Asset

note this method is of type ProcedureMethod, which means you can call modify.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Parameters:

Name
Type

args

opts?

Returns: Promise‹TransactionQueue‹Asset››


modifyPrimaryIssuanceAgent

▸ modifyPrimaryIssuanceAgent(args: ModifyPrimaryIssuanceAgentParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››

Defined in src/api/entities/Asset/index.ts:504

Assign a new primary issuance agent for the Asset

note this will create an Authorization Request which has to be accepted by the target Identity. An Account or Identity can fetch its pending Authorization Requests by calling authorizations.getReceived. Also, an Account or Identity can directly fetch the details of an Authorization Request by calling authorizations.getOne

deprecated in favor of inviteAgent

note this method is of type ProcedureMethod, which means you can call modifyPrimaryIssuanceAgent.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Parameters:

Name
Type

args

opts?

Returns: Promise‹TransactionQueue‹void››


redeem

▸ redeem(args: RedeemTokensParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››

Defined in src/api/entities/Asset/index.ts:530

Redeem (burn) an amount of this Asset's tokens

note tokens are removed from the caller's Default Portfolio

note this method is of type ProcedureMethod, which means you can call redeem.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Parameters:

Name
Type

args

opts?

Returns: Promise‹TransactionQueue‹void››


removePrimaryIssuanceAgent

▸ removePrimaryIssuanceAgent(opts?: ProcedureOpts): Promise‹TransactionQueue‹void››

Defined in src/api/entities/Asset/index.ts:518

Remove the primary issuance agent of the Asset

note if primary issuance agent is not set, Asset owner would be used by default

deprecated

note this method is of type NoArgsProcedureMethod, which means you can call removePrimaryIssuanceAgent.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Parameters:

Name
Type

opts?

Returns: Promise‹TransactionQueue‹void››


toHuman

▸ toHuman(): string

Overrides Entity.toHuman

Defined in src/api/entities/Asset/index.ts:733

Return the Asset's ticker

Returns: string


transferOwnership

▸ transferOwnership(args: TransferAssetOwnershipParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹AuthorizationRequest››

Defined in src/api/entities/Asset/index.ts:199

Transfer ownership of the Asset to another Identity. This generates an authorization request that must be accepted by the recipient

note this will create Authorization Request which has to be accepted by the target Identity. An Account or Identity can fetch its pending Authorization Requests by calling authorizations.getReceived. Also, an Account or Identity can directly fetch the details of an Authorization Request by calling authorizations.getOne

note this method is of type ProcedureMethod, which means you can call transferOwnership.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Parameters:

Name
Type

args

opts?

Returns: Promise‹TransactionQueue‹AuthorizationRequest››


unfreeze

▸ unfreeze(opts?: ProcedureOpts): Promise‹TransactionQueue‹Asset››

Defined in src/api/entities/Asset/index.ts:454

Unfreeze transfers of the Asset

note this method is of type NoArgsProcedureMethod, which means you can call unfreeze.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Parameters:

Name
Type

opts?

Returns: Promise‹TransactionQueue‹Asset››


Static generateUuid

▸ generateUuid‹Identifiers›(identifiers: Identifiers): string

Inherited from CheckpointSchedule.generateUuid

Defined in src/api/entities/Entity.ts:14

Generate the Entity's UUID from its identifying properties

Type parameters:

▪ Identifiers

Parameters:

Name
Type
Description

identifiers

Identifiers

Returns: string


Static unserialize

▸ unserialize‹Identifiers›(serialized: string): Identifiers

Inherited from CheckpointSchedule.unserialize

Defined in src/api/entities/Entity.ts:23

Unserialize a UUID into its Unique Identifiers

Type parameters:

▪ Identifiers

Parameters:

Name
Type
Description

serialized

string

UUID to unserialize

Returns: Identifiers

PreviousAccountManagementNextAssetHolders

Last updated 2 years ago

Was this helpful?

‹string | null›

‹›

‹[]›

‹unknown, unknown›

‹boolean›

ControllerTransferParams
ProcedureOpts
SubCallback
SubCallback
AssetDetails
ProcedureOpts
SubCallback
SecurityIdentifier
Entity
SubCallback
ModifyAssetParams
ProcedureOpts
ModifyPrimaryIssuanceAgentParams
ProcedureOpts
RedeemTokensParams
ProcedureOpts
ProcedureOpts
TransferAssetOwnershipParams
ProcedureOpts
ProcedureOpts