Intro | Audits | Setup | Tasks | Architecture | Domain Model | State Machines | Sequences
Done or in progress are:
- ✅ Developer environment configuration
- ✅ Developer setup and tasks documentation
- ✅ Role-based access controller contract, with tests
- ✅ High level architecture documentation
- ✅ Proxied voucher contract
- ✅ Protocol Diamond contract, libs, and facets, with tests
- ✅ Shared domain model for contracts (minimal)
- ✅ Domain model expressed in JS, with tests
- ✅ Shared script modules for use in deployment and testing
- ✅ Github Actions for CI
- ✅ Support for EIP-712 meta-transactions
- ✅ Protocol facet contracts and interfaces
- ✅ Remediated audits
- ✅ Generated contract documentation
- Audits - See the results of our latest security audits
- Setup - Get going quickly on your local system
- Tasks - Build, test, analyse, and deploy
- Architecture - Start with the big picture
- Domain Model - Entities and their relationships
- State Machines - State Machines in the Core Exchange Mechanism
- Sequences - Timeline of the simplest exchange
- Examples - Enhancing the capabilities of the protocol with external contracts
- Contributing - Guidelines for contributing to this repo
- License - License information
We welcome contributions! Until now, Boson Protocol has been largely worked on by a small dedicated team. However, the ultimate goal is for all of the Boson Protocol repositories to be fully owned by the community and contributors. Issues, pull requests, suggestions, and any sort of involvement are more than welcome.
If you have noticed a bug, please report it via our Bug Bounty program.
Questions and feedback are always welcome, we will use them to improve our offering.
All PRs must pass all tests before being merged.
By being in this community, you agree to the Code of Conduct. Take a look at it, if you haven't already.
Before starting to contribute, please check out Local development guide.
Licensed under GPL-v3.