[Tokenomics] Implement difficulty proportional rewards #840

red-0ne · 2024-09-26T15:55:51Z

Summary

This PR incorporated the mining difficulty into the claim reward calculation.

Encapsulates the claimed tokens into a claim.GetClaimeduPOKT(params, difficulty)
Implements a test to assert that the difficulty based rewards are proportional to the off-chain relays served.
Removes unused min_relay_difficulty_bits gov. param.

It is based on the preparation work of PR #836.

Issue

[Relay Mining] Probabilistic Proofs <> Relay Mining Feedback Loop (i.e. Proportional Rewards) #781
[Load Testing] Permissionless Demand Implementation Umbrella Ticket #758

Type of change

Select one or more from the following:

New feature, functionality or library
Consensus breaking; add the consensus-breaking label if so. See [Infra] Automatically add the consensus-breaking label #791 for details
Bug fix
Code health or cleanup
Documentation
Other (specify)

Testing

Unit Tests: make go_develop_and_test
LocalNet E2E Tests: make test_e2e
DevNet E2E Tests: Add the devnet-test-e2e label to the PR.

Sanity Checklist

I have tested my changes using the available tooling
I have commented my code
I have performed a self-review of my own code; both comments & source code
I create and reference any new tickets, if applicable
I have left TODOs throughout the codebase, if applicable

…onal-rewards' into feat/difficulty-proportional-rewards

bryanchriswhite

Reviewed everything except for keeper_settle_pending_claims_test.go. Looking really clean! 👌 😎 🧼

pkg/crypto/rings/client.go

tests/integration/tokenomics/relay_mining_integration_test.go

x/proof/types/claim.go

x/service/keeper/update_relay_mining_difficulty.go

x/tokenomics/keeper/token_logic_modules_test.go

x/tokenomics/keeper/token_logic_modules.go

x/tokenomics/keeper/settle_pending_claims.go

…onal-rewards' into feat/difficulty-proportional-rewards

## Summary This PR prepares for claimed amount calculation to use the `RelayDifficultyMultiplier`. * It removes the `RelayDifficultyTargetHash` `proof` param. * Replace `prooftypes.DefaultRelayDifficultyTargetHash` occurrences with `protocol.BaseRelayDifficultyHashBz`. * Moves the `RleayMiningDifficulty` logic to the `service` module due to cyclic dependencies. * Rename `num_compute_units` to `num_claimed_compute_units` and add `num_estimated_compute_units` and `claimed_amount_upokt` * Remove the no longer used tokenomics querier to retrieve a service difficulty target hash. The PR is only renaming and moving of files most (~13200LOC) changes are auto-generated code. ## Type of change Select one or more from the following: - [ ] New feature, functionality or library - [x] Consensus breaking; add the `consensus-breaking` label if so. See #791 for details - [ ] Bug fix - [x] Code health or cleanup - [ ] Documentation - [ ] Other (specify) ## Testing - [ ] **Documentation**: `make docusaurus_start`; only needed if you make doc changes - [x] **Unit Tests**: `make go_develop_and_test` - [x] **LocalNet E2E Tests**: `make test_e2e` - [ ] **DevNet E2E Tests**: Add the `devnet-test-e2e` label to the PR. ## Sanity Checklist - [x] I have tested my changes using the available tooling - [x] I have commented my code - [x] I have performed a self-review of my own code; both comments & source code - [ ] I create and reference any new tickets, if applicable - [ ] I have left TODOs throughout the codebase, if applicable

github-actions · 2024-10-10T20:50:51Z

The CI will now also run the e2e tests on devnet, which increases the time it takes to complete all CI checks.

You may need to run make trigger_ci to submit an empty commit that'll trigger the tests.

GCP workloads (requires changing the namespace to 840)
Grafana network dashboard for devnet-issue-840

bryanchriswhite

Preemptively approving - just a few suggestions, otherwise LGTM! 🙌

Please do merge main before merging this.

🚢

tests/integration/service/relay_mining_difficulty_test.go

tests/integration/tokenomics/relay_mining_integration_test.go

