TickerReservation

Represents a reserved token symbol in the Polymesh chain. 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 a Security Token with it

Hierarchy

• Entity‹UniqueIdentifiers›

  ↳ TickerReservation

Index

Properties

• context

• ticker

• uuid

Methods

• createToken

• details

• extend

• generateUuid

• unserialize

Properties

Protected context

• context: Context

Inherited from Entity.context

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

ticker

• ticker: string

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

reserved ticker

uuid

• uuid: string

Inherited from Entity.uuid

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

Methods

createToken

▸ createToken(args: CreateSecurityTokenParams): Promise‹TransactionQueue‹SecurityToken››

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

Create a Security Token using the reserved ticker

note the issuer DID will be set as the primary issuance agent

Parameters:

Name	Type
args	CreateSecurityTokenParams

Returns: Promise‹TransactionQueue‹SecurityToken››

details

▸ details(): Promise‹TickerReservationDetails›

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

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:64

Parameters:

Name	Type
callback	SubCallback‹TickerReservationDetails›

Returns: Promise‹UnsubCallback›

extend

▸ extend(): Promise‹TransactionQueue‹TickerReservation››

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

Extend the Reservation time period of the ticker for 60 days from now to later use it in the creation of a Security Token.

Returns: Promise‹TransactionQueue‹TickerReservation››

Static generateUuid

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

Inherited from Entity.generateUuid

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

Generate the Entity's UUID from its identifying properties

Type parameters:

▪ Identifiers: object

Parameters:

Name	Type	Description
identifiers	Identifiers

Returns: string

Static unserialize

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

Inherited from Entity.unserialize

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

Unserialize a UUID into its Unique Identifiers

Type parameters:

▪ Identifiers: object

Parameters:

Name	Type	Description
serialized	string	UUID to unserialize

Returns: Identifiers