interledger / interledger-rs

An easy-to-use, high-performance Interledger implementation written in Rust
http://interledger.rs
Other
201 stars 70 forks source link

Document balances and how to configure settlement parameters #593

Open kincaidoneil opened 4 years ago

kincaidoneil commented 4 years ago

In trying to setup an account that would prefund its peer, I couldn't find any documentation on what a positive/negative balance represents or how I should set the settle_to, nor what units I should use. The best I could find was this in line the ETH example:

The settle_threshold and settle_to parameters control when settlements are triggered. The node will send a settlement when an account's balance reaches the settle_threshold, and it will settle for balance - settle_to.

We need to document, within the HTTP API specification and the ilp-cli help text (and maybe elsewhere, too?):

Related to #120

kincaidoneil commented 4 years ago

The peering doc is more helpful, but still not great, and isn't linked from the README

gakonst commented 4 years ago

I've expanded our unit tests for that functionality here: https://github.com/interledger-rs/interledger-rs/pull/622/commits/2f83e7069cef6f014b0642b0ac8df1c82f1cba5b. These should be helpful for someone trying to understand the usage and should probably be added as examples to the readmes