> For the complete documentation index, see [llms.txt](https://developers.polymath.network/polymesh-sdk-api-reference/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_tickerreservation.tickerreservation.md).

# api\_entities\_TickerReservation.TickerReservation

[@polymeshassociation/polymesh-sdk](/polymesh-sdk-api-reference/docs-alpha/classes.md) / [Modules](/polymesh-sdk-api-reference/docs-alpha/modules.md) / [api/entities/TickerReservation](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_tickerreservation.md) / TickerReservation

## Class: TickerReservation

[api/entities/TickerReservation](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_tickerreservation.md).TickerReservation

Represents a reserved Asset symbol in the Polymesh blockchain. Ticker reservations expire after a set length of time, after which they can be reserved by another Identity. A Ticker must be previously reserved by an Identity for that Identity to be able create an Asset with it

### Hierarchy

* [`Entity`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_entity.entity.md)<[`UniqueIdentifiers`](/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_tickerreservation.uniqueidentifiers.md), `string`>

  ↳ **`TickerReservation`**

### Table of contents

#### Properties

* [ticker](#ticker)
* [uuid](#uuid)

#### Methods

* [createAsset](#createasset)
* [details](#details)
* [exists](#exists)
* [extend](#extend)
* [isEqual](#isequal)
* [toHuman](#tohuman)
* [transferOwnership](#transferownership)
* [generateUuid](#generateuuid)
* [unserialize](#unserialize)

### Properties

#### ticker

• **ticker**: `string`

reserved ticker

**Defined in**

[api/entities/TickerReservation/index.ts:51](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/TickerReservation/index.ts#L51)

***

#### uuid

• **uuid**: `string`

**Inherited from**

[Entity](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_entity.entity.md).[uuid](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_entity.entity.md#uuid)

**Defined in**

[api/entities/Entity.ts:46](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/Entity.ts#L46)

### Methods

#### createAsset

▸ **createAsset**(`args`, `opts?`): `Promise`<`TransactionQueue`<[`Asset`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_asset.asset.md), [`Asset`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_asset.asset.md), `unknown`\[]\[]>>

Create an Asset using the reserved ticker

**`note`** required role:

* Ticker Owner

**`note`** this method is of type [ProcedureMethod](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.proceduremethod.md), which means you can call [createAsset.checkAuthorization](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.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`  | [`CreateAssetParams`](/polymesh-sdk-api-reference/docs-alpha/interfaces/api_procedures_createasset.createassetparams.md) |
| `opts?` | [`ProcedureOpts`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.procedureopts.md)                              |

**Returns**

`Promise`<`TransactionQueue`<[`Asset`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_asset.asset.md), [`Asset`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_asset.asset.md), `unknown`\[]\[]>>

**Defined in**

[api/entities/TickerReservation/index.ts:196](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/TickerReservation/index.ts#L196)

***

#### details

▸ **details**(): `Promise`<[`TickerReservationDetails`](/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_tickerreservation_types.tickerreservationdetails.md)>

Retrieve the Reservation's owner, expiry date and status

**`note`** can be subscribed to

**Returns**

`Promise`<[`TickerReservationDetails`](/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_tickerreservation_types.tickerreservationdetails.md)>

**Defined in**

[api/entities/TickerReservation/index.ts:91](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/TickerReservation/index.ts#L91)

▸ **details**(`callback`): `Promise`<[`UnsubCallback`](/polymesh-sdk-api-reference/docs-alpha/modules-1/types.md#unsubcallback)>

**Parameters**

| Name       | Type                                                                                                                                                                                                                                     |
| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `callback` | [`SubCallback`](/polymesh-sdk-api-reference/docs-alpha/modules-1/types.md#subcallback)<[`TickerReservationDetails`](/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_tickerreservation_types.tickerreservationdetails.md)> |

**Returns**

`Promise`<[`UnsubCallback`](/polymesh-sdk-api-reference/docs-alpha/modules-1/types.md#unsubcallback)>

**Defined in**

[api/entities/TickerReservation/index.ts:92](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/TickerReservation/index.ts#L92)

***

#### exists

▸ **exists**(): `Promise`<`boolean`>

Determine whether this Ticker Reservation exists on chain

**Returns**

`Promise`<`boolean`>

**Overrides**

[Entity](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_entity.entity.md).[exists](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_entity.entity.md#exists)

**Defined in**

[api/entities/TickerReservation/index.ts:221](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/TickerReservation/index.ts#L221)

***

#### extend

▸ **extend**(`opts?`): `Promise`<`TransactionQueue`<[`TickerReservation`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_tickerreservation.tickerreservation.md), [`TickerReservation`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_tickerreservation.tickerreservation.md), `unknown`\[]\[]>>

Extend the Reservation time period of the ticker for 60 days from now to later use it in the creation of an Asset.

**`note`** required role:

* Ticker Owner

**`note`** this method is of type [NoArgsProcedureMethod](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.noargsproceduremethod.md), which means you can call [extend.checkAuthorization](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.noargsproceduremethod.md#checkauthorization) on it to see whether the signing Account and Identity have the required roles and permissions to run it

**Parameters**

| Name    | Type                                                                                        |
| ------- | ------------------------------------------------------------------------------------------- |
| `opts?` | [`ProcedureOpts`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.procedureopts.md) |

**Returns**

`Promise`<`TransactionQueue`<[`TickerReservation`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_tickerreservation.tickerreservation.md), [`TickerReservation`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_tickerreservation.tickerreservation.md), `unknown`\[]\[]>>

**Defined in**

[api/entities/TickerReservation/index.ts:183](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/TickerReservation/index.ts#L183)

***

#### isEqual

▸ **isEqual**(`entity`): `boolean`

Determine whether this Entity is the same as another one

**Parameters**

| Name     | Type                                                                                                           |
| -------- | -------------------------------------------------------------------------------------------------------------- |
| `entity` | [`Entity`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_entity.entity.md)<`unknown`, `unknown`> |

**Returns**

`boolean`

**Inherited from**

[Entity](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_entity.entity.md).[isEqual](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_entity.entity.md#isequal)

**Defined in**

[api/entities/Entity.ts:61](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/Entity.ts#L61)

***

#### toHuman

▸ **toHuman**(): `string`

Return the Reservation's ticker

**Returns**

`string`

**Overrides**

[Entity](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_entity.entity.md).[toHuman](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_entity.entity.md#tohuman)

**Defined in**

[api/entities/TickerReservation/index.ts:234](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/TickerReservation/index.ts#L234)

***

#### transferOwnership

▸ **transferOwnership**(`args`, `opts?`): `Promise`<`TransactionQueue`<[`AuthorizationRequest`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_authorizationrequest.authorizationrequest.md), [`AuthorizationRequest`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_authorizationrequest.authorizationrequest.md), `unknown`\[]\[]>>

Transfer ownership of the Ticker Reservation to another Identity. This generates an authorization request that must be accepted by the target

**`note`** this will create [Authorization Request](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_authorizationrequest.authorizationrequest.md) which has to be accepted by the `target` Identity. An [Account](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_account.account.md) or [Identity](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_identity.identity.md) can fetch its pending Authorization Requests by calling [authorizations.getReceived](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_common_namespaces_authorizations.authorizations.md#getreceived). Also, an Account or Identity can directly fetch the details of an Authorization Request by calling [authorizations.getOne](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_common_namespaces_authorizations.authorizations.md#getone)

**`note`** required role:

* Ticker Owner

**`note`** this method is of type [ProcedureMethod](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.proceduremethod.md), which means you can call [transferOwnership.checkAuthorization](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.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`  | [`TransferTickerOwnershipParams`](/polymesh-sdk-api-reference/docs-alpha/interfaces/api_procedures_transfertickerownership.transfertickerownershipparams.md) |
| `opts?` | [`ProcedureOpts`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.procedureopts.md)                                                                  |

**Returns**

`Promise`<`TransactionQueue`<[`AuthorizationRequest`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_authorizationrequest.authorizationrequest.md), [`AuthorizationRequest`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_authorizationrequest.authorizationrequest.md), `unknown`\[]\[]>>

**Defined in**

[api/entities/TickerReservation/index.ts:214](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/TickerReservation/index.ts#L214)

***

#### generateUuid

▸ `Static` **generateUuid**<`Identifiers`>(`identifiers`): `string`

Generate the Entity's UUID from its identifying properties

**Type parameters**

| Name          |
| ------------- |
| `Identifiers` |

**Parameters**

| Name          | Type          |
| ------------- | ------------- |
| `identifiers` | `Identifiers` |

**Returns**

`string`

**Inherited from**

[Entity](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_entity.entity.md).[generateUuid](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_entity.entity.md#generateuuid)

**Defined in**

[api/entities/Entity.ts:14](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/Entity.ts#L14)

***

#### unserialize

▸ `Static` **unserialize**<`Identifiers`>(`serialized`): `Identifiers`

Unserialize a UUID into its Unique Identifiers

**Type parameters**

| Name          |
| ------------- |
| `Identifiers` |

**Parameters**

| Name         | Type     | Description         |
| ------------ | -------- | ------------------- |
| `serialized` | `string` | UUID to unserialize |

**Returns**

`Identifiers`

**Inherited from**

[Entity](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_entity.entity.md).[unserialize](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_entity.entity.md#unserialize)

**Defined in**

[api/entities/Entity.ts:23](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/Entity.ts#L23)