CurrentAccount
Represents the current account that is bound to the SDK instance
Hierarchy
↳ Account
↳ CurrentAccount
Index
Properties
Methods
Properties
address
• address: string
Inherited from Account.address
Defined in src/api/entities/Account.ts:45
Polymesh-specific address of the account. Serves as an identifier
authorizations
• authorizations: Authorizations‹Account›
Inherited from Account.authorizations
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›
Inherited from Account.getBalance
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›
Inherited from Account.getBalance
Defined in src/api/entities/Account.ts:76
Parameters:
Name
Type
callback
Returns: Promise‹UnsubCallback›
getIdentity
▸ getIdentity(): Promise‹CurrentIdentity | null›
Overrides Account.getIdentity
Defined in src/api/entities/CurrentAccount.ts:18
Retrieve the current Identity (null if there is none)
Returns: Promise‹CurrentIdentity | null›
getPermissions
▸ getPermissions(): Promise‹Permissions›
Defined in src/api/entities/CurrentAccount.ts:27
Retrieve the Permissions this Signer has as a Signing Key for its corresponding Identity
Returns: Promise‹Permissions›
getTransactionHistory
▸ getTransactionHistory(filters: object): Promise‹ResultSet‹ExtrinsicData››
Inherited from Account.getTransactionHistory
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››
hasPermissions
▸ hasPermissions(permissions: PermissionsLike): Promise‹boolean›
Defined in src/api/entities/CurrentAccount.ts:55
Check if this Account possesses certain Permissions for its corresponding Identity
Parameters:
Name
Type
permissions
Returns: Promise‹boolean›
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