Skip to content

Latest commit

 

History

History
85 lines (60 loc) · 4.11 KB

README.md

File metadata and controls

85 lines (60 loc) · 4.11 KB

License: GPL v3 CI Codecov vkey check

Elusiv

Scaling privacy with Zero-knowledge proofs and MPC on the Solana blockchain.

Programs

This repository contains a collection of on-chain programs:

The addresses for the on-chain programs are located in (and linked at compilation from) Id.toml.

Supported tokens

All tokens (SOL and SPL-tokens) supported by the Elusiv on-chain programs are located in (and linked at compilation from) Token.toml. On-chain price data is provided through the Pyth oracle network.

Development

Please ensure that you have Rust and the Solana tool suite installed on your local machine.

Building

The build crate allows for accessible building and testing of any program in this repository. Build a program library with:

$ sh build.sh build --cluster <mainnet|devnet> --target <program-name>

Testing

This library comes with comprehensive unit and integration tests for each of the provided crates. Execute the tests with:

$ sh build.sh test --test-kind <unit|integration|...> --target <program-name>

Using Docker

Testing can be performed in a Docker container using ./docker_test.sh. Running this will result in the creation of an elusiv-dev Docker image as well as a few cache volumes.

Program interaction

In order to easily interact with the program from a Rust client, import a program library with the elusiv-client feature enabled. This results in access to all instruction-generation functions located in each program-crate's instructions module.

When constructing instructions from other clients, serialize the instructions using Borsh.

Contribution

We welcome contributions and pull requests. Please check our contribution rules and code of conduct.

Security

To ensure that Elusiv is secure we did the following among other things:

  • independent security audit of the Elusiv on-chain program with OtterSec,
  • independent security audit of the associated Zero-knowledge-proof circuits with ABDK Consulting,
  • running the Sec3 X-Ray tool after any changes to the on-chain code,
  • open sourced the codebase together with our security policy.

Our goal is to make the Elusiv on-chain programs non-upgradeable as soon as possible.

License

This project is licensed under the terms of the GNU General Public License v3.0.

Disclaimer

This project is provided "AS IS", WITHOUT WARRANTIES OF ANY KIND, either express or implied. This project provides complex software that utilizes an advanced and experimental smart contract runtime.

We do not guarantee that the code in this project is error-free, complete, or up-to-date. Even with all measures taken to ensure its reliability, mistakes can still occur. We are not liable for any damages or losses that may result from your use of this project. Please use this project at your own risk.

We reserve the right to modify this disclaimer at any time.