Fetch ZK Config Provider

ZK configuration provider that retrieves proving keys, verifier keys, and ZK intermediate representation over HTTP/HTTPS. Designed for browser environments.

Installation

yarn add @midnight-ntwrk/midnight-js-fetch-zk-config-provider

Quick Start

import { FetchZkConfigProvider } from '@midnight-ntwrk/midnight-js-fetch-zk-config-provider';

const zkConfigProvider = new FetchZkConfigProvider('https://example.com/zk-artifacts');

const proverKey = await zkConfigProvider.getProverKey('myCircuit');
const verifierKey = await zkConfigProvider.getVerifierKey('myCircuit');
const zkir = await zkConfigProvider.getZKIR('myCircuit');

Configuration

| Parameter | Required | Description | | ----------- | -------- | ----------------------------------------------------- | | baseURL | ✓ | Base URL for ZK artifact server (http:// or https://) | | fetchFunc | | Custom fetch function (defaults to cross-fetch) |

API

FetchZkConfigProvider

class FetchZkConfigProvider<K extends string> extends ZKConfigProvider<K> {
  constructor(baseURL: string, fetchFunc?: typeof fetch);

  getProverKey(circuitId: K): Promise<ProverKey>;
  getVerifierKey(circuitId: K): Promise<VerifierKey>;
  getZKIR(circuitId: K): Promise<ZKIR>;
}

Directory Structure

The provider expects the following URL structure on the server:

{baseURL}/
├── keys/
│   ├── {circuitId}.prover      # Prover key (binary)
│   └── {circuitId}.verifier    # Verifier key (binary)
└── zkir/
    └── {circuitId}.bzkir       # ZK intermediate representation (binary)

Exports

import { FetchZkConfigProvider } from '@midnight-ntwrk/midnight-js-fetch-zk-config-provider';

Resources

• Midnight Network
• Developer Hub

Terms & License

By using this package, you agree to Midnight's Terms and Conditions and Privacy Policy.

Licensed under Apache License 2.0.