refactor(testutil): remove staking from testutil/sims
#21059
Conversation
julienrbrt
added
the
backport/v0.52.x
WalkthroughWalkthroughThe changes primarily focus on renaming and restructuring test suites to reflect a transition from integration tests to end-to-end (E2E) tests, enhancing clarity in the test suite's purpose. Additionally, significant updates were made to the staking management code, including new data structures and improved state handling through protobuf serialization. These modifications aim to enhance code maintainability and functionality while streamlining configuration management. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant TestSuite
participant StakingModule
User->>TestSuite: Run E2E Tests
TestSuite->>StakingModule: Initialize Staking State
StakingModule->>StakingModule: Serialize State to Proto
StakingModule->>TestSuite: Return Staking State
TestSuite->>User: Test Results
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
github-actions
bot
added
C:server/v2
C:server/v2 cometbft
and removed
C:CLI
C:x/genutil
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Files selected for processing (6)
- tests/e2e/server/grpc/out_of_gas_test.go (3 hunks)
- tests/e2e/server/grpc/server_test.go (10 hunks)
- testutil/sims/app_helpers.go (5 hunks)
- testutil/sims/staking.go (1 hunks)
- testutil/sims/state_helpers.go (4 hunks)
- x/genutil/client/testutil/helpers.go (1 hunks)
Files skipped from review due to trivial changes (2)
- tests/e2e/server/grpc/server_test.go
- x/genutil/client/testutil/helpers.go
Additional context used
Path-based instructions (4)
tests/e2e/server/grpc/out_of_gas_test.go (3)
Pattern
**/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.
Pattern
tests/**/*: "Assess the integration and e2e test code assessing sufficient code coverage for the changes associated in the pull request"
Pattern
**/*_test.go: "Assess the unit test code assessing sufficient code coverage for the changes associated in the pull request"testutil/sims/state_helpers.go (1)
Pattern
**/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.testutil/sims/app_helpers.go (1)
Pattern
**/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.testutil/sims/staking.go (1)
Pattern
**/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.
Additional comments not posted (29)
tests/e2e/server/grpc/out_of_gas_test.go (6)
27-33: Renaming is consistent.The struct
E2ETestOutOfGasSuiteis correctly renamed fromIntegrationTestOutOfGasSuite. The struct fields remain unchanged.
Line range hint
35-64:
Renaming and log message update are consistent.The method
SetupSuiteis correctly renamed toE2ETestOutOfGasSuite.SetupSuite. The log message correctly reflects the E2E test suite.
66-70: Renaming and log message update are consistent.The method
TearDownSuiteis correctly renamed toE2ETestOutOfGasSuite.TearDownSuite. The log message correctly reflects the E2E test suite.
72-78: Renaming is consistent.The method
TestGRPCServer_TestServiceis correctly renamed toE2ETestOutOfGasSuite.TestGRPCServer_TestService. The method functionality remains unchanged.
Line range hint
80-94:
Renaming is consistent.The method
TestGRPCServer_BankBalance_OutOfGasis correctly renamed toE2ETestOutOfGasSuite.TestGRPCServer_BankBalance_OutOfGas. The method functionality remains unchanged.
96-98: Renaming is consistent.The method
TestE2ETestOutOfGasSuiteis correctly renamed fromTestIntegrationTestOutOfGasSuite. The method functionality remains unchanged.testutil/sims/state_helpers.go (6)
150-153: Verify the status value for unbonded validators.The status value
1for unbonded validators should be verified to ensure it is correctly used.
142-145: EnsureToProtomethod is correctly implemented.The
ToProtomethod of the staking state should be verified to ensure it correctly converts the staking state to protobuf.Verification successful
Ensure
ToProtomethod is correctly implemented.The
ToProtomethod forStakingGenesisStatecorrectly converts the staking state to protobuf format. It handles the conversion of parameters and other necessary fields, and appropriately manages error cases.
- File:
testutil/sims/staking.go- Method:
func (s *StakingGenesisState) ToProto() (*anypb.Any, error)Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the implementation of `ToProto` method. # Test: Search for the implementation of `ToProto` method. Expect: Correct implementation. rg --type go --pattern 'ToProto'Length of output: 444
Script:
#!/bin/bash # Description: Verify the implementation of `ToProto` method. # Test: Search for the implementation of `ToProto` method. Expect: Correct implementation. rg 'func (.*) ToProto' --type go -A 10Length of output: 4801
127-128: Ensuretestutil.StakingModuleNameis correctly defined.The usage of
testutil.StakingModuleNameshould be verified to ensure it is correctly defined and used.Verification successful
The
StakingModuleNameis correctly defined and used.
testutil/types.go: StakingModuleName = "staking"Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the definition of `StakingModuleName` in `testutil`. # Test: Search for the definition of `StakingModuleName`. Expect: Correct definition. rg --type go --pattern 'StakingModuleName'Length of output: 454
Script:
#!/bin/bash # Description: Verify the definition of `StakingModuleName` in `testutil`. # Test: Search for the definition of `StakingModuleName`. Expect: Correct definition. rg 'StakingModuleName' --type goLength of output: 1072
183-189: Ensure module state callback is correctly implemented.The module state callback function should be verified to ensure it is correctly implemented and used.
Verification successful
Module state callback is correctly implemented.
The
moduleStateCbfunction is correctly defined and used within thetestutil/sims/state_helpers.gofile. It is conditionally invoked to handle module states, ensuring safe execution.
testutil/sims/state_helpers.go: Lines 183-189, 197-202Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the implementation of module state callback function. # Test: Search for the implementation of module state callback function. Expect: Correct implementation. rg --type go --pattern 'moduleStateCb'Length of output: 450
Script:
#!/bin/bash # Description: Verify the implementation of module state callback function. # Test: Search for the implementation of module state callback function. Expect: Correct implementation. rg 'moduleStateCb'Length of output: 856
Script:
#!/bin/bash # Description: Extract context around the implementation and usage of moduleStateCb function. # Test: Extract context around the lines where moduleStateCb is defined and used. rg 'moduleStateCb' -A 5 -B 5 testutil/sims/state_helpers.goLength of output: 1668
132-133: Ensureanypb.Anyis correctly used for unmarshaling.The usage of
anypb.Anyfor unmarshaling the staking state should be verified to ensure it is correctly implemented.Verification successful
Usage of
anypb.Anyfor unmarshaling is correctly implemented.The code correctly unmarshals JSON into an
anypb.Anyobject and then converts it to a specific staking genesis state.
testutil/sims/state_helpers.go:
- Lines 132-133: Correct usage of
anypb.Anyfor unmarshalingScripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the usage of `anypb.Any` for unmarshaling. # Test: Search for the usage of `anypb.Any`. Expect: Correct usage. rg --type go --pattern 'anypb.Any'Length of output: 446
Script:
#!/bin/bash # Description: Verify the usage of `anypb.Any` for unmarshaling. # Test: Search for the usage of `anypb.Any`. Expect: Correct usage. rg 'anypb.Any' --type goLength of output: 76203
Script:
#!/bin/bash # Description: Extract lines around the usage of `anypb.Any` in `testutil/sims/state_helpers.go` to verify correct implementation for unmarshaling. # Extract 10 lines before and after the usage of `anypb.Any` in `testutil/sims/state_helpers.go` rg 'anypb.Any' -A 10 -B 10 testutil/sims/state_helpers.goLength of output: 547
137-140: EnsureProtoToStakingGenesisStatefunction is correctly implemented.The function
ProtoToStakingGenesisStateshould be verified to ensure it correctly converts the protobuf representation to the staking genesis state.testutil/sims/app_helpers.go (7)
244-248: EnsureLegacyNewDecFromStrmethod is correctly used for commission rate.The method
LegacyNewDecFromStrshould be verified to ensure it correctly sets the commission rate.Verification successful
Verified: The
LegacyNewDecFromStrmethod is correctly used for setting the commission rate.The method is used to convert a string representation of a decimal to a
LegacyDectype, and the error handling is properly implemented.
testutil/sims/app_helpers.goline 244:commission, err := sdkmath.LegacyNewDecFromStr("0.5")Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the usage of `LegacyNewDecFromStr` method for commission rate. # Test: Search for the usage of `LegacyNewDecFromStr`. Expect: Correct usage. rg --type go --pattern 'LegacyNewDecFromStr'Length of output: 456
Script:
#!/bin/bash # Description: Verify the usage of `LegacyNewDecFromStr` method for commission rate. # Test: Search for the usage of `LegacyNewDecFromStr`. Expect: Correct usage. rg 'LegacyNewDecFromStr'Length of output: 9581
277-282: EnsureStakingDelegationfields are correctly set.The fields of
StakingDelegationshould be verified to ensure they are correctly set, includingDelegatorAddress,ValidatorAddress, andShares.Verification successful
The fields of
StakingDelegationare correctly set.The fields
DelegatorAddress,ValidatorAddress, andSharesin theStakingDelegationstruct match the fields being set in the provided code snippet.
DelegatorAddressis set togenAccs[0].GetAddress().String()ValidatorAddressis set tosdk.ValAddress(val.Address).String()Sharesis set tosdkmath.LegacyOneDec()Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the fields of `StakingDelegation` are correctly set. # Test: Search for the definition of `StakingDelegation` and verify the fields. Expect: Correct fields. rg --type go --pattern 'type StakingDelegation'Length of output: 461
Script:
#!/bin/bash # Description: Verify the fields of `StakingDelegation` are correctly set. # Test: Search for the definition of `StakingDelegation` and verify the fields. Expect: Correct fields. rg 'type StakingDelegation' --type go -A 10Length of output: 1030
226-228: EnsureStakingValidator,LastValidatorPower, andStakingDelegationare correctly defined.The new types
StakingValidator,LastValidatorPower, andStakingDelegationshould be verified to ensure they are correctly defined and used.Verification successful
Ensure
StakingValidator,LastValidatorPower, andStakingDelegationare correctly defined.The new types
StakingValidator,LastValidatorPower, andStakingDelegationare defined as follows:
StakingValidatoris defined with fields for operator address, consensus public key, jailed status, validator status, and tokens.LastValidatorPoweris defined with fields for address and power.StakingDelegationis defined with fields for delegator address, validator address, and shares.These definitions appear to be correctly structured and include the necessary fields for their respective purposes.
testutil/sims/staking.go:
type StakingValidator structtype LastValidatorPower structtype StakingDelegation structScripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the definition of new types `StakingValidator`, `LastValidatorPower`, and `StakingDelegation`. # Test: Search for the definition of new types. Expect: Correct definition. rg --type go --pattern 'type StakingValidator' rg --type go --pattern 'type LastValidatorPower' rg --type go --pattern 'type StakingDelegation'Length of output: 1385
Script:
#!/bin/bash # Description: Verify the definition of new types `StakingValidator`, `LastValidatorPower`, and `StakingDelegation`. # Test: Search for the definition of new types. Expect: Correct definition. rg 'type StakingValidator' --type go rg 'type LastValidatorPower' --type go rg 'type StakingDelegation' --type goLength of output: 497
Script:
#!/bin/bash # Description: Retrieve the definitions of `StakingValidator`, `LastValidatorPower`, and `StakingDelegation` from `testutil/sims/staking.go`. # Test: Extract the definitions. rg 'type StakingValidator struct' -A 10 testutil/sims/staking.go rg 'type LastValidatorPower struct' -A 10 testutil/sims/staking.go rg 'type StakingDelegation struct' -A 10 testutil/sims/staking.goLength of output: 2370
272-275: EnsureLastValidatorPowerfields are correctly set.The fields of
LastValidatorPowershould be verified to ensure they are correctly set, includingAddressandPower.Verification successful
Verification successful:
LastValidatorPowerfields are correctly set.The fields
AddressandPowerare correctly defined in theLastValidatorPowerstruct.
x/staking/types/genesis.pb.gotestutil/sims/staking.goScripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the fields of `LastValidatorPower` are correctly set. # Test: Search for the definition of `LastValidatorPower` and verify the fields. Expect: Correct fields. rg --type go --pattern 'type LastValidatorPower'Length of output: 462
Script:
#!/bin/bash # Description: Verify the fields of `LastValidatorPower` are correctly set. # Test: Search for the definition of `LastValidatorPower` and verify the fields. Expect: Correct fields. rg 'type LastValidatorPower' -A 5Length of output: 1416
286-301: EnsureStakingGenesisStateis correctly defined and used.The new type
StakingGenesisStateshould be verified to ensure it is correctly defined and used, including its fieldsParams,LastTotalPower,LastValidatorPowers,Validators,Delegations, andExported.Verification successful
StakingGenesisState is correctly defined and used.
The definition of
StakingGenesisStateintestutil/sims/staking.goincludes all the fields used in the provided snippet, ensuring its correctness.
ParamsLastTotalPowerLastValidatorPowersValidatorsDelegationsExportedScripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the definition and usage of `StakingGenesisState`. # Test: Search for the definition of `StakingGenesisState` and verify the fields. Expect: Correct definition and usage. rg --type go --pattern 'type StakingGenesisState'Length of output: 463
Script:
#!/bin/bash # Description: Verify the definition and usage of `StakingGenesisState`. # Test: Search for the definition of `StakingGenesisState` and verify the fields. Expect: Correct definition and usage. rg 'type StakingGenesisState' --type go -A 10Length of output: 1185
Script:
#!/bin/bash # Description: Verify the definition and usage of `StakingGenesisState`. # Test: Search for the remaining fields `Delegations` and `Exported` in the `StakingGenesisState` definition. rg 'type StakingGenesisState' --type go -A 20Length of output: 1925
249-267: EnsureStakingValidatorfields are correctly set.The fields of
StakingValidatorshould be verified to ensure they are correctly set, includingOperatorAddress,ConsensusPubkey,Status,Tokens,DelegatorShares,Description,Commission, andMinSelfDelegation.Verification successful
Verified: The fields of
StakingValidatorare correctly set.The struct
StakingValidatorincludes all the necessary fields:OperatorAddress,ConsensusPubkey,Status,Tokens,DelegatorShares,Description,Commission, andMinSelfDelegation.
OperatorAddressConsensusPubkeyStatusTokensDelegatorSharesDescriptionCommissionMinSelfDelegationScripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the fields of `StakingValidator` are correctly set. # Test: Search for the definition of `StakingValidator` and verify the fields. Expect: Correct fields. rg --type go --pattern 'type StakingValidator'Length of output: 460
Script:
#!/bin/bash # Description: Verify the fields of `StakingValidator` are correctly set. # Test: Search for the definition of `StakingValidator` and verify the fields. Expect: Correct fields. rg 'type StakingValidator' --type goLength of output: 160
Script:
#!/bin/bash # Description: Extract the definition of `StakingValidator` struct to verify the fields. # Extract the definition of the `StakingValidator` struct from the file. rg 'type StakingValidator struct' -A 20 testutil/sims/staking.goLength of output: 2002
Script:
#!/bin/bash # Description: Extract more lines from the definition of `StakingValidator` struct to verify the remaining fields. # Extract the definition of the `StakingValidator` struct from the file, including more lines. rg 'type StakingValidator struct' -A 40 testutil/sims/staking.goLength of output: 3222
308-316: Ensure marshaling and extracting staking genesis proto is correctly implemented.The marshaling and extracting of staking genesis proto should be verified to ensure it is correctly implemented.
testutil/sims/staking.go (10)
23-29: LGTM!The
LastValidatorPowerstruct is well-defined.
31-46: LGTM!The fields in
StakingGenesisStateare well-defined and follow protobuf conventions.
182-198: LGTM!The fields in
StakingParamsare well-defined and follow protobuf conventions.
200-219: LGTM!The
ToProtomethod inStakingParamsis well-structured and does not have any issues.
222-258: LGTM!The
ProtoToStakingParamsmethod inStakingParamsis well-structured and does not have any issues.
260-287: LGTM!The fields in
StakingValidatorare well-defined and follow protobuf conventions.
290-292: LGTM!The
SetPubKeyContretemethod is simple and does not have any issues.
428-439: LGTM!The fields in
StakingDescriptionare well-defined and follow protobuf conventions.
442-456: LGTM!The
ToProtomethod inStakingDescriptionis well-structured and does not have any issues.
459-472: LGTM!The
ProtoToStakingDescriptionmethod inStakingDescriptionis well-structured and does not have any issues.
| func ProtoToStakingGenesisState(protoMsg *anypb.Any) (*StakingGenesisState, error) { | ||
| var s structpb.Struct | ||
| if err := protoMsg.UnmarshalTo(&s); err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| genesisState := &StakingGenesisState{} | ||
|
|
||
| // Parse Params | ||
| paramsAny, err := anypb.New(s.Fields["params"].GetStructValue()) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| params, err := ProtoToStakingParams(paramsAny) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| genesisState.Params = *params | ||
|
|
||
| // Parse LastTotalPower | ||
| lastTotalPower, ok := math.NewIntFromString(s.Fields["last_total_power"].GetStringValue()) | ||
| if !ok { | ||
| return nil, fmt.Errorf("failed to parse last_total_power") | ||
| } | ||
| genesisState.LastTotalPower = lastTotalPower | ||
|
|
||
| // Parse LastValidatorPowers | ||
| lastValidatorPowersValue := s.Fields["last_validator_powers"].GetListValue() | ||
| genesisState.LastValidatorPowers = make([]LastValidatorPower, len(lastValidatorPowersValue.Values)) | ||
| for i, v := range lastValidatorPowersValue.Values { | ||
| lvpStruct := v.GetStructValue() | ||
| genesisState.LastValidatorPowers[i] = LastValidatorPower{ | ||
| Address: lvpStruct.Fields["address"].GetStringValue(), | ||
| Power: int64(lvpStruct.Fields["power"].GetNumberValue()), | ||
| } | ||
| } | ||
|
|
||
| // Parse Validators | ||
| validatorsValue := s.Fields["validators"].GetListValue() | ||
| genesisState.Validators = make([]StakingValidator, len(validatorsValue.Values)) | ||
| for i, v := range validatorsValue.Values { | ||
| validatorAny, err := anypb.New(v.GetStructValue()) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| validator, err := ProtoToStakingValidator(validatorAny) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| genesisState.Validators[i] = *validator | ||
| } | ||
|
|
||
| // Parse Delegations | ||
| delegationsValue := s.Fields["delegations"].GetListValue() | ||
| genesisState.Delegations = make([]StakingDelegation, len(delegationsValue.Values)) | ||
| for i, v := range delegationsValue.Values { | ||
| delegationAny, err := anypb.New(v.GetStructValue()) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| delegation, err := ProtoToStakingDelegation(delegationAny) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| genesisState.Delegations[i] = *delegation | ||
| } | ||
|
|
||
| // Parse Exported | ||
| genesisState.Exported = s.Fields["exported"].GetBoolValue() | ||
|
|
||
| return genesisState, nil |
There was a problem hiding this comment.
Refactor repetitive code in ProtoToStakingGenesisState method.
The method has repetitive code blocks for parsing fields from protobuf maps. Consider extracting this logic into a helper function to improve maintainability.
func ProtoToStakingGenesisState(protoMsg *anypb.Any) (*StakingGenesisState, error) {
var s structpb.Struct
if err := protoMsg.UnmarshalTo(&s); err != nil {
return nil, err
}
genesisState := &StakingGenesisState{}
params, err := parseProtoField(s.Fields["params"])
if err != nil {
return nil, err
}
genesisState.Params = *params.(*StakingParams)
lastTotalPower, err := parseProtoField(s.Fields["last_total_power"])
if err != nil {
return nil, err
}
genesisState.LastTotalPower = lastTotalPower.(math.Int)
lastValidatorPowers, err := parseProtoListField(s.Fields["last_validator_powers"])
if err != nil {
return nil, err
}
genesisState.LastValidatorPowers = lastValidatorPowers.([]LastValidatorPower)
validators, err := parseProtoListField(s.Fields["validators"])
if err != nil {
return nil, err
}
genesisState.Validators = validators.([]StakingValidator)
delegations, err := parseProtoListField(s.Fields["delegations"])
if err != nil {
return nil, err
}
genesisState.Delegations = delegations.([]StakingDelegation)
genesisState.Exported = s.Fields["exported"].GetBoolValue()
return genesisState, nil
}
func parseProtoField(field *structpb.Value) (interface{}, error) {
// Logic to parse a single field from protobuf map
}
func parseProtoListField(field *structpb.Value) (interface{}, error) {
// Logic to parse a list of fields from protobuf map
}| func (s *StakingValidator) ToProto() (*anypb.Any, error) { | ||
| var consensusPubkeyProto map[string]interface{} | ||
| if s.ConsensusPubkey != nil { | ||
| consensusPubkeyProto = map[string]interface{}{ | ||
| "@type": s.ConsensusPubkey.TypeUrl, | ||
| "key": s.consensusPubKeyConcrete.Bytes(), | ||
| } | ||
| } | ||
|
|
||
| descriptionAny, err := s.Description.ToProto() | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| descriptionProto, err := structpbToMap(descriptionAny) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| commissionAny, err := s.Commission.ToProto() | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| commissionProto, err := structpbToMap(commissionAny) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| unbondingIds := make([]interface{}, len(s.UnbondingIds)) | ||
| for i, id := range s.UnbondingIds { | ||
| unbondingIds[i] = id | ||
| } | ||
|
|
||
| fields := map[string]interface{}{ | ||
| "operator_address": s.OperatorAddress, | ||
| "consensus_pubkey": consensusPubkeyProto, | ||
| "jailed": s.Jailed, | ||
| "status": s.Status, | ||
| "tokens": s.Tokens.String(), | ||
| "delegator_shares": s.DelegatorShares.String(), | ||
| "description": descriptionProto, | ||
| "unbonding_height": s.UnbondingHeight, | ||
| "unbonding_time": s.UnbondingTime.Format(time.RFC3339), | ||
| "commission": commissionProto, | ||
| "min_self_delegation": s.MinSelfDelegation.String(), | ||
| "unbonding_on_hold_ref_count": s.UnbondingOnHoldRefCount, | ||
| "unbonding_ids": unbondingIds, | ||
| } | ||
|
|
||
| pbStruct, err := structpb.NewStruct(fields) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| return anypb.New(pbStruct) |
There was a problem hiding this comment.
Refactor repetitive code in ToProto method.
The method has repetitive code blocks for converting fields to protobuf maps. Consider extracting this logic into a helper function to improve maintainability.
func (s *StakingValidator) ToProto() (*anypb.Any, error) {
consensusPubkeyProto, err := convertToProtoMap(s.ConsensusPubkey)
if err != nil {
return nil, err
}
descriptionProto, err := convertToProtoMap(s.Description)
if err != nil {
return nil, err
}
commissionProto, err := convertToProtoMap(s.Commission)
if err != nil {
return nil, err
}
unbondingIds, err := convertListToProtoMap(s.UnbondingIds)
if err != nil {
return nil, err
}
fields := map[string]interface{}{
"operator_address": s.OperatorAddress,
"consensus_pubkey": consensusPubkeyProto,
"jailed": s.Jailed,
"status": s.Status,
"tokens": s.Tokens.String(),
"delegator_shares": s.DelegatorShares.String(),
"description": descriptionProto,
"unbonding_height": s.UnbondingHeight,
"unbonding_time": s.UnbondingTime.Format(time.RFC3339),
"commission": commissionProto,
"min_self_delegation": s.MinSelfDelegation.String(),
"unbonding_on_hold_ref_count": s.UnbondingOnHoldRefCount,
"unbonding_ids": unbondingIds,
}
pbStruct, err := structpb.NewStruct(fields)
if err != nil {
return nil, err
}
return anypb.New(pbStruct)
}
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Files selected for processing (1)
- server/v2/cometbft/client/grpc/cmtservice/service.go (2 hunks)
Files skipped from review due to trivial changes (1)
- server/v2/cometbft/client/grpc/cmtservice/service.go
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Files selected for processing (1)
- testutil/sims/staking.go (1 hunks)
Files skipped from review as they are similar to previous changes (1)
- testutil/sims/staking.go
|
Closing this and won't extract #20887 as more changes need to happen at the same place, so might as well do it there. |
Description
Extracts testutil/sims changes from #20887.
Integration tests should pass.
Author Checklist
All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.
I have...
!in the type prefix if API or client breaking changeCHANGELOG.mdReviewers Checklist
All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.
Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.
I have...
Summary by CodeRabbit