ceremonyclient/README.md

83 lines
3.7 KiB
Markdown
Raw Permalink Normal View History

# Quilibrium - Solstice
2023-04-15 04:07:41 +00:00
2023-09-30 07:04:43 +00:00
Quilibrium is a decentralized alternative to platform as a service providers.
2024-06-08 11:32:45 +00:00
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
2023-09-30 07:04:43 +00:00
underlying technology can be found at https://www.quilibrium.com/
## Quick Start
2024-06-08 11:32:45 +00:00
Running production nodes from source is no longer recommended given build complexity. Please refer to our release information to obtain the latest version.
2023-09-30 07:04:43 +00:00
2024-06-08 11:32:45 +00:00
## Running From Source
2023-09-30 07:04:43 +00:00
2024-06-08 11:32:45 +00:00
Builds are now a hybrid of Rust and Go, so you will need both go 1.22 and latest Rust + Cargo.
2023-09-30 07:04:43 +00:00
2024-06-08 11:32:45 +00:00
### VDF
2023-09-30 07:04:43 +00:00
2024-06-08 11:32:45 +00:00
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.
2023-09-30 07:04:43 +00:00
2024-06-08 11:32:45 +00:00
Install the go plugin for uniffi-rs:
2024-06-08 11:32:45 +00:00
cargo install uniffi-bindgen-go --git https://github.com/NordSecurity/uniffi-bindgen-go --tag v0.2.1+v0.25.0
2024-06-08 11:32:45 +00:00
Be sure to follow the PATH export given by the installer.
2024-06-08 11:32:45 +00:00
Build the Rust VDF implementation by navigating to the vdf folder, and run `./generate.sh`.
2024-06-08 11:32:45 +00:00
### 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:
listenGrpcMultiaddr: <multiaddr>
listenRESTMultiaddr: <multiaddr>
Please note: this interface, while read-only, is unauthenticated and not rate-
limited. It is recommended that you only enable if you are properly controlling
access via firewall or only query via localhost.
2024-01-29 21:11:40 +00:00
## Token Balance
In order to query the token balance of a running node, execute the following command from the `node/` folder:
2024-06-08 11:32:45 +00:00
./node-$version-$platform -balance
2023-09-30 07:04:43 +00:00
2024-06-08 11:32:45 +00:00
The accumulated token balance will be printed to stdout in QUILs.
2023-09-30 07:04:43 +00:00
2024-06-08 11:32:45 +00:00
Note that this feature requires that [gRPC support](#grpcrest-support) is enabled.
2023-09-30 07:04:43 +00:00
## 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
v1.4.18 (#193) * Remove bootstrap peer (#189) * Change bootstrap servers to DHT-only peers (#187) * support voucher file-based claims (#183) * Change bootstrap servers to DHT-only peers Changing my bootstrap servers to DHT-only peers with somewhat lower specs. One of the new ones is in the US and the other one is in Switzerland. Both use reliable providers and have 10Gbps network interfaces. --------- Co-authored-by: Cassandra Heart <7929478+CassOnMars@users.noreply.github.com> * Don't run self-test in DHT-only mode (#186) * support voucher file-based claims (#183) * Don't run self-test in DHT-only mode The node tries to create a self-test when ran with the `-dht-only` flag, but it doesn't load the KZG ceremony data in DHT-only mode which leads to a crash. Don't run self-test when the `-dht-only` flag is set. I tested by starting a node locally with and without existing self-test and with the `-dht-only` flag. --------- Co-authored-by: Cassandra Heart <7929478+CassOnMars@users.noreply.github.com> * Embed json files in binary (#182) * Embed ceremony.json in binary * Embed retroactive_peers.json in binary * Signers build and verification tasks (#181) * add signers specific Taskfile * add verify tasks * move signer task under signer folder * create docker image specific for signers * map current user into docker image and container * ignore node-tmp-* * add verify:build:internal * prevent tasks with docker commands from being run inside a container * rename *:internal to *:container * add README.md * add pem files to git * Updating Q Guide link (#173) * Update README.md Updated link to Quilibrium guide to new website * Update README.md * feat: network switching and namespaced announce strings/bitmasks (#190) * feat: network switching and namespaced announce strings/bitmasks * bump version name and logo * feat: mini pomw proofs as part of peer manifest (#191) * shift default config directory under current folder (#176) * feat: signature check (#192) * feat: signature check * adjust docker command so it doesn't invoke sigcheck * remove old version * add binaries and digests * fix bug, revert build * shasum has weird byte at end * proper binaries and digests * Signatory #13 added * Signatory #3 added * Signer 4 (#194) * Signatory #5 added * Signatory #9 added (#195) * Signatory #1 added * added sig.6 files (#196) * Signatories #8 and #16 added * Signatory #12 added * Add signature (#197) * reset build for v1.4.18 after testnet bug * updated build, resigned by #13 * Signatory #16 added * added sig.6 files (#198) * Signatory #8 added * Signatory #17 added * Signatory #1 added * Signatory #7 added * Signatory #4 added * Signatory #14 added * remove binaries, ready to ship --------- Co-authored-by: littleblackcloud <163544315+littleblackcloud@users.noreply.github.com> Co-authored-by: Agost Biro <5764438+agostbiro@users.noreply.github.com> Co-authored-by: Marius Scurtescu <marius.scurtescu@gmail.com> Co-authored-by: Demipoet <161999657+demipoet@users.noreply.github.com> Co-authored-by: 0xOzgur <29779769+0xOzgur@users.noreply.github.com> Co-authored-by: Freekers <1370857+Freekers@users.noreply.github.com>
2024-05-25 05:22:50 +00:00
- A detailed beginners' guide for how to setup a Quilibrium Node, created by [@demipoet](https://www.github.com/demipoet) - [link](https://quilibrium.guide/)<br/>
2024-06-08 11:32:45 +00:00
## Development
2023-09-30 07:04:43 +00:00
2024-06-08 11:32:45 +00:00
Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file for more information on
how to contribute to this repository.
2023-09-30 07:04:43 +00:00
## License + Interpretation
Significant portions of Quilibrium's codebase depends on GPL-licensed code,
mandating a minimum license of GPL, however Quilibrium is licensed as AGPL to
accomodate the scenario in which a cloud provider may wish to coopt the network
software. The AGPL allows such providers to do so, provided they are willing
to contribute back the management code that interacts with the protocol and node
software. To provide clarity, our interpretation is with respect to node
provisioning and management tooling for deploying alternative networks, and not
applications which are deployed to the network, mainnet status monitors, or
container deployments of mainnet nodes from the public codebase.