Polymesh SDK API Reference
v6.0.0
v6.0.0
  • Introduction
  • Globals
  • Classes
    • Account
    • AuthorizationRequest
    • Authorizations
    • Checkpoint
    • CheckpointSchedule
    • Checkpoints
    • Claims
    • Compliance
    • Context
    • CorporateAction
    • CorporateActions
    • Count
    • CurrentAccount
    • CurrentIdentity
    • DefaultPortfolio
    • DefaultTrustedClaimIssuer
    • Distributions
    • DividendDistribution
    • Documents
    • Entity
    • Identity
    • IdentityAuthorizations
    • Instruction
    • Issuance
    • Middleware
    • NumberedPortfolio
    • Offerings
    • Percentage
    • Polymesh
    • PolymeshError
    • PolymeshTransaction
    • PolymeshTransactionBase
    • PolymeshTransactionBatch
    • Portfolio
    • Portfolios
    • Requirements
    • Schedules
    • SecurityToken
    • Settlements
    • Sto
    • TickerReservation
    • TokenHolders
    • TransactionQueue
    • TransferRestrictionBase
    • TransferRestrictions
    • TrustedClaimIssuers
    • Venue
  • Enums
    • AffirmationStatus
    • AuthorizationType
    • CalendarUnit
    • ClaimType
    • ConditionTarget
    • ConditionType
    • CorporateActionKind
    • CountryCode
    • ErrorCode
    • InstructionStatus
    • InstructionType
    • KnownTokenType
    • ProposalStage
    • RoleType
    • ScopeType
    • StoBalanceStatus
    • StoSaleStatus
    • StoTimingStatus
    • TargetTreatment
    • TickerReservationStatus
    • TokenIdentifierType
    • TransactionArgumentType
    • TransactionQueueStatus
    • TransactionStatus
    • TransferError
    • TransferRestrictionType
    • TransferStatus
    • TxGroup
    • VenueType
  • Interfaces
    • AccountData
    • ActiveTransferRestrictions
    • AddBatchTransactionOpts
    • AddClaimsParams
    • AddInstructionParams
    • AddInstructionsParams
    • AddInvestorUniquenessClaimParams
    • AddTransactionOpts
    • AddTransactionOptsBase
    • ArrayTransactionArgument
    • Balance
    • CalendarPeriod
    • CddProviderRole
    • CheckpointWithData
    • ClaimClassicTickerParams
    • ClaimData
    • ClaimScope
    • ClaimTarget
    • ComplexTransactionArgument
    • ConditionCompliance
    • ConnectParamsBase
    • ConstructorParams
    • ConsumeParams
    • ControllerTransferParams
    • CorporateActionDefaults
    • CorporateActionTargets
    • CountTransferRestriction
    • CountTransferRestrictionInput
    • CreateCheckpointScheduleParams
    • CreateSecurityTokenParams
    • CreateVenueParams
    • DeletePortfolioParams
    • DistributionParticipant
    • DistributionPayment
    • DistributionWithDetails
    • DividendDistributionDetails
    • DividendDistributionParams
    • EditClaimsParams
    • EventIdentifier
    • ExtrinsicData
    • Fees
    • HistoricSettlement
    • IdentityBalance
    • IdentityWithClaims
    • InstructionAffirmation
    • InvestInStoParams
    • Investment
    • InviteAccountParams
    • IssueTokensParams
    • KeyringPair
    • LeaveIdentityParams
    • Leg
    • LinkCaDocsParams
    • MiddlewareConfig
    • ModifyCorporateActionsAgentParams
    • ModifyInstructionAffirmationParams
    • ModifyPrimaryIssuanceAgentParams
    • ModifySignerPermissionsParams
    • ModifyTokenTrustedClaimIssuersAddSetParams
    • ModifyTokenTrustedClaimIssuersRemoveParams
    • MoveFundsParams
    • NetworkProperties
    • PaginationOptions
    • PayDividendsParams
    • PercentageTransferRestriction
    • PercentageTransferRestrictionInput
    • Permissions
    • PermissionsLike
    • PlainTransactionArgument
    • PortfolioBalance
    • PortfolioCustodianRole
    • PortfolioMovement
    • ProcedureAuthorizationStatus
    • ProcedureMethod
    • ProposalDetails
    • ProposalTimeFrames
    • ProposalVote
    • RedeemTokenParams
    • RegisterIdentityParams
    • RemoveCheckpointScheduleParams
    • RemoveCorporateActionParams
    • RemoveSecondaryKeysParams
    • RenamePortfolioParams
    • Requirement
    • RequirementCompliance
    • ReserveTickerParams
    • ResultSet
    • RevokeClaimsParams
    • ScheduleDetails
    • ScheduleWithDetails
    • Scope
    • SecondaryKey
    • SecurityTokenDetails
    • SetAssetRequirementsParams
    • SetCountTransferRestrictionsParams
    • SetCustodianParams
    • SetPercentageTransferRestrictionsParams
    • SetTokenDocumentsParams
    • SettlementLeg
    • SimpleEnumTransactionArgument
    • StoDetails
    • StoStatus
    • StoTier
    • StoWithDetails
    • TaxWithholding
    • TickerOwnerRole
    • TickerReservationDetails
    • Tier
    • ToggleFreezeSecondaryKeysParams
    • ToggleFreezeStoParams
    • ToggleFreezeTransfersParams
    • TogglePauseRequirementsParams
    • TokenCaaRole
    • TokenDocument
    • TokenIdentifier
    • TokenOwnerRole
    • TokenPiaRole
    • TransferBreakdown
    • TransferPolyxParams
    • TransferRestriction
    • TransferRestrictionInputBase
    • TransferRestrictionResult
    • TransferTickerOwnershipParams
    • TransferTokenOwnershipParams
    • TrustedClaimIssuer
    • UiKeyring
    • UniqueIdentifiers
    • VenueDetails
    • VenueOwnerRole
