# Assets

Handles all Asset related functionality

## Hierarchy

* **Assets**

## Index

### Methods

* [claimClassicTicker](#claimclassicticker)
* [createAsset](#createasset)
* [getAsset](#getasset)
* [getAssets](#getassets)
* [getTickerReservation](#gettickerreservation)
* [getTickerReservations](#gettickerreservations)
* [isTickerAvailable](#istickeravailable)
* [reserveTicker](#reserveticker)

## Methods

### claimClassicTicker

▸ **claimClassicTicker**(`args`: [ClaimClassicTickerParams](https://github.com/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/claimclassictickerparams.md), `opts?`: [ProcedureOpts](https://github.com/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/procedureopts.md)): *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/classes/transactionqueue)*‹*[*TickerReservation*](https://developers.polymath.network/polymesh-sdk-api-reference/classes/tickerreservation)*››*

*Defined in* [*src/Assets.ts:79*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/46845947/src/Assets.ts#L79)

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](https://github.com/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/proceduremethod.md), which means you can call [claimClassicTicker.checkAuthorization](https://github.com/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/proceduremethod.md#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](https://github.com/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/claimclassictickerparams.md) |
| `opts?` | [ProcedureOpts](https://github.com/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/procedureopts.md)                       |

**Returns:** *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/classes/transactionqueue)*‹*[*TickerReservation*](https://developers.polymath.network/polymesh-sdk-api-reference/classes/tickerreservation)*››*

***

### createAsset

▸ **createAsset**(`args`: [CreateAssetWithTickerParams](https://github.com/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/createassetwithtickerparams.md), `opts?`: [ProcedureOpts](https://github.com/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/procedureopts.md)): *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/classes/transactionqueue)*‹*[*Asset*](https://developers.polymath.network/polymesh-sdk-api-reference/classes/asset)*››*

*Defined in* [*src/Assets.ts:92*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/46845947/src/Assets.ts#L92)

Create an Asset

**`note`** if ticker is already reserved, then required role:

* Ticker Owner

**`note`** this method is of type [ProcedureMethod](https://github.com/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/proceduremethod.md), which means you can call [createAsset.checkAuthorization](https://github.com/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/proceduremethod.md#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](https://github.com/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/createassetwithtickerparams.md) |
| `opts?` | [ProcedureOpts](https://github.com/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/procedureopts.md)                             |

**Returns:** *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/classes/transactionqueue)*‹*[*Asset*](https://developers.polymath.network/polymesh-sdk-api-reference/classes/asset)*››*

***

### getAsset

▸ **getAsset**(`args`: object): *Promise‹*[*Asset*](https://developers.polymath.network/polymesh-sdk-api-reference/classes/asset)*›*

*Defined in* [*src/Assets.ts:236*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/46845947/src/Assets.ts#L236)

Retrieve an Asset

**Parameters:**

▪ **args**: *object*

| Name     | Type   | Description  |
| -------- | ------ | ------------ |
| `ticker` | string | Asset ticker |

**Returns:** *Promise‹*[*Asset*](https://developers.polymath.network/polymesh-sdk-api-reference/classes/asset)*›*

***

### getAssets

▸ **getAssets**(`args?`: undefined | object): *Promise‹*[*Asset*](https://developers.polymath.network/polymesh-sdk-api-reference/classes/asset)*\[]›*

*Defined in* [*src/Assets.ts:204*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/46845947/src/Assets.ts#L204)

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*](https://developers.polymath.network/polymesh-sdk-api-reference/classes/asset)*\[]›*

***

### getTickerReservation

▸ **getTickerReservation**(`args`: object): *Promise‹*[*TickerReservation*](https://developers.polymath.network/polymesh-sdk-api-reference/classes/tickerreservation)*›*

*Defined in* [*src/Assets.ts:167*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/46845947/src/Assets.ts#L167)

Retrieve a Ticker Reservation

**Parameters:**

▪ **args**: *object*

| Name     | Type   | Description  |
| -------- | ------ | ------------ |
| `ticker` | string | Asset ticker |

**Returns:** *Promise‹*[*TickerReservation*](https://developers.polymath.network/polymesh-sdk-api-reference/classes/tickerreservation)*›*

***

### getTickerReservations

▸ **getTickerReservations**(`args?`: undefined | object): *Promise‹*[*TickerReservation*](https://developers.polymath.network/polymesh-sdk-api-reference/classes/tickerreservation)*\[]›*

*Defined in* [*src/Assets.ts:133*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/46845947/src/Assets.ts#L133)

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*](https://developers.polymath.network/polymesh-sdk-api-reference/classes/tickerreservation)*\[]›*

***

### isTickerAvailable

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

*Defined in* [*src/Assets.ts:101*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/46845947/src/Assets.ts#L101)

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](https://developers.polymath.network/polymesh-sdk-api-reference/globals#subcallback)‹boolean›): *Promise‹*[*UnsubCallback*](https://developers.polymath.network/polymesh-sdk-api-reference/globals#unsubcallback)*›*

*Defined in* [*src/Assets.ts:102*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/46845947/src/Assets.ts#L102)

**Parameters:**

▪ **args**: *object*

| Name     | Type   |
| -------- | ------ |
| `ticker` | string |

▪ **callback**: [*SubCallback*](https://developers.polymath.network/polymesh-sdk-api-reference/globals#subcallback)*‹boolean›*

**Returns:** *Promise‹*[*UnsubCallback*](https://developers.polymath.network/polymesh-sdk-api-reference/globals#unsubcallback)*›*

***

### reserveTicker

▸ **reserveTicker**(`args`: [ReserveTickerParams](https://github.com/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/reservetickerparams.md), `opts?`: [ProcedureOpts](https://github.com/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/procedureopts.md)): *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/classes/transactionqueue)*‹*[*TickerReservation*](https://developers.polymath.network/polymesh-sdk-api-reference/classes/tickerreservation)*››*

*Defined in* [*src/Assets.ts:67*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/46845947/src/Assets.ts#L67)

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](https://github.com/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/proceduremethod.md), which means you can call [reserveTicker.checkAuthorization](https://github.com/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/proceduremethod.md#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](https://github.com/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/reservetickerparams.md) |
| `opts?` | [ProcedureOpts](https://github.com/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/procedureopts.md)             |

**Returns:** *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/classes/transactionqueue)*‹*[*TickerReservation*](https://developers.polymath.network/polymesh-sdk-api-reference/classes/tickerreservation)*››*