Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/interledger-rs/interledger-rs
An easy-to-use, high-performance Interledger implementation written in Rust
https://github.com/interledger-rs/interledger-rs
bitcoin blockchain ethereum ilp interledger interoperability lightning micropayments nanopayments payment rust streaming xrp
Last synced: about 1 month ago
JSON representation
An easy-to-use, high-performance Interledger implementation written in Rust
- Host: GitHub
- URL: https://github.com/interledger-rs/interledger-rs
- Owner: interledger
- License: other
- Created: 2017-07-06T23:04:01.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-06-16T05:31:55.000Z (over 1 year ago)
- Last Synced: 2024-05-01T23:13:22.661Z (5 months ago)
- Topics: bitcoin, blockchain, ethereum, ilp, interledger, interoperability, lightning, micropayments, nanopayments, payment, rust, streaming, xrp
- Language: Rust
- Homepage: http://interledger.rs
- Size: 6.24 MB
- Stars: 199
- Watchers: 25
- Forks: 70
- Open Issues: 87
-
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-blockchain-rust - Interledger
README
---
> Interledger implementation in Rust :money_with_wings:
[](https://crates.io/crates/interledger)
[](https://docs.rs/interledger)
[](https://circleci.com/gh/interledger-rs/interledger-rs)
[](https://hub.docker.com/r/interledgerrs/ilp-node/)
[](https://opensource.org/licenses/Apache-2.0)
## Requirements
All crates require Rust 2018 edition and are tested on the following channels:
- `stable`
## Connecting to the Testnet
See the [testnet instructions](./docs/testnet.md) to quickly connect to the testnet with a bundle that includes the Interledger.rs node and settlement engines.
## Understanding Interledger.rs
- [HTTP API](./docs/api.md)
- [Rust API](https://docs.rs/interledger)
- [Interledger.rs Architecture](./docs/architecture.md)
- [Interledger Forum](https://forum.interledger.org) for general questions about the Interledger Protocol and Project
## Installation and Usage
To run the Interledger.rs components by themselves (rather than the `testnet-bundle`), you can follow these instructions:
### Using Docker
#### Prerequisites
- Docker
#### Install
```bash #
docker pull interledgerrs/ilp-node
docker pull interledgerrs/ilp-cli
docker pull interledgerrs/ilp-settlement-ethereum
```
#### Run
```bash #
# This runs the sender / receiver / router bundle
docker run -it interledgerrs/ilp-node
# This is a simple CLI for interacting with the node's HTTP API
docker run -it --rm interledgerrs/ilp-cli
# This includes the Ethereum Settlement Engines written in Rust
docker run -it interledgerrs/ilp-settlement-ethereum
```
### Building From Source
#### Prerequisites
- Git
- [Redis](https://redis.io/)
- [Rust](https://www.rust-lang.org/tools/install) - latest stable version
#### Install
```bash #
# 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](https://github.com/interledger-rs/settlement-engines).
#### Run
```bash #
# This runs the ilp-node
cargo run --bin ilp-node -- # Put CLI args after the "--"
cargo run --bin ilp-cli -- # Put CLI args after the "--"
```
Append the `--help` flag to see available options.
See [configuration](./docs/configuration.md) for more details on how the node is configured.
#### Configuring Redis
We have some account settings such as `amount_per_minute_limit` or `packets_per_minute_limit`. In order to enable these options, you need to load the [redis-cell](https://github.com/brandur/redis-cell) module as follows. *You don't need to load this module unless you use the rate-limit options.*
```
# in your redis config file
# libredis_cell.so file will be found in crates/interledger-store/external
loadmodule /path/to/modules/libredis_cell.so
```
or you can specify an argument when you start up the redis instance as follows.
```
redis-server --loadmodule /path/to/modules/libredis_cell.so
```
## Examples
See the [examples](./examples/README.md) 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](docs/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)!