Class Base

Hierarchy

Base
- MerkleTree

Index

Constructors

constructor

new Base(): Base
Returns Base

Methods

bigNumberify

bigNumberify(value: any): BigInt
Parameters
- value: any
Returns BigInt
- Defined in node_modules/.pnpm/merkletreejs@0.3.9/node_modules/merkletreejs/dist/Base.d.ts:93

binarySearch

binarySearch(array: Buffer[], element: Buffer, compareFunction: ((a: unknown, b: unknown) => number)): number
binarySearch

Desc
Returns the first index of which given item is found in array using binary search.

Returns
- Index number
Example
```
const index = tree.binarySearch(array, element, Buffer.compare)
```
Parameters
- array: Buffer[]
  
  Array of items.
- element: Buffer
  
  Item to find.
- compareFunction: ((a: unknown, b: unknown) => number)
  - - (a: unknown, b: unknown): number
    - Parameters
      
      a: unknown
      
      b: unknown
      
      Returns number
Returns number
- Defined in node_modules/.pnpm/merkletreejs@0.3.9/node_modules/merkletreejs/dist/Base.d.ts:52

`Protected` bufferIndexOf

bufferIndexOf(array: Buffer[], element: Buffer, isSorted?: boolean): number
bufferIndexOf

Desc
Returns the first index of which given buffer is found in array.

Returns
- Index number
Example
```
const index = tree.bufferIndexOf(haystack, needle)
```
Parameters
- array: Buffer[]
- element: Buffer
- Optional isSorted: boolean
Returns number
- Defined in node_modules/.pnpm/merkletreejs@0.3.9/node_modules/merkletreejs/dist/Base.d.ts:24

bufferToHex

bufferToHex(value: Buffer, withPrefix?: boolean): string
bufferToHex

Desc
Returns a hex string with 0x prefix for given buffer.

Returns

Example
```
const hexStr = tree.bufferToHex(Buffer.from('A'))
```
Parameters
- value: Buffer
- Optional withPrefix: boolean
Returns string
- Defined in node_modules/.pnpm/merkletreejs@0.3.9/node_modules/merkletreejs/dist/Base.d.ts:128

bufferify

bufferify(value: any): Buffer
bufferify

Desc
Returns a buffer type for the given value.

Returns

Example
```
const buf = tree.bufferify('0x1234')
```
Parameters
- value: any
Returns Buffer
- Defined in node_modules/.pnpm/merkletreejs@0.3.9/node_modules/merkletreejs/dist/Base.d.ts:151

bufferifyFn

bufferifyFn(f: any): any
bufferifyFn

Desc
Returns a function that will bufferify the return value.

Returns

Example
```
const fn = tree.bufferifyFn((value) => sha256(value))
```
Parameters
- f: any
Returns any
- Defined in node_modules/.pnpm/merkletreejs@0.3.9/node_modules/merkletreejs/dist/Base.d.ts:163

`Protected` isHexString

isHexString(value: string): boolean
isHexString

Desc
Returns true if value is a hex string.

Returns

Example
```
console.log(MerkleTree.isHexString('0x1234'))
```
Parameters
- value: string
Returns boolean
- Defined in node_modules/.pnpm/merkletreejs@0.3.9/node_modules/merkletreejs/dist/Base.d.ts:175

linearSearch

linearSearch(array: Buffer[], element: Buffer, eqChecker: ((a: unknown, b: unknown) => boolean)): number
linearSearch

Desc
Returns the first index of which given item is found in array using linear search.

Returns
- Index number
Example
```
const index = tree.linearSearch(array, element, (a, b) => a === b)
```
Parameters
- array: Buffer[]
  
  Array of items.
- element: Buffer
  
  Item to find.
- eqChecker: ((a: unknown, b: unknown) => boolean)
  - - (a: unknown, b: unknown): boolean
    - Parameters
      
      a: unknown
      
      b: unknown
      
      Returns boolean
Returns number
- Defined in node_modules/.pnpm/merkletreejs@0.3.9/node_modules/merkletreejs/dist/Base.d.ts:80

`Protected` log2

log2(n: number): number
log2

Desc
Returns the log2 of number.

Returns
Parameters
- n: number
Returns number
- Defined in node_modules/.pnpm/merkletreejs@0.3.9/node_modules/merkletreejs/dist/Base.d.ts:182

print

print(): void
print

Desc
Prints out a visual representation of the merkle tree.

Example
```
tree.print()
```
Returns void
- Defined in node_modules/.pnpm/merkletreejs@0.3.9/node_modules/merkletreejs/dist/Base.d.ts:11

`Protected` zip

zip(a: any[], b: any[]): any[][]
zip

Desc
Returns true if value is a hex string.

Returns

Example
```
const zipped = tree.zip(['a', 'b'],['A', 'B'])
console.log(zipped) // [ [ 'a', 'A' ], [ 'b', 'B' ] ]
```
Parameters
- a: any[]
  
  first array
- b: any[]
  
  second array
Returns any[][]
- Defined in node_modules/.pnpm/merkletreejs@0.3.9/node_modules/merkletreejs/dist/Base.d.ts:196

`Static` bigNumberify

