Assets

Handles all Asset related functionality

Hierarchy

• Assets

Index

Methods

• claimClassicTicker

• createAsset

• getAsset

• getAssets

• getTickerReservation

• getTickerReservations

• isTickerAvailable

• reserveTicker

Methods

claimClassicTicker

▸ claimClassicTicker(args: ClaimClassicTickerParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹TickerReservation››

Defined in src/Assets.ts:79

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

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

Parameters:

Name	Type
args	ClaimClassicTickerParams
opts?	ProcedureOpts

Returns: Promise‹TransactionQueue‹TickerReservation››

---

createAsset

▸ createAsset(args: CreateAssetWithTickerParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹Asset››

Defined in src/Assets.ts:92

Create an Asset

note if ticker is already reserved, then required role:

• Ticker Owner

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

Parameters:

Name	Type
args	CreateAssetWithTickerParams
opts?	ProcedureOpts

Returns: Promise‹TransactionQueue‹Asset››

---

getAsset

▸ getAsset(args: object): Promise‹Asset›

Defined in src/Assets.ts:236

Retrieve an Asset

Parameters:

▪ args: object

Name	Type	Description
ticker	string	Asset ticker

Returns: Promise‹Asset›

---

getAssets

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

Defined in src/Assets.ts:204

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

Returns: Promise‹Asset[]›

---

getTickerReservation

▸ getTickerReservation(args: object): Promise‹TickerReservation›

Defined in src/Assets.ts:167

Retrieve a Ticker Reservation

Parameters:

▪ args: object

Name	Type	Description
ticker	string	Asset ticker

Returns: Promise‹TickerReservation›

---

getTickerReservations

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

Defined in src/Assets.ts:133

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

Returns: Promise‹TickerReservation[]›

---

isTickerAvailable

▸ isTickerAvailable(args: object): Promise‹boolean›

Defined in src/Assets.ts:101

Check if a ticker hasn't been reserved

note can be subscribed to

Parameters:

▪ args: object

Name	Type
ticker	string

Returns: Promise‹boolean›

▸ isTickerAvailable(args: object, callback: SubCallback‹boolean›): Promise‹UnsubCallback›

Defined in src/Assets.ts:102

Parameters:

▪ args: object

Name	Type
ticker	string

▪ callback: SubCallback‹boolean›

Returns: Promise‹UnsubCallback›

---

reserveTicker

▸ reserveTicker(args: ReserveTickerParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹TickerReservation››

Defined in src/Assets.ts:67

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

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

Parameters:

Name	Type
args	ReserveTickerParams
opts?	ProcedureOpts

Returns: Promise‹TransactionQueue‹TickerReservation››