@zkoracle/opennautilus-contracts NPM

OpenNautilus | contracts

Develop	Berkeley
	🔥🔥🔥

OpenNautilus Contracts is an open-source library designed to empower developers building smart contracts for zero-knowledge applications (zkApps).

It provides a set of tools and abstractions that simplify the development process, enabling you to focus on the core logic of your zkApp without getting bogged down in low-level complexities.

Overview

Installation

npm i @zkoracle/opennuatilus-contracts --save

Usage

Building the Project

Use the following command to build the project:

npm run build

Running Tests

Execute the following commands to run tests:

npm run test
npm run testw # watch mode

Documentation & Code Coverage

To run a code coverage report:

npm run docs
npm run coverage

Local Setup

Here's how to set up the project locally:

npm link --global

cd <project>
npm link --global @zkoracle/opennautilus-contracts

Learn More

TBD

Security

TBD

Contribute

OpenNautilus Contracts exists thanks to its contributors. There are many ways you can participate and help build high quality software. Check out the contribution guide!