Fair-Squares / fair-squares

Fair housing for all
http://www.fair-squares.nl
Apache License 2.0
16 stars 8 forks source link

Tenancy pallet design #234

Closed ndkazu closed 1 year ago

ndkazu commented 1 year ago

PR content

A few more tests for the payment_pallet, as well as additional documentation, are still needed, but all the functionalities are implemented, tested, and documented. Also, we might want to use floats when calculating the rent-per-block in the asset_management pallet, in order to avoid roundoff errors. The test in the Tenancy pallet is using ALL the pallets created until now, to execute a basic workflow and is therefore a good tool to check if everything is working as expected. Feel free to add to/edit it in order to check different aspects of the workflow.

Additional note

Although it is composed of several small commits, this is a big PR. In order to facilitate its review, a lot of effort has been poured into code documentation. Unfortunately, documentation might be lacking at times, for I might have missed a few vital spots (big or small...) here and there... When this will be the case, feel free to inform me and I will be more than happy to explain, and complete the documentation accordingly.

codecov-commenter commented 1 year ago

Codecov Report

Merging #234 (c0c2108) into main (71d3f91) will decrease coverage by 0.54%. The diff coverage is 77.50%.

:exclamation: Current head c0c2108 differs from pull request most recent head d57743f. Consider uploading reports for the commit d57743f to get more accurate results

:mega: This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

@@            Coverage Diff             @@
##             main     #234      +/-   ##
==========================================
- Coverage   81.67%   81.14%   -0.54%     
==========================================
  Files          58       69      +11     
  Lines        5523     6560    +1037     
==========================================
+ Hits         4511     5323     +812     
- Misses       1012     1237     +225     
Impacted Files Coverage Δ
pallets/asset_management/src/types.rs 100.00% <ø> (ø)
pallets/bidding/src/lib.rs 70.00% <ø> (ø)
pallets/payment/src/weights.rs 0.00% <0.00%> (ø)
pallets/tenancy/src/types.rs 0.00% <0.00%> (ø)
pallets/tenancy/src/weights.rs 0.00% <0.00%> (ø)
runtime/src/constants.rs 0.00% <ø> (ø)
runtime/src/lib.rs 10.28% <0.00%> (-0.72%) :arrow_down:
pallets/payment/src/lib.rs 42.51% <42.51%> (ø)
pallets/payment/src/functions.rs 53.65% <53.65%> (ø)
pallets/payment/src/mock.rs 54.16% <54.16%> (ø)
... and 16 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.