refactor: Improve txRaw decoder code (#9769)
<!-- The default pull request template is for types feat, fix, or refactor. For other templates, add one of the following parameters to the url: - template=docs.md - template=other.md --> ## Description Apply post-merge reviews to a previous PR ref: https://github.com/cosmos/cosmos-sdk/pull/9754#pullrequestreview-713819730 <!-- Add a description of the changes that this PR introduces and the files that are the most critical to review. --> --- ### 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... - [ ] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] added `!` to the type prefix if API or client breaking change - [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting)) - [ ] provided a link to the relevant issue or specification - [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules) - [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing) - [ ] added a changelog entry to `CHANGELOG.md` - [ ] included comments for [documenting Go code](https://blog.golang.org/godoc) - [ ] updated the relevant documentation or specification - [ ] reviewed "Files changed" and left comments if necessary - [ ] confirmed all CI checks have passed ### Reviewers 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.* I have... - [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] confirmed `!` in the type prefix if API or client breaking change - [ ] confirmed all author checklist items have been addressed - [ ] reviewed state machine logic - [ ] reviewed API design and naming - [ ] reviewed documentation is accurate - [ ] reviewed tests and test coverage - [ ] manually tested (if applicable)
This commit is contained in:
parent
9ea1fee8b2
commit
3771ebdf24
|
@ -16,7 +16,7 @@ import (
|
|||
func DefaultTxDecoder(cdc codec.ProtoCodecMarshaler) sdk.TxDecoder {
|
||||
return func(txBytes []byte) (sdk.Tx, error) {
|
||||
// Make sure txBytes follow ADR-027.
|
||||
err := rejectNonADR027(txBytes)
|
||||
err := rejectNonADR027TxRaw(txBytes)
|
||||
if err != nil {
|
||||
return nil, sdkerrors.Wrap(sdkerrors.ErrTxDecode, err.Error())
|
||||
}
|
||||
|
@ -90,13 +90,14 @@ func DefaultJSONTxDecoder(cdc codec.ProtoCodecMarshaler) sdk.TxDecoder {
|
|||
}
|
||||
}
|
||||
|
||||
// rejectNonADR027 rejects txBytes that do not follow ADR-027. This function
|
||||
// rejectNonADR027TxRaw rejects txBytes that do not follow ADR-027. This is NOT
|
||||
// a generic ADR-027 checker, it only applies decoding TxRaw. Specifically, it
|
||||
// only checks that:
|
||||
// - field numbers are in ascending order (1, 2, and potentially multiple 3s),
|
||||
// - and varints as as short as possible.
|
||||
// All other ADR-027 edge cases (e.g. TxRaw fields having default values) will
|
||||
// not happen with TxRaw.
|
||||
func rejectNonADR027(txBytes []byte) error {
|
||||
// - and varints are as short as possible.
|
||||
// All other ADR-027 edge cases (e.g. default values) are not applicable with
|
||||
// TxRaw.
|
||||
func rejectNonADR027TxRaw(txBytes []byte) error {
|
||||
// Make sure all fields are ordered in ascending order with this variable.
|
||||
prevTagNum := protowire.Number(0)
|
||||
|
||||
|
@ -105,21 +106,25 @@ func rejectNonADR027(txBytes []byte) error {
|
|||
if m < 0 {
|
||||
return fmt.Errorf("invalid length; %w", protowire.ParseError(m))
|
||||
}
|
||||
// TxRaw only has bytes fields.
|
||||
if wireType != protowire.BytesType {
|
||||
return fmt.Errorf("expected %d wire type, got %d", protowire.VarintType, wireType)
|
||||
return fmt.Errorf("expected %d wire type, got %d", protowire.BytesType, wireType)
|
||||
}
|
||||
// Make sure fields are ordered in ascending order.
|
||||
if tagNum < prevTagNum {
|
||||
return fmt.Errorf("txRaw must follow ADR-027, got tagNum %d after tagNum %d", tagNum, prevTagNum)
|
||||
}
|
||||
prevTagNum = tagNum
|
||||
|
||||
// All 3 fields of TxRaw have wireType == 2, so their next component
|
||||
// is a varint.
|
||||
// We make sure that the varint is as short as possible.
|
||||
// is a varint, so we can safely call ConsumeVarint here.
|
||||
// Byte structure: <varint of bytes length><bytes sequence>
|
||||
// Inner fields are verified in `DefaultTxDecoder`
|
||||
lengthPrefix, m := protowire.ConsumeVarint(txBytes[m:])
|
||||
if m < 0 {
|
||||
return fmt.Errorf("invalid length; %w", protowire.ParseError(m))
|
||||
}
|
||||
// We make sure that this varint is as short as possible.
|
||||
n := varintMinLength(lengthPrefix)
|
||||
if n != m {
|
||||
return fmt.Errorf("length prefix varint for tagNum %d is not as short as possible, read %d, only need %d", tagNum, m, n)
|
||||
|
@ -141,23 +146,23 @@ func rejectNonADR027(txBytes []byte) error {
|
|||
func varintMinLength(n uint64) int {
|
||||
switch {
|
||||
// Note: 1<<N == 2**N.
|
||||
case n < 1<<7:
|
||||
case n < 1<<(7):
|
||||
return 1
|
||||
case n < 1<<14:
|
||||
case n < 1<<(7*2):
|
||||
return 2
|
||||
case n < 1<<21:
|
||||
case n < 1<<(7*3):
|
||||
return 3
|
||||
case n < 1<<28:
|
||||
case n < 1<<(7*4):
|
||||
return 4
|
||||
case n < 1<<35:
|
||||
case n < 1<<(7*5):
|
||||
return 5
|
||||
case n < 1<<42:
|
||||
case n < 1<<(7*6):
|
||||
return 6
|
||||
case n < 1<<49:
|
||||
case n < 1<<(7*7):
|
||||
return 7
|
||||
case n < 1<<56:
|
||||
case n < 1<<(7*8):
|
||||
return 8
|
||||
case n < 1<<63:
|
||||
case n < 1<<(7*9):
|
||||
return 9
|
||||
default:
|
||||
return 10
|
||||
|
|
Loading…
Reference in New Issue