[PROTOCOL-NG] Solidity Semantic Money draft release 1

[hellwolf]

Background

This is the first release of the solidity semantic money library, used for building GDA in SuperToken v1 and SuperToken v2. The audience of this is the implementers of SuperTokens on any target system.

⚠️ Note that many concepts are brand new without prio-art, and the time to provide the detailed documentation for the new idea is limited. As a result, considering the fairly limited audience for this library, for ones actually interested in using it, instead of asking for the documentation, one should contact the author and Superfluid team for further assistance to your work.

What's In the Bag

• A Solidity library for building the general payment primitives aspect of the semantic money is ready:

  • A pure functional solidity library: SemanticMoney.
    • Property based testing using foundry fuzz.
    • (Limited, WIP) Certora formal verification using CVL (Certora Verification Language) v1.
  • A token monad using abstract contract approach: `TokenMonad.
  • Toy models for ToySuperToken & TokenSuperfluidPool, as reference implementation for GDA & SuperToken v2.
    • Property based testing using foundry fuzz, notably also with a randomized steps generation testing in it (to be replaced by foundy invariance testing in the future).
  • Toy model for Aqueduct, a ZILMM (Zero Intermediate Liquidity Money Market).
    • Property based testing using foundry fuzz.

• Update the yellow paper deferred to next PR.

[github-actions]

Changelog Reminder

Reminder to update the CHANGELOG.md for any of the modified packages in this PR.

• CHANGELOG.md modified
• Double check before merge

[codecov]

Codecov Report

Patch coverage has no change and project coverage change: +9.65 🎉

Comparison is base (48212b2) 88.28% compared to head (5716f0e) 97.94%.

❗ Current head 5716f0e differs from pull request most recent head 60d0c2f. Consider uploading reports for the commit 60d0c2f to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@
##              dev    #1280      +/-   ##
==========================================
+ Coverage   88.28%   97.94%   +9.65%     
==========================================
  Files          86       38      -48     
  Lines        4311     2092    -2219     
  Branches      180        0     -180     
==========================================
- Hits         3806     2049    -1757     
+ Misses        461       43     -418     
+ Partials       44        0      -44     

Flag	Coverage Δ
ethereum-contracts	97.94% <ø> (ø)
sdk-core	?

Flags with carried forward coverage won't be shown. Click here to find out more.

see 48 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

[hellwolf]

If this got merged and used by the #1357 branch, let's merge so that GDA branch will be cleaner to maintain. I will do the a series of library explanation sessions as a separate and an ongoing process live.

[0xdavinchee]

LGTM

[github-actions]

XKCD Comic Relif

Link: https://xkcd.com/1280