search

sablier-labs / flow

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

Add `PRECISION.md` file #267

Closed andreivladbrg closed 1 month ago

andreivladbrg commented 2 months ago

This PR introduces the PRECISION.md file which explain in detail the delay problem in case of rps with 18 decimals.

Since the audit starts in October, I decided to change our time reference from MAY_1_2024 to OCT_1_2024

smol-ninja commented 2 months ago

An idea: we should run these docs through ChatGPT as well and ask for improvements for clarity and readability. It can also come up with new terms.

andreivladbrg commented 2 months ago

An idea: we should run these docs through ChatGPT as well and ask for improvements for clarity and readability. It can also come up with new terms

I’ve already done that, but not for the entire file, as GPT is still kinda "stupid" with larger prompts :)) (don't ask him how many "r" are in strawberry)

instead, i passed paragraphs one by one

if you succed on exploating gpt better, lmk

andreivladbrg commented 2 months ago

@smol-ninja I’ve pushed some new commits. Could you please go through the file again to see if the current version is better?

andreivladbrg commented 1 month ago

@smol-ninja @IaroslavMazur, does the current version look good?

I’m planning to merge it to the main branch so that the auditors can have easier access to the explanations

andreivladbrg commented 1 month ago

Thank you so much @smol-ninja and @IaroslavMazur for your feedbacks. The file definitely looks better now. Merging! 🎉🚀