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

  ↳ TickerReservation

Index

Properties

• context

• ticker

• uuid

Methods

• createToken

• details

• extend

• isEqual

• toJson

• transferOwnership

• 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:49

reserved ticker

uuid

• uuid: string

Inherited from Entity.uuid

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

Methods

createToken

▸ createToken(args: CreateSecurityTokenParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹SecurityToken››

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

Create a Security Token using the reserved ticker

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

note required role:

• Ticker Owner

note this method is of type ProcedureMethod, which means you can call createToken.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Parameters:

Name	Type
args	CreateSecurityTokenParams
opts?	ProcedureOpts

Returns: Promise‹TransactionQueue‹SecurityToken››

details

▸ details(): Promise‹TickerReservationDetails›

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

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

Parameters:

Name	Type
callback	SubCallback‹TickerReservationDetails›

Returns: Promise‹UnsubCallback›

extend

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

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

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

note this method is of type ProcedureMethod, which means you can call extend.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Parameters:

Name	Type
args	void
opts?	ProcedureOpts

Returns: Promise‹TransactionQueue‹TickerReservation››

isEqual

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

Inherited from Entity.isEqual

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

Whether this Entity is the same as another one

Parameters:

Name	Type
entity	Entity‹unknown, unknown›

Returns: boolean

toJson

▸ toJson(): string

Overrides Entity.toJson

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

Return the Reservation's ticker

Returns: string

transferOwnership

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

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

Transfer ownership of the Ticker Reservation to another Identity. This generates an authorization request that must be accepted by the destinatary

note this will create Authorization Requests which have to be accepted by the corresponding Accounts and/or Identities. An Account or Identity can fetch its pending Authorization Requests by calling authorizations.getReceived

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 Current Account has the required permissions to run it

Parameters:

Name	Type
args	TransferTickerOwnershipParams
opts?	ProcedureOpts

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

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

Parameters:

Name	Type	Description
serialized	string	UUID to unserialize

Returns: Identifiers