[Gateway] Add `min_stake` gateway module param #809

bryanchriswhite · 2024-09-10T11:55:43Z

Summary

Adds the min_stake_gateway param to the gateway.

Depends on

Issue

[Utility] Minimum staking values for each actor #612

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

## Summary Ports the `MsgUpdateParams` and `MsgUpdateParam` E2E tests to integration tests, improving execution speed and maintainability. ## Depends on - #827 - #820 - #821 - #815 ## Dependents - #809 ## Issue - #799 ## 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 #791 for details - [ ] Bug fix - [x] Code health or cleanup - [ ] Documentation - [ ] Other (specify) ## Testing - [x] **Documentation**: `make docusaurus_start`; only needed if you make doc changes - [ ] **Unit Tests**: `make go_develop_and_test` - [ ] **LocalNet E2E Tests**: `make test_e2e` - [x] **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 - [x] I create and reference any new tickets, if applicable - [x] I have left TODOs throughout the codebase, if applicable --------- Co-authored-by: Daniel Olshansky <[email protected]> Co-authored-by: red-0ne <[email protected]>

…me as_type --response params

red-0ne

Left a few change requests but looks good overall.

config.yml

tools/scripts/params/gateway_min_stake.json

red-0ne · 2024-09-27T09:48:44Z

x/gateway/keeper/msg_server_update_param.go

