This monorepo hosts a variety of applications and libraries written in Clojure providing access to all aspects of the Convex network with additional capabilities à la carte.
Since some key aspects of Convex have been modeled on Clojure constructs. Hence, there is no surprise in realizing that both form a unique and perfect match. Even without having any interest in blockchain, it is still worth exploring features offered by this repository such as the immutable Etch database.
Released applications and libraries:
Project | Library | Cljdoc | Download |
---|---|---|---|
:project/crypto | / | ||
:project/cvm | / | ||
:project/dapp | / | ||
:project/db | / | ||
:project/net | / | ||
:project/run | CVX runner |
Overview of main folders in the ./project directory:
Project | Purpose |
---|---|
:project/app.fuzz | CLI multicore fuzzy tester, generates and tests random Convex Lisp forms |
:project/break | Advanced generative test suite for the CVM ; novel smart contract testing |
:project/crypto | Key pair creation and management for digital signing |
:project/cvm | Convex types, reading Convex Lisp code, execution |
:project/dapp | Bundle of useful libraries for building decentralized applications |
:project/db | Create and handle immutable Etch databases crafted for Convex types |
:project/net | Convex network stack (running peers and using the binary client) |
:project/recipe | Recipes for understanding Convex and writing dApps |
:project/run | Convex Lisp Runner and REPL, advanced terminal environment |
Most of the time, using :project/dapp
is what you look for. It bundles useful libraries from this repository for the purpose of writing high-performance dApps (decentralized applications).
For learning, it is best starting with :project/recipe
. This collection of examples showcases how to write efficient dApps, step-by-step, while learning more about
the Convex network.
We use Discord as the primary means for discussing Convex - you can join the public server at https://discord.gg/5j2mPsk
Alternatively, email the core maintainer of this repository: adam(at)convex.world
More information about the Convex network: https://convex.world/
Each project follows a predictable structure:
./src
directory of each project or subprojectclj
, cvx
) and then by purpose (eg. main
, test
)The following conventions are enforced in READMEs and source files:
convex
into $
: convex.cvm
-> $.cvm
+
at the end: items
-> item+
More information about maintenance and organization can be found in this file.
Copyright © 2021 Adam Helinski, the Convex Foundation, and contributors
Licensed under the Apache License, Version 2.0
Can you improve this documentation? These fine people already did:
Adam Helinski & Adam HelinsEdit on GitHub
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close