Class SparseMerkleProof

Merkle proof CircuitValue for an element in a SparseMerkleTree.

SparseMerkleProof

Hierarchy

{
root: Field;
sideNodes: Field[];
}
- SparseMerkleProof

Index

Constructors

constructor

new SparseMerkleProof(value): SparseMerkleProof
Parameters
- value: {
  root: Field;
  sideNodes: Field[];
  }
  - root: Field
  - sideNodes: Field[]
Returns SparseMerkleProof
Inherited from Struct({ sideNodes: Provable.Array(Field, SMT_DEPTH), root: Field, }).constructor
- Defined in node_modules/.store/o1js@1.2.0/node_modules/o1js/dist/node/lib/provable/types/struct.d.ts:100

Properties

root

root: Field = Field

sideNodes

sideNodes: Field[] = ...

`Static` _isStruct

_isStruct: true

`Static` check

check: ((value) => void)

Add assertions to the proof to check if value is a valid member of type T. This function does not return anything, instead it creates any number of assertions to prove that value is a valid member of the type T.

For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0.

Type declaration

- (value): void
- Parameters
  - value: {
    root: Field;
    sideNodes: Field[];
    }
    the element of type T to put assertions on.
    - root: Field
    - sideNodes: Field[]
  Returns void

`Static` empty

empty: (() => {
root: Field;
sideNodes: Field[];
})

Type declaration

- (): {
  root: Field;
  sideNodes: Field[];
  }
- Returns {
  root: Field;
  sideNodes: Field[];
  }
  - root: Field
  - sideNodes: Field[]

`Static` fromFields

fromFields: ((fields) => {
root: Field;
sideNodes: Field[];
})

Type declaration

- (fields): {
  root: Field;
  sideNodes: Field[];
  }
- Parameters
  - fields: Field[]
  Returns {
  root: Field;
  sideNodes: Field[];
  }
  - root: Field
  - sideNodes: Field[]

`Static` fromJSON

fromJSON: ((x) => {
root: Field;
sideNodes: Field[];
})

Type declaration

- (x): {
  root: Field;
  sideNodes: Field[];
  }
- Parameters
  - x: {
    root: string;
    sideNodes: string[];
    }
    - root: string
    - sideNodes: string[]
  Returns {
  root: Field;
  sideNodes: Field[];
  }
  - root: Field
  - sideNodes: Field[]

`Static` fromValue

fromValue: ((x) => {
    root: Field;
    sideNodes: Field[];
}) & ((value) => {
    root: Field;
    sideNodes: Field[];
})

Convert provable type from a normal JS type.

Type declaration

- (x): {
  root: Field;
  sideNodes: Field[];
  }
- Parameters
  - x: {
        root: Field;
        sideNodes: Field[];
    } | {
        root: bigint;
        sideNodes: bigint[];
    }
  Returns {
  root: Field;
  sideNodes: Field[];
  }
  - root: Field
  - sideNodes: Field[]

Type declaration

- (value): {
  root: Field;
  sideNodes: Field[];
  }
- Parameters
  - value: {
    root: string | number | bigint | Field;
    sideNodes: Field[] | bigint[];
    }
    - root: string | number | bigint | Field
    - sideNodes: Field[] | bigint[]
  Returns {
  root: Field;
  sideNodes: Field[];
  }
  - root: Field
  - sideNodes: Field[]

`Static` toAuxiliary

toAuxiliary: ((value?) => any[])

A function that takes value (optional), an element of type T, as argument and returns an array of any type that make up the "auxiliary" (non-provable) data of value.

Type declaration

- (value?): any[]
- Parameters
  - Optional value: {
    root: Field;
    sideNodes: Field[];
    }
    the element of type T to generate the auxiliary data array from, optional. If not provided, a default value for auxiliary data is returned.
    - root: Field
    - sideNodes: Field[]
  Returns any[]

Returns

An array of any type describing how this T element is made up of "auxiliary" (non-provable) data.

`Static` toFields

toFields: ((value) => Field[])

A function that takes value, an element of type T, as argument and returns an array of Field elements that make up the provable data of value.

Type declaration

- (value): Field[]
- Parameters
  - value: {
    root: Field;
    sideNodes: Field[];
    }
    the element of type T to generate the Field array from.
    - root: Field
    - sideNodes: Field[]
  Returns Field[]