bigNumberify(value: any): BigInt
Parameters
- value: any
Returns BigInt
- Defined in node_modules/.pnpm/merkletreejs@0.3.9/node_modules/merkletreejs/dist/Base.d.ts:94

`Static` binarySearch

binarySearch(array: Buffer[], element: Buffer, compareFunction: ((a: unknown, b: unknown) => number)): number
binarySearch

Desc
Returns the first index of which given item is found in array using binary search.

Returns
- Index number
Example
```
const index = MerkleTree.binarySearch(array, element, Buffer.compare)
```
Parameters
- array: Buffer[]
  
  Array of items.
- element: Buffer
  
  Item to find.
- compareFunction: ((a: unknown, b: unknown) => number)
  - - (a: unknown, b: unknown): number
    - Parameters
      
      a: unknown
      
      b: unknown
      
      Returns number
Returns number
- Defined in node_modules/.pnpm/merkletreejs@0.3.9/node_modules/merkletreejs/dist/Base.d.ts:38

`Static` bufferToHex

bufferToHex(value: Buffer, withPrefix?: boolean): string
bufferToHex

Desc
Returns a hex string with 0x prefix for given buffer.

Returns

Example
```
const hexStr = MerkleTree.bufferToHex(Buffer.from('A'))
```
Parameters
- value: Buffer
- Optional withPrefix: boolean
Returns string
- Defined in node_modules/.pnpm/merkletreejs@0.3.9/node_modules/merkletreejs/dist/Base.d.ts:139

`Static` bufferify

bufferify(value: any): Buffer
bufferify

Desc
Returns a buffer type for the given value.

Returns

Example
```
const buf = MerkleTree.bufferify('0x1234')
```
Parameters
- value: any
Returns Buffer
- Defined in node_modules/.pnpm/merkletreejs@0.3.9/node_modules/merkletreejs/dist/Base.d.ts:92

`Static` hexZeroPad

hexZeroPad(hexStr: string, length: number): string
Parameters
- hexStr: string
- length: number
Returns string
- Defined in node_modules/.pnpm/merkletreejs@0.3.9/node_modules/merkletreejs/dist/Base.d.ts:197

`Static` isHexString

isHexString(v: string): boolean
isHexString

Desc
Returns true if value is a hex string.

Returns

Example
```
console.log(MerkleTree.isHexString('0x1234'))
```
Parameters
- v: string
Returns boolean
- Defined in node_modules/.pnpm/merkletreejs@0.3.9/node_modules/merkletreejs/dist/Base.d.ts:106

`Static` linearSearch

linearSearch(array: Buffer[], element: Buffer, eqChecker: ((a: unknown, b: unknown) => boolean)): number
linearSearch

Desc
Returns the first index of which given item is found in array using linear search.

Returns
- Index number
Example
```
const index = MerkleTree.linearSearch(array, element, (a, b) => a === b)
```
Parameters
- array: Buffer[]
  
  Array of items.
- element: Buffer
  
  Item to find.
- eqChecker: ((a: unknown, b: unknown) => boolean)
  - - (a: unknown, b: unknown): boolean
    - Parameters
      
      a: unknown
      
      b: unknown
      
      Returns boolean
Returns number
- Defined in node_modules/.pnpm/merkletreejs@0.3.9/node_modules/merkletreejs/dist/Base.d.ts:66

`Static` print

print(tree: any): void
print

Desc
Prints out a visual representation of the given merkle tree.

Returns

Example
```
MerkleTree.print(tree)
```
Parameters
- tree: any
  
  Merkle tree instance.
Returns void
- Defined in node_modules/.pnpm/merkletreejs@0.3.9/node_modules/merkletreejs/dist/Base.d.ts:117

Class Base

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns Base

Methods

bigNumberify

Parameters

value: any

Returns BigInt

binarySearch

Desc

Returns

Example

Parameters

array: Buffer[]

element: Buffer

compareFunction: ((a: unknown, b: unknown) => number)

Parameters

a: unknown

b: unknown

Returns number

Returns number

Protected bufferIndexOf

Desc

Returns

Example

Parameters

array: Buffer[]

element: Buffer

Optional isSorted: boolean

Returns number

bufferToHex

Desc

Returns

Example

Parameters

value: Buffer

Optional withPrefix: boolean

Returns string

bufferify

Desc

Returns

Example

Parameters

value: any

Returns Buffer

bufferifyFn

Desc

Returns

Example

Parameters

f: any

Returns any

Protected isHexString

Desc

Returns

Example

Parameters

value: string

Returns boolean

linearSearch

Desc

Returns

Example

Parameters

array: Buffer[]

element: Buffer

eqChecker: ((a: unknown, b: unknown) => boolean)

Parameters

a: unknown

b: unknown

Returns boolean

Returns number

Protected log2

Desc

Returns

`Protected` bufferIndexOf

`Optional` isSorted: boolean

`Optional` withPrefix: boolean

`Protected` isHexString

`Protected` log2

`Protected` zip

`Static` bigNumberify

`Static` binarySearch

`Static` bufferToHex

`Optional` withPrefix: boolean

`Static` bufferify

`Static` hexZeroPad

`Static` isHexString

`Static` linearSearch