api.client.Assets.Assets - PolymeshAssociation/polymesh-sdk GitHub Wiki
api/client/Assets.Assets
Handles all Asset related functionality
- createAsset
- createNftCollection
- get
- getAsset
- getAssets
- getFungibleAsset
- getGlobalMetadataKeys
- getNftCollection
- getTickerReservation
- getTickerReservations
- isTickerAvailable
- reserveTicker
▸ createAsset(args
, opts?
): Promise
<GenericPolymeshTransaction
<FungibleAsset
, FungibleAsset
>>
Create an Asset
Name | Type |
---|---|
args |
CreateAssetWithTickerParams |
opts? |
ProcedureOpts |
Promise
<GenericPolymeshTransaction
<FungibleAsset
, FungibleAsset
>>
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
▸ createNftCollection(args
, opts?
): Promise
<GenericPolymeshTransaction
<NftCollection
, NftCollection
>>
Create an NftCollection
Name | Type |
---|---|
args |
CreateNftCollectionParams |
opts? |
ProcedureOpts |
Promise
<GenericPolymeshTransaction
<NftCollection
, NftCollection
>>
Note
if ticker is already reserved, then required role:
- Ticker Owner
Note
this method is of type ProcedureMethod, which means you can call createNftCollection.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it
▸ get(paginationOpts?
): Promise
<ResultSet
<Asset
>>
Retrieve all the Assets on chain
Name | Type |
---|---|
paginationOpts? |
PaginationOptions |
Note
supports pagination
▸ getAsset(args
): Promise
<Asset
>
Retrieve a FungibleAsset or NftCollection
Name | Type |
---|---|
args |
Object |
args.ticker |
string |
Promise
<Asset
>
Note
getFungibleAsset
and getNftCollection
are similar to this method, but return a more specific type
▸ getAssets(args?
): Promise
<Asset
[]>
Retrieve all of the Assets owned by an Identity
Name | Type | Description |
---|---|---|
args? |
Object |
- |
args.owner |
string | Identity
|
Identity representation or Identity ID as stored in the blockchain |
Promise
<Asset
[]>
Note
Assets with unreadable characters in their tickers will be left out
▸ getFungibleAsset(args
): Promise
<FungibleAsset
>
Retrieve a FungibleAsset
Name | Type | Description |
---|---|---|
args |
Object |
- |
args.ticker |
string |
Asset ticker |
Promise
<FungibleAsset
>
▸ getGlobalMetadataKeys(): Promise
<GlobalMetadataKey
[]>
Retrieve all the Asset Global Metadata on chain. This includes metadata id, name and specs
Promise
<GlobalMetadataKey
[]>
▸ getNftCollection(args
): Promise
<NftCollection
>
Retrieve an NftCollection
Name | Type | Description |
---|---|---|
args |
Object |
- |
args.ticker |
string |
NftCollection ticker |
Promise
<NftCollection
>
▸ getTickerReservation(args
): TickerReservation
Retrieve a Ticker Reservation
Name | Type | Description |
---|---|---|
args |
Object |
- |
args.ticker |
string |
Asset ticker |
▸ getTickerReservations(args?
): Promise
<TickerReservation
[]>
Retrieve all the ticker reservations currently owned by an Identity. This doesn't include Assets that have already been launched
Name | Type | Description |
---|---|---|
args? |
Object |
- |
args.owner |
string | Identity
|
defaults to the signing Identity |
Promise
<TickerReservation
[]>
Note
reservations with unreadable characters in their tickers will be left out
▸ isTickerAvailable(args
): Promise
<boolean
>
Check if a ticker hasn't been reserved
Name | Type |
---|---|
args |
Object |
args.ticker |
string |
Promise
<boolean
>
Note
can be subscribed to, if connected to node using a web socket
▸ isTickerAvailable(args
, callback
): Promise
<UnsubCallback
>
Name | Type |
---|---|
args |
Object |
args.ticker |
string |
callback |
SubCallback <boolean > |
Promise
<UnsubCallback
>
▸ reserveTicker(args
, opts?
): Promise
<GenericPolymeshTransaction
<TickerReservation
, TickerReservation
>>
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
Name | Type |
---|---|
args |
ReserveTickerParams |
opts? |
ProcedureOpts |
Promise
<GenericPolymeshTransaction
<TickerReservation
, TickerReservation
>>
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