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

Index

Properties

• context

• ticker

• uuid

Methods

• createAsset

• details

• exists

• extend

• isEqual

• toHuman

• transferOwnership

• generateUuid

• unserialize

Properties

Protected context

• context: Context

Inherited from CheckpointSchedule.context

Defined in src/api/entities/Entity.ts:48

---

ticker

• ticker: string

Defined in src/api/entities/TickerReservation/index.ts:51

reserved ticker

---

uuid

• uuid: string

Inherited from CheckpointSchedule.uuid

Defined in src/api/entities/Entity.ts:46

Methods

createAsset

▸ createAsset(args: CreateAssetParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹Asset››

Defined in src/api/entities/TickerReservation/index.ts:196

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››

---

details

▸ details(): Promise‹TickerReservationDetails›

Defined in src/api/entities/TickerReservation/index.ts:91

Retrieve the Reservation's owner, expiry date and status

note can be subscribed to

Returns: Promise‹TickerReservationDetails›

▸ details(callback: SubCallback‹TickerReservationDetails›): Promise‹UnsubCallback›

Defined in src/api/entities/TickerReservation/index.ts:92

Parameters:

Name	Type
callback	SubCallback‹TickerReservationDetails›

Returns: Promise‹UnsubCallback›

---

exists

▸ exists(): Promise‹boolean›

Overrides Entity.exists

Defined in src/api/entities/TickerReservation/index.ts:221

Determine whether this Ticker Reservation exists on chain

Returns: Promise‹boolean›

---

extend

▸ extend(opts?: ProcedureOpts): Promise‹TransactionQueue‹TickerReservation››

Defined in src/api/entities/TickerReservation/index.ts:183

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››

---

isEqual

▸ isEqual(entity: Entity‹unknown, unknown›): boolean

Inherited from CheckpointSchedule.isEqual

Defined in src/api/entities/Entity.ts:61

Determine whether this Entity is the same as another one

Parameters:

Name	Type
entity	Entity‹unknown, unknown›

Returns: boolean

---

toHuman

▸ toHuman(): string

Overrides Entity.toHuman

Defined in src/api/entities/TickerReservation/index.ts:234

Return the Reservation's ticker

Returns: string

---

transferOwnership

▸ transferOwnership(args: TransferTickerOwnershipParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹AuthorizationRequest››

Defined in src/api/entities/TickerReservation/index.ts:214

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››

---

Static generateUuid

▸ generateUuid‹Identifiers›(identifiers: Identifiers): string

Inherited from CheckpointSchedule.generateUuid

Defined in src/api/entities/Entity.ts:14

Generate the Entity's UUID from its identifying properties

Type parameters:

▪ Identifiers

Parameters:

Name	Type	Description
identifiers	Identifiers

Returns: string

---

Static unserialize

▸ unserialize‹Identifiers›(serialized: string): Identifiers

Inherited from CheckpointSchedule.unserialize

Defined in src/api/entities/Entity.ts:23

Unserialize a UUID into its Unique Identifiers

Type parameters:

▪ Identifiers

Parameters:

Name	Type	Description
serialized	string	UUID to unserialize

Returns: Identifiers