https://github.com/convex-dev/convex
Convex Main Repository - Decentralised platform for the Internet of Value
https://github.com/convex-dev/convex
blockchain cryptocurrency database gaming java lisp metaverse
Last synced: about 2 months ago
JSON representation
Convex Main Repository - Decentralised platform for the Internet of Value
- Host: GitHub
- URL: https://github.com/convex-dev/convex
- Owner: Convex-Dev
- License: other
- Created: 2020-07-15T04:15:52.000Z (about 5 years ago)
- Default Branch: develop
- Last Pushed: 2024-04-19T16:00:49.000Z (over 1 year ago)
- Last Synced: 2024-04-19T16:14:10.766Z (over 1 year ago)
- Topics: blockchain, cryptocurrency, database, gaming, java, lisp, metaverse
- Language: Java
- Homepage: https://convex.world
- Size: 18 MB
- Stars: 83
- Watchers: 7
- Forks: 27
- Open Issues: 131
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Convex
[](https://search.maven.org/search?q=world.convex)
Convex is a decentralised network and execution engine for the Internet of Value. It can be seen as an implementation of a "Stateful Internet" where the network itself securely hosts and executes code and data.
It is designed as a full stack solution for decentralised applications and programmable economic systems that manage digital assets, where asset ownership is cryptographically secured and can be managed (optionally) with Smart Contracts.
Convex is based on Lattice Technology, exploiting the mathematical properties of lattices to achieve efficient consensus and verifiability. Lattice technology can be used to solve problems in a similar manner to blockchains, but offers some significant advantages:
- Global State model with immutable data structures and atomic transactions
- Lambda Calculus based VM supporting Turing complete Smart Contracts
- High transaction throughput (tens of thousands of write transactions per second, potentially scaling to millions in the future)
- Simple networking protocol based on random gossip
- Low latency for transaction confirmation (milliseconds for global consensus, depending on network speed)
- 100% Green - energy efficiency using the Convergent Proof of Stake consensus algorithm
- Integrated on-chain compiler (Convex Lisp)
## About this repository
This repository contains the core Convex distribution including:
- The Convex Virtual Machine (CVM) including data structures and execution environment
- The standard Convex Peer server implementation (NIO based) implementing Convergent Proof of Stake (CPoS) for consensus
- CLI Tools for operating Peers, scripting transactions and more
- The Etch database for persistent data storage
- A Swing GUI for managing local peers / exploring the network
- A simple REST API server
- JMH Benchmarking suite
- Java Client API
The repository also contains core "on-chain" libraries providing key full-stack functionality and tools for decentralised applications, including:
- `convex.fungible` - Fungible Tokens
- `asset.nft.simple` - Basic lightweight Non-fungible tokens
- `convex.asset` - library for managing arbitrary digital assets using a common abstraction
- `convex.trust` - library for access control and trusted operations
- `torus.exchange` - decentralised exchange for trading fungible tokens and currencies
- Example code and templates for various forms of smart contracts
## Modules
| Name | Description | Maven | Javadoc |
| ----- | ----------- | ----- | ------- |
| [convex-core](https://github.com/Convex-Dev/convex/tree/develop/convex-core/) | CVM, data structures and consensus | [](https://search.maven.org/search?q=world.convex) | [](https://javadoc.io/doc/world.convex/convex-core) |
| [convex-peer](https://github.com/Convex-Dev/convex/tree/develop/convex-peer/) | Peer implementation and networking | [](https://search.maven.org/search?q=world.convex) | [](https://javadoc.io/doc/world.convex/convex-peer) |
| [convex-cli](https://github.com/Convex-Dev/convex/tree/develop/convex-cli/) | Command Line Tools | [](https://search.maven.org/search?q=world.convex) | [](https://javadoc.io/doc/world.convex/convex-cli) |
| [convex-gui](https://github.com/Convex-Dev/convex/tree/develop/convex-gui/) | Convex Desktop GUI Interface | [](https://search.maven.org/search?q=world.convex) | [](https://javadoc.io/doc/world.convex/convex-gui) |
For local use of Convex data structures and CVM execution, `convex-core` is typically sufficient. To run a peer or communicate with one over the network, include `convex-peer` as a dependency. Other modules are designed primarily as standalone applications or client libraries.
## Key features
* *Convex Virtual Machine (CVM)* - Secure, Lambda Calculus-based environment for smart contracts and autonomous agents.
* *Decentralised Consensus* - Tamper-proof and censorship-resistant via Convergent Proof of Stake (CPoS).
* *Performance and Scalability* - Processes tens of thousands (and sometimes up to millions) of transactions per second with sub-second global consensus.
* *Eco-Friendly* - Minimal energy consumption with CPoS, ensuring a sustainable platform.
## Running Convex
### Pre-requisities
- Java JDK 21+ (for running Convex and related tools)
- Maven 3.7+ (for building Convex from source)
- git (for source control / contributing)
### Download
Recent development snapshot builds of `convex.jar` are made available here:
- [Snapshots](https://drive.google.com/drive/folders/1AZdyuZOmC70i_TtuEW3uEKvjYLOqIMiv?usp=drive_link)
### Building locally
To get a local development build of Convex you need [git](https://git-scm.com/) and [Apache Maven](https://maven.apache.org/). You will also need a recent version of Java ([JDK 21+ recommended](https://www.oracle.com/java/technologies/downloads/).
1. Clone [this repository](https://github.com/Convex-Dev/convex) using `git` - you probably want the `develop` branch (the default)
2. Build using `mvn install` in the root directory
This should download all necessary dependencies and perform a standard build.
### Running Convex Desktop
Convex Desktop is a GUI application for power users and developers providing full access to the capabilities of Convex. To run, you will need a modern version of Java installed (21+) and the `convex.jar` executable file (which can be found in the outputs of the Maven build above, or downloaded from trusted sources).
If Java is correctly installed, you should be able to double-click the executable `convex.jar` file to run it. Depending on your security settings, you may need to grant approval for this to run.
Alternatively, run Convex Desktop using `java` at the command line as follows:
```bash
java -jar convex.jar desktop
```
### Running the Convex Command Line Interface (CLI)
If you have an already built version of the Convex CLI `convex.jar` file and installed a recent version of Java you can run it as follows:
```bash
java -jar convex.jar
```
For convenience, there are shell scripts to automate this for common platforms in the root directory of this repo, e.g.
```bash
./convex --help
```
Using the CLI, you can start the Convex Desktop GUI for a local peer test network by using the `local gui` command:
```
./convex local gui
```
## Contributing
Contributions are welcome under the Convex Public License. Contributors retain copyright but must accept the license terms. A Contributors Agreement is required for all submissions to the core repository.
The Convex Foundation may award Convex Coins to contributors for significant ecosystem contributions. These native utility tokens enable network service access and may be exchangeable for other digital assets.
## Community
We use Discord as for discussing Convex - you can join the public server at [https://discord.gg/5j2mPsk](https://discord.gg/5j2mPsk)
Alternatively, email: info(at)convex.world
## Copyright
Copyright 2017-2025 The Convex Foundation and Contributors
Unless otherwise specified, source code is available under the terms of the [Convex
Public License](LICENSE.md)