doc: Add Redeemer docs #1535
doc: Add Redeemer docs #1535
Conversation
|
|
||
| 1. The `ticketQueue` is a loop that runs everytime a new block is seen. It will then pop tickets off the queue starting with the oldest ticket first, and sends it to the `LocalSenderMonitor` for redemption if the `recipientRand` for the ticket has expired. | ||
|
|
||
| 2. When the `LocalSenderMonitor` receives a ticket from the `ticketQueue` it will substract `ticket.faceValue` from the outstanding `maxFloat` as long as the ticket is in limbo. |
There was a problem hiding this comment.
Clarify "in limbo" ? Would it be clearer to say "not yet confirmed on the blockchain" ?
There was a problem hiding this comment.
pending between the Redeemer and the ethereum node
This can be either pending on-chain or an HTTP request to the eth node that has some latency to it.
kyriediculous
force-pushed
the
nv/redeemer-doc
branch
from
e5624db to
855e1eb
Compare
|
this branch has been force pushed with changes in accordance with #1513 (comment) |
|
|
||
| 8. The local cache for `sender` will be cleaned up if is not requested for 5 minutes. | ||
|
|
||
|  |
There was a problem hiding this comment.
I really like these sequence diagrams, but 200-300 KB is kind of large. I suppose if we're going to be doing a lot more of these types of checkins, we should look at a blob storage extension such as git-lfs (which Github supports).
There was a problem hiding this comment.
Do you want to include this in this PR? I think this is the only remaining issue for this PR, right?
There was a problem hiding this comment.
Up to you, but I'm generally mindful of repo growth especially with large binary blobs in Git. Another option: since the source for these diagrams has been checked in and can be reproduced [1], we could upload the images themselves to Github (drag+drop the image in this text box) and link within the docs?
[1] Maybe add a comment to the source(s) noting which tools / service can interpret the code for these diagrams?
There was a problem hiding this comment.
now using git lfs for .png files
# This is the 1st commit message: doc: redeemer sequence diagrams source # This is the commit message #2: doc: redeemer sequence diagrams
kyriediculous
force-pushed
the
nv/redeemer-doc
branch
from
7987098 to
7c156fc
Compare
What does this pull request do? Explain your changes. (required)
This PR adds documentation for the
Redeemerservice andticketQueuetable.Does this pull request close any open issues?
Fixes #1532
Checklist:
./test.shpass