fix(params): SetBytes should not alter the value bytes
SetBytes is used by the IBC contract to store the commitment bytes. Then the relayer submit the proof of existence of those bytes to the counter party chain, but if the value bytes are different, the proof cannot be verified.
This PR updates SetBytes to use directly the store instead of passing by the common set method, preventing the value to be aminoJSON encoded.
Removed GetRaw/SetRaw since GetBytes/SetBytes can be used as a replacement.
Note: I can't use SetRaw from gno code.
EDIT: added an other feature which is the deletion of value when SetBytes is invoked with a nil value. This is also required to remove the traces of packet commitments in IBC.
π PR Checks Summary
All Automated Checks passed. β
Manual Checks (for Reviewers):
- [ ] IGNORE the bot requirements for this PR (force green CI check)
Read More
π€ This bot helps streamline PR reviews by verifying automated checks and providing guidance for contributors and reviewers.
β Automated Checks (for Contributors):
π’ Maintainers must be able to edit this pull request (more info) π’ Pending initial approval by a review team member, or review from tech-staff
βοΈ Contributor Actions:
- Fix any issues flagged by automated checks.
- Follow the Contributor Checklist to ensure your PR is ready for review.
- Add new tests, or document why they are unnecessary.
- Provide clear examples/screenshots, if necessary.
- Update documentation, if required.
- Ensure no breaking changes, or include
BREAKING CHANGEnotes. - Link related issues/PRs, where applicable.
βοΈ Reviewer Actions:
- Complete manual checks for the PR, including the guidelines and additional checks if applicable.
π Resources:
Debug
Automated Checks
Maintainers must be able to edit this pull request (more info)
If
π’ Condition met βββ π’ And βββ π’ The base branch matches this pattern: ^master$ βββ π’ The pull request was created from a fork (head branch repo: tbruyelle/gno)Then
π’ Requirement satisfied βββ π’ Maintainer can modify this pull requestPending initial approval by a review team member, or review from tech-staff
If
π’ Condition met βββ π’ And βββ π’ The base branch matches this pattern: ^master$ βββ π’ Not (π΄ Pull request author is a member of the team: tech-staff)Then
π’ Requirement satisfied βββ π’ If βββ π’ Condition β βββ π’ Or β βββ π΄ At least one of these user(s) reviewed the pull request: [jefft0 leohhhn n0izn0iz notJoon omarsy x1unix] (with state "APPROVED") β βββ π’ At least 1 user(s) of the team tech-staff reviewed pull request β βββ π΄ This pull request is a draft βββ π’ Then βββ π’ Not (π΄ This label is applied to pull request: review/triage-pending)Manual Checks
**IGNORE** the bot requirements for this PR (force green CI check)
If
π’ Condition met βββ π’ On every pull requestCan be checked by
- Any user with comment edit permission
Codecov Report
:x: Patch coverage is 77.77778% with 2 lines in your changes missing coverage. Please review.
| Files with missing lines | Patch % | Lines |
|---|---|---|
| tm2/pkg/sdk/params/keeper.go | 75.00% | 2 Missing :warning: |
:loudspeaker: Thoughts on this report? Let us know!
Hi @tbruyelle . Are you able to fix the failed CI checks?
Hi @tbruyelle . Are you able to fix the failed CI checks?
Thank you for pointing that out; I hadn't spotted it. I'll take a look.
@jefft0 Tests are fixed, ty
I opened this PR (#4926) as an alternative that achieves the goal of the original while maintaining the previous API and ensuring consistency with other calls in this library.
I opened this PR (#4926) as an alternative that achieves the goal of the original while maintaining the previous API and ensuring consistency with other calls in this library.
Since GetBytes replaces GetRaw, it sounded more logic to me to stick to GetRaw API rather than the others Get*.
The others Get* take a pointer mainly because of the extra amino decoding step, which is now absent from GetBytes.
Hence, I'm in favour of keeping my version, but yours also works well for what I need, so up to you.
This is the inconsistency I mentioned in your PR. Since you said my PR works as well, I suggest merging mine, which has the highest level of consistency.
This is the inconsistency I mentioned in your PR. Since you said my PR works as well, I suggest merging mine, which has the highest level of consistency.
The inconsistency was already present in master between GetRaw and the others Get*.
And this higher level of consistency forces you to declare a byte array before using GetBytes while it is useless.
I'm not convinced but feel free to merge your PR and close that one. As along as I can use the parameters to store arbitrary bytes, it's OK for me.
GetRaw was an exception. GetString is more similar to other type-based getters. My PR (#4926) implements the necessary changes while maintaining consistency. ~(Edit: currently addressing your comment)~
If you dislike the current API with the needed declaration, we could consider changing it for all types, not just for String as you did here.
GetRaw was an exception. GetString is more similar to other type-based getters. My PR (#4926) implements the necessary changes while maintaining consistency. ~(Edit: currently addressing your comment)~
If you dislike the current API with the needed declaration, we could consider changing it for all types, not just for String as you did here.
You mean GetBytes rather than GetString right ?
You can't change the API for the other types, because as mentionned above the pointer is used for the amino unmarshalling.
GetBytes becomes the exception just as GetRaw used to be, because it doesn't amino marshal the passed data.
The key point is that GetXXX / SetXXX automatically append the XXX type suffix (.string, .int, etc.) to the key.
GetRaw / SetRaw were an exception not only because they skipped Amino marshalling, but because they allowed access to the raw value of any key. You had to manually append the suffix yourself, which made this possible:
SetString("foo", "bar")
GetRaw("foo.string")
GetBytes / SetBytes do append the .bytes suffix, so they are not an exception from that perspective. The only difference is that Amino marshalling is skipped, which is expected and sufficient here. That alone doesnβt justify having a separate or special API IMO.
This PR's approach may simplify a codebase that only ever uses a single type, but it breaks consistency for users who rely on multiple types and expect a uniform API.
Merged #4905 so we can move forward, thank you.
The key point is that
GetXXX/SetXXXautomatically append theXXXtype suffix (.string,.int, etc.) to the key.
GetBytes/SetBytesdo append the.bytessuffix
@moul Where does this take place? I've never seen anything like it before. It is potentially problematic because if the key is modified like this, it could compromise the proof verification process.
This is the inconsistency I mentioned in your PR. Since you said my PR works as well, I suggest merging mine, which has the highest level of consistency.