README.md

Panther Protocol: core repository

This repository contains the heart of the Panther Protocol code:

• contracts/ - smart contracts:
  • staking/ - contracts for classic and advanced staking
  • protocol/ - contracts for the MASP (Multi-Asset Shielded Pool)
  • common/ - shared utility contracts
• crypto/ - cryptography code
• dapp/ - the frontend web-based dApp interface
• subgraph/ - code for Panther's subgraph on The Graph

It does not include the zero knowledge circuits, although these will be published in the future.

At the time of writing, the repository contains the code for v0.5 of the MASP, which provides both advanced staking and the foundation (i.e. a significant part but not the entirety) of the future v1.0 release.

Development / testing / contributing

Please note: deployment of this code requires in-depth understanding of many technical topics including EVM chains, Solidity, Hardhat, React, TypeScript, The Graph, Zero Knowledge Proofs, and various other cryptographic techniques.

The development guide in docs/dev-guide.md explains how to deploy a test environment. This is currently work in progress.

Please see CONTRIBUTING.md and the below community links for how to contribute.

Community resources

Please see the Panther DAO documentation on Community and Other resources.

Licenses

Please see the top-level LICENSE, other LICENSE and LICENSE.info files, and license headers present in many of the files. If any files are not explicitly marked as licensed then it should be assumed that they are unlicensed, i.e. no rights are granted.