api_entities_TickerReservation.TickerReservation

@polymeshassociation/polymesh-sdk / Modules / api/entities/TickerReservation / TickerReservation

Class: TickerReservation

api/entities/TickerReservation.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<UniqueIdentifiers, string>

  ↳ TickerReservation

Table of contents

Properties

• ticker

• uuid

Methods

• createAsset

• details

• exists

• extend

• isEqual

• toHuman

• transferOwnership

• generateUuid

• unserialize

Properties

ticker

• ticker: string

reserved ticker

Defined in

api/entities/TickerReservation/index.ts:51

---

uuid

• uuid: string

Inherited from

Entity.uuid

Defined in

api/entities/Entity.ts:46

Methods

createAsset

▸ createAsset(args, opts?): Promise<TransactionQueue<Asset, Asset, unknown[][]>>

Create an Asset using the reserved ticker

note 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	CreateAssetParams
opts?	ProcedureOpts

Returns

Promise<TransactionQueue<Asset, Asset, unknown[][]>>

Defined in

api/entities/TickerReservation/index.ts:196

---

details

▸ details(): Promise<TickerReservationDetails>

Retrieve the Reservation's owner, expiry date and status

note can be subscribed to

Returns

Promise<TickerReservationDetails>

Defined in

api/entities/TickerReservation/index.ts:91

▸ details(callback): Promise<UnsubCallback>

Parameters

Name	Type
callback	SubCallback<TickerReservationDetails>

Returns

Promise<UnsubCallback>

Defined in

api/entities/TickerReservation/index.ts:92

---

exists

▸ exists(): Promise<boolean>

Determine whether this Ticker Reservation exists on chain

Returns

Promise<boolean>

Overrides

Entity.exists

Defined in

api/entities/TickerReservation/index.ts:221

---

extend

▸ extend(opts?): Promise<TransactionQueue<TickerReservation, TickerReservation, 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, which means you can call extend.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

Returns

Promise<TransactionQueue<TickerReservation, TickerReservation, unknown[][]>>

Defined in

api/entities/TickerReservation/index.ts:183

---

isEqual

▸ isEqual(entity): boolean

Determine whether this Entity is the same as another one

Parameters

Name	Type
entity	Entity<unknown, unknown>

Returns

boolean

Inherited from

Entity.isEqual

Defined in

api/entities/Entity.ts:61

---

toHuman

▸ toHuman(): string

Return the Reservation's ticker

Returns

string

Overrides

Entity.toHuman

Defined in

api/entities/TickerReservation/index.ts:234

---

transferOwnership

▸ transferOwnership(args, opts?): Promise<TransactionQueue<AuthorizationRequest, AuthorizationRequest, 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 which has to be accepted by the target Identity. An Account or Identity can fetch its pending Authorization Requests by calling authorizations.getReceived. Also, an Account or Identity can directly fetch the details of an Authorization Request by calling authorizations.getOne

note required role:

• Ticker Owner

note this method is of type ProcedureMethod, which means you can call transferOwnership.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
opts?	ProcedureOpts

Returns

Promise<TransactionQueue<AuthorizationRequest, AuthorizationRequest, unknown[][]>>

Defined in

api/entities/TickerReservation/index.ts:214

---

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.generateUuid

Defined in

api/entities/Entity.ts:14

---

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.unserialize

Defined in

api/entities/Entity.ts:23