Class: TickerReservation
api/entities/TickerReservation.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
Properties
ticker
• ticker: string
reserved ticker
Defined in
api/entities/TickerReservation/index.ts:59
uuid
• uuid: string
Inherited from
Defined in
Methods
createAsset
▸ createAsset(args, opts?): Promise<GenericPolymeshTransaction<FungibleAsset, FungibleAsset>>
Create an Asset using the reserved ticker
Parameters
| Name | 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
Defined in
api/entities/TickerReservation/index.ts:213
details
▸ details(): Promise<TickerReservationDetails>
Retrieve the Reservation's owner, expiry date and status
Returns
Promise<TickerReservationDetails>
Note
can be subscribed to, if connected to node using a web socket
Defined in
api/entities/TickerReservation/index.ts:99
▸ details(callback): Promise<UnsubCallback>
Parameters
| Name | Type |
|---|---|
callback | SubCallback<TickerReservationDetails> |
Returns
Promise<UnsubCallback>
Defined in
api/entities/TickerReservation/index.ts:100
exists
▸ exists(): Promise<boolean>
Determine whether this Ticker Reservation exists on chain
Returns
Promise<boolean>
Overrides
Defined in
api/entities/TickerReservation/index.ts:238
extend
▸ extend(opts?): Promise<GenericPolymeshTransaction<TickerReservation, TickerReservation>>
Extend the Reservation time period of the ticker for 60 days from now to later use it in the creation of an Asset.
Parameters
| Name | 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
Defined in
api/entities/TickerReservation/index.ts:200
isEqual
▸ isEqual(entity): boolean
Determine whether this Entity is the same as another one
Parameters
| Name | Type |
|---|---|
entity | Entity<unknown, unknown> |
Returns
boolean
Inherited from
Defined in
toHuman
▸ toHuman(): string
Return the Reservation's ticker
Returns
string
Overrides
Defined in
api/entities/TickerReservation/index.ts:257
transferOwnership
▸ transferOwnership(args, opts?): Promise<GenericPolymeshTransaction<AuthorizationRequest, AuthorizationRequest>>
Transfer ownership of the Ticker Reservation to another Identity. This generates an authorization request that must be accepted by the target
Parameters
| Name | 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
Defined in
api/entities/TickerReservation/index.ts:231
generateUuid
▸ Static generateUuid<Identifiers>(identifiers): string
Generate the Entity's UUID from its identifying properties
Type parameters
| Name |
|---|
Identifiers |
Parameters
| Name | Type |
|---|---|
identifiers | Identifiers |
Returns
string
Inherited from
Defined in
unserialize
▸ Static unserialize<Identifiers>(serialized): Identifiers
Unserialize a UUID into its Unique Identifiers
Type parameters
| Name |
|---|
Identifiers |
Parameters
| Name | Type | Description |
|---|---|---|
serialized | string | UUID to unserialize |
Returns
Identifiers