[Tokenomics] Harden settlement (part 1: TLM isolation) #889

bryanchriswhite · 2024-10-22T13:35:09Z

Summary

Refactors claim settlement and token logic module processing:

Isolates TLM processors from the tokenomics keeper
Restructures settlement and TLM processing to avoid non-determinism
Consolidates and postpones ALL state modification until the end of settlement

Issue

[Tokenomics] Settlement safety #881

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

Documentation: make docusaurus_start; only needed if you make doc changes
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

github-actions · 2024-10-22T13:35:20Z

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 889)
Grafana network dashboard for devnet-issue-889

github-actions

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

linter-name (fail-on-found)

x/tokenomics/keeper/settle_pending_claims.go

x/tokenomics/token_logic_module/result.go

testutil/keeper/tokenomics.go

testutil/integration/options.go

tests/integration/tokenomics/token_logic_modules_test.go

x/tokenomics/token_logic_module/result.go

testutil/sample/sample.go

tests/integration/tokenomics/token_logic_modules_test.go

x/tokenomics/token_logic_module/distribution.go

x/tokenomics/token_logic_module/global_mint.go

- Isolate TLM processors from the tokenomics keeper - Restructure TLM processors to avoid non-deterministic execution - Consolidate and postpone ALL state modification until the end of settlement

…able

…ocessors

tests/integration/tokenomics/token_logic_modules/commutative_test.go

tests/integration/tokenomics/token_logic_modules/tlm_processor_suite_test.go

x/tokenomics/module/abci.go

x/tokenomics/token_logic_module/global_mint.go

Co-authored-by: Daniel Olshansky <[email protected]>

config.yml

proto/poktroll/tokenomics/types.proto

x/proof/module/autocli.go

x/proof/types/key_claim.go

x/tokenomics/keeper/keeper_settle_pending_claims_test.go

x/tokenomics/keeper/settle_pending_claims.go

x/tokenomics/types/settlement_result.go

Olshansk · 2024-11-18T19:08:29Z

x/tokenomics/types/settlement_result.go

+
+// GetNumComputeUnits returns the number of claimed compute units in the result's claim.
+func (r *SettlementResult) GetNumComputeUnits() (uint64, error) {
+	return r.Claim.GetNumClaimedComputeUnits()


OPTIONAL NIT (here and below):

if r.Claim == nil { return 0, fmt.Errorf("Claim is nil in SettlementResult") }

#Claim is not a pointer.

proto/poktroll/tokenomics/types.proto

Olshansk · 2024-11-18T20:48:13Z

x/tokenomics/keeper/settle_pending_claims.go

+			logger.Error(fmt.Sprintf("error slashing supplier %s: %s", expiredResult.GetSupplierOperatorAddr(), err))
+			return err
+		}
+		//}


x/tokenomics/keeper/settle_pending_claims.go

Olshansk · 2024-11-18T20:51:07Z

x/tokenomics/keeper/settle_pending_claims.go

