Add staker info tools to `nucypher status` by cygnusv · Pull Request #1259 · nucypher/nucypher

cygnusv · 2019-08-24T11:21:26Z

If you have ideas to improve these commands (or new commands), don't be shy! Maybe I can add them.

Usage:

To see evolution of overall locked tokens of the network for next N days (default is 90):
nucypher status locked-tokens --provider <GETH> --poa [--periods N]
To see all stakers info (optionally a staking address can be supplied):
nucypher status stakers --provider <GETH> --poa [--staking-address 0xfoobar]

codecov · 2019-09-04T19:52:55Z

Codecov Report

Merging #1259 into master will decrease coverage by 1.64%.
The diff coverage is 73.22%.

@@            Coverage Diff             @@
##           master    #1259      +/-   ##
==========================================
- Coverage   81.19%   79.55%   -1.65%     
==========================================
  Files          72       72              
  Lines       10018    10269     +251     
==========================================
+ Hits         8134     8169      +35     
- Misses       1884     2100     +216

Impacted Files	Coverage Δ
nucypher/cli/characters/stake.py	`81.36% <0%> (+0.5%)`	⬆️
nucypher/cli/characters/ursula.py	`64.9% <0%> (ø)`	⬆️
nucypher/blockchain/economics.py	`98.34% <100%> (ø)`	⬆️
nucypher/cli/actions.py	`74.25% <100%> (-2.4%)`	⬇️
nucypher/utilities/sandbox/constants.py	`98.36% <100%> (+0.14%)`	⬆️
nucypher/blockchain/eth/token.py	`88.96% <100%> (+0.07%)`	⬆️
nucypher/blockchain/eth/registry.py	`70.94% <100%> (-5.58%)`	⬇️
nucypher/blockchain/eth/interfaces.py	`70.91% <50%> (-1.07%)`	⬇️
nucypher/blockchain/eth/agents.py	`75.9% <55.88%> (-15.06%)`	⬇️
nucypher/cli/deploy.py	`51.65% <66.66%> (-23.35%)`	⬇️
... and 22 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a1db783...7565c24. Read the comment docs.

vepkenez · 2019-09-04T23:59:44Z

I very much wish there was an --json option to get this data as json.

nucypher/cli/status.py

nucypher/cli/painting.py

nucypher/blockchain/eth/agents.py

vzotova · 2019-09-05T08:50:23Z

nucypher/cli/painting.py

+
+    MAX_ROWS = 30
+    period_range = list(range(1, periods + 1))
+    token_counter = Counter({day: agent.get_all_locked_tokens(day) for day in period_range})


Just a reminder - this will print using only "active" workers/stakers

How can we get the non active stakers too?

It's not trivial question. Because if you want to print period by period all stakes for all stakers - this will be not fast, because should do this manualy (calculate next period, get next staker, get locked tokens, sum or get next staker, get all sub stakes and then do all others summarization)
Also possible other solution if only current/next periods will be enough

Can this be derived by listing all the stakers that have ever connected to the network, then removing the currently active stakers?

nucypher/blockchain/eth/token.py

michwill

Omg, this is insanely awesome!

nucypher/blockchain/eth/agents.py

nucypher/cli/status.py

tests/blockchain/eth/interfaces/test_token_and_stake.py

cygnusv · 2019-09-05T14:49:49Z

@szotov Thanks, man! You've made very good points. I'll fix these issues now.

@vepkenez

I very much wish there was an --json option to get this data as json.

Yes! That's a wonderful idea, I don't know why I didn't think of that. I'll work on it.

derekpierre · 2019-09-06T15:19:18Z

nucypher/cli/painting.py

 Actively Staked Tokens ... {NU.from_nunits(staking_agent.get_global_locked_tokens())}
 Published Stakes ......... {staking_agent.get_staker_population()}
-Gas Price ................ {Web3.fromWei(blockchain.client.gas_price, 'gwei')} Gwei
+Active Staking Ursulas ... {staking_agent.get_staker_population()}


This prints the same thing as the line before ('Published Stakes')? Rebase issue perhaps...?

Yes, I think published stakes doesn't make much sense here, since there's a 1 to 1 relation between stake and stakers. I also changed the Active Staking Ursulas part since "Staking Ursulas" is not correct, and also get_staker_population() gives you all stakers, both active and inactive. Instead, I added a new functionality to get stakers partitioned by different confirmation status.

derekpierre

Left a prior comment about a problematic line in painting.py

KPrasch

Awesome Work! Giving eyes to the network.... Approved with pending rebase over master. I'd love to see a follow-up PR that allows for JSON output generation, perhaps via composition on Moe.

derekpierre

Great stuff @cygnusv !! A couple comments about the units used for token balance output.

nucypher/cli/painting.py

…taker

…> 'network'. Support status via registry filepath.

…n `nucypher status network`

…uff here and there.

See nucypher#1288

cygnusv · 2019-09-10T20:18:12Z

@vepkenez @KPrasch

I very much wish there was an --json option to get this data as json.

I'm afraid I'll have to leave that for a later PR. I lean now towards merging this soon and moving on into other work I don't want to grow stale (#1227).

arjunhassard

Tools like this really level the playing field between large and small stakers! @cygnusv

arjunhassard · 2019-09-11T00:24:47Z

nucypher/cli/painting.py

+
+        stake = agent.owned_tokens(staker)
+        last_confirmed_period = agent.get_last_active_period(staker)
+        worker = agent.get_worker_from_staker(staker)


Can this function retrieve the addresses of multiple workers associated with the same staker/stake? Re: #1302

def get_worker_from_staker(self, staker_address: str) -> str: worker = self.contract.functions.getWorkerFromStaker(staker_address).call() return to_checksum_address(worker)

