Adrian Duke
da2c523d41
Introduce a property testing harness for asserting a set of properties expected of the repository identity. The harness uses the `Network` fixture for providing four nodes that can interact with the repository identity. The state of the harness is advanced by providing an actor and operation on the identity document. Invariants are then asserted about the identity. The current invariants are: - The `current` revision is the one and only `Accepted` revision. - The chain of revisions is valid. That is, `Active` revisions only have a parent that is `Accepted`, and not `Rejected` or `Redacted`. - `Active` revisions do not contain a majority approval. - `Accepted` revisions contain a majority approval. - `Rejected` revisions do not contain a majority approval. - For each revision, at most one child is `Accepted`. - For each revision, if any of its children is `Accepted`, all other children are `Rejected`. - A revision which is `Rejected(RejectedBy::Parent)` has a parent that is `Rejected`. - A revision which is `Redacted(RedactedBy::Parent)` has a parent that is `Redacted`. - For each revision that is `Rejected` or `Redacted`, none of its children is `Active`. - A sibling or ancestor revision's rejected state applies to its sibling or descendant. - The repository identity documents converge when all nodes have applied all operations.
❤️🪵
Radicle Heartwood Protocol & Stack
Heartwood is the third iteration of the Radicle Protocol, a powerful
peer-to-peer code collaboration and publishing stack. The repository contains a
full implementation of Heartwood, complete with a user-friendly command-line
interface (rad) and network daemon (radicle-node).
Radicle was designed to be a secure, decentralized and powerful alternative to code forges such as GitHub and GitLab that preserves user sovereignty and freedom.
See the Radicle home page for general information, and the Zulip chat to talk to the project.
See the Protocol Guide for an in-depth description of how Radicle works.
Installation
Requirements
- Linux or Unix based operating system.
- Git 2.34 or later
- OpenSSH 9.1 or later with
ssh-agent
📀 From binaries
Requires
curlandtar.
Run the following command to install the latest binary release:
curl -sSf https://radicle.dev/install | sh
Or visit our download page.
📦 From source
Requires the Rust toolchain.
You can install the Radicle stack from source, by running the following commands from inside this repository:
cargo install --path crates/radicle-cli --force --locked --root ~/.radicle
cargo install --path crates/radicle-node --force --locked --root ~/.radicle
cargo install --path crates/radicle-remote-helper --force --locked --root ~/.radicle
Or directly from our seed node:
cargo install --force --locked --root ~/.radicle \
--git https://seed.radicle.dev/z3gqcJUoA1n9HaHKufZs5FCSGazv5.git \
crates/radicle-cli crates/radicle-node crates/radicle-remote-helper
Running
Systemd unit files are provided for the node under the /systemd folder.
They can be used as a starting point for further customization.
For running in debug mode, see HACKING.md.
Feedback
If you have feedback, feel free to create issues using rad issue, join
our Zulip, or email feedback@radicle.dev.
Emails sent to this address are automatically posted to
our public #feedback channel on Zulip, revealing the
From header (which usually contains your name and email
address). This allows us to discuss your feedback on Zulip, and, if necessary,
respond to you via email.
Contributing
See CONTRIBUTING.md and HACKING.md for an introduction to contributing to Radicle.
License
Radicle is distributed under the terms of both the MIT license and the Apache License (Version 2.0).
See LICENSE-APACHE and LICENSE-MIT for details.