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

Our software is currently undergoing a security audit. It's a process to identify potential vulnerabilities in the code.

Contribute

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

License

OpenNautilus Contracts is released under the terms of the Apache-2.0 License apply both to users and contributors, the latter of whom bear sole responsibility for their modifications.

This software is provided "as is", without any warranties, either express or implied. By using OpenNautilus Contracts, you're agreeing to our terms and accepting that we can't be held responsible for any damages. We don't collect personal data, and we fully respect user privacy.