Implement `accounts/{accountId}/staking-payouts` #217

emostov · 2020-08-17T02:17:28Z

Closes #216

In this PR we add accounts/{accountId}/staking-payouts, and Rust code to do payout calculations. The @polkadot/calc-fee wasm-pack built package becomes @substrate/calc as it now incorporates both fee calculation and payout calculation.

The main things to consider for this PR:

Payout amounts match on-chain so this endpoint can be used for accounting
No type issues going between JS - wasm. (I assume Perbill's like validator_commission fit into a u32, however if they don't we will run into overflow)
API is designed in such a way that is maintainable and we will not need to make breaking changes in the future.

TODO:

Correct arithmetic methods to simulate substrate's Perbill
Verify why 0% commissions still show up as one Perbill
General testing to verify accuracy of results
Update openapi-proposal.yaml to match

Follow up PRs

Unit tests

Remove unused comment Update comments and org Update response structure Remove validator count

athei

Only reviewed the Rust part. Looks generally good to me. However, I thought maybe it would be better to put all Rust stuff in one package and give it a more general name rather than having one per function. Otherwise this creates a lot of code duplication and friction when adding new stuff.

You could just put those functionalities into different submodules.

calc-payout/src/lib.rs

danforbes

Just a few nitpicks...looks great!

README.md

calc/Cargo.toml

calc/README.md

kianenigma · 2020-08-21T07:25:15Z

calc/src/calc_fee.rs

@@ -0,0 +1,203 @@
+use crate::debug;


I think you should have used git mv somewhere to avoid this. These are not new, right?

kianenigma · 2020-08-21T07:27:44Z

calc/src/calc_payout.rs

