-
Notifications
You must be signed in to change notification settings - Fork 11
api.entities.TickerReservation.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
-
Entity<UniqueIdentifiers,string>↳
TickerReservation
• ticker: string
reserved ticker
api/entities/TickerReservation/index.ts:59
• uuid: string
▸ createAsset(args, opts?): Promise<GenericPolymeshTransaction<FungibleAsset, FungibleAsset>>
Create an Asset using the reserved ticker
| Name | Type |
|---|---|
args |
CreateAssetParams |
opts? |
ProcedureOpts |
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
api/entities/TickerReservation/index.ts:226
▸ details(): Promise<TickerReservationDetails>
Retrieve the Reservation's owner, expiry date and status
Promise<TickerReservationDetails>
Note
can be subscribed to, if connected to node using a web socket
api/entities/TickerReservation/index.ts:99
▸ details(callback): Promise<UnsubCallback>
| Name | Type |
|---|---|
callback |
SubCallback<TickerReservationDetails> |
Promise<UnsubCallback>
api/entities/TickerReservation/index.ts:100
▸ exists(): Promise<boolean>
Determine whether this Ticker Reservation exists on chain
Promise<boolean>
api/entities/TickerReservation/index.ts:251
▸ 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.
| Name | Type |
|---|---|
opts? |
ProcedureOpts |
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
api/entities/TickerReservation/index.ts:213
▸ isEqual(entity): boolean
Determine whether this Entity is the same as another one
| Name | Type |
|---|---|
entity |
Entity<unknown, unknown> |
boolean
▸ toHuman(): string
Return the Reservation's ticker
string
api/entities/TickerReservation/index.ts:278
▸ 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
| Name | Type |
|---|---|
args |
TransferTickerOwnershipParams |
opts? |
ProcedureOpts |
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
api/entities/TickerReservation/index.ts:244
▸ Static generateUuid<Identifiers>(identifiers): string
Generate the Entity's UUID from its identifying properties
| Name |
|---|
Identifiers |
| Name | Type |
|---|---|
identifiers |
Identifiers |
string
▸ Static unserialize<Identifiers>(serialized): Identifiers
Unserialize a UUID into its Unique Identifiers
| Name |
|---|
Identifiers |
| Name | Type | Description |
|---|---|---|
serialized |
string |
UUID to unserialize |
Identifiers
Entities
- Account
- Asset
- Authorization Request
- Checkpoint
- Checkpoint Schedule
- Corporate Action
- Corporate Action Base
- Custom Permission Group
- Default Portfolio
- Default Trusted Claim Issuer
- Dividend Distribution
- Entity
- Identity
- Instruction
- Known Permission Group
- Metadata Entry
- Multi Sig Proposal
- Numbered Portfolio
- Offering
- Permission Group
- Portfolio
- Subsidies
- Subsidy
- Ticker Reservation
- Venue
- Authorizations
- Types