Add Random Activity to README and CLI Options #125
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
carlaKC
force-pushed
the
72-configanddocs
branch
3 times, most recently
from
95362d9 to
06b45fd
Compare
|
Including the alias improvements in #103 in the readme here so that we can do all our fancy updates in one do, so this PR is a dependent. |
👍🏿
sr-gi
reviewed
Oct 5, 2023
README.md
Outdated
| } | ||
| ``` | ||
|
|
||
| Nodes can be identified by an arbitrary string ("Alice", "CLN1" etc) or |
README.md
Outdated
| will be sent by nodes, randomness will be introduced such that larger | ||
| nodes send a wider variety of payment sizes around this expectation. | ||
| * `--capacity-multiplier`: the number of times over that each node in | ||
| the network sends their capacity in a calendar month - 2 indicating |
There was a problem hiding this comment.
Using - style here reads pretty weird
There was a problem hiding this comment.
Meaning, don't use ` to make it a code block?
There was a problem hiding this comment.
Oh no, I mean "- 2 indicating ..."
Looks like you're talking to minus two
README.md
Outdated
| sim-cli --config config.json | ||
| ``` | ||
| Activity source nodes may be reference by id string | ||
| or public key (as specified in `nodes`), but destin |
There was a problem hiding this comment.
Is this an unfinished, probably old, rephased sentence?
There was a problem hiding this comment.
Whoop, yeah should be deleted!
carlaKC
force-pushed
the
72-configanddocs
branch
from
06b45fd to
fa3a1cf
Compare
|
Updated to include #130 as well |
carlaKC
force-pushed
the
72-configanddocs
branch
2 times, most recently
from
9e719cd to
7066853
Compare
Surface so that end users can configure these values. Note that expected payment amount is intentionally called "avg" in the user config because that's a more user friendly / recognizable term, but we keep expected payment amount elsewhere in the code base since it's the expectation we provide for our distribution.
Add sections for each "type" of config. Also move getting started up so that we have something actionable before the long/difficult configuration part.
carlaKC
force-pushed
the
72-configanddocs
branch
from
7066853 to
3e8b1db
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is a small follow up for #113 adding:
multiplier+expected_payment_amount.