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 |
|
Returns: Promise‹UnsubCallback›
getIdentity
▸ getIdentity(): Promise‹CurrentIdentity | null›
Overrides Account.getIdentity
Defined in src/api/entities/CurrentAccount.ts:43
Retrieve the current Identity (null if there is none)
Returns: Promise‹CurrentIdentity | null›
getPermissions
▸ getPermissions(): Promise‹Permissions›
Defined in src/api/entities/CurrentAccount.ts:52
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 |
| BigNumber | - |
| TransactionOrderByInput | - |
| undefined | number | page size |
| undefined | number | page offset |
| undefined | false | true | whether the transaction was successful or not |
| TxTag | tag associated with the transaction |
Returns: Promise‹ResultSet‹ExtrinsicData››
hasPermissions
▸ hasPermissions(permissions: PermissionsLike): Promise‹boolean›
Defined in src/api/entities/CurrentAccount.ts:80
Check if this Account possesses certain Permissions for its corresponding Identity
Parameters:
Name | Type |
|
Returns: Promise‹boolean›
isEqual
▸ isEqual(entity: Entity‹unknown›): 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‹unknown› |
Returns: boolean
isFrozen
▸ isFrozen(): Promise‹boolean›
Inherited from Account.isFrozen
Defined in src/api/entities/Account.ts:211
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
▸ leaveIdentity(args: void): Promise‹TransactionQueue‹void››
Defined in src/api/entities/CurrentAccount.ts:36
Leave the current Identity. This operation can only be done if this Account is a secondary key for the Identity
note this method is of type ProcedureMethod, which means you can call leaveIdentity.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Parameters:
Name | Type |
| void |
Returns: Promise‹TransactionQueue‹void››
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
Parameters:
Name | Type | Description |
| 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
Parameters:
Name | Type | Description |
| string | UUID to unserialize |
Returns: Identifiers
Last updated