Convex Design
This repository is dedicated to Convex Design and Documentation
Key Documents
Current CADs
Convex Architecture Documents (CADs) are defined for standards relating to the Convex network and ecosystem, in a manner inspired by Internet RFCs.
| Code | Title | Status | Editor |
|---|---|---|---|
| CAD0 | Design principles | Active | mikera |
| CAD1 | Vision & Architecture | Active | mikera |
| CAD2 | CVM Values | Active | mikera |
| CAD3 | Encoding Format | Active | mikera |
| CAD4 | Account Model | Pending | mikera |
| CAD5 | CVM Execution | Initial | mikera |
| CAD6 | Memory Accounting | Active | mikera |
| CAD7 | Juice Accounting | Pending | mikera |
| CAD8 | Convex Lisp Compiler | Pending | mikera |
| CAD9 | Expanders and Macros | Pending | mikera |
| CAD10 | Transactions | Pending | mikera |
| CAD11 | Error Handling | Active | mikera |
| CAD12 | Numerics | Pending | mikera |
| CAD13 | Metadata | Initial | helins |
| CAD14 | CNS Registry | Pending | mikera |
| CAD15 | Peer Connection Protocol | Pending | mikera |
| CAD16 | Peer Staking | Pending | mikera |
| CAD17 | Peer Operations | Pending | mikera |
| CAD18 | Scheduler | Pending | mikera |
| CAD19 | Asset Model | Draft | mikera |
Convex Project Portfolio
We are undertaking a number of projects under the umbrella of the Convex-Dev organisation.
| Name | Description | Status | Lead Dev. |
|---|---|---|---|
| Convex | Main Convex distribution | Active | mikera |
| Convex Design | Architecture and design documents | Active | mikera |
| convex-web | Website and live sandbox (convex.world) | Active | pedrorgirardi |
| convexity | Mobile application and wallet | Active | pedrorgirardi |
| convex-api-py | Python REST client | Active | billbsing |
| convex-api-js | NodeJS REST client | Active | billbsing |
| convex-java | Java REST client | Active | mikera |
| convex.cljc | Clojure libraries, Convex Lisp Runner | Active | helins |
| Pending | LSP (Language Server Protocol) implementation | Pending | pedrorgirardi |
Contributing
Contributions to this repository are welcome. Contributors may clarify existing design documents, or propose new formal specification changes to Convex by opening issues.
For questions and broader discussions, please join the Convex Discord channel (https://discord.com/invite/xfYGq4CT7v).
It is recommended consulting the broader community first before preparing proposals or improvements that might otherwise be rejected.
License
Copyright 2021 Convex Foundation (UK) and contributors
Contributors retain copyright in their contributions, but agree that the Convex Foundation may freely distribute these contributions under any license of its choice.