bryanchriswhite · 2024-10-11T08:56:36Z

tests/integration/tokenomics/relay_mining_integration_test.go

+
+	// Prepare the test supplier.
+	supplierAddress := sample.AccAddress()
+	supplierStake := sdk.NewInt64Coin(volatile.DenomuPOKT, 1000)


Suggested change

supplierStake := sdk.NewInt64Coin(volatile.DenomuPOKT, 1000)

supplierStake := suppliertypes.DefaultMinStake

Supplier min stake is not merged yet

tests/integration/tokenomics/relay_mining_integration_test.go

x/tokenomics/keeper/keeper_settle_pending_claims_test.go

bryanchriswhite · 2024-10-11T09:39:47Z

x/tokenomics/keeper/keeper_settle_pending_claims_test.go

 	require.NoError(t, err)

 	// +1 to push threshold above s.claim's compute units
-	proofRequirementThreshold, err := tokenomics.NumComputeUnitsToCoin(sharedParams, numClaimComputeUnits+1)
-	require.NoError(t, err)
+	proofRequirementThreshold = proofRequirementThreshold.Add(uPOKTCoin(1))


Loving this pattern ❤️; nice and 🧼! 😎

x/tokenomics/keeper/settle_pending_claims.go

bryanchriswhite · 2024-10-11T09:50:22Z

x/tokenomics/keeper/token_logic_modules_test.go

+				// The current test suite sets the CUPR to 1, making sum == count * CUPR
+				// valid. So, we can change the last byte to 'b' to make it invalid.


👌 Thank you!

## Summary Updates `ProcessTokenLogicModules()` logic to unbond applications whose stake is below the minimum **after** processing all TLMs. ## Dependencies - #809 - #843 - #844 - #845 - #847 ## Dependents - #849 - #850 - #857 - #852 - #861 - #851 - #863 ## Issue - #612 ## Type of change Select one or more from the following: - [x] New feature, functionality or library - [ ] Consensus breaking; add the `consensus-breaking` label if so. See #791 for details - [ ] Bug fix - [ ] Code health or cleanup - [ ] Documentation - [ ] Other (specify) ## Testing - [ ] **Documentation**: `make docusaurus_start`; only needed if you make doc changes - [x] **Unit Tests**: `make go_develop_and_test` - [ ] **LocalNet E2E Tests**: `make test_e2e` - [ ] **DevNet E2E Tests**: Add the `devnet-test-e2e` label to the PR. ## Sanity Checklist - [x] I have tested my changes using the available tooling - [x] I have commented my code - [x] I have performed a self-review of my own code; both comments & source code - [ ] I create and reference any new tickets, if applicable - [x] I have left TODOs throughout the codebase, if applicable --------- Co-authored-by: Redouane Lakrache <[email protected]> Co-authored-by: Daniel Olshansky <[email protected]> Co-authored-by: red-0ne <[email protected]>

…rtional-rewards

**This is a repost of PR #840 which did not get merged into main** ## Summary This PR incorporated the mining difficulty into the claim reward calculation. * Encapsulates the claimed tokens into a `claim.GetClaimeduPOKT(params, difficulty)` * Implements a test to assert that the difficulty based rewards are proportional to the off-chain relays served. * Removes unused `min_relay_difficulty_bits` gov. param. It is based on the preparation work of PR #836. ## Issue - #781 - #758 ## Type of change Select one or more from the following: - [x] New feature, functionality or library - [ ] Consensus breaking; add the `consensus-breaking` label if so. See #791 for details - [ ] Bug fix - [ ] Code health or cleanup - [ ] Documentation - [ ] Other (specify) ## Testing - [x] **Unit Tests**: `make go_develop_and_test` - [x] **LocalNet E2E Tests**: `make test_e2e` - [ ] **DevNet E2E Tests**: Add the `devnet-test-e2e` label to the PR. ## Sanity Checklist - [x] I have tested my changes using the available tooling - [x] I have commented my code - [x] I have performed a self-review of my own code; both comments & source code - [ ] I create and reference any new tickets, if applicable - [x] I have left TODOs throughout the codebase, if applicable

