refactor(store/v2): updates from integration #18633
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,178 @@ | ||
| package store | ||
|
|
||
| import ( | ||
| "fmt" | ||
|
|
||
| "github.com/cometbft/cometbft/crypto/merkle" | ||
| cmtcrypto "github.com/cometbft/cometbft/proto/tendermint/crypto" | ||
alexanderbez marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ics23 "github.com/cosmos/ics23/go" | ||
|
|
||
| errorsmod "cosmossdk.io/errors" | ||
| sdkmaps "cosmossdk.io/store/v2/internal/maps" | ||
| sdkproofs "cosmossdk.io/store/v2/internal/proofs" | ||
| ) | ||
|
|
||
| // Proof operation types | ||
| const ( | ||
| ProofOpIAVLCommitment = "ics23:iavl" | ||
| ProofOpSimpleMerkleCommitment = "ics23:simple" | ||
| ProofOpSMTCommitment = "ics23:smt" | ||
| ) | ||
|
|
||
| var _ merkle.ProofOperator = CommitmentOp{} | ||
|
|
||
| // CommitmentOp implements merkle.ProofOperator by wrapping an ics23 CommitmentProof. | ||
| // It also contains a Key field to determine which key the proof is proving. | ||
| // NOTE: CommitmentProof currently can either be ExistenceProof or NonexistenceProof | ||
| // | ||
| // Type and Spec are classified by the kind of merkle proof it represents allowing | ||
| // the code to be reused by more types. Spec is never on the wire, but mapped | ||
| // from type in the code. | ||
| type CommitmentOp struct { | ||
| Type string | ||
| Key []byte | ||
| Spec *ics23.ProofSpec | ||
| Proof *ics23.CommitmentProof | ||
| } | ||
|
|
||
| func NewIAVLCommitmentOp(key []byte, proof *ics23.CommitmentProof) CommitmentOp { | ||
| return CommitmentOp{ | ||
| Type: ProofOpIAVLCommitment, | ||
| Spec: ics23.IavlSpec, | ||
| Key: key, | ||
| Proof: proof, | ||
| } | ||
| } | ||
|
|
||
| func NewSimpleMerkleCommitmentOp(key []byte, proof *ics23.CommitmentProof) CommitmentOp { | ||
| return CommitmentOp{ | ||
| Type: ProofOpSimpleMerkleCommitment, | ||
| Spec: ics23.TendermintSpec, | ||
| Key: key, | ||
| Proof: proof, | ||
| } | ||
| } | ||
|
|
||
| func NewSMTCommitmentOp(key []byte, proof *ics23.CommitmentProof) CommitmentOp { | ||
| return CommitmentOp{ | ||
| Type: ProofOpSMTCommitment, | ||
| Spec: ics23.SmtSpec, | ||
| Key: key, | ||
| Proof: proof, | ||
| } | ||
| } | ||
|
|
||
| // CommitmentOpDecoder takes a ProofOp and attempts to decode it into a CommitmentOp | ||
| // ProofOperator. The proofOp.Data is just a marshaled CommitmentProof. The Key | ||
| // of the CommitmentOp is extracted from the unmarshalled proof. | ||
| func CommitmentOpDecoder(pop cmtcrypto.ProofOp) (merkle.ProofOperator, error) { | ||
| var spec *ics23.ProofSpec | ||
| switch pop.Type { | ||
| case ProofOpIAVLCommitment: | ||
| spec = ics23.IavlSpec | ||
|
|
||
| case ProofOpSimpleMerkleCommitment: | ||
| spec = ics23.TendermintSpec | ||
|
|
||
| case ProofOpSMTCommitment: | ||
| spec = ics23.SmtSpec | ||
|
|
||
| default: | ||
| return nil, errorsmod.Wrapf(ErrInvalidProof, "unexpected ProofOp.Type; got %s, want supported ics23 subtypes 'ProofOpSimpleMerkleCommitment', 'ProofOpIAVLCommitment', or 'ProofOpSMTCommitment'", pop.Type) | ||
| } | ||
|
|
||
| proof := &ics23.CommitmentProof{} | ||
| if err := proof.Unmarshal(pop.Data); err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| return CommitmentOp{ | ||
| Type: pop.Type, | ||
| Key: pop.Key, | ||
| Spec: spec, | ||
| Proof: proof, | ||
| }, nil | ||
| } | ||
|
|
||
| func (op CommitmentOp) GetKey() []byte { | ||
| return op.Key | ||
| } | ||
|
|
||
| // Run takes in a list of arguments and attempts to run the proof op against these | ||
| // arguments. Returns the root wrapped in [][]byte if the proof op succeeds with | ||
| // given args. If not, it will return an error. | ||
| // | ||
| // CommitmentOp will accept args of length 1 or length 0. If length 1 args is | ||
| // passed in, then CommitmentOp will attempt to prove the existence of the key | ||
| // with the value provided by args[0] using the embedded CommitmentProof and returns | ||
| // the CommitmentRoot of the proof. If length 0 args is passed in, then CommitmentOp | ||
| // will attempt to prove the absence of the key in the CommitmentOp and return the | ||
| // CommitmentRoot of the proof. | ||
| func (op CommitmentOp) Run(args [][]byte) ([][]byte, error) { | ||
| // calculate root from proof | ||
| root, err := op.Proof.Calculate() | ||
| if err != nil { | ||
| return nil, errorsmod.Wrapf(ErrInvalidProof, "could not calculate root for proof: %v", err) | ||
alexanderbez marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
|
|
||
| // Only support an existence proof or nonexistence proof (batch proofs currently unsupported) | ||
| switch len(args) { | ||
| case 0: | ||
| // Args are nil, so we verify the absence of the key. | ||
| absent := ics23.VerifyNonMembership(op.Spec, root, op.Proof, op.Key) | ||
| if !absent { | ||
| return nil, errorsmod.Wrapf(ErrInvalidProof, "proof did not verify absence of key: %s", string(op.Key)) | ||
alexanderbez marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
|
|
||
| case 1: | ||
| // Args is length 1, verify existence of key with value args[0] | ||
| if !ics23.VerifyMembership(op.Spec, root, op.Proof, op.Key, args[0]) { | ||
| return nil, errorsmod.Wrapf(ErrInvalidProof, "proof did not verify existence of key %s with given value %x", op.Key, args[0]) | ||
alexanderbez marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
|
|
||
| default: | ||
| return nil, errorsmod.Wrapf(ErrInvalidProof, "args must be length 0 or 1, got: %d", len(args)) | ||
| } | ||
|
|
||
| return [][]byte{root}, nil | ||
| } | ||
|
|
||
| // ProofOp implements ProofOperator interface and converts a CommitmentOp into a | ||
| // ProofOp format that can later be decoded by CommitmentOpDecoder back into a | ||
| // CommitmentOp for proof verification. | ||
| func (op CommitmentOp) ProofOp() cmtcrypto.ProofOp { | ||
| bz, err := op.Proof.Marshal() | ||
| if err != nil { | ||
| panic(fmt.Errorf("failed to marshal CommitmentProof: %w", err)) | ||
alexanderbez marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
|
|
||
| return cmtcrypto.ProofOp{ | ||
| Type: op.Type, | ||
| Key: op.Key, | ||
| Data: bz, | ||
| } | ||
| } | ||
|
|
||
| // ProofOpFromMap generates a single proof from a map and converts it to a ProofOp. | ||
| func ProofOpFromMap(cmap map[string][]byte, storeName string) (cmtcrypto.ProofOp, error) { | ||
| _, proofs, _ := sdkmaps.ProofsFromMap(cmap) | ||
|
|
||
| proof := proofs[storeName] | ||
| if proof == nil { | ||
| return cmtcrypto.ProofOp{}, fmt.Errorf("ProofOp for %s but not registered store name", storeName) | ||
| } | ||
|
|
||
| // convert merkle.SimpleProof to CommitmentProof | ||
| existProof, err := sdkproofs.ConvertExistenceProof(proof, []byte(storeName), cmap[storeName]) | ||
| if err != nil { | ||
| return cmtcrypto.ProofOp{}, fmt.Errorf("could not convert simple proof to existence proof: %w", err) | ||
| } | ||
|
|
||
| commitmentProof := &ics23.CommitmentProof{ | ||
| Proof: &ics23.CommitmentProof_Exist{ | ||
| Exist: existProof, | ||
| }, | ||
| } | ||
|
|
||
| return NewSimpleMerkleCommitmentOp([]byte(storeName), commitmentProof).ProofOp(), nil | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Note to reviewer(s): This is a direct port from store v1 (with linting/cleanup).