name: AccountId
description: A wrapper around an AccountId/PublicKey representation. Since we are dealing with underlying PublicKeys (32 bytes in length), we extend from U8aFixed which is just a Uint8Array wrapper with a fixed length.
Hierarchy
↳ U8aFixed
↳ AccountId
Implements
Indexable
[index: number]: number
Constructors
constructor
⊕ new AccountId(value?: AnyU8a): AccountId
Overrides U8aFixed.constructor
Defined in AccountId.ts:19
Parameters:
| Name | Type | Default value |
|---|---|---|
Default value value |
AnyU8a | new Uint8Array() |
Returns: AccountId
Accessors
encodedLength
getencodedLength(): number
Inherited from U8a.encodedLength
Defined in codec/U8a.ts:36
description: The length of the value when encoded as a Uint8Array
Returns: number
isEmpty
getisEmpty(): boolean
Defined in AccountId.ts:46
description: Returns true if the type wraps an empty value
Returns: boolean
isInvalid
getisInvalid(): boolean
Defined in AccountId.ts:53
description: Returns true if the type wraps a non-valid value
Returns: boolean
length
getlength(): number
Overrides Uint8Array.length
Defined in codec/U8a.ts:43
description: The length of the value
Returns: number
Methods
bitLength
▸ bitLength(): number
Inherited from U8aFixed.bitLength
Defined in codec/U8aFixed.ts:39
description: Returns the number of bits in the value
Returns: number
subarray
▸ subarray(begin: number, end?: undefined | number): Uint8Array
Overrides Uint8Array.subarray
Defined in codec/U8a.ts:53
description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here
Parameters:
| Name | Type | Description | |
|---|---|---|---|
| begin | number |
The position to start at | |
Optional end |
undefined |
number |
The position to end at |
Returns: Uint8Array
toHex
▸ toHex(): string
Defined in codec/U8a.ts:60
description: Returns a hex string representation of the value
Returns: string
toJSON
▸ toJSON(): any
Implementation of Codec.toJSON
Defined in AccountId.ts:60
description: Converts the Object to JSON, typically used for RPC transfers
Returns: any
toString
▸ toString(): string
Implementation of Codec.toString
Defined in AccountId.ts:67
description: Returns the string representation of the value
Returns: string
toU8a
▸ toU8a(isBare?: undefined | false | true): Uint8Array
Defined in codec/U8a.ts:82
description: Encodes the value as a Uint8Array as per the parity-codec specifications
Parameters:
| Name | Type | Description | ||
|---|---|---|---|---|
Optional isBare |
undefined |
false |
true |
true when the value has none of the type-specific prefixes (internal) |
Returns: Uint8Array
<Static> encode
▸ encode(value: Uint8Array): string
Defined in AccountId.ts:27
Parameters:
| Name | Type |
|---|---|
| value | Uint8Array |
Returns: string