Our current model assumes a 1-to-1 relation between Workers and Stakers.

arjunhassard · 2019-09-11T00:36:22Z

nucypher/cli/painting.py

+        bucket_end = bucket[-1]
+
+        bucket_max = max([token_counter[period] for period in bucket])
+        bucket_min = min([token_counter[period] for period in bucket])


Visuals showing min, max and total tokens locked for each set of periods are great. Maybe a note explaining what min and max mean wouldn't go amiss?

arjunhassard · 2019-09-11T00:38:41Z

nucypher/cli/painting.py

+
+    MAX_ROWS = 30
+    period_range = list(range(1, periods + 1))
+    token_counter = Counter({day: agent.get_all_locked_tokens(day) for day in period_range})


Can this be derived by listing all the stakers that have ever connected to the network, then removing the currently active stakers?

michwill mentioned this pull request Aug 29, 2019

[EPIC] Earl Grey Tea, Hot. #1225

Merged

cygnusv mentioned this pull request Aug 29, 2019

Fix automatic confirm-activity #1281

Closed

cygnusv force-pushed the stakers branch from 06bb0e0 to 8f6623c Compare September 4, 2019 19:52

cygnusv force-pushed the stakers branch 2 times, most recently from 5f10d15 to 52790ac Compare September 4, 2019 22:09

cygnusv changed the title ~~[WIP] Staker info tools~~ Add staker info tools to nucypher status Sep 4, 2019

cygnusv marked this pull request as ready for review September 4, 2019 22:11

cygnusv requested review from KPrasch, arjunhassard, derekpierre, fjarri, jMyles, michwill, mswilkison, tuxxy, vepkenez and vzotova September 4, 2019 22:15

KPrasch reviewed Sep 5, 2019

View reviewed changes

nucypher/cli/status.py Outdated Show resolved Hide resolved

vzotova reviewed Sep 5, 2019

View reviewed changes

tuxxy reviewed Sep 5, 2019

View reviewed changes

nucypher/blockchain/eth/token.py Show resolved Hide resolved

michwill approved these changes Sep 5, 2019

View reviewed changes

derekpierre reviewed Sep 5, 2019

View reviewed changes

nucypher/blockchain/eth/agents.py Outdated Show resolved Hide resolved

nucypher/cli/status.py Outdated Show resolved Hide resolved

nucypher/cli/status.py Outdated Show resolved Hide resolved

tests/blockchain/eth/interfaces/test_token_and_stake.py Show resolved Hide resolved

cygnusv mentioned this pull request Sep 5, 2019

Touches to StakingEscrow.sample() #1280

Merged

cygnusv force-pushed the stakers branch from 52790ac to 634ff78 Compare September 5, 2019 16:34

derekpierre reviewed Sep 6, 2019

View reviewed changes

derekpierre requested changes Sep 6, 2019

View reviewed changes

KPrasch mentioned this pull request Sep 7, 2019

Ownership Inspection and Transference #1157

Merged

KPrasch approved these changes Sep 7, 2019

View reviewed changes

KPrasch added CLI This effects the nucypher CLI Enhancement New or improved features labels Sep 9, 2019

cygnusv force-pushed the stakers branch from 634ff78 to 5f13305 Compare September 10, 2019 11:48

derekpierre approved these changes Sep 10, 2019

View reviewed changes

nucypher/cli/painting.py Show resolved Hide resolved

nucypher/cli/painting.py Outdated Show resolved Hide resolved

nucypher/cli/painting.py Outdated Show resolved Hide resolved

cygnusv and others added 15 commits September 10, 2019 22:14

Enrich API of StakingEscrowAgent: get_stakers(), get_all_locked_tokens()

9e5a825

Add round() to NU

20de10e

First pass at nucypher status stakers and nucypher status locked-tokens

99403a3

Improve coverage of StakingEscrowAgent wrt to StakingEscrow contract

beb0e04

Improve nucypher status locked-tokens: shows bars with min & max

b416b74

Improve nucypher status stakers: prettier output, allow specify one s…

38f736d

…taker

Add basic help text to nucypher status

70b7307

Remove configuration dependency from status CLI. renames CLI 'view' -…

f505012

…> 'network'. Support status via registry filepath.

Addresses assorted RFCs

241254c

Tests for nucypher status stakers and nucypher status network

e1b4de2

Reduce probability of skewed stake distribution in stakers fixture

812349f

Utility to get list of active, pending and inactive stakers. Use it i…

39f6289

…n `nucypher status network`

Getting rid of old session_agency fixture. Use agency instead.

7b8b31d

Use regex matching in tests for nucypher status output. Fix broken st…

9614646

…uff here and there.

Skip test_sampling_distribution until we have a solution for snail tests

76103e8

See nucypher#1288

cygnusv force-pushed the stakers branch from 7565c24 to 76103e8 Compare September 10, 2019 20:14

cygnusv merged commit d6e842d into nucypher:master Sep 10, 2019

arjunhassard reviewed Sep 11, 2019

View reviewed changes

Conversation

cygnusv commented Aug 24, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Sep 4, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

vepkenez commented Sep 4, 2019

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

michwill left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cygnusv commented Sep 5, 2019

Uh oh!

derekpierre Sep 6, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

derekpierre left a comment

Choose a reason for hiding this comment

Uh oh!

KPrasch left a comment

Choose a reason for hiding this comment

Uh oh!

derekpierre left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cygnusv commented Sep 10, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

arjunhassard left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

cygnusv commented Aug 24, 2019 •

edited

Loading

codecov bot commented Sep 4, 2019 •

edited

Loading

derekpierre Sep 6, 2019 •

edited

Loading

cygnusv commented Sep 10, 2019 •

edited

Loading

arjunhassard left a comment •

edited

Loading