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

Methods

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

reserved ticker

uuid

uuid: string

Inherited from Entity.uuid

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

Methods

createToken

createToken(args: CreateSecurityTokenParams): Promise‹TransactionQueueSecurityToken››

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

Create a Security Token using the reserved ticker

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

Parameters:

Returns: Promise‹TransactionQueueSecurityToken››

details

details(): Promise‹TickerReservationDetails

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

Retrieve the Reservation's owner, expiry date and status

note can be subscribed to

Returns: Promise‹TickerReservationDetails

details(callback: SubCallbackTickerReservationDetails›): Promise‹UnsubCallback

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

Parameters:

Returns: Promise‹UnsubCallback

extend

extend(): Promise‹TransactionQueueTickerReservation››

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

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

Static generateUuid

generateUuidIdentifiers›(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:

Returns: string

Static unserialize

unserializeIdentifiers›(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:

Returns: Identifiers

Last updated