latenssi / interledger-rs Goto Github PK

Interledger implementation in Rust 💸

See the testnet instructions to quickly connect to the testnet with a bundle that includes the Interledger.rs node and settlement engines.

• HTTP API
• Rust API
• Interledger.rs Architecture
• Interledger Forum for general questions about the Interledger Protocol and Project

To run the Interledger.rs components by themselves (rather than the testnet-bundle), you can follow these instructions:

• Docker

docker pull interledgerrs/node
docker pull interledgerrs/ilp-cli
docker pull interledgerrs/settlement-engines

# This runs the sender / receiver / router bundle
docker run -it interledgerrs/node

# This is a simple CLI for interacting with the node's HTTP API
docker run -it --rm interledgerrs/ilp-cli

# This includes the Settlement Engines written in Rust
docker run -it interledgerrs/settlement-engines

• Git
• Rust - latest stable version

# 1. Clone the repsitory and change the working directory
git clone https://github.com/interledger-rs/interledger-rs && cd interledger-rs

# 2. Build interledger-rs (add `--release` to compile the release version, which is slower to compile but faster to run)
cargo build

You can find the Interledger Settlement Engines in a separate repository.

# This runs the ilp-node
cargo run -p ilp-node -- # Put CLI args after the "--"

cargo run -p ilp-cli -- # Put CLI args after the "--"

Append the --help flag to see available options.

See configuration for more details on how the node is configured.

See the examples for demos of Interledger functionality and how to use the Interledger.rs implementation.

Contributions are very welcome and if you're interested in getting involved, see CONTRIBUTING.md. We're more than happy to answer questions and mentor you in making your first contributions to Interledger.rs (even if you've never written in Rust before)!