Class: TickerReservation

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

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

Extends

• Entity<UniqueIdentifiers, string>

Properties

ticker

ticker: string

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

reserved ticker

---

uuid

uuid: string

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

Inherited from

Entity.uuid

Methods

createAsset()

createAsset(args: CreateAssetParams, opts?: ProcedureOpts): Promise<GenericPolymeshTransaction<FungibleAsset, FungibleAsset>>

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

Create an Asset using the reserved ticker

Parameters

Parameter	Type
args	CreateAssetParams
opts?	ProcedureOpts

Returns

Promise<GenericPolymeshTransaction<FungibleAsset, FungibleAsset>>

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

---

details()

Call Signature

details(): Promise<TickerReservationDetails>

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

Retrieve the Reservation's owner, expiry date and status

Returns

Promise<TickerReservationDetails>

Call Signature

details(callback: SubCallback<TickerReservationDetails>): Promise<UnsubCallback>

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

Retrieve the Reservation's owner, expiry date and status

Parameters

Parameter	Type	Description
callback	SubCallback<TickerReservationDetails>	Callback function that can be used to listen for changes to the reservation details

Returns

Promise<UnsubCallback>

Note

can be subscribed to, if connected to node using a web socket

---

exists()

exists(): Promise<boolean>

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

Determine whether this Ticker Reservation exists on chain

Returns

Promise<boolean>

Overrides

Entity.exists

---

extend()

extend(opts?: ProcedureOpts): Promise<GenericPolymeshTransaction<TickerReservation, TickerReservation>>

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

Extend the Reservation time period of the ticker for 60 days from now to later use it in the creation of an Asset.

Parameters

Parameter	Type
opts?	ProcedureOpts

Returns

Promise<GenericPolymeshTransaction<TickerReservation, TickerReservation>>

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

---

isEqual()

isEqual(entity: Entity<unknown, unknown>): boolean

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

Determine whether this Entity is the same as another one

Parameters

Parameter	Type
entity	Entity<unknown, unknown>

Returns

boolean

Inherited from

Entity.isEqual

---

toHuman()

toHuman(): string

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

Return the Reservation's ticker

Returns

string

Overrides

Entity.toHuman

---

transferOwnership()

transferOwnership(args: TransferTickerOwnershipParams, opts?: ProcedureOpts): Promise<GenericPolymeshTransaction<AuthorizationRequest, AuthorizationRequest>>

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

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

Parameters

Parameter	Type
args	TransferTickerOwnershipParams
opts?	ProcedureOpts

Returns

Promise<GenericPolymeshTransaction<AuthorizationRequest, AuthorizationRequest>>

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

---

generateUuid()

static generateUuid<Identifiers>(identifiers: Identifiers): string

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

Generate the Entity's UUID from its identifying properties

Type Parameters

Type Parameter
Identifiers

Parameters

Parameter	Type	Description
identifiers	Identifiers	‐

Returns

string

Inherited from

Entity.generateUuid

---

unserialize()

static unserialize<Identifiers>(serialized: string): Identifiers

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

Unserialize a UUID into its Unique Identifiers

Type Parameters

Type Parameter
Identifiers

Parameters

Parameter	Type	Description
serialized	string	UUID to unserialize

Returns

Identifiers

Inherited from

Entity.unserialize