Added Quilibrium Space to Community Section

This commit is contained in:
0xOzgur 2024-06-07 22:43:47 +00:00
parent 14e39d9f0a
commit bacd0250ec

View File

@ -1,31 +1,40 @@
# Quilibrium - Aurora
# Quilibrium - Betelgeuse
Quilibrium is a decentralized alternative to platform as a service providers.
This release, mirrored to GitHub, is the Dawn release, which contains the
initial application, the MPC Powers-of-Tau Ceremony. Documentation for the
This release is part of the phases of the Dusk release, which finalizes with
the full permissionless mainnet in version 2.0. Documentation for the
underlying technology can be found at https://www.quilibrium.com/
## Quick Start
All commands are to be run in the `node/` folder.
Running production nodes from source is no longer recommended given build complexity. Please refer to our release information to obtain the latest version.
If you have a voucher from the offline ceremony, first run:
## Running From Source
GOEXPERIMENT=arenas go run ./... -import-priv-key `cat /path/to/voucher.hex`
Builds are now a hybrid of Rust and Go, so you will need both go 1.22 and latest Rust + Cargo.
If you do not, or have already run the above, run:
### VDF
GOEXPERIMENT=arenas go run ./...
The VDF implementation is now in Rust, and requires GMP to build. On Mac, you can install GMP with brew (`brew install gmp`). On Linux, you will need to find the appropriate package for your distro.
## Peer ID
Install the go plugin for uniffi-rs:
In order to find the peer id of a running node, execute the following command from the `node/` folder:
cargo install uniffi-bindgen-go --git https://github.com/NordSecurity/uniffi-bindgen-go --tag v0.2.1+v0.25.0
GOEXPERIMENT=arenas go run ./... -peer-id
Be sure to follow the PATH export given by the installer.
The peer id will be printed to stdout.
Build the Rust VDF implementation by navigating to the vdf folder, and run `./generate.sh`.
## EXPERIMENTAL gRPC/REST Support
### Node
Because of the Rust interop, be sure you follow the above steps for the VDF before proceeding to this. Navigate to the node folder, and run (making sure to update the path for the repo):
CGO_LDFLAGS="-L/path/to/ceremonyclient/target/release -lvdf -ldl -lm" \
CGO_ENABLED=1 \
GOEXPERIMENT=arenas \
go run ./... --signature-check=false
## gRPC/REST Support
If you want to enable gRPC/REST, add the following entries to your config.yml:
@ -40,61 +49,24 @@ access via firewall or only query via localhost.
In order to query the token balance of a running node, execute the following command from the `node/` folder:
GOEXPERIMENT=arenas go run ./... -balance
./node-$version-$platform -balance
The confirmed token balance will be printed to stdout in QUILs.
The accumulated token balance will be printed to stdout in QUILs.
Note that this feature requires that [gRPC support](#experimental--grpcrest-support) is enabled.
## Stats Collection
In order to opt-in to stats collection about the health of the network, edit your `config.yml` in the `node/.config` directory to have a new section under `engine`:
```yml
<earlier parts of config>
engine:
statsMultiaddr: "/dns/stats.quilibrium.com/tcp/443"
<rest of config continues below>
```
## Purpose
The ceremony application provides a secure reference string (SRS) from which
KZG proofs can be constructed for the network. This yields applicability for a
number of proof systems, in particular for the release after Dawn, the ability
to provide proofs of execution, and proofs of data availability for the network.
### Rewards
For participating in a round of the ceremony, nodes will be allocated:
reward = 161 * log_2(participant_count) QUIL
### Basic Flow
Rounds of the ceremony follow the following order:
- OPEN: Nodes can join in for the round, deferring preference to nodes that
could not join in on the prior round
- IN PROGRESS: The MPC ceremony round is in progress, nodes are engaging in a
logarithmic collection of Multiplication-to-Add Oblivious Transfer circuits,
each sub round producing a new collection of values, until the sub rounds have
completed, producing a collection of public G1 and G2 BLS48-581 points for each
peer.
- FINALIZING: The collection of points are broadcasted, and added together,
producing a singular ceremony transcript contribution.
- VALIDATING: The updated ceremony transcript is validated against the
predecessor, and is confirmed to be the new state, issuing rewards to the
participant set. The next round can begin.
Note that this feature requires that [gRPC support](#grpcrest-support) is enabled.
## Community Section
This section contains community-built clients, applications, guides, etc <br /><br />
<b>Disclaimer</b>: Because some of these may contain external links, do note that these are unofficial every dependency added imparts risk, so if another project's github account were compromised, for example, it could lead people down a dangerous or costly path. Proceed with caution as always and refer to reliable members of the community for verification of links before clicking or connecting your wallets
### 1. The Q Guide - Beginners Guide
### 1. Quilibrium Space
- A detailed beginners' guide for how to setup a Quilibrium Node, created by [@demipoet](https://www.github.com/demipoet) - [link](https://quilibrium.guide/)<br/>
- A comprehensive documentation with handful tools for node management, created by [@0xOzgur](https://github.com/0xOzgur) - [Quilibrium Space](https://quilibrium.space/)<br/>
### 2. The Q Guide - Beginners Guide
- A detailed beginners' guide for how to setup a Quilibrium Node, created by [@demipoet](https://www.github.com/demipoet) - [Quilibrium Guide](https://quilibrium.guide/)<br/>
## Pull Requests
@ -108,15 +80,6 @@ impossible to achieve otherwise
- Error wrapping matching function names
- Interface composition and dependency injection with Wire
## Minimum System Requirements
For the Dawn phase, a server must have a minimum of 16GB of RAM, preferably
32 GB, 250GB of storage, preferably via SSD, and 50MBps symmetric bandwidth.
For Intel/AMD, the baseline processor is a Skylake processor @ 3.4GHz with 12
dedicated cores. For ARM, the M1 line of Apple is a good reference.
With Dusk, these minimum requirements will reduce significantly.
## License + Interpretation
Significant portions of Quilibrium's codebase depends on GPL-licensed code,