P
P
Polymesh SDK API Reference
v14.1.0
Search…
⌃K

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

Methods

Properties

Protected context

context: Context
Inherited from CheckpointSchedule.context

ticker

ticker: string
reserved ticker

uuid

uuid: string
Inherited from CheckpointSchedule.uuid

Methods

createAsset

createAsset(args: CreateAssetParams, opts?: ProcedureOpts): Promise‹TransactionQueueAsset››
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
opts?
Returns: Promise‹TransactionQueueAsset››

details

details(): Promise‹TickerReservationDetails
Retrieve the Reservation's owner, expiry date and status
note can be subscribed to
Returns: Promise‹TickerReservationDetails
details(callback: SubCallbackTickerReservationDetails›): Promise‹UnsubCallback
Parameters:
Name
Type
callback
Returns: Promise‹UnsubCallback

exists

exists(): Promise‹boolean›
Overrides Entity.exists
Determine whether this Ticker Reservation exists on chain
Returns: Promise‹boolean›

extend

extend(opts?: ProcedureOpts): Promise‹TransactionQueueTickerReservation››
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?
Returns: Promise‹TransactionQueueTickerReservation››

isEqual

isEqual(entity: Entity‹unknown, unknown›): boolean
Inherited from CheckpointSchedule.isEqual
Determine whether this Entity is the same as another one
Parameters:
Name
Type
entity
Entity‹unknown, unknown›
Returns: boolean

toJson

toJson(): string
Overrides Entity.toJson
Return the Reservation's ticker
Returns: string

transferOwnership

transferOwnership(args: TransferTickerOwnershipParams, opts?: ProcedureOpts): Promise‹TransactionQueueAuthorizationRequest››
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
opts?
Returns: Promise‹TransactionQueueAuthorizationRequest››

Static generateUuid

generateUuidIdentifiers›(identifiers: Identifiers): string
Generate the Entity's UUID from its identifying properties
Type parameters:
Identifiers
Parameters:
Name
Type
Description
identifiers
Identifiers
Returns: string

Static unserialize

unserializeIdentifiers›(serialized: string): Identifiers
Unserialize a UUID into its Unique Identifiers
Type parameters:
Identifiers
Parameters:
Name
Type
Description
serialized
string
UUID to unserialize
Returns: Identifiers