-
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
- getNextAssetId
- getOffChainReceipts
- getPendingProposals
- getPermissions
- getPolyxTransactions
- getTransactionHistory
- getTypeInfo
- isEqual
- isFrozen
- toHuman
- generateUuid
- unserialize
• address: string
Polymesh-specific address of the Account. Serves as an identifier
api/entities/Account/index.ts:88
• authorizations: Authorizations<Account>
api/entities/Account/index.ts:97
• 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:94
• subsidies: Subsidies
api/entities/Account/index.ts:98
• 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
api/entities/Account/index.ts:367
▸ exists(): Promise<boolean>
Determine whether this Account exists on chain
Promise<boolean>
api/entities/Account/index.ts:450
▸ getBalance(): Promise<Balance>
Get the free/locked POLYX balance of the Account
Promise<Balance>
Note
can be subscribed to, if connected to node using a web socket
api/entities/Account/index.ts:121
▸ getBalance(callback): Promise<UnsubCallback>
| Name | Type |
|---|---|
callback |
SubCallback<Balance> |
Promise<UnsubCallback>
api/entities/Account/index.ts:122
▸ getCurrentNonce(): Promise<BigNumber>
Retrieve the current nonce for this Account
Promise<BigNumber>
api/entities/Account/index.ts:464
▸ getIdentity(): Promise<null | Identity>
Retrieve the Identity associated to this Account (null if there is none)
Promise<null | Identity>
api/entities/Account/index.ts:141
▸ 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>
api/entities/Account/index.ts:422
▸ getNextAssetId(): Promise<string>
Returns next assetID that will be generated for this Identity
Promise<string>
api/entities/Account/index.ts:609
▸ getOffChainReceipts(): Promise<BigNumber[]>
Returns all off chain receipts used by this Account
Promise<BigNumber[]>
api/entities/Account/index.ts:582
▸ getPendingProposals(): Promise<MultiSigProposal[]>
Returns pending MultiSig proposals for this Account
Promise<MultiSigProposal[]>
Note
uses the middleware
Throws
if the Account is not a signer on any MultiSig
api/entities/Account/index.ts:566
▸ getPermissions(): Promise<Permissions>
Retrieve the Permissions this Account has as a Permissioned Account for its corresponding Identity
Promise<Permissions>
Throws
if there is no Identity associated with the Account
api/entities/Account/index.ts:314
▸ getPolyxTransactions(filters): Promise<ResultSet<HistoricPolyxTransaction>>
Returns POLYX transactions associated with this account
| Name | Type | Description |
|---|---|---|
filters |
Object |
- |
filters.size? |
BigNumber |
page size |
filters.start? |
BigNumber |
page offset |
Promise<ResultSet<HistoricPolyxTransaction>>
Note
uses the middleware
api/entities/Account/index.ts:548
▸ getTransactionHistory(filters?): Promise<ResultSet<ExtrinsicData>>
Retrieve a list of transactions signed by this Account. Can be filtered using parameters
| 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>>
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
api/entities/Account/index.ts:177
▸ getTypeInfo(): Promise<AccountTypeInfo>
Retrieve the type of Account, and its relation to an Identity, if applicable
Promise<AccountTypeInfo>
api/entities/Account/index.ts:485
▸ 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
Promise<boolean>
Note
returns false if the Account isn't associated to any Identity
api/entities/Account/index.ts:293
▸ toHuman(): string
Return the Account's address
string
api/entities/Account/index.ts:457
▸ 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
- Types