Liking cljdoc? Tell your friends :D

Any aspect of the Convex stack

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:

ProjectLibraryCljdocDownload
:project/cryptoClojarscljdoc/
:project/cvmClojarscljdoc/
:project/dappClojarscljdoc/
:project/dbClojarscljdoc/
:project/netClojarscljdoc/
:project/runClojarscljdocCVX runner

Overview of main folders in the ./project directory:

ProjectPurpose
:project/app.fuzzCLI multicore fuzzy tester, generates and tests random Convex Lisp forms
:project/breakAdvanced generative test suite for the CVM ; novel smart contract testing
:project/cryptoKey pair creation and management for digital signing
:project/cvmConvex types, reading Convex Lisp code, execution
:project/dappBundle of useful libraries for building decentralized applications
:project/dbCreate and handle immutable Etch databases crafted for Convex types
:project/netConvex network stack (running peers and using the binary client)
:project/recipeRecipes for understanding Convex and writing dApps
:project/runConvex 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.

Community

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/

This repository

Each project follows a predictable structure:

  • Project details are exposed in a dedicated README
  • All source is located under the ./src directory of each project or subproject
  • Source is subdivided by language (eg. clj, cvx) and then by purpose (eg. main, test)
  • All scripts and tasks are located and executed at the root of this repository

The following conventions are enforced in READMEs and source files:

  • Namespaces shorten convex into $: convex.cvm -> $.cvm
  • Symbols referring to collections are pluralized with + at the end: items -> item+

More information about maintenance and organization can be found in this file.

License

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 Helins
Edit on GitHub

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close