Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document balances and how to configure settlement parameters #593

Open
kincaidoneil opened this issue Jan 23, 2020 · 2 comments
Open

Document balances and how to configure settlement parameters #593

kincaidoneil opened this issue Jan 23, 2020 · 2 comments
Labels

Comments

@kincaidoneil
Copy link
Member

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?):

  • When settle_to gets triggered, and what a positive or negative balance represents
  • What units the settlement parameters need to be in, with a couple examples (I was using an account with asset scale 2 and I tried to set settle_to to 4.52 but the CLI gave me a confusing error until I changed it to 452. We should clarify this or change the API to use the standard, arbitrary precision representation of the asset, since it's more intuitive).

Related to #120

@kincaidoneil
Copy link
Member Author

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

@gakonst
Copy link
Member

gakonst commented Feb 6, 2020

I've expanded our unit tests for that functionality here: 2f83e70. These should be helpful for someone trying to understand the usage and should probably be added as examples to the readmes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants