Sapling V1 Contracts

Documentation

See docs.sapling.finance

Auto maintained API docs: saplingteam.github.io/contracts

Whitepaper: sapling.finance/whitepaper

Getting Started

Quickstart

1. Install Node v16, node version manager or NVM may be helpful.
2. Install packages: npm install
3. Setup .env file. Copy .env.example as .env: cp .env.example .env
4. Run tests: npm run test

Dependencies

• Node v16

Packages Installation

npm install

Environment Setup

cd into project directory and create .env by running the command below on *NIX systems, or by copying the file manually.

cp .env.example .env

Then update the values accordingly in .env

Basic Usage

• Run unit tests: npm run test
• Run unit tests with coverage report: npm run coverage

Deployment

See DEPLOYMENT for a sample guide. Plan and test production deployments on case by case basis.

Contributing

If you would like to contribute, join 👥-contributors channel on Sapling discord and tell us about how you'd like to help.

License

Sapling V1 contracts are under the MIT license.