[RelayMiner] Supplier rate limiting #895

red-0ne · 2024-10-28T17:12:29Z

Summary

This PR adds an optimistic RelayMeter to the RelayMiner to monitor the consumed stake and stops servicing when maxStake is reached.

It works by

Intercepting RelayRequests before being served.
Assume the relay will be mined and deduce the corresponding amount from the consumed stake.
Send a rate-limited error if app stake share cannot cover of a minable RelayRequest.
After a relay has been served check if the Relay is volume applicable and revert the initial deduction if it is not.
Updates the known Applications stake if an EventApplicationStaked is observed.
Resets the Applications stakes at the beginning of every session.

Issue

RelayMiners need to know how much of the Application's stake they are allowed to consume without over-servicing.

Type of change

Select one or more from the following:

New feature, functionality or library

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

…Invalid_SupplierExceedsMaxClaimableAmount

…ributionCorrect

…_pokt_reimbursement_request

Olshansk

@red-0ne Please review all my comments (at a glance) before targeting them one-by-one. Something things made sense only when I finished reviewing anything.

@bryanchriswhite Want to make sure we get your 👀 on this as well.

config.yml

pkg/relayer/interface.go

pkg/relayer/proxy/relay_meter.go

Olshansk

@red-0ne Looking good to me w/ no blockers.

PTAL at the lingering nits.
Lmk what you want to do with the unit tests.
We definitely need a review from @bryanchriswhite given the overlap w/ settlement hardening.

config.yml

x/tokenomics/keeper/token_logic_modules.go

x/tokenomics/keeper/settle_pending_claims.go

pkg/relayer/proxy/relay_meter.go

Olshansk · 2024-11-07T18:23:01Z

pkg/relayer/proxy/relay_meter.go

