-
Notifications
You must be signed in to change notification settings - Fork 3.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: ADR-040: ICS-23 proofs for SMT store (#10015)
## Description Implements [ICS-23](https://github.com/cosmos/ibc/tree/master/spec/core/ics-023-vector-commitments) conformant proofs for the SMT-based KV store and defines the proof spec as part of [ADR-040](https://github.com/cosmos/cosmos-sdk/blob/eb7d939f86c6cd7b4218492364cdda3f649f06b5/docs/architecture/adr-040-storage-and-smt-state-commitments.md). Closes: vulcanize#8 --- ### 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... - [x] 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 - [x] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting)) - [x] 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) - n/a - [x] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing) - [x] added a changelog entry to `CHANGELOG.md` - [x] 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)
- Loading branch information
Showing
22 changed files
with
552 additions
and
73 deletions.
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
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 |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| package root | ||
| package multi | ||
|
|
||
| import ( | ||
| "github.com/cosmos/cosmos-sdk/store/cachekv" | ||
|
|
||
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,52 @@ | ||
| package multi | ||
|
|
||
| import ( | ||
| "crypto/sha256" | ||
|
|
||
| "github.com/tendermint/tendermint/crypto/merkle" | ||
| tmcrypto "github.com/tendermint/tendermint/proto/tendermint/crypto" | ||
|
|
||
| types "github.com/cosmos/cosmos-sdk/store/v2" | ||
| "github.com/cosmos/cosmos-sdk/store/v2/smt" | ||
| ) | ||
|
|
||
| // DefaultProofRuntime returns a ProofRuntime supporting SMT and simple merkle proofs. | ||
| func DefaultProofRuntime() (prt *merkle.ProofRuntime) { | ||
| prt = merkle.NewProofRuntime() | ||
| prt.RegisterOpDecoder(types.ProofOpSMTCommitment, types.CommitmentOpDecoder) | ||
| prt.RegisterOpDecoder(types.ProofOpSimpleMerkleCommitment, types.CommitmentOpDecoder) | ||
| return prt | ||
| } | ||
|
|
||
| // Prove commitment of key within an smt store and return ProofOps | ||
| func proveKey(s *smt.Store, key []byte) (*tmcrypto.ProofOps, error) { | ||
| var ret tmcrypto.ProofOps | ||
| keyProof, err := s.GetProofICS23(key) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| hkey := sha256.Sum256(key) | ||
| ret.Ops = append(ret.Ops, types.NewSmtCommitmentOp(hkey[:], keyProof).ProofOp()) | ||
| return &ret, nil | ||
| } | ||
|
|
||
| // GetProof returns ProofOps containing: a proof for the given key within this substore; | ||
| // and a proof of the substore's existence within the MultiStore. | ||
| func (s *viewSubstore) GetProof(key []byte) (*tmcrypto.ProofOps, error) { | ||
| ret, err := proveKey(s.stateCommitmentStore, key) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| // Prove commitment of substore within root store | ||
| storeHashes, err := s.root.getMerkleRoots() | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| storeProof, err := types.ProofOpFromMap(storeHashes, s.name) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| ret.Ops = append(ret.Ops, storeProof) | ||
| return ret, nil | ||
| } |
Oops, something went wrong.