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 CheckpointSchedule.context

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

createToken

createToken: ProcedureMethod‹CreateSecurityTokenParams, SecurityToken

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

Create a Security Token using the reserved ticker

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

param amount of tokens that will be minted on creation

param whether a single token can be divided into decimal parts

param type of security that the token represents (i.e. Equity, Debt, Commodity, etc)

param domestic or international alphanumeric security identifiers for the token (ISIN, CUSIP, etc)

param (optional) funding round in which the token currently is (Series A, Series B, etc)

note required role:

  • Ticker Owner

extend

extend: ProcedureMethod‹void, TickerReservation

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

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

note required role:

  • Ticker Owner

ticker

ticker: string

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

reserved ticker

uuid

uuid: string

Inherited from CheckpointSchedule.uuid

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

Methods

details

details(): Promise‹TickerReservationDetails

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

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

Parameters:

Returns: Promise‹UnsubCallback

isEqual

isEqual(entity: Entity‹object›): boolean

Inherited from CheckpointSchedule.isEqual

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

Whether this Entity is the same as another one

Parameters:

Name

Type

entity

Entity‹object›

Returns: boolean

Static generateUuid

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

Parameters:

Name

Type

Description

identifiers

Identifiers

Returns: string

Static unserialize

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

Parameters:

Name

Type

Description

serialized

string

UUID to unserialize

Returns: Identifiers

Last updated