Account
Represents an account in the Polymesh blockchain. Accounts can hold POLYX, control Identities and vote on proposals (among other things)
Hierarchy
Index
Properties
Methods
Properties
address
• address: string
Defined in src/api/entities/Account.ts:45
Polymesh-specific address of the account. Serves as an identifier
authorizations
• authorizations: Authorizations‹Account›
Defined in src/api/entities/Account.ts:53
Protected context
Protected context• context: Context
Inherited from CheckpointSchedule.context
Defined in src/api/entities/Entity.ts:48
key
• key: string
Defined in src/api/entities/Account.ts:50
public key of the account. This is a hex representation of the address that is transversal to any Substrate chain
uuid
• uuid: string
Inherited from CheckpointSchedule.uuid
Defined in src/api/entities/Entity.ts:46
Methods
getBalance
▸ getBalance(): Promise‹AccountBalance›
Defined in src/api/entities/Account.ts:75
Get the free/locked POLYX balance of the account
note can be subscribed to
Returns: Promise‹AccountBalance›
▸ getBalance(callback: SubCallback‹AccountBalance›): Promise‹UnsubCallback›
Defined in src/api/entities/Account.ts:76
Parameters:
Name
Type
callback
Returns: Promise‹UnsubCallback›
getIdentity
▸ getIdentity(): Promise‹Identity | null›
Defined in src/api/entities/Account.ts:94
Retrieve the Identity associated to this Account (null if there is none)
Returns: Promise‹Identity | null›
getTransactionHistory
▸ getTransactionHistory(filters: object): Promise‹ResultSet‹ExtrinsicData››
Defined in src/api/entities/Account.ts:126
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
Returns: Promise‹ResultSet‹ExtrinsicData››
isEqual
▸ isEqual(entity: Entity‹object›): boolean
Inherited from CheckpointSchedule.isEqual
Defined in src/api/entities/Entity.ts:61
Whether this Entity is the same as another one
Parameters:
Name
Type
entity
Returns: boolean
Static generateUuid
Static generateUuid▸ generateUuid‹Identifiers›(identifiers: Identifiers): string
Inherited from CheckpointSchedule.generateUuid
Defined in src/api/entities/Entity.ts:14
Generate the Entity's UUID from its identifying properties
Type parameters:
▪ Identifiers: object
Parameters:
Name
Type
Description
identifiers
Identifiers
Returns: string
Static unserialize
Static unserialize▸ unserialize‹Identifiers›(serialized: string): Identifiers
Inherited from CheckpointSchedule.unserialize
Defined in src/api/entities/Entity.ts:23
Unserialize a UUID into its Unique Identifiers
Type parameters:
▪ Identifiers: object
Parameters:
Name
Type
Description
serialized
string
UUID to unserialize
Returns: Identifiers
Last updated