Skip to content

DEV_README.md

Latest commit

 

History

History
104 lines (68 loc) · 2.47 KB

DEV_README.md

File metadata and controls

104 lines (68 loc) · 2.47 KB

zkVerifyJS Setup

Pre-Requisities

  1. Node 18+
ls-engines // Get minimum node version required for project based on dependencies.
ls-engines --save// Get minimum node version required for project based on dependencies and SAVE it to the package.json.
  1. SEED_PHRASE="your seed phrase..." entered into a .env file with your own seed phrase.
SEED_PHRASE="MY SEED PHRASE WORDS GO HERE"

Fresh Install

  1. Build & install zkverifyjs pack, install dependencies
npm install && npm run pack-and-install

Install Package Locally

  1. Deploy the package with latest code
npm run pack-and-install
  1. Install the tgz in frontend project, renaming the tgz in the command below as necessary
npm install ./path-to-package/zkverifyjs-0.2.0.tgz

Add New Proof Types

  1. Update src/config/index.ts
  2. Add a new proof to src/proofTypes including processor and formatter, and add export to src/proofTypes/index.ts
  3. Adding new SEED_PHRASE_* environment variables will provide more throughput for tests if they are locked waiting for one to become available from the WalletPool
  • Search for ADD_NEW_PROOF_TYPE in the codebase.

Add New Supported Network

If we want to add a new configured network (e.g. mainnet)

  1. Update src/config/index.ts
  • Search for ADD_NEW_SUPPORTED_NETWORK in the codebase.

Local GitHub Actions with Act

Environment

  • Copy the .env.template into .env file and set the required values.

Build & Test

act workflow_dispatch -j build-and-test -P ubuntu-latest=ghcr.io/catthehacker/ubuntu:act-latest --network host

Publish Package

act workflow_dispatch -j build-and-publish -P ubuntu-latest=ghcr.io/catthehacker/ubuntu:act-latest --network host

Run Tests

  • Run a specific test
npx jest tests/verify.test.ts
  • Run all tests
npm run test

Test Coverage

  • Run coverage for a specific file
npm run test:file:coverage src/api/connection
  • Run coverage for entire project
npm run test:coverage

DOCS.md

The DOCS.md file gets generated from the README file onpre-commit automatically with husky, utilizing the ci/generateDocsReadme.js script. Do not edit DOCS.md directly. It will get overwritten.

This file is copied over and used in the zkVerify docs. See: https://github.com/HorizenLabs/zkverify-docs/blob/main/scripts/github_readme.js