Skip to main content

NodeZkConfigProvider

Midnight.js API Reference v2.0.2

Midnight.js API Reference / @midnight-ntwrk/midnight-js-node-zk-config-provider / NodeZkConfigProvider

Class: NodeZkConfigProvider<K>

Implementation of ZKConfigProvider that reads the keys and zkIR from the local filesystem.

Extends​

Type Parameters​

K​

K extends string

The type of the circuit ID used by the provider.

Constructors​

Constructor​

new NodeZkConfigProvider<K>(directory): NodeZkConfigProvider<K>

Parameters​

directory​

string

The path to the base directory containing the key and ZKIR subdirectories.

Returns​

NodeZkConfigProvider<K>

Overrides​

ZKConfigProvider.constructor

Properties​

directory​

readonly directory: string

The path to the base directory containing the key and ZKIR subdirectories.

Methods​

get()​

get(circuitId): Promise<ZKConfig<K>>

Retrieves all zero-knowledge artifacts produced by compactc for the given circuit.

Parameters​

circuitId​

K

The circuit ID of the artifacts to retrieve.

Returns​

Promise<ZKConfig<K>>

Inherited from​

ZKConfigProvider.get

getProverKey()​

getProverKey(circuitId): Promise<ProverKey>

ZKConfigProvider.getProverKey

Parameters​

circuitId​

K

Returns​

Promise<ProverKey>

Overrides​

ZKConfigProvider.getProverKey

getVerifierKey()​

getVerifierKey(circuitId): Promise<VerifierKey>

ZKConfigProvider.getVerifierKey

Parameters​

circuitId​

K

Returns​

Promise<VerifierKey>

Overrides​

ZKConfigProvider.getVerifierKey

getVerifierKeys()​

getVerifierKeys(circuitIds): Promise<[K, VerifierKey][]>

Retrieves the verifier keys produced by compactc for the given circuits.

Parameters​

circuitIds​

K[]

The circuit IDs of the verifier keys to retrieve.

Returns​

Promise<[K, VerifierKey][]>

Inherited from​

ZKConfigProvider.getVerifierKeys

getZKIR()​

getZKIR(circuitId): Promise<ZKIR>

ZKConfigProvider.getZKIR

Parameters​

circuitId​

K

Returns​

Promise<ZKIR>

Overrides​

ZKConfigProvider.getZKIR