Polymesh SDK API Reference
v2.0.0
v2.0.0
  • Introduction
  • Globals
  • Classes
    • Account
    • AuthorizationRequest
    • Authorizations
    • Claims
    • Compliance
    • Context
    • CurrentAccount
    • CurrentIdentity
    • DefaultPortfolio
    • Documents
    • Entity
    • Identity
    • IdentityAuthorizations
    • Instruction
    • Issuance
    • Middleware
    • NumberedPortfolio
    • Polymesh
    • PolymeshError
    • PolymeshTransaction
    • Portfolio
    • Portfolios
    • Requirements
    • SecurityToken
    • Settlements
    • TickerReservation
    • TokenHolders
    • TransactionQueue
    • TrustedClaimIssuer
    • TrustedClaimIssuers
    • Venue
  • Enums
    • AuthorizationStatus
    • AuthorizationType
    • ClaimType
    • ConditionTarget
    • ConditionType
    • CountryCode
    • ErrorCode
    • InstructionStatus
    • InstructionType
    • KnownTokenType
    • Permission
    • ProposalStage
    • RoleType
    • ScopeType
    • TickerReservationStatus
    • TokenIdentifierType
    • TransactionArgumentType
    • TransactionQueueStatus
    • TransactionStatus
    • TransferStatus
    • VenueType
  • Interfaces
    • AccountBalance
    • AccountData
    • AddClaimItem
    • AddClaimsParams
    • AddInstructionParams
    • AddTransactionOpts
    • ArrayTransactionArgument
    • CddProviderRole
    • ClaimData
    • ClaimScope
    • ClaimTarget
    • ComplexTransactionArgument
    • ConditionCompliance
    • ConnectParamsBase
    • ConstructorParams
    • ConsumeParams
    • CreateSecurityTokenParams
    • CreateVenueParams
    • DeletePortfolioParams
    • EditClaimsParams
    • EventIdentifier
    • ExtrinsicData
    • Fees
    • IdentityBalance
    • IdentityWithClaims
    • InstructionAuthorization
    • InviteAccountParams
    • IssueTokensParams
    • KeyringPair
    • Leg
    • MiddlewareConfig
    • ModifyInstructionAuthorizationParams
    • ModifyPrimaryIssuanceAgentParams
    • ModifyTokenTrustedClaimIssuersParams
    • MoveFundsParams
    • NetworkProperties
    • PaginationOptions
    • PlainTransactionArgument
    • PortfolioBalance
    • PortfolioCustodianRole
    • PortfolioMovement
    • ProposalDetails
    • ProposalTimeFrames
    • ProposalVote
    • RegisterIdentityParams
    • RemoveSecondaryKeysParams
    • RenamePortfolioParams
    • Requirement
    • RequirementCompliance
    • ReserveTickerParams
    • ResultSet
    • RevokeClaimsParams
    • Scope
    • SecondaryKey
    • SecurityTokenDetails
    • SetAssetRequirementsParams
    • SetCustodianParams
    • SetTokenDocumentsParams
    • SimpleEnumTransactionArgument
    • TickerOwnerRole
    • TickerReservationDetails
    • ToggleFreezeTransfersParams
    • TogglePauseRequirementsParams
    • TokenDocument
    • TokenHolderOptions
    • TokenHolderProperties
    • TokenIdentifier
    • TokenOwnerRole
    • TransferPolyXParams
    • TransferTokenOwnershipParams
    • UiKeyring
    • UniqueIdentifiers
    • VenueDetails
    • VenueOwnerRole
Powered by GitBook
On this page
  • Hierarchy
  • Index
  • Properties
  • Methods
  • Properties
  • address
  • authorizations
  • Protected context
  • key
  • uuid
  • Methods
  • getBalance
  • getIdentity
  • getTransactionHistory
  • Static generateUuid
  • Static unserialize

Was this helpful?

  1. Classes

Account

PreviousClassesNextAuthorizationRequest

Last updated 4 years ago

Was this helpful?

Represents an account in the Polymesh blockchain. Accounts can hold POLYX, control Identities and vote on proposals (among other things)

Hierarchy

  • ‹UniqueIdentifiers›

    ↳ Account

    ↳

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 Identity associated to this Account (null if there is none)

getTransactionHistory

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

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

Static generateUuid

▸ generateUuid‹Identifiers›(identifiers: Identifiers): string

Generate the Entity's UUID from its identifying properties

Type parameters:

â–ª Identifiers: object

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: object

Parameters:

Name

Type

Description

serialized

string

UUID to unserialize

Returns: Identifiers

Defined in

• authorizations: ‹›

Defined in

• context:

Inherited from .

Defined in

Defined in

Inherited from .

Defined in

▸ getBalance(): Promise‹›

Defined in

Returns: Promise‹›

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

Defined in

‹›

Returns: Promise‹›

▸ getIdentity(): Promise‹ | null›

Defined in

Returns: Promise‹ | null›

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

Defined in

Returns: Promise‹‹››

Inherited from .

Defined in

Inherited from .

Defined in

src/api/entities/Account.ts:47
Authorizations
Account
src/api/entities/Account.ts:55
Context
src/api/entities/Entity.ts:48
src/api/entities/Account.ts:52
src/api/entities/Entity.ts:46
AccountBalance
src/api/entities/Account.ts:75
AccountBalance
src/api/entities/Account.ts:76
Identity
src/api/entities/Account.ts:94
Identity
ResultSet
ExtrinsicData
src/api/entities/Account.ts:125
ResultSet
ExtrinsicData
src/api/entities/Entity.ts:14
src/api/entities/Entity.ts:23
Entity
CurrentAccount
address
authorizations
context
key
uuid
getBalance
getIdentity
getTransactionHistory
generateUuid
unserialize
Entity
Entity
AccountBalance
Entity
Entity
AccountBalance
context
uuid
generateUuid
unserialize
SubCallback
UnsubCallback
UnsubCallback
SubCallback