Powered by GitBook
On this page
  • Hierarchy
  • Index
  • Properties
  • Methods
  • Properties
  • address
  • authorizations
  • Protected context
  • key
  • uuid
  • Methods
  • getBalance
  • getIdentity
  • getPermissions
  • getTransactionHistory
  • hasPermissions
  • isEqual
  • isFrozen
  • leaveIdentity
  • Static generateUuid
  • Static unserialize

Was this helpful?

  1. Classes

CurrentAccount

PreviousCountNextCurrentIdentity

Last updated 3 years ago

Was this helpful?

Represents the current account that is bound to the SDK instance

Hierarchy

↳

↳ CurrentAccount

Index

Properties

Methods

Properties

address

• address: string

Polymesh-specific address of the account. Serves as an identifier

authorizations

Protected context

key

• key: string

public key of the account. This is a hex representation of the address that is transversal to any Substrate chain

uuid

• uuid: string

Methods

getBalance

Get the free/locked POLYX balance of the account

note can be subscribed to

Parameters:

Name

Type

callback

getIdentity

Retrieve the current Identity (null if there is none)

getPermissions

Retrieve the Permissions this Signer has as a Signing Key for its corresponding Identity

getTransactionHistory

Retrieve a list of transactions signed by this account. Can be filtered using parameters

note uses the middleware

Parameters:

â–ªDefault value filters: object= {}

Name

Type

Description

blockNumber?

BigNumber

-

orderBy?

TransactionOrderByInput

-

size?

undefined | number

page size

start?

undefined | number

page offset

success?

undefined | false | true

whether the transaction was successful or not

tag?

TxTag

tag associated with the transaction

hasPermissions

Check if this Account possesses certain Permissions for its corresponding Identity

Parameters:

Name

Type

permissions

Returns: Promise‹boolean›

isEqual

Whether this Entity is the same as another one

Parameters:

Name

Type

entity

Returns: boolean

isFrozen

▸ isFrozen(): Promise‹boolean›

Check whether this Account is frozen. If frozen, it cannot perform any action until the primary key of the Identity unfreezes all secondary keys

Returns: Promise‹boolean›

leaveIdentity

Leave the current Identity. This operation can only be done if this Account is a secondary key for the Identity

Parameters:

Name

Type

args

void

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

Inherited from .

Defined in

• authorizations: ‹›

Inherited from .

Defined in

• context:

Inherited from .

Defined in

Inherited from .

Defined in

Inherited from .

Defined in

▸ getBalance(): Promise‹›

Inherited from .

Defined in

Returns: Promise‹›

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

Inherited from .

Defined in

‹›

Returns: Promise‹›

▸ getIdentity(): Promise‹ | null›

Overrides .

Defined in

Returns: Promise‹ | null›

▸ getPermissions(): Promise‹›

Defined in

Returns: Promise‹›

▸ getTransactionHistory(filters: object): Promise‹‹››

Inherited from .

Defined in

Returns: Promise‹‹››

▸ hasPermissions(permissions: ): Promise‹boolean›

Defined in

▸ isEqual(entity: ‹unknown›): boolean

Inherited from .

Defined in

‹unknown›

Inherited from .

Defined in

▸ leaveIdentity(args: void): Promise‹‹void››

Defined in

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

Returns: Promise‹‹void››

Inherited from .

Defined in

Inherited from .

Defined in

src/api/entities/Account.ts:45
Authorizations
Account
src/api/entities/Account.ts:53
Context
src/api/entities/Entity.ts:48
src/api/entities/Account.ts:50
src/api/entities/Entity.ts:46
src/api/entities/Account.ts:75
src/api/entities/Account.ts:76
CurrentIdentity
src/api/entities/CurrentAccount.ts:43
CurrentIdentity
Permissions
src/api/entities/CurrentAccount.ts:52
Permissions
ResultSet
ExtrinsicData
src/api/entities/Account.ts:126
ResultSet
ExtrinsicData
PermissionsLike
src/api/entities/CurrentAccount.ts:80
Entity
src/api/entities/Entity.ts:61
src/api/entities/Account.ts:211
TransactionQueue
src/api/entities/CurrentAccount.ts:36
ProcedureMethod
TransactionQueue
src/api/entities/Entity.ts:14
src/api/entities/Entity.ts:23
Account
address
authorizations
context
key
uuid
getBalance
getIdentity
getPermissions
getTransactionHistory
hasPermissions
isEqual
isFrozen
leaveIdentity
generateUuid
unserialize
PermissionsLike
Entity
CheckpointSchedule
context
CheckpointSchedule
uuid
CheckpointSchedule
isEqual
CheckpointSchedule
generateUuid
CheckpointSchedule
unserialize
Account
Account
Account
Account
Account
Account
Account
Account
address
authorizations
key
getBalance
getBalance
getIdentity
getTransactionHistory
isFrozen
AccountBalance
AccountBalance
SubCallback
AccountBalance
UnsubCallback
UnsubCallback
SubCallback
AccountBalance