api_entities_Account.Account
Last updated
Was this helpful?
Last updated
Was this helpful?
/ / / Account
.Account
Represents an Account in the Polymesh blockchain. Accounts can hold POLYX, control Identities and vote on proposals (among other things)
<, string
>
↳ Account
• address: string
Polymesh-specific address of the Account. Serves as an identifier
Defined in
Defined in
• 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.
Defined in
• uuid: string
Inherited from
Defined in
Check if this Account possesses certain Permissions to act on behalf of its corresponding Identity
Parameters
permissions
Returns
which permissions the Account is missing (if any) and the final result
Defined in
â–¸ exists(): Promise
<boolean
>
Determine whether this Account exists on chain
Returns
Promise
<boolean
>
Overrides
Defined in
Get the free/locked POLYX balance of the Account
note
can be subscribed to
Returns
Defined in
Parameters
callback
Returns
Defined in
Retrieve the Identity associated to this Account (null if there is none)
Returns
Defined in
Retrieve the Permissions this Account has as a Permissioned Account for its corresponding Identity
throws
if there is no Identity associated with the Account
Returns
Defined in
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
Returns
Defined in
Parameters
callback
Returns
Defined in
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
note
uses the middleware
Parameters
filters
Object
-
filters.blockHash?
string
-
filters.blockNumber?
BigNumber
-
filters.orderBy?
TransactionOrderByInput
-
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
Returns
Defined in
â–¸ hasPermissions(permissions
): Promise
<boolean
>
Check if this Account possesses certain Permissions to act on behalf of its corresponding Identity
deprecated
in favor of checkPermissions
Parameters
permissions
Returns
Promise
<boolean
>
Defined in
â–¸ isEqual(entity
): boolean
Determine whether this Entity is the same as another one
Parameters
entity
Returns
boolean
Inherited from
Defined in
â–¸ 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
Returns
Promise
<boolean
>
Defined in
â–¸ toHuman(): string
Return the Account's address
Returns
string
Overrides
Defined in
â–¸ Static
generateUuid<Identifiers
>(identifiers
): string
Generate the Entity's UUID from its identifying properties
Type parameters
Identifiers
Parameters
identifiers
Identifiers
Returns
string
Inherited from
Defined in
â–¸ Static
unserialize<Identifiers
>(serialized
): Identifiers
Unserialize a UUID into its Unique Identifiers
Type parameters
Identifiers
Parameters
serialized
string
UUID to unserialize
Returns
Identifiers
Inherited from
Defined in
• authorizations: <>
.
â–¸ checkPermissions(permissions
): Promise
<<>>
Promise
<<>>
.
â–¸ getBalance(): Promise
<>
Promise
<>
â–¸ getBalance(callback
): Promise
<>
<>
Promise
<>
â–¸ getIdentity(): Promise
<null
| >
Promise
<null
| >
â–¸ getPermissions(): Promise
<>
Promise
<>
â–¸ getSubsidy(): Promise
<null
| >
Promise
<null
| >
â–¸ getSubsidy(callback
): Promise
<>
<null
| >
Promise
<>
â–¸ getTransactionHistory(filters?
): Promise
<<>>
Promise
<<>>
<unknown
, unknown
>
.
.
.
.