+
+	// Perform a global validation on all params, which includes the updated param.
+	// This is needed to ensure that the updated param is valid in the context of all other params.
+	if err := params.Validate(); err != nil {


Suggested change

if err := params.Validate(); err != nil {

if err := params.ValidateBasic(); err != nil {

I chose not to rename it this time. My rationale is that it requires changing it in lots of other places which is not conducive to making the "adding parameters" step-by-step instructions any more concise. 😅

Do you have a strong opinion on this and/or a rationale that you could share?

x/gateway/keeper/msg_server_update_param_test.go

x/gateway/keeper/params_test.go

red-0ne · 2024-09-27T09:52:16Z

x/gateway/keeper/params_test.go

+			expectedErr: gatewaytypes.ErrGatewayParamInvalid.Wrapf("invalid type for %s: int64; expected *cosmostypes.Coin", gatewaytypes.ParamMinStake),
+		},
+		{
+			desc: "MinStake less than zero",


Shouldn't we validate that it's greater than zero?

Yes; however, the test descriptions are describing the test case. In this case, the min stake is less than zero. I was aiming for consistency with other tests but we can change it (and document it).

Do you have a principled way to think about how we should be phrasing test cases / scenarios?

x/gateway/types/params.go

tools/scripts/params/gateway_min_stake.json

Co-authored-by: Redouane Lakrache <[email protected]>

…e-param' into issues/612/param/min-stake-gateway * pokt/issues/612/chore/gateway-msg-update-param: chore: review feedback improvements [Docs] Update README(s) (#842)

## Summary ``` ignite scaffold message update-param --module gateway --signer authority name as_type --response params ``` Adds the `MsgUpdateParam` message so that the gateway module may update individual parameters. The gateway module's `min_stake` param will be added in #809. ## Issue - #612 ## Type of change Select one or more from the following: - [x] New feature, functionality or library - [x] 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 - [ ] **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 --------- Co-authored-by: Redouane Lakrache <[email protected]>

…ake-gateway * pokt/main: [Gateway] chore: add `MsgUpdateParam` to gateway module (#808)

bryanchriswhite added gateway Changes related to the Gateway actor governance Governance related changes on-chain On-chain business logic consensus-breaking IMPORTANT! If the PR with this tag is merged, next release WILL HAVE TO BE an upgrade. labels Sep 10, 2024

bryanchriswhite added this to the Shannon Beta TestNet Launch milestone Sep 10, 2024

bryanchriswhite self-assigned this Sep 10, 2024

bryanchriswhite linked an issue Sep 10, 2024 that may be closed by this pull request

[Utility] Minimum staking values for each actor #612

Open

10 tasks

bryanchriswhite force-pushed the issues/612/chore/gateway-msg-update-param branch from 65e0659 to 59b9b2d Compare September 23, 2024 15:40

bryanchriswhite force-pushed the issues/612/param/min-stake-gateway branch from 5e9c013 to 6e345d5 Compare September 23, 2024 15:41

bryanchriswhite force-pushed the issues/612/chore/gateway-msg-update-param branch from 59b9b2d to ae16cf3 Compare September 23, 2024 19:36

bryanchriswhite force-pushed the issues/612/param/min-stake-gateway branch 2 times, most recently from 6783b88 to 7e66b1d Compare September 23, 2024 19:49

bryanchriswhite mentioned this pull request Sep 25, 2024

[Testing] refractor: param update E2E tests as integration tests #826

Merged

15 tasks

bryanchriswhite added 4 commits September 26, 2024 08:56

scaffold: message update-param --module gateway --signer authority na…

d1cd5e6

…me as_type --response params

chore: update gateway MsgUpdateParam fields

91eecfc

chore: update MsgUpdateParamResponse fields

ef62280

chore: comment out autocli for gateway module param updates

f7a6e5b

bryanchriswhite force-pushed the issues/612/chore/gateway-msg-update-param branch from ae16cf3 to f7a6e5b Compare September 26, 2024 06:59

bryanchriswhite force-pushed the issues/612/param/min-stake-gateway branch 3 times, most recently from e4cc6df to 7b9c71a Compare September 26, 2024 08:37

bryanchriswhite added 4 commits September 26, 2024 10:43

fix: linter error

8957f1c

revert: premature changes

3016ca3

feat: add min_stake gateway module param

899effb

chore: cleanup makefiles and param update JSON files

83c1d74

bryanchriswhite mentioned this pull request Sep 26, 2024

[Gateway] chore: add MsgUpdateParam to gateway module #808

Merged

15 tasks

bryanchriswhite force-pushed the issues/612/param/min-stake-gateway branch from 7b9c71a to 1e46e35 Compare September 26, 2024 09:07

chore: add gateway module param make targets

55e6a31

bryanchriswhite force-pushed the issues/612/param/min-stake-gateway branch from 1e46e35 to 85019ff Compare September 26, 2024 09:26

bryanchriswhite added 6 commits September 26, 2024 13:04

refctor: consolidate param config types

ddd68bb

tests: improve error messaging

fa8caf6

tests: add coverage over gateway min stake param updates

ae006e2

chore: add as_coin as_type type 😉

e92e3b1

chore: add app MsgUpdateParam to genesis authorizations

b2e1267

fix: typo

0373fa2

bryanchriswhite force-pushed the issues/612/param/min-stake-gateway branch from d00b420 to 0373fa2 Compare September 26, 2024 11:05

chore: cleanup makefiles

da7894a

bryanchriswhite marked this pull request as draft September 26, 2024 11:38

bryanchriswhite added 2 commits September 26, 2024 14:28

wip: fixing tests

015c537

tests: add tests

1ac6c48

bryanchriswhite force-pushed the issues/612/param/min-stake-gateway branch from d6b5e0a to 1ac6c48 Compare September 26, 2024 13:51

bryanchriswhite marked this pull request as ready for review September 26, 2024 13:52

tests: remove erroneous case

db366f6

bryanchriswhite changed the title ~~[Params] Add min_stake_gateway gateway module param~~ [Params] Add min_stake gateway module param Sep 27, 2024

bryanchriswhite mentioned this pull request Sep 27, 2024

[Utility] Minimum staking values for each actor #612

Open

10 tasks

bryanchriswhite changed the title ~~[Params] Add min_stake gateway module param~~ [Gateway] Add min_stake gateway module param Sep 27, 2024

red-0ne requested changes Sep 27, 2024

View reviewed changes

bryanchriswhite commented Sep 27, 2024

View reviewed changes

x/gateway/types/params.go Outdated Show resolved Hide resolved

bryanchriswhite commented Sep 27, 2024

View reviewed changes

x/gateway/types/params.go Outdated Show resolved Hide resolved

bryanchriswhite commented Sep 27, 2024

View reviewed changes

tools/scripts/params/gateway_min_stake.json Show resolved Hide resolved

bryanchriswhite and others added 4 commits September 30, 2024 11:12

chore: review feedback improvements

4340590

Co-authored-by: Redouane Lakrache <[email protected]>

Merge branch 'main' into issues/612/chore/gateway-msg-update-param

4b8e95b

chore: review feedback improvements

0839ae4

Merge remote-tracking branch 'pokt/issues/612/chore/gateway-msg-updat…

34b0d6d

…e-param' into issues/612/param/min-stake-gateway * pokt/issues/612/chore/gateway-msg-update-param: chore: review feedback improvements [Docs] Update README(s) (#842)

fix: test error message

a77877b

bryanchriswhite changed the base branch from issues/612/chore/gateway-msg-update-param to main September 30, 2024 10:48

Merge remote-tracking branch 'pokt/main' into issues/612/param/min-st…

28962ba

…ake-gateway * pokt/main: [Gateway] chore: add `MsgUpdateParam` to gateway module (#808)

bryanchriswhite requested a review from red-0ne September 30, 2024 10:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Gateway] Add `min_stake` gateway module param #809

[Gateway] Add `min_stake` gateway module param #809

bryanchriswhite commented Sep 10, 2024 •

edited

Loading

red-0ne left a comment

red-0ne Sep 27, 2024

bryanchriswhite Sep 27, 2024

red-0ne Sep 27, 2024

bryanchriswhite Sep 27, 2024 •

edited

Loading

	if err := params.Validate(); err != nil {
	if err := params.ValidateBasic(); err != nil {

[Gateway] Add min_stake gateway module param #809

Are you sure you want to change the base?

[Gateway] Add min_stake gateway module param #809

Conversation

bryanchriswhite commented Sep 10, 2024 • edited Loading

Summary

Depends on

Issue

Type of change

Testing

Sanity Checklist

red-0ne left a comment

Choose a reason for hiding this comment

red-0ne Sep 27, 2024

Choose a reason for hiding this comment

bryanchriswhite Sep 27, 2024

Choose a reason for hiding this comment

red-0ne Sep 27, 2024

Choose a reason for hiding this comment

bryanchriswhite Sep 27, 2024 • edited Loading

Choose a reason for hiding this comment

[Gateway] Add `min_stake` gateway module param #809

[Gateway] Add `min_stake` gateway module param #809

bryanchriswhite commented Sep 10, 2024 •

edited

Loading

bryanchriswhite Sep 27, 2024 •

edited

Loading