​

primitives/BinaryTree

​

Classes

​

InvalidAddressLengthError

​

Example

throw new InvalidAddressLengthError(
  'Address must be 20 bytes',
  {
    value: addr.length,
    expected: '20 bytes',
    code: 'BINARY_TREE_INVALID_ADDRESS_LENGTH',
    docsPath: '/primitives/binary-tree/address-to-key#error-handling'
  }
)

​

Extends

• InvalidLengthError

​

Constructors

Constructor

new InvalidAddressLengthError(message?, options?): InvalidAddressLengthError

Parameters

message?

options?

cause?

code?

context?

docsPath?

expected?

value?

Returns

Overrides

​

Properties

cause?

optional cause: Error

Inherited from

code

code: string

Example

'INVALID_FORMAT', 'INVALID_LENGTH'

Inherited from

context?

optional context: Record<string, unknown>

Example

{ value: '0x123', expected: '20 bytes' }

Inherited from

docsPath?

optional docsPath: string

Example

'/primitives/address/from-hex#error-handling'

Inherited from

expected

expected: string

Inherited from

name

name: string

Inherited from

value

value: unknown

Inherited from

​

Methods

getErrorChain()

getErrorChain(): string

Returns

Inherited from

toJSON()

toJSON(): Record<string, unknown>

Returns

Inherited from

​

InvalidKeyLengthError

​

Example

throw new InvalidKeyLengthError(
  'Key must be 32 bytes',
  {
    value: key.length,
    expected: '32 bytes',
    code: 'BINARY_TREE_INVALID_KEY_LENGTH',
    docsPath: '/primitives/binary-tree/split-key#error-handling'
  }
)

​

Extends

• InvalidLengthError

​

Constructors

Constructor

new InvalidKeyLengthError(message?, options?): InvalidKeyLengthError

Parameters

message?

options?

cause?

code?

context?

docsPath?

expected?

value?

Returns

Overrides

​

Properties

cause?

optional cause: Error

Inherited from

code

code: string

Example

'INVALID_FORMAT', 'INVALID_LENGTH'

Inherited from

context?

optional context: Record<string, unknown>

Example

{ value: '0x123', expected: '20 bytes' }

Inherited from

docsPath?

optional docsPath: string

Example

'/primitives/address/from-hex#error-handling'

Inherited from

expected

expected: string

Inherited from

name

name: string

Inherited from

value

value: unknown

Inherited from

​

Methods

getErrorChain()

getErrorChain(): string

Returns

Inherited from

toJSON()

toJSON(): Record<string, unknown>

Returns

Inherited from

​

InvalidTreeStateError

​

Example

throw new InvalidTreeStateError(
  'Cannot insert into leaf node',
  {
    value: node.type,
    expected: 'empty, stem, or internal',
    code: 'BINARY_TREE_INVALID_STATE',
    docsPath: '/primitives/binary-tree/insert#error-handling'
  }
)

​

Extends

• ValidationError

​

Constructors

Constructor

new InvalidTreeStateError(message?, options?): InvalidTreeStateError

Parameters

message?

options?

cause?

code?

context?

docsPath?

expected?

value?

Returns

Overrides

​

Properties

cause?

optional cause: Error

Inherited from

code

code: string

Example

'INVALID_FORMAT', 'INVALID_LENGTH'

Inherited from

context?

optional context: Record<string, unknown>

Example

{ value: '0x123', expected: '20 bytes' }

Inherited from

docsPath?

optional docsPath: string

Example

'/primitives/address/from-hex#error-handling'

Inherited from

expected

expected: string

Inherited from

name

name: string

Inherited from

value

value: unknown

Inherited from

​

Methods

getErrorChain()

getErrorChain(): string

Returns

Inherited from

toJSON()

toJSON(): Record<string, unknown>

Returns

Inherited from

​

Interfaces

​

AccountData

• Version (1 byte)
• Code size (3 bytes)
• Nonce (8 bytes)
• Balance (16 bytes)

​

Properties

balance

readonly balance: bigint

codeSize

readonly codeSize: number

nonce

readonly nonce: bigint

version

