vlayer monorepo

May 29, 2024 · View on GitHub

This monorepo contains two sub-projects:

ethereum - Noir library for proving and verifying historical data on the Ethereum blockchain and other EVM compatible blockchains. It supports proving accounts, storage, logs, receipts & transactions. Read more.
vlayer - Contains vlayer SDK along with real life examples. It's a work in progress and lacks documentation. Stay tuned for updates.

Prerequisites

nargo and foundry must be installed in order to compile and test code in this repository.

Getting started

Installing dependencies

Run yarn to install dependencies.

Running checks

To run all static checks (eslint, prettier, typecheck) type:

yarn check

To run checks individually use:

yarn lint:all - to run eslint on the whole repo
yarn format:all - to run prettier on the whole repo
yarn typecheck:all - to run typescript checks on the whole repo

CI workflows

We use Github actions to run tests on CI. For a detailed description of what does each workflow do consult Workflow Docs

DISCLAIMER

The code in this repo is in active development and subject to breaking changes. Use at your own risk. No responsibility is assumed for any potential issues arising from its use.