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
  • id
  • ticker
  • uuid
  • Methods
  • close
  • details
  • exists
  • freeze
  • getInvestments
  • invest
  • isEqual
  • modifyTimes
  • toJson
  • unfreeze
  • Static generateUuid
  • Static unserialize

Was this helpful?

  1. Classes

Sto

PreviousSettlementsNextTickerReservation

Last updated 3 years ago

Was this helpful?

Represents a Security Token Offering in the Polymesh blockchain

Hierarchy

  • ‹UniqueIdentifiers, ›

    ↳ Sto

Index

Properties

Methods

Properties

Protected context

id

• id: BigNumber

identifier number of the Offering

ticker

• ticker: string

ticker of the Security Token being offered

uuid

• uuid: string

Methods

close

Close the STO

Parameters:

Name
Type

args

void

opts?

details

Retrieve the STO's details

note can be subscribed to

Parameters:

Name
Type

callback

exists

▸ exists(): Promise‹boolean›

Determine whether this STO exists on chain

Returns: Promise‹boolean›

freeze

Freeze the STO

Parameters:

Name
Type

args

void

opts?

getInvestments

Retrieve all investments made on this STO

note supports pagination

note uses the middleware

Parameters:

â–ªDefault value opts: object= {}

Name
Type
Description

size?

undefined | number

page size

start?

undefined | number

page offset

invest

Invest in the STO

note required roles:

  • Purchase Portfolio Custodian

  • Funding Portfolio Custodian

Parameters:

Name
Type

args

opts?

isEqual

Determine whether this Entity is the same as another one

Parameters:

Name
Type

entity

Returns: boolean

modifyTimes

Modify the start/end time of the STO

throws if:

  • Trying to modify the start time on an STO that already started

  • Trying to modify anything on an STO that already ended

  • Trying to change start or end time to a past date

Parameters:

Name
Type

args

opts?

toJson

Return the Sto's ID and Token ticker

unfreeze

Unfreeze the STO

Parameters:

Name
Type

args

void

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

Defined in

Inherited from .

Defined in

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

Defined in

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

Returns: Promise‹‹void››

▸ details(): Promise‹›

Defined in

Returns: Promise‹›

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

Defined in

‹›

Returns: Promise‹›

Overrides .

Defined in

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

Defined in

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

Returns: Promise‹‹››

▸ getInvestments(opts: object): Promise‹‹››

Defined in

Returns: Promise‹‹››

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

Defined in

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

Returns: Promise‹‹void››

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

Inherited from .

Defined in

‹unknown, unknown›

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

Defined in

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

Returns: Promise‹‹void››

â–¸ toJson():

Overrides .

Defined in

Returns:

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

Defined in

note this method is of type , which means you can call unfreeze.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

Context
src/api/entities/Entity.ts:48
src/api/entities/Sto/index.ts:61
src/api/entities/Sto/index.ts:66
src/api/entities/Entity.ts:46
ProcedureOpts
TransactionQueue
src/api/entities/Sto/index.ts:159
ProcedureMethod
TransactionQueue
StoDetails
src/api/entities/Sto/index.ts:106
StoDetails
src/api/entities/Sto/index.ts:107
src/api/entities/Sto/index.ts:276
ProcedureOpts
TransactionQueue
Sto
src/api/entities/Sto/index.ts:169
ProcedureMethod
TransactionQueue
Sto
ResultSet
Investment
src/api/entities/Sto/index.ts:221
ResultSet
Investment
InvestInStoParams
ProcedureOpts
TransactionQueue
src/api/entities/Sto/index.ts:208
ProcedureMethod
TransactionQueue
Entity
src/api/entities/Entity.ts:61
src/api/entities/Sto/index.ts:194
ProcedureMethod
TransactionQueue
HumanReadable
src/api/entities/Sto/index.ts:290
HumanReadable
ProcedureOpts
TransactionQueue
Sto
src/api/entities/Sto/index.ts:179
ProcedureMethod
TransactionQueue
Sto
src/api/entities/Entity.ts:14
src/api/entities/Entity.ts:23
Entity
HumanReadable
context
id
ticker
uuid
close
details
exists
freeze
getInvestments
invest
isEqual
modifyTimes
toJson
unfreeze
generateUuid
unserialize
ProcedureOpts
ProcedureOpts
InvestInStoParams
ProcedureOpts
Entity
ProcedureOpts
ProcedureOpts
Entity
Entity
StoDetails
Entity
Entity
ProcedureOpts
TransactionQueue
Entity
Entity
Entity
StoDetails
context
uuid
exists
isEqual
toJson
generateUuid
unserialize
SubCallback
UnsubCallback
UnsubCallback
ModifyStoTimesParams
SubCallback
ModifyStoTimesParams