api_client_Assets.Assets
Last updated
Was this helpful?
Last updated
Was this helpful?
/ / / Assets
.Assets
Handles all Asset related functionality
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
args
opts?
Returns
Defined in
Create an Asset
note
if ticker is already reserved, then required role:
Ticker Owner
Parameters
args
opts?
Returns
Defined in
Retrieve an Asset
Parameters
args
Object
-
args.ticker
string
Asset ticker
Returns
Defined in
Retrieve all of the Assets owned by an Identity
note
Assets with unreadable characters in their tickers will be left out
Parameters
args?
Object
-
args.owner
Identity representation or Identity ID as stored in the blockchain
Returns
Defined in
Retrieve a Ticker Reservation
Parameters
args
Object
-
args.ticker
string
Asset ticker
Returns
Defined in
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
args?
Object
-
args.owner
defaults to the signing Identity
Returns
Defined in
â–¸ isTickerAvailable(args
): Promise
<boolean
>
Check if a ticker hasn't been reserved
note
can be subscribed to
Parameters
args
Object
args.ticker
string
Returns
Promise
<boolean
>
Defined in
Parameters
args
Object
args.ticker
string
callback
Returns
Defined in
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
args
opts?
Returns
Defined in
â–¸ claimClassicTicker(args
, opts?
): Promise
<TransactionQueue
<, , unknown
[][]>>
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
Promise
<TransactionQueue
<, , unknown
[][]>>
â–¸ createAsset(args
, opts?
): Promise
<TransactionQueue
<, , unknown
[][]>>
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
Promise
<TransactionQueue
<, , unknown
[][]>>
â–¸ getAsset(args
): Promise
<>
Promise
<>
â–¸ getAssets(args?
): Promise
<[]>
string
|
Promise
<[]>
â–¸ getTickerReservation(args
):
â–¸ getTickerReservations(args?
): Promise
<[]>
string
|
Promise
<[]>
â–¸ isTickerAvailable(args
, callback
): Promise
<>
<boolean
>
Promise
<>
â–¸ reserveTicker(args
, opts?
): Promise
<TransactionQueue
<, , unknown
[][]>>
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
Promise
<TransactionQueue
<, , unknown
[][]>>