red-0ne added 3 commits September 26, 2024 17:14

feat: Implement difficulty proportional rewards

9ea68c7

chore: Move misplaced comment

b4ee63a

chore: Add TODO to embed difficulty into service

f1a9dc2

red-0ne added the tokenomics Token Economics - what else do you need? label Sep 26, 2024

red-0ne added this to the Shannon Beta TestNet Launch milestone Sep 26, 2024

red-0ne requested review from bryanchriswhite and Olshansk September 26, 2024 15:55

red-0ne self-assigned this Sep 26, 2024

red-0ne mentioned this pull request Sep 26, 2024

[Load Testing] Permissionless Demand Implementation Umbrella Ticket #758

Open

23 tasks

red-0ne added 3 commits September 27, 2024 15:14

fix: Difficulty increase

a71f831

fix: Higher ratio delta

399ac9a

Merge remote-tracking branch 'origin/feat/prepare-difficulty-proporti…

67fcf24

…onal-rewards' into feat/difficulty-proportional-rewards

bryanchriswhite requested changes Oct 7, 2024

View reviewed changes

red-0ne added 4 commits October 10, 2024 00:34

fix: Relay mining difficulty keeper integration test

0ae2757

Merge remote-tracking branch 'origin/feat/prepare-difficulty-proporti…

53362ca

…onal-rewards' into feat/difficulty-proportional-rewards

fix: New service difficulty update

b349d6a

chore: Address reiview change requests

ee04055

red-0ne requested a review from bryanchriswhite October 10, 2024 02:55

red-0ne added the devnet-test-e2e label Oct 10, 2024

github-actions bot added devnet push-image CI related - pushes images to ghcr.io labels Oct 10, 2024

bryanchriswhite approved these changes Oct 11, 2024

View reviewed changes

bryanchriswhite and others added 5 commits October 11, 2024 17:26

Merge remote-tracking branch 'origin/main' into feat/difficulty-propo…

4567b61

…rtional-rewards

chore: Address review change requests

ba45eec

fix: Badly named variable

43f60de

fix: Shadowed declaration

e8b6a2d

red-0ne merged commit aab06af into feat/prepare-difficulty-proportional-rewards Oct 11, 2024
4 checks passed

This was referenced Oct 11, 2024

[Relay Mining] Probabilistic Proofs <> Relay Mining Feedback Loop (i.e. Proportional Rewards) #781

Closed

[Tokenomics] Implement difficulty proportional rewards #880

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Tokenomics] Implement difficulty proportional rewards #840

[Tokenomics] Implement difficulty proportional rewards #840

red-0ne commented Sep 26, 2024

bryanchriswhite left a comment

github-actions bot commented Oct 10, 2024

bryanchriswhite left a comment •

edited

Loading

bryanchriswhite Oct 11, 2024

red-0ne Oct 11, 2024

bryanchriswhite Oct 11, 2024

bryanchriswhite Oct 11, 2024

	supplierStake := sdk.NewInt64Coin(volatile.DenomuPOKT, 1000)
	supplierStake := suppliertypes.DefaultMinStake

		// The current test suite sets the CUPR to 1, making sum == count * CUPR
		// valid. So, we can change the last byte to 'b' to make it invalid.

[Tokenomics] Implement difficulty proportional rewards #840

[Tokenomics] Implement difficulty proportional rewards #840

Conversation

red-0ne commented Sep 26, 2024

Summary

Issue

Type of change

Testing

Sanity Checklist

bryanchriswhite left a comment

Choose a reason for hiding this comment

github-actions bot commented Oct 10, 2024

bryanchriswhite left a comment • edited Loading

Choose a reason for hiding this comment

bryanchriswhite Oct 11, 2024

Choose a reason for hiding this comment

red-0ne Oct 11, 2024

Choose a reason for hiding this comment

bryanchriswhite Oct 11, 2024

Choose a reason for hiding this comment

bryanchriswhite Oct 11, 2024

Choose a reason for hiding this comment

bryanchriswhite left a comment •

edited

Loading