Polymesh SDK API Reference
v10.0.0
v10.0.0
  • Introduction
  • Globals
  • Classes
    • Account
    • AuthorizationRequest
    • Authorizations
    • Checkpoint
    • CheckpointSchedule
    • Checkpoints
    • Claims
    • Compliance
    • Context
    • CorporateAction
    • CorporateActions
    • Count
    • CustomPermissionGroup
    • DefaultPortfolio
    • DefaultTrustedClaimIssuer
    • Distributions
    • DividendDistribution
    • Documents
    • Entity
    • Identity
    • IdentityAuthorizations
    • Instruction
    • Issuance
    • KnownPermissionGroup
    • Middleware
    • NumberedPortfolio
    • Offerings
    • Percentage
    • PermissionGroup
    • Permissions
    • Polymesh
    • PolymeshError
    • PolymeshTransaction
    • PolymeshTransactionBase
    • PolymeshTransactionBatch
    • Portfolio
    • Portfolios
    • Requirements
    • Schedules
    • SecurityToken
    • Settlements
    • Sto
    • TickerReservation
    • TokenHolders
    • TokenPermissions
    • TransactionQueue
    • TransferRestrictionBase
    • TransferRestrictions
    • TrustedClaimIssuers
    • Venue
  • Enums
    • AffirmationStatus
    • AuthorizationType
    • CalendarUnit
    • ClaimType
    • ConditionTarget
    • ConditionType
    • CorporateActionKind
    • CountryCode
    • ErrorCode
    • InstructionStatus
    • InstructionType
    • KnownTokenType
    • PermissionGroupType
    • PermissionType
    • ProposalStage
    • RoleType
    • ScopeType
    • SignerType
    • StoBalanceStatus
    • StoSaleStatus
    • StoTimingStatus
    • TargetTreatment
    • TickerReservationStatus
    • TokenIdentifierType
    • TransactionArgumentType
    • TransactionQueueStatus
    • TransactionStatus
    • TransferError
    • TransferRestrictionType
    • TransferStatus
    • TxGroup
    • VenueType
  • Interfaces
    • ActiveTransferRestrictions
    • AddBatchTransactionOpts
    • AddClaimsParams
    • AddInstructionParams
    • AddInstructionsParams
    • AddInvestorUniquenessClaimParams
    • AddPairBaseParams
    • AddTransactionOpts
    • AddTransactionOptsBase
    • AgentWithGroup
    • ArrayTransactionArgument
    • Balance
    • CalendarPeriod
    • CddProviderRole
    • CheckpointWithData
    • ClaimClassicTickerParams
    • ClaimData
    • ClaimScope
    • ClaimTarget
    • ComplexTransactionArgument
    • ConditionCompliance
    • ConnectParamsBase
    • ConstructorParams
    • ConsumeParams
    • ControllerTransferParams
    • CorporateActionDefaults
    • CorporateActionTargets
    • CountTransferRestriction
    • CountTransferRestrictionInput
    • CreateCheckpointScheduleParams
    • CreateGroupParams
    • CreateSecurityTokenParams
    • CreateVenueParams
    • DeletePortfolioParams
    • DistributionParticipant
    • DistributionPayment
    • DistributionWithDetails
    • DividendDistributionDetails
    • DividendDistributionParams
    • EditClaimsParams
    • EventIdentifier
    • ExtrinsicData
    • Fees
    • FeesBreakdown
    • GroupedInstructions
    • HistoricAgentOperation
    • HistoricSettlement
    • HumanReadable
    • IdentityBalance
    • IdentityRole
    • IdentityWithClaims
    • InstructionAffirmation
    • InvestInStoParams
    • Investment
    • InviteAccountParams
    • InviteExternalAgentParams
    • IssueTokensParams
    • KeyringPair
    • LeaveIdentityParams
    • Leg
    • LinkCaDocsParams
    • MiddlewareConfig
    • ModifyCorporateActionsAgentParams
    • ModifyInstructionAffirmationParams
    • ModifyPrimaryIssuanceAgentParams
    • ModifySignerPermissionsParams
    • ModifyTokenTrustedClaimIssuersAddSetParams
    • ModifyTokenTrustedClaimIssuersRemoveParams
    • MoveFundsParams
    • NetworkProperties
    • PaginationOptions
    • PayDividendsParams
    • PercentageTransferRestriction
    • PercentageTransferRestrictionInput
    • PlainTransactionArgument
    • PortfolioBalance
    • PortfolioCustodianRole
    • PortfolioMovement
    • ProcedureAuthorizationStatus
    • ProcedureMethod
    • ProcedureOpts
    • ProposalDetails
    • ProposalTimeFrames
    • ProposalVote
    • RedeemTokenParams
    • RegisterIdentityParams
    • RemoveCheckpointScheduleParams
    • RemoveCorporateActionParams
    • RemoveExternalAgentParams
    • RemoveSecondaryKeysParams
    • RenamePortfolioParams
    • Requirement
    • RequirementCompliance
    • ReserveTickerParams
    • ResultSet
    • RevokeClaimsParams
    • ScheduleDetails
    • ScheduleWithDetails
    • Scope
    • SecondaryKey
    • SectionPermissions
    • SecurityTokenDetails
    • SetAssetRequirementsParams
    • SetCountTransferRestrictionsParams
    • SetCustodianParams
    • SetGroupPermissionsParams
    • SetPercentageTransferRestrictionsParams
    • SetPermissionGroupParams
    • SetTokenDocumentsParams
    • SettlementLeg
    • SignerValue
    • SimpleEnumTransactionArgument
    • SimplePermissions
    • StoDetails
    • StoStatus
    • StoTier
    • StoWithDetails
    • Subsidy
    • TaxWithholding
    • ThirdPartyFees
    • TickerOwnerRole
    • TickerReservationDetails
    • Tier
    • ToggleFreezeSecondaryKeysParams
    • ToggleFreezeStoParams
    • ToggleFreezeTransfersParams
    • TogglePauseRequirementsParams
    • TokenBase
    • TokenDocument
    • TokenIdentifier
    • TokenWithGroup
    • TransactionPermissions
    • TransactionsParams
    • TransferBreakdown
    • TransferPolyxParams
    • TransferRestriction
    • TransferRestrictionInputBase
    • TransferRestrictionResult
    • TransferTickerOwnershipParams
    • TransferTokenOwnershipParams
    • TrustedClaimIssuer
    • TxGroupParams
    • UiKeyring
    • UniqueIdentifiers
    • VenueDetails
    • VenueOwnerRole
    • WaivePermissionsParams