+
+	// In case Allowance is positive, add it to the maxCoin to allow no or limited over-servicing.
+	if !allowUnlimitedOverServicing {
+		maxAllowedOverServicing := appRelayMeter.maxCoin.Add(rmtr.overServicingAllowanceCoins)


Could (should?) this be a value that we cache on initialization or new sessions?

There seems to be no need to caching or initialization, this is the only place where it's being used.

The maxCoin is updated at the beginning of each session, while overServicingAllowanceCoins are configured at startup and unchanged.

pkg/relayer/proxy/relay_meter.go

bryanchriswhite

Very clean and well commented! 🙌 🚀

pkg/relayer/miner/miner.go

pkg/relayer/miner/miner_test.go

pkg/relayer/proxy/proxy.go

x/tokenomics/keeper/token_logic_modules.go

Olshansk

@red-0ne Left one comment that really requies attention but approving a prior otherwise!

x/shared/types/session.go

bryanchriswhite · 2024-11-13T18:59:50Z

@red-0ne I'm confident that you addressed the comments from my prior review and then some. 💪 @Olshansk approved and I'm too distracted with other stuff to re-review this in a timely manner. Please merge! 🙌 🚢

(@Olshansk also approves this message 😉)

Olshansk · 2024-11-13T19:04:02Z

(@Olshansk also approves this message 😉)

Can't re-review in time.

…pdates * pokt/main: (51 commits) [RelayMiner] Supplier rate limiting (#895) [Tokenomics] refactor: `MintAllocationApplication` var usage to param usage (#918) [Tokenomics] feat: add `mint_allocation_application` param to tokenomics module (#917) [Tokenomics] refactor: `MintAllocationSourceOwner` var usage to param usage (#916) [Tokenomics] feat: add `mint_allocation_source_owner` param to tokenomics module (#915) [Tokenomics] refactor: `MintAllocationSupplier` var usage to param usage (#914) [Tokenomics] feat: add `mint_allocation_supplier` param to tokenomics module (#913) [Tokenomics] refactor: `MintAllocationProposer` var usage to param usage (#912) [Tokenomics] feat: add `mint_allocation_proposer` param to tokenomics module (#911) [Tokenomics] refactor: `MintAllocationDao` var usage to param usage (#910) [Tokenomics] Add `mint_allocation_dao` tokenomics module param (#909) [quick-pr] change full-node.sh script links (#920) [Supplier] refactor: `NumSuppliersPerSession` var usage to param usage (#908) [Session Params] Add `num_suppliers_per_session` param to session module (#907) [Session Params] Add `MsgUpdateParam` to session module (#906) Updated some compiled proto files [TODOs] Update #2 to `TODO_BETA` to only reflect ACTUAL blockers (#900) [Workflow] Enforce `TODO_UPNEXT` comments to have an associated username (#896) [Observability] Foundation for load testing telemetry (#832) [Tokenomics] Implement Global Mint Reimbursement Request (#878) ...

…tlement * pokt/main: [RelayMiner] Supplier rate limiting (#895) [Tokenomics] refactor: `MintAllocationApplication` var usage to param usage (#918) [Tokenomics] feat: add `mint_allocation_application` param to tokenomics module (#917) [Tokenomics] refactor: `MintAllocationSourceOwner` var usage to param usage (#916) [Tokenomics] feat: add `mint_allocation_source_owner` param to tokenomics module (#915) [Tokenomics] refactor: `MintAllocationSupplier` var usage to param usage (#914) [Tokenomics] feat: add `mint_allocation_supplier` param to tokenomics module (#913) [Tokenomics] refactor: `MintAllocationProposer` var usage to param usage (#912) [Tokenomics] feat: add `mint_allocation_proposer` param to tokenomics module (#911) [Tokenomics] refactor: `MintAllocationDao` var usage to param usage (#910) [Tokenomics] Add `mint_allocation_dao` tokenomics module param (#909) [quick-pr] change full-node.sh script links (#920) [Supplier] refactor: `NumSuppliersPerSession` var usage to param usage (#908) [Session Params] Add `num_suppliers_per_session` param to session module (#907) [Session Params] Add `MsgUpdateParam` to session module (#906) Updated some compiled proto files [TODOs] Update #2 to `TODO_BETA` to only reflect ACTUAL blockers (#900) [Workflow] Enforce `TODO_UPNEXT` comments to have an associated username (#896)

Olshansk and others added 30 commits August 15, 2024 21:39

WIP

6738d21

Merge branch 'main' into inflation

3e6a146

Checkpoint

c3a235a

Finished first version of the documentation

846bc1d

Merge branch 'main' into inflation

40c56a5

Revert tokenomic docs

98736f3

Performed self review

eeabb30

Merge with main

10ef513

Remove everything related to TLMGlobalMintReimbursementRequest

0e725a4

WIP

bbe2366

Fixed the TestProcessTokenLogicModules_TLMBurnEqualsMintValid test

ad70e70

WIP

b02ef24

Finished implementing TestProcessTokenLogicModules_TLMBurnEqualsMint_…

8663fac

…Invalid_SupplierExceedsMaxClaimableAmount

Implemented TestProcessTokenLogicModules_TLMGlobalMint_Valid_MintDist…

085d134

…ributionCorrect

Updated comments in e2e/tests/0_settlement.feature

1de13ba

Fixed failing unit test

b8dff51

Merge branch 'main' into issues/732_max_claimable_pokt

9231d6f

Merge branch 'main' into issues/732_max_claimable_pokt

f79989a

update compile proto

4c335e7

Merge remote-tracking branch 'origin/main' into issues/732_tokenomics…

0020303

…_pokt_reimbursement_request

fix: Remove merge added lines

f7a0da7

feat: Add GMRR

79ac3e6

fix: Skip GMRR if GMI is disabled

1befc5e

Merge remote-tracking branch 'origin/main' into issues/732_tokenomics…

e5a732b

…_pokt_reimbursement_request

fix: Activate GMRR TLM

197c5a0

chore: Add TODO for the relay miner to account for GMRR

61a62fa

Merge remote-tracking branch 'origin/main' into feat/gmrr

942c525

Merge remote-tracking branch 'origin/main' into feat/gmrr

5db96bc

fix: Min stake tests

13784b8

Merge remote-tracking branch 'origin/main' into feat/gmrr

2be5464

Olshansk requested changes Nov 5, 2024

View reviewed changes

red-0ne added 2 commits November 6, 2024 17:02

chore: Address review change requests

1146aba

fix: Do not process 0 claim amounts

7b8998e

red-0ne requested a review from Olshansk November 6, 2024 23:15

red-0ne added 3 commits November 7, 2024 00:20

Empty commit

88a3d45

fix: Prevent 0 settlement due to int div

4b04353

fix: consumed coin calculation

331654f

Olshansk requested changes Nov 7, 2024

View reviewed changes

bryanchriswhite previously requested changes Nov 8, 2024

View reviewed changes

chore: Address review change requests

1cb995c

red-0ne requested review from Olshansk and bryanchriswhite November 11, 2024 15:35

Olshansk approved these changes Nov 11, 2024

View reviewed changes

x/shared/types/session.go Outdated Show resolved Hide resolved

red-0ne added 9 commits November 11, 2024 18:04

fix: Remove wrong param comment

a39d5b2

chore: Remove already tackled TODOs

a2dd722

Merge remote-tracking branch 'origin/main' into feat/no-overservicing

2b64d0b

Merge remote-tracking branch 'origin/main' into feat/no-overservicing

586b20e

Merge remote-tracking branch 'origin/main' into feat/no-overservicing

75fc9b6

fix: Merge with main

b46cb72

Merge remote-tracking branch 'origin/main' into feat/no-overservicing

e7d14ba

Merge remote-tracking branch 'origin/main' into feat/no-overservicing

02e40fb

Merge remote-tracking branch 'origin/main' into feat/no-overservicing

990ef42

red-0ne added 2 commits November 13, 2024 21:25

fix: Missing session querier

8d491ce

Merge remote-tracking branch 'origin/main' into feat/no-overservicing

a800fbd

red-0ne merged commit fac4d6f into main Nov 13, 2024
11 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[RelayMiner] Supplier rate limiting #895

[RelayMiner] Supplier rate limiting #895

red-0ne commented Oct 28, 2024

Olshansk left a comment

Olshansk left a comment

Olshansk Nov 7, 2024

red-0ne Nov 11, 2024

bryanchriswhite left a comment

Olshansk left a comment

bryanchriswhite commented Nov 13, 2024

Olshansk commented Nov 13, 2024

[RelayMiner] Supplier rate limiting #895

[RelayMiner] Supplier rate limiting #895

Conversation

red-0ne commented Oct 28, 2024

Summary

Issue

Type of change

Testing

Sanity Checklist

Olshansk left a comment

Choose a reason for hiding this comment

Olshansk left a comment

Choose a reason for hiding this comment

Olshansk Nov 7, 2024

Choose a reason for hiding this comment

red-0ne Nov 11, 2024

Choose a reason for hiding this comment

bryanchriswhite left a comment

Choose a reason for hiding this comment

Olshansk left a comment

Choose a reason for hiding this comment

bryanchriswhite commented Nov 13, 2024

Olshansk commented Nov 13, 2024