HttpZkConfigProvider

Defined in: src/ZkConfig.ts:360

HTTP-based ZK configuration provider class.

Wraps the module functions to provide compatibility with the midnight-js ZKConfigProvider interface.

Example

const zkConfig = new Midday.ZkConfig.HttpZkConfigProvider(
  'https://cdn.example.com/contracts/counter',
);
const contract = await client.loadContract({ module, zkConfig });

Since

0.2.0

Extends

• ZKConfigProvider<K>

Type Parameters

K

K extends string = string

Constructors

Constructor

new HttpZkConfigProvider<K>(baseUrl, fetchFn?): HttpZkConfigProvider<K>

Defined in: src/ZkConfig.ts:363

Parameters

baseUrl

string

fetchFn?

{(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Returns

HttpZkConfigProvider<K>

Overrides

ZKConfigProviderBase<K>.constructor

Properties

httpEffect

readonly httpEffect: object

Defined in: src/ZkConfig.ts:384

getProverKey()

getProverKey: (circuitId) => Effect<ProverKey, ZkConfigError, never>

Parameters

circuitId

K

Returns

Effect<ProverKey, ZkConfigError, never>

getVerifierKey()

getVerifierKey: (circuitId) => Effect<VerifierKey, ZkConfigError, never>

Parameters

circuitId

K

Returns

Effect<VerifierKey, ZkConfigError, never>

getZKIR()

getZKIR: (circuitId) => Effect<ZKIR, ZkConfigError, never>

Parameters

circuitId

K

Returns

Effect<ZKIR, ZkConfigError, never>

Methods

clearCache()

clearCache(circuitId?): void

Defined in: src/ZkConfig.ts:380

Parameters

circuitId?

K

Returns

void

---

getProverKey()

getProverKey(circuitId): Promise<ProverKey>

Defined in: src/ZkConfig.ts:372

Retrieves the prover key produced by compactc compiler for the given circuit.

Parameters

circuitId

K

The circuit ID of the prover key to retrieve.

Returns

Promise<ProverKey>

Overrides

ZKConfigProviderBase.getProverKey

---

getVerifierKey()

getVerifierKey(circuitId): Promise<VerifierKey>

Defined in: src/ZkConfig.ts:376

Retrieves the verifier key produced by compactc compiler for the given circuit.

Parameters

circuitId

K

The circuit ID of the verifier key to retrieve.

Returns

Promise<VerifierKey>

Overrides

ZKConfigProviderBase.getVerifierKey

---

getZKIR()

getZKIR(circuitId): Promise<ZKIR>

Defined in: src/ZkConfig.ts:368

Retrieves the zero-knowledge intermediate representation produced by compactc compiler for the given circuit.

Parameters

circuitId

K

The circuit ID of the ZKIR to retrieve.

Returns

Promise<ZKIR>

Overrides

ZKConfigProviderBase.getZKIR