Class Account

Hierarchy (View Summary)

EllipticKey
- Account
  - HDWallet

Implements

AccountInstance

Index

Constructors

Properties

_node _previousHash? _addressMap _protectedConstructorKey previousHashStore uniqueName

Accessors

address addressBytes base58 bytes hex keccak256 length previousHash previousHashBytes private public

Methods

initialize loadPreviousHash sign verify verifyUniqueAddress create from fromPrivateKey is isAddress random

Constructors

`Protected`constructor

new Account(
    key: unknown,
    privateKey: PrivateKeyInstance,
    node?: HDNodeWallet,
): Account
Parameters
- key: unknown
- privateKey: PrivateKeyInstance
- Optionalnode: HDNodeWallet
Returns Account
Overrides EllipticKey.constructor
- Defined in packages/protocol/packages/account/dist/neutral/index.d.ts:60

Properties

`Protected`_node

_node: undefined | HDNodeWallet

`Protected` `Optional`_previousHash

_previousHash?: ArrayBufferLike

`Protected` `Static`_addressMap

_addressMap: Record<string, WeakRef<AccountInstance>>

`Protected` `Static`_protectedConstructorKey

_protectedConstructorKey: symbol

`Static`previousHashStore

previousHashStore: undefined | PreviousHashStore

`Static` `Readonly`uniqueName

uniqueName: string

Accessors

address

get address(): Lowercase<string>
Returns Lowercase<string>
Implementation of AccountInstance.address
- Defined in packages/protocol/packages/account/dist/neutral/index.d.ts:61

addressBytes

get addressBytes(): ArrayBufferLike
Returns ArrayBufferLike
Implementation of AccountInstance.addressBytes
- Defined in packages/protocol/packages/account/dist/neutral/index.d.ts:62

base58

get base58(): string
Returns string
Inherited from EllipticKey.base58
- Defined in packages/protocol/packages/core/packages/data/dist/neutral/index.d.ts:22

bytes

get bytes(): ArrayBuffer | SharedArrayBuffer
Returns ArrayBuffer | SharedArrayBuffer
Inherited from EllipticKey.bytes
- Defined in packages/protocol/packages/core/packages/data/dist/neutral/index.d.ts:23

hex

get hex(): Lowercase<string>
Returns Lowercase<string>
Inherited from EllipticKey.hex
- Defined in packages/protocol/packages/core/packages/data/dist/neutral/index.d.ts:24

keccak256

get keccak256(): ArrayBufferLike
Returns ArrayBufferLike
Inherited from EllipticKey.keccak256
- Defined in packages/protocol/packages/core/packages/data/dist/neutral/index.d.ts:25

length

get length(): number
Returns number
Inherited from EllipticKey.length
- Defined in packages/protocol/packages/core/packages/data/dist/neutral/index.d.ts:10

previousHash

get previousHash(): undefined | Lowercase<string>
Returns undefined | Lowercase<string>
Implementation of AccountInstance.previousHash
- Defined in packages/protocol/packages/account/dist/neutral/index.d.ts:63

previousHashBytes

get previousHashBytes(): undefined | ArrayBufferLike
Returns undefined | ArrayBufferLike
Implementation of AccountInstance.previousHashBytes
- Defined in packages/protocol/packages/account/dist/neutral/index.d.ts:64

private

get private(): PrivateKeyInstance
Returns PrivateKeyInstance
Implementation of AccountInstance.private
- Defined in packages/protocol/packages/account/dist/neutral/index.d.ts:65

public

get public(): PublicKeyInstance
Returns PublicKeyInstance
Implementation of AccountInstance.public
- Defined in packages/protocol/packages/account/dist/neutral/index.d.ts:66

Methods

initialize

initialize(): Promise<Account>
Returns Promise<Account>
- Defined in packages/protocol/packages/account/dist/neutral/index.d.ts:71

loadPreviousHash

loadPreviousHash(previousHash?: string | ArrayBufferLike): Promise<Account>
Parameters
- OptionalpreviousHash: string | ArrayBufferLike
Returns Promise<Account>
- Defined in packages/protocol/packages/account/dist/neutral/index.d.ts:72

sign

sign(
hash: ArrayBufferLike,
previousHash: undefined | ArrayBufferLike,
): Promise<[ArrayBufferLike, Lowercase<string>?]>
Parameters
- hash: ArrayBufferLike
- previousHash: undefined | ArrayBufferLike
Returns Promise<[ArrayBufferLike, Lowercase<string>?]>
Implementation of AccountInstance.sign
- Defined in packages/protocol/packages/account/dist/neutral/index.d.ts:73

verify

verify(msg: ArrayBufferLike, signature: ArrayBufferLike): Promise<boolean>
Parameters
- msg: ArrayBufferLike
- signature: ArrayBufferLike
Returns Promise<boolean>
Implementation of AccountInstance.verify
- Defined in packages/protocol/packages/account/dist/neutral/index.d.ts:74

verifyUniqueAddress

verifyUniqueAddress(): Account | AccountInstance
Returns Account | AccountInstance
- Defined in packages/protocol/packages/account/dist/neutral/index.d.ts:75

`Static`create

create(opts?: AccountConfig): Promise<AccountInstance>
Parameters
- Optionalopts: AccountConfig
Returns Promise<AccountInstance>
- Defined in packages/protocol/packages/account/dist/neutral/index.d.ts:67

`Static`from

from(data: undefined | ArrayBuffer): undefined | Data
Parameters
- data: undefined | ArrayBuffer
Returns undefined | Data
Inherited from EllipticKey.from
- Defined in packages/protocol/packages/core/packages/data/dist/neutral/index.d.ts:26

`Static`fromPrivateKey

fromPrivateKey(key: string | bigint | ArrayBufferLike): Promise<AccountInstance>
Parameters
- key: string | bigint | ArrayBufferLike
Returns Promise<AccountInstance>
- Defined in packages/protocol/packages/account/dist/neutral/index.d.ts:68

`Static`is

is(value: unknown): value is AbstractData
Parameters
- value: unknown
Returns value is AbstractData
Inherited from EllipticKey.is
- Defined in packages/protocol/packages/core/packages/data/dist/neutral/index.d.ts:15

`Static`isAddress

isAddress(address: Lowercase<string>): boolean
Parameters
- address: Lowercase<string>
Returns boolean
- Defined in packages/protocol/packages/account/dist/neutral/index.d.ts:69

`Static`random

random(): Promise<AccountInstance>
Returns Promise<AccountInstance>
- Defined in packages/protocol/packages/account/dist/neutral/index.d.ts:70