-
Notifications
You must be signed in to change notification settings - Fork 11
api.entities.Account.Account
api/entities/Account.Account
Represents an Account in the Polymesh blockchain. Accounts can hold POLYX, control Identities and vote on proposals (among other things)
- checkPermissions
- exists
- getBalance
- getCurrentNonce
- getIdentity
- getMultiSig
- getPermissions
- getPolyxTransactions
- getSubsidy
- getTransactionHistory
- getTypeInfo
- isEqual
- isFrozen
- toHuman
- generateUuid
- unserialize
• address: string
Polymesh-specific address of the Account. Serves as an identifier
api/entities/Account/index.ts:74
• authorizations: Authorizations<Account>
api/entities/Account/index.ts:83
• key: string
A hex representation of the cryptographic public key of the Account. This is consistent across Substrate chains, while the address depends on the chain as well.
api/entities/Account/index.ts:80
• subsidies: Subsidies
api/entities/Account/index.ts:84
• uuid: string
▸ checkPermissions(permissions): Promise<CheckPermissionsResult<Account>>
Check if this Account possesses certain Permissions to act on behalf of its corresponding Identity
| Name | Type |
|---|---|
permissions |
SimplePermissions |
Promise<CheckPermissionsResult<Account>>
which permissions the Account is missing (if any) and the final result
▸ exists(): Promise<boolean>
Determine whether this Account exists on chain
Promise<boolean>
▸ getBalance(): Promise<Balance>
Get the free/locked POLYX balance of the Account
Note
can be subscribed to
Promise<Balance>
▸ getBalance(callback): Promise<UnsubCallback>
| Name | Type |
|---|---|
callback |
SubCallback<Balance> |
Promise<UnsubCallback>
▸ getCurrentNonce(): Promise<BigNumber>
Retrieve the current nonce for this Account
Promise<BigNumber>
▸ getIdentity(): Promise<null | Identity>
Retrieve the Identity associated to this Account (null if there is none)
Promise<null | Identity>
▸ getMultiSig(): Promise<null | MultiSig>
Fetch the MultiSig this Account is part of. If this Account is not a signer on any MultiSig, return null
Promise<null | MultiSig>
▸ getPermissions(): Promise<Permissions>
Retrieve the Permissions this Account has as a Permissioned Account for its corresponding Identity
Throws
if there is no Identity associated with the Account
Promise<Permissions>
▸ getPolyxTransactions(filters): Promise<ResultSet<HistoricPolyxTransaction>>
Returns POLYX transactions associated with this account
Note
uses the middleware
| Name | Type | Description |
|---|---|---|
filters |
Object |
- |
filters.size? |
BigNumber |
page size |
filters.start? |
BigNumber |
page offset |
Promise<ResultSet<HistoricPolyxTransaction>>
▸ getSubsidy(): Promise<null | SubsidyWithAllowance>
Get the subsidized balance of this Account and the subsidizer Account. If this Account isn't being subsidized, return null
Note
can be subscribed to
Deprecated
in favour of subsidies.getSubsidizer
Promise<null | SubsidyWithAllowance>
▸ getSubsidy(callback): Promise<UnsubCallback>
| Name | Type |
|---|---|
callback |
SubCallback<null | SubsidyWithAllowance> |
Promise<UnsubCallback>
▸ getTransactionHistory(filters?): Promise<ResultSet<ExtrinsicData>>
Retrieve a list of transactions signed by this Account. Can be filtered using parameters
Note
if both blockNumber and blockHash are passed, only blockNumber is taken into account.
Also, for ordering by block_id, one should pass ExtrinsicsOrderBy.CreatedAtAsc or ExtrinsicsOrderBy.CreatedAtDesc
in order of their choice (since block ID is a string field in middleware v2)
Note
uses the middleware v2
| Name | Type | Description |
|---|---|---|
filters |
Object |
- |
filters.blockHash? |
string |
- |
filters.blockNumber? |
BigNumber |
- |
filters.orderBy? |
ExtrinsicsOrderBy |
- |
filters.size? |
BigNumber |
page size |
filters.start? |
BigNumber |
page offset |
filters.success? |
boolean |
whether the transaction was successful or not |
filters.tag? |
TxTag |
tag associated with the transaction |
Promise<ResultSet<ExtrinsicData>>
▸ getTypeInfo(): Promise<AccountTypeInfo>
Retrieve the type of Account, and its relation to an Identity, if applicable
Promise<AccountTypeInfo>
▸ isEqual(entity): boolean
Determine whether this Entity is the same as another one
| Name | Type |
|---|---|
entity |
Entity<unknown, unknown> |
boolean
▸ isFrozen(): Promise<boolean>
Check whether this Account is frozen. If frozen, it cannot perform any Identity related action until the primary Account of the Identity unfreezes all secondary Accounts
Note
returns false if the Account isn't associated to any Identity
Promise<boolean>
▸ toHuman(): string
Return the Account's address
string
▸ Static generateUuid<Identifiers>(identifiers): string
Generate the Entity's UUID from its identifying properties
| Name |
|---|
Identifiers |
| Name | Type |
|---|---|
identifiers |
Identifiers |
string
▸ Static unserialize<Identifiers>(serialized): Identifiers
Unserialize a UUID into its Unique Identifiers
| Name |
|---|
Identifiers |
| Name | Type | Description |
|---|---|---|
serialized |
string |
UUID to unserialize |
Identifiers
Entities
- Account
- Asset
- Authorization Request
- Checkpoint
- Checkpoint Schedule
- Corporate Action
- Corporate Action Base
- Custom Permission Group
- Default Portfolio
- Default Trusted Claim Issuer
- Dividend Distribution
- Entity
- Identity
- Instruction
- Known Permission Group
- Metadata Entry
- Multi Sig Proposal
- Numbered Portfolio
- Offering
- Permission Group
- Portfolio
- Subsidies
- Subsidy
- Ticker Reservation
- Venue
- Authorizations