readonly version: number

​

BinaryTreeType

​

See

​

Properties

root

readonly root: Node

​

Type Aliases

​

EmptyNode

EmptyNode = Extract<Node, { type: "empty"; }>

​

InternalNode

InternalNode = Extract<Node, { type: "internal"; }>

​

LeafNode

LeafNode = Extract<Node, { type: "leaf"; }>

​

Node

Node = { type: "empty"; } | { left: Uint8Array; right: Uint8Array; type: "internal"; } | { stem: Uint8Array; type: "stem"; values: (Uint8Array | null)[]; } | { type: "leaf"; value: Uint8Array; }

​

StemNode

StemNode = Extract<Node, { type: "stem"; }>

​

Variables

​

addressToKey()

const addressToKey: (address) => Uint8Array = _addressToKey

​

Parameters

address

​

Returns

​

BinaryTree

const BinaryTree: object

​

Type Declaration

addressToKey()

addressToKey: (address) => Uint8Array

Parameters

address

Returns

get()

get: (tree, key) => Uint8Array<ArrayBufferLike> | null

Parameters

tree

key

Returns

getStemBit()

getStemBit: (stem, index) => 0 | 1

Parameters

stem

index

Returns

hashInternal()

hashInternal: (l, r) => Uint8Array

Parameters

l

r

Returns

hashLeaf()

hashLeaf: (node) => Uint8Array

Parameters

node

type

value

Returns

hashNode()

hashNode: (node) => Uint8Array

Parameters

node

Returns

hashStem()

hashStem: (node) => Uint8Array

Parameters

node

stem

type

values

Returns

init()

init: () => BinaryTreeType

Returns

insert()

insert: (tree, key, value) => BinaryTreeType

Parameters

tree

key

value

Returns

rootHash()

rootHash: (tree) => Uint8Array

Parameters

tree

Returns

rootHashHex()

rootHashHex: (tree) => HexType

Parameters

tree

Returns

splitKey()

splitKey: (key) => object

Parameters

key

Returns

idx

idx: number

stem

stem: Uint8Array

​

get()

const get: (tree, key) => Uint8Array | null = _get

​

Parameters

tree

key

​

Returns

​

getStemBit()

const getStemBit: (stem, index) => 0 | 1 = _getStemBit

​

Parameters

stem

index

​

Returns

​

hashInternal()

const hashInternal: (l, r) => Uint8Array

​

Parameters

l

r

​

Returns

​

HashInternal()

const HashInternal: (deps) => (l, r) => Uint8Array = _HashInternal

​

Parameters

deps

​

Returns

(l, r): Uint8Array

Parameters

l

r

Returns

​

hashLeaf()

const hashLeaf: (node) => Uint8Array

​

Parameters

node

​

Returns

​

HashLeaf()

const HashLeaf: (deps) => (node) => Uint8Array = _HashLeaf

​

Parameters

deps

​

Returns

(node): Uint8Array

Parameters

node

Returns

​

hashNode()

const hashNode: (node) => Uint8Array

​

Parameters

node

​

Returns

​

HashNode()

const HashNode: (deps) => (node) => Uint8Array = _HashNode

​

Parameters

deps

​

Returns

(node): Uint8Array

Parameters

node

Returns

​

hashStem()

const hashStem: (node) => Uint8Array

​

Parameters

node

​

Returns

​

HashStem()

const HashStem: (deps) => (node) => Uint8Array = _HashStem

​

Parameters

deps

​

Returns

(node): Uint8Array

Parameters

node

Returns

​

init()

const init: () => BinaryTreeType = _init

​

Returns

​

insert()

const insert: (tree, key, value) => BinaryTreeType

​

Parameters

tree

key

value

​

Returns

​

rootHash()

const rootHash: (tree) => Uint8Array = _rootHash

​

Parameters

tree

​

Returns

​

rootHashHex()

const rootHashHex: (tree) => HexType = _rootHashHex

​

Parameters

tree

​

Returns

​

splitKey()

const splitKey: (key) => object = _splitKey

​

Parameters

key

​

Returns

idx

idx: number

stem

stem: Uint8Array