search

sablier-labs / flow

🍃 Smart contracts of the Sablier Flow protocol.
Other
10 stars 2 forks source link

docs: refactor technical doc #314

Closed smol-ninja closed 4 weeks ago

smol-ninja commented 1 month ago

Refactors technical doc in line with https://github.com/sablier-labs/flow/pull/312.

smol-ninja commented 1 month ago

@andreivladbrg so after the new update, the unlock interval takes into account the last withdraw time ($wt$) and not snapshot time ($st$) anymore. Thats what the PR is about.

I've updated the content. Without changing the numbers we can say that time values are considered since last withdraw time and not the last snapshot time. This will require updating the charts with the new labels.

Alternatively, I am in favour of removing the numbers and charts and only keep the theory part in brief to understand the precision problem. This is due to the fact that with numbers and charts, the cost of maintenance of the technical doc is non-zero. The purpose of the doc is to explain delays and precision issues in calculations of withdrawn amount which imo is already well explained. What do you think?

smol-ninja commented 1 month ago

@andreivladbrg do you remember what we discussed about it last week? I forgot to make notes and now can't recall what we decided about this doc.

andreivladbrg commented 1 month ago

@andreivladbrg do you remember what we discussed about it last week? I forgot to make notes and now can't recall what we decided about this doc.

the most important thing we have discussed about was to we could define "withdraw previous time" and use the abbreviation $wpt$ instead of simple withdraw time. and in our specific example we can still use $st$ as we isolate the scenario to only withdrawals

https://github.com/sablier-labs/flow/blob/b01cc2daf6493ae792a858d6179facc6250403e2/TECHNICAL-DOC.md?plain=1#L388-L389

that's what i remember

smol-ninja commented 1 month ago

@andreivladbrg I have made the suggested changes. Let me know if it looks good now.

andreivladbrg commented 4 weeks ago

@smol-ninja as discussed on slack, we should remove everything from this line and below https://github.com/sablier-labs/flow/blob/4c198886f80a472aec17f3a54b55830f1a29e961/TECHNICAL-DOC.md?plain=1#L215

since there is no more delay due to sd in 18 decimals, also it can be proved by these equality checks in the PR: https://github.com/sablier-labs/flow/pull/320

smol-ninja commented 4 weeks ago

Not that line. MVT is one of the two problems that led us to use 18-decimal fixed-point number for rps and sd. Everything from here should be deleted.