Powered by GitBook
On this page
  • Hierarchy
  • Index
  • Properties
  • Methods
  • Properties
  • Protected context
  • ticker
  • uuid
  • Methods
  • createToken
  • details
  • exists
  • extend
  • isEqual
  • toJson
  • transferOwnership
  • Static generateUuid
  • Static unserialize

Was this helpful?

  1. Classes

TickerReservation

PreviousStoNextTokenHolders

Last updated 3 years ago

Was this helpful?

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

  • ‹UniqueIdentifiers, string›

    ↳ TickerReservation

Index

Properties

Methods

Properties

Protected context

ticker

• ticker: string

reserved ticker

uuid

• uuid: string

Methods

createToken

Create a Security Token using the reserved ticker

note required role:

  • Ticker Owner

Parameters:

Name
Type

args

opts?

details

Retrieve the Reservation's owner, expiry date and status

note can be subscribed to

Parameters:

Name
Type

callback

exists

▸ exists(): Promise‹boolean›

Determine whether this Ticker Reservation exists on chain

Returns: Promise‹boolean›

extend

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

Parameters:

Name
Type

args

void

opts?

isEqual

Determine whether this Entity is the same as another one

Parameters:

Name
Type

entity

Returns: boolean

toJson

â–¸ toJson(): string

Return the Reservation's ticker

Returns: string

transferOwnership

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

note required role:

  • Ticker Owner

Parameters:

Name
Type

args

opts?

Static generateUuid

▸ generateUuid‹Identifiers›(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

▸ unserialize‹Identifiers›(serialized: string): Identifiers

Unserialize a UUID into its Unique Identifiers

Type parameters:

â–ª Identifiers

Parameters:

Name
Type
Description

serialized

string

UUID to unserialize

Returns: Identifiers

• context:

Inherited from .

Defined in

Defined in

Inherited from .

Defined in

▸ createToken(args: , opts?: ): Promise‹‹››

Defined in

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

Returns: Promise‹‹››

▸ details(): Promise‹›

Defined in

Returns: Promise‹›

▸ details(callback: ‹›): Promise‹›

Defined in

‹›

Returns: Promise‹›

Overrides .

Defined in

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

Defined in

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

Returns: Promise‹‹››

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

Inherited from .

Defined in

‹unknown, unknown›

Overrides .

Defined in

▸ transferOwnership(args: , opts?: ): Promise‹‹››

Defined in

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

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

Returns: Promise‹‹››

Inherited from .

Defined in

Inherited from .

Defined in

Entity
context
ticker
uuid
createToken
details
exists
extend
isEqual
toJson
transferOwnership
generateUuid
unserialize
Context
Entity
context
src/api/entities/Entity.ts:48
src/api/entities/TickerReservation/index.ts:49
Entity
uuid
src/api/entities/Entity.ts:46
CreateSecurityTokenParams
ProcedureOpts
TransactionQueue
SecurityToken
src/api/entities/TickerReservation/index.ts:182
ProcedureMethod
TransactionQueue
SecurityToken
TickerReservationDetails
src/api/entities/TickerReservation/index.ts:82
TickerReservationDetails
SubCallback
TickerReservationDetails
UnsubCallback
src/api/entities/TickerReservation/index.ts:83
UnsubCallback
Entity
exists
src/api/entities/TickerReservation/index.ts:207
ProcedureOpts
TransactionQueue
TickerReservation
src/api/entities/TickerReservation/index.ts:169
ProcedureMethod
TransactionQueue
TickerReservation
Entity
Entity
isEqual
src/api/entities/Entity.ts:61
Entity
toJson
src/api/entities/TickerReservation/index.ts:220
TransferTickerOwnershipParams
ProcedureOpts
TransactionQueue
TickerReservation
src/api/entities/TickerReservation/index.ts:200
Authorization Requests
Accounts
Identities
ProcedureMethod
TransactionQueue
TickerReservation
Entity
generateUuid
src/api/entities/Entity.ts:14
Entity
unserialize
src/api/entities/Entity.ts:23
CreateSecurityTokenParams
ProcedureOpts
SubCallback
TickerReservationDetails
ProcedureOpts
Entity
TransferTickerOwnershipParams
ProcedureOpts