+        calc_payout
+    }
+
+    pub fn calc_payout(


You could look into making a PR to substrate and so that pallet-staking exposes a function that only does the calculation, and then you simply call into that here, rather than duplicating code.

Given that it can be done with sensible changes to staking, I will totally support this.

100% support this as it will make future runtime upgrades much easier to support.

calc/src/calc_payout.rs

calc/src/debug.rs

openapi/openapi-proposal.yaml

Co-authored-by: joe petrowski <25483142+joepetrowski@users.noreply.github.com>

Reverse

…sidecar into zeke-rewards

Co-authored-by: Dan Forbes <dan@danforbes.dev>

openapi/openapi-proposal.yaml

src/controllers/accounts/AccountsStakingPayoutsController.ts

emostov added the A3 - In Progress PR in progress, not ready for review label Aug 17, 2020

emostov marked this pull request as draft August 17, 2020 02:19

Initial impl with Big.js

4973186

Remove unused comment Update comments and org Update response structure Remove validator count

emostov force-pushed the zeke-rewards branch from 50a64d1 to 4973186 Compare August 17, 2020 06:22

emostov added 3 commits August 17, 2020 10:33

Convert to Perbill arithmetic

20733fe

Merge origin master

20492ef

Implement calc-payout crate

ea1aca2

emostov force-pushed the zeke-rewards branch from 2d1c07c to ea1aca2 Compare August 20, 2020 05:11

emostov added A0 - Please Review PR is ready for review B3 - API Noteworthy API is not broken, but worth noting and removed A3 - In Progress PR in progress, not ready for review labels Aug 20, 2020

emostov marked this pull request as ready for review August 20, 2020 05:14

emostov requested review from joepetrowski and danforbes August 20, 2020 05:14

eslintignore calc-payout

0c77ea5

emostov requested review from athei and kianenigma August 20, 2020 16:00

athei reviewed Aug 20, 2020

View reviewed changes

calc-payout/src/lib.rs Outdated Show resolved Hide resolved

calc-payout/src/lib.rs Outdated Show resolved Hide resolved

calc-payout/src/lib.rs Outdated Show resolved Hide resolved

emostov added 4 commits August 20, 2020 12:53

Alexander feedback

127c2e4

Add check for era - depth; Update openapi

3101bbe

update README debug section

90f9f73

Merge remote-tracking branch 'origin' into zeke-rewards

8b5e6c5

danforbes approved these changes Aug 20, 2020

View reviewed changes

README.md Outdated Show resolved Hide resolved

calc/Cargo.toml Outdated Show resolved Hide resolved

calc/README.md Outdated Show resolved Hide resolved

kianenigma reviewed Aug 21, 2020

View reviewed changes

calc/src/calc_payout.rs Show resolved Hide resolved

kianenigma reviewed Aug 21, 2020

View reviewed changes

calc/src/debug.rs Show resolved Hide resolved

Update readmes

2857759

joepetrowski reviewed Aug 21, 2020

View reviewed changes

openapi/openapi-proposal.yaml Outdated Show resolved Hide resolved

joepetrowski reviewed Aug 21, 2020

View reviewed changes

openapi/openapi-proposal.yaml Outdated Show resolved Hide resolved

joepetrowski reviewed Aug 21, 2020

View reviewed changes

openapi/openapi-proposal.yaml Outdated Show resolved Hide resolved

joepetrowski reviewed Aug 21, 2020

View reviewed changes

openapi/openapi-proposal.yaml Outdated Show resolved Hide resolved

Apply suggestions from Joe code review

5fe7d76

Co-authored-by: joe petrowski <25483142+joepetrowski@users.noreply.github.com>

joepetrowski approved these changes Aug 21, 2020

View reviewed changes

emostov mentioned this pull request Aug 21, 2020

Implement V1 endpoints #227

Closed

19 tasks

emostov and others added 5 commits August 21, 2020 10:09

add docs to payouts controller

4724f85

Clean up docs

ee7778f

Reverse

Merge branch 'master' of https://github.com/paritytech/substrate-api-…

659486e

…sidecar into zeke-rewards

Update calc/Cargo.toml

ecf35c1

Co-authored-by: Dan Forbes <dan@danforbes.dev>

Update return property names for nominator and validator rewards

d26155e

joepetrowski approved these changes Aug 23, 2020

View reviewed changes

openapi/openapi-proposal.yaml Outdated Show resolved Hide resolved

src/controllers/accounts/AccountsStakingPayoutsController.ts Outdated Show resolved Hide resolved

joepetrowski and others added 7 commits August 23, 2020 21:02

themself -> itself

faca979

Code style refactors and comment updates

ea2a034

Small era message update

7b7dbf8

Delete line in ReadMe

e8a7206

Remove accidental add

a85d02f

Update ReadMe.md with link

29b1819

Merge branch 'master' into zeke-rewards

6f37ceb

joepetrowski merged commit 2f817d1 into master Aug 24, 2020

joepetrowski deleted the zeke-rewards branch August 24, 2020 08:03

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement `accounts/{accountId}/staking-payouts` #217

Implement `accounts/{accountId}/staking-payouts` #217

emostov commented Aug 17, 2020 •

edited by joepetrowski

athei left a comment

danforbes left a comment

kianenigma Aug 21, 2020

emostov Aug 21, 2020

kianenigma Aug 21, 2020

joepetrowski Aug 21, 2020

Implement accounts/{accountId}/staking-payouts #217

Implement accounts/{accountId}/staking-payouts #217

Conversation

emostov commented Aug 17, 2020 • edited by joepetrowski

athei left a comment

Choose a reason for hiding this comment

danforbes left a comment

Choose a reason for hiding this comment

kianenigma Aug 21, 2020

Choose a reason for hiding this comment

emostov Aug 21, 2020

Choose a reason for hiding this comment

kianenigma Aug 21, 2020

Choose a reason for hiding this comment

joepetrowski Aug 21, 2020

Choose a reason for hiding this comment

Implement `accounts/{accountId}/staking-payouts` #217

Implement `accounts/{accountId}/staking-payouts` #217

emostov commented Aug 17, 2020 •

edited by joepetrowski