Returns

A Field array describing how this T element is made up of Field elements.

`Static` toInput

toInput: ((x) => {
fields?: Field[];
packed?: [Field, number][];
})

Type declaration

- (x): {
  fields?: Field[];
  packed?: [Field, number][];
  }
- Parameters
  - x: {
    root: Field;
    sideNodes: Field[];
    }
    - root: Field
    - sideNodes: Field[]
  Returns {
  fields?: Field[];
  packed?: [Field, number][];
  }
  - Optional fields?: Field[]
  - Optional packed?: [Field, number][]

`Static` toJSON

toJSON: ((x) => {
root: string;
sideNodes: string[];
})

Type declaration

- (x): {
  root: string;
  sideNodes: string[];
  }
- Parameters
  - x: {
    root: Field;
    sideNodes: Field[];
    }
    - root: Field
    - sideNodes: Field[]
  Returns {
  root: string;
  sideNodes: string[];
  }
  - root: string
  - sideNodes: string[]

`Static` toValue

toValue: ((x) => {
root: bigint;
sideNodes: bigint[];
})

Convert provable type to a normal JS type.

Type declaration

- (x): {
  root: bigint;
  sideNodes: bigint[];
  }
- Parameters
  - x: {
    root: Field;
    sideNodes: Field[];
    }
    - root: Field
    - sideNodes: Field[]
  Returns {
  root: bigint;
  sideNodes: bigint[];
  }
  - root: bigint
  - sideNodes: bigint[]

Methods

`Static` sizeInFields

sizeInFields(): number
Return the size of the T type in terms of Field type, as Field is the primitive type.

Returns number
A number representing the size of the T type in terms of Field type.
Inherited from Struct({ sideNodes: Provable.Array(Field, SMT_DEPTH), root: Field, }).sizeInFields
- Defined in node_modules/.store/o1js@1.2.0/node_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51

Class SparseMerkleProof

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

root: Field

sideNodes: Field[]

Returns SparseMerkleProof

Properties

root

sideNodes

Static _isStruct

Static check

Type declaration

Parameters

root: Field

sideNodes: Field[]

Returns void

Static empty

Type declaration

Returns { root: Field; sideNodes: Field[]; }

root: Field

sideNodes: Field[]

Static fromFields

Type declaration

Parameters

Returns { root: Field; sideNodes: Field[]; }

root: Field

sideNodes: Field[]

Static fromJSON

Type declaration

Parameters

root: string

sideNodes: string[]

Returns { root: Field; sideNodes: Field[]; }

root: Field

sideNodes: Field[]

Static fromValue

Type declaration

Parameters

Returns { root: Field; sideNodes: Field[]; }

root: Field

sideNodes: Field[]

Type declaration

Parameters

root: string | number | bigint | Field

sideNodes: Field[] | bigint[]

Returns { root: Field; sideNodes: Field[]; }

root: Field

sideNodes: Field[]

Static toAuxiliary

Type declaration

Parameters

root: Field

sideNodes: Field[]

Returns any[]

Returns

Static toFields

Type declaration

Parameters

root: Field

sideNodes: Field[]

Returns Field[]

Returns

Static toInput

Type declaration

Parameters

root: Field

sideNodes: Field[]

Returns { fields?: Field[]; packed?: [Field, number][]; }

Optional fields?: Field[]

Optional packed?: [Field, number][]

Static toJSON

Type declaration

Parameters

root: Field

`Static` _isStruct

`Static` check

`Static` empty

Returns {
root: Field;
sideNodes: Field[];
}

`Static` fromFields

Returns {
root: Field;
sideNodes: Field[];
}

`Static` fromJSON

Returns {
root: Field;
sideNodes: Field[];
}

`Static` fromValue

Returns {
root: Field;
sideNodes: Field[];
}

Returns {
root: Field;
sideNodes: Field[];
}

`Static` toAuxiliary

`Static` toFields

`Static` toInput

Returns {
fields?: Field[];
packed?: [Field, number][];
}

`Optional` fields?: Field[]

`Optional` packed?: [Field, number][]

`Static` toJSON

Returns {
root: string;
sideNodes: string[];
}

`Static` toValue

Returns {
root: bigint;
sideNodes: bigint[];
}

`Static` sizeInFields