Skip to content
Interledger implementation in Rust
Rust Other
  1. Rust 99.3%
  2. Other 0.7%
Branch: master
Clone or download

README.md

Interledger.rs


Interledger implementation in Rust 💸

crates.io Interledger.rs Documentation CircleCI Rust Version Docker Image

Understanding Interledger.rs

Installation and Usage

Docker

Prerequisites:

  • Docker

Install

  1. docker pull interledgerrs/node

Run

  1. docker run -it interledgerrs/node (append help node to see the available options)

Building From Source

Prerequisites:

  • Git
  • Rust - latest stable version

Install

  1. git clone https://github.com/interledger-rs/interledger-rs && cd interledger-rs
  2. cargo build (add --release to compile the release version, which is slower to compile but faster to run)

Run

cargo run -- node

Append the --help flag to see available options.

Configuration

Interledger.rs commands such as node and ethereum-ledger accept configuration options in the following ways:

  1. Environment variables
  2. Standard In (stdin)
  3. Configuration files
  4. Command line arguments

The priority is: Environment Variables > stdin > configuration files > command line arguments.

# 1.
# Passing by command line arguments.
# --{parameter name} {value}
cargo run -- node --ilp_address example.alice

# 2.
# Passing by a configuration file in JSON, TOML, YAML format.
# The first argument after subcommands such as `node` is the path to the configuration file.
# Note that in order for a docker image to have access to a local file, it must be included in
# a directory that is mounted as a Volume at `/config`
cargo run -- node config.yml

# 3.
# Passing from STDIN in JSON, TOML, YAML format.
some_command | cargo run -- node

# 4.
# passing as environment variables
# {parameter name (typically in capital)}={value}
# note that the parameter names MUST begin with a prefix of "ILP_" e.g. ILP_SECRET_SEED
ILP_ADDRESS=example.alice \
ILP_OTHER_PARAMETER=other_value \
cargo run -- node

Examples

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

Contributing

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!

You can’t perform that action at this time.