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
  • Methods
  • Methods
  • claimClassicTicker
  • createAsset
  • getAsset
  • getAssets
  • getTickerReservation
  • getTickerReservations
  • reserveTicker

Was this helpful?

  1. Classes

Assets

PreviousAssetPermissionsNextAuthorizationRequest

Last updated 2 years ago

Was this helpful?

Handles all Asset related functionality

Hierarchy

  • Assets

Index

Methods

Methods

claimClassicTicker

Claim a ticker symbol that was reserved in Polymath Classic (Ethereum). The Ethereum Account that owns the ticker must sign a special message that contains the DID of the Identity that will own the ticker in Polymesh, and provide the signed data to this call

Parameters:

Name
Type

args

opts?


createAsset

Create an Asset

note if ticker is already reserved, then required role:

  • Ticker Owner

Parameters:

Name
Type

args

opts?


getAsset

Retrieve an Asset

Parameters:

▪ args: object

Name
Type
Description

ticker

string

Asset ticker


getAssets

Retrieve all of the Assets owned by an Identity

note Assets with unreadable characters in their tickers will be left out

Parameters:

Name
Type

args?

undefined | object


getTickerReservation

Retrieve a Ticker Reservation

Parameters:

▪ args: object

Name
Type
Description

ticker

string

Asset ticker


getTickerReservations

Retrieve all the ticker reservations currently owned by an Identity. This doesn't include Assets that have already been launched

note reservations with unreadable characters in their tickers will be left out

Parameters:

Name
Type

args?

undefined | object


reserveTicker

Reserve a ticker symbol under the ownership of the signing Identity to later use in the creation of an Asset. The ticker will expire after a set amount of time, after which other users can reserve it

Parameters:

Name
Type

args

opts?

▸ claimClassicTicker(args: , opts?: ): Promise‹‹››

Defined in

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

Returns: Promise‹‹››

▸ createAsset(args: , opts?: ): Promise‹‹››

Defined in

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

Returns: Promise‹‹››

▸ getAsset(args: object): Promise‹›

Defined in

Returns: Promise‹›

▸ getAssets(args?: undefined | object): Promise‹[]›

Defined in

Returns: Promise‹[]›

▸ getTickerReservation(args: object):

Defined in

Returns:

▸ getTickerReservations(args?: undefined | object): Promise‹[]›

Defined in

Returns: Promise‹[]›

▸ reserveTicker(args: , opts?: ): Promise‹‹››

Defined in

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

Returns: Promise‹‹››

ClaimClassicTickerParams
ProcedureOpts
TransactionQueue
TickerReservation
src/Assets.ts:73
ProcedureMethod
claimClassicTicker.checkAuthorization
TransactionQueue
TickerReservation
CreateAssetWithTickerParams
ProcedureOpts
TransactionQueue
Asset
src/Assets.ts:86
ProcedureMethod
createAsset.checkAuthorization
TransactionQueue
Asset
Asset
src/Assets.ts:178
Asset
Asset
src/Assets.ts:146
Asset
TickerReservation
src/Assets.ts:132
TickerReservation
TickerReservation
src/Assets.ts:98
TickerReservation
ReserveTickerParams
ProcedureOpts
TransactionQueue
TickerReservation
src/Assets.ts:61
ProcedureMethod
reserveTicker.checkAuthorization
TransactionQueue
TickerReservation
claimClassicTicker
createAsset
getAsset
getAssets
getTickerReservation
getTickerReservations
reserveTicker
ClaimClassicTickerParams
ProcedureOpts
CreateAssetWithTickerParams
ProcedureOpts
ReserveTickerParams
ProcedureOpts