+		//slices.Sort(expiredClaimSupplierOperatorAddresses)
+		//for _, supplierOperatorAddress := range expiredClaimSupplierOperatorAddresses {
+		//	slashingCount := supplierToExpiredClaimCount[supplierOperatorAddress]
+		if err := k.slashSupplierStake(ctx, expiredResult, expiredResult.GetSupplierOperatorAddr()); err != nil {


Why not just pass expiredResult and that's it?

Thanks for calling this out! 🙌

I think this was an incomplete refactor. This PR has gotten quite large and has been around for a bit. 😅 🎂 ➕

x/tokenomics/keeper/settle_pending_claims.go

Olshansk · 2024-11-18T20:54:25Z

x/tokenomics/keeper/settle_pending_claims.go

-	if err := k.bankKeeper.SendCoinsFromModuleToModule(ctx, suppliertypes.ModuleName, tokenomicstypes.ModuleName, cosmostypes.NewCoins(totalSlashingCoin)); err != nil {
-		return err
-	}
+	//if err := k.bankKeeper.SendCoinsFromModuleToModule(ctx, suppliertypes.ModuleName, tokenomicstypes.ModuleName, cosmostypes.NewCoins(slashingCoin)); err != nil {


Co-authored-by: Daniel Olshansky <[email protected]>

* pokt/main: [C&P] Populate NumEstimatedComputeUnits and ClaimedUpokt of Claim and Proof events (#927) [Tokenomics] feat: add `dao_reward_address` param to tokenomics module (#922)

* todo_beta/upnext: [C&P] Populate NumEstimatedComputeUnits and ClaimedUpokt of Claim and Proof events (#927) [Tokenomics] feat: add `dao_reward_address` param to tokenomics module (#922) chore: review feedback improvements chore: review feedback improvements [Service] Return the default RelayMinerDifficuly for services that have none. (#926) [Upgrade] Alpha TestNet v0.0.10 upgrade (#894) Update reviewdog.yml

…tlement * pokt/main: [Tokenomics] Consolidate `mint_allocation_<actor>` params & CLI cleanup (#923)

bryanchriswhite added on-chain On-chain business logic code health Cleans up some code devnet-test-e2e tokenomics Token Economics - what else do you need? labels Oct 22, 2024

bryanchriswhite added this to the Shannon Beta TestNet Launch milestone Oct 22, 2024

bryanchriswhite self-assigned this Oct 22, 2024

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

github-actions bot reviewed Oct 22, 2024

View reviewed changes

bryanchriswhite linked an issue Oct 23, 2024 that may be closed by this pull request

[Tokenomics] Settlement safety #881

Open

6 tasks

bryanchriswhite force-pushed the issues/881/refactor/settlement branch from 2df9645 to 77a3944 Compare October 23, 2024 17:56

github-actions bot reviewed Oct 23, 2024

View reviewed changes

github-actions bot reviewed Oct 24, 2024

View reviewed changes

bryanchriswhite force-pushed the issues/881/refactor/settlement branch from 3731434 to 65c9499 Compare October 24, 2024 17:31

bryanchriswhite added 8 commits October 24, 2024 22:09

wip: refactor:

656994e

- Isolate TLM processors from the tokenomics keeper - Restructure TLM processors to avoid non-deterministic execution - Consolidate and postpone ALL state modification until the end of settlement

chore: configurable tlm processors and dao reward address global vari…

aab77f5

…able

refactor: rename session testkeeper WithSharedModuleParams helper

f1339ef

refactor: TokenomicsModuleKeepers helpers to support injecting TLM pr…

bec435f

…ocessors

refactor: eliminate non-deterministic iteration from claim settlement

2f33a71

test: ALL TLMs are commutative

c39c096

refactor: val & cons addr helpers

86e28cb

chore: don't schedule transfers for 0 amounts

24ceb12

bryanchriswhite force-pushed the issues/881/refactor/settlement branch from d5eb029 to 24ceb12 Compare October 24, 2024 20:40

bryanchriswhite added 3 commits October 24, 2024 22:56

test: improve permute test

a111ecc

wip: chore: add comments

c04a919

test: split up tlm processor test suite

29a75b2

github-actions bot reviewed Oct 24, 2024

View reviewed changes

bryanchriswhite commented Oct 24, 2024

View reviewed changes

x/tokenomics/module/abci.go Outdated Show resolved Hide resolved

bryanchriswhite commented Oct 24, 2024

View reviewed changes

x/tokenomics/token_logic_module/global_mint.go Show resolved Hide resolved

github-actions bot added the devnet label Nov 15, 2024

bryanchriswhite and others added 5 commits November 18, 2024 10:35

chore: review feedback improvements

6a76fad

Co-authored-by: Daniel Olshansky <[email protected]>

Merge branch 'main' into todo_beta/params/dao_reward_address

dc27640

chore: review feedback improvements

fb6466f

chore: review feedback improvements

60ea928

chore: review feedback improvements

9db0399