Roy Crihfield
e66b8ef212
## 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](eb7d939f86/docs/architecture/adr-040-storage-and-smt-state-commitments.md).
Closes: https://github.com/vulcanize/cosmos-sdk/issues/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)
105 lines
2.4 KiB
Go
105 lines
2.4 KiB
Go
package proofs
|
|
|
|
import (
|
|
"errors"
|
|
"fmt"
|
|
"sort"
|
|
|
|
ics23 "github.com/confio/ics23/go"
|
|
|
|
sdkmaps "github.com/cosmos/cosmos-sdk/store/internal/maps"
|
|
)
|
|
|
|
var (
|
|
ErrEmptyKey = errors.New("key is empty")
|
|
ErrEmptyKeyInData = errors.New("data contains empty key")
|
|
)
|
|
|
|
/*
|
|
CreateMembershipProof will produce a CommitmentProof that the given key (and queries value) exists in the map.
|
|
If the key doesn't exist in the tree, this will return an error.
|
|
*/
|
|
func CreateMembershipProof(data map[string][]byte, key []byte) (*ics23.CommitmentProof, error) {
|
|
if len(key) == 0 {
|
|
return nil, ErrEmptyKey
|
|
}
|
|
exist, err := createExistenceProof(data, key)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
proof := &ics23.CommitmentProof{
|
|
Proof: &ics23.CommitmentProof_Exist{
|
|
Exist: exist,
|
|
},
|
|
}
|
|
return proof, nil
|
|
}
|
|
|
|
/*
|
|
CreateNonMembershipProof will produce a CommitmentProof that the given key doesn't exist in the map.
|
|
If the key exists in the tree, this will return an error.
|
|
*/
|
|
func CreateNonMembershipProof(data map[string][]byte, key []byte) (*ics23.CommitmentProof, error) {
|
|
if len(key) == 0 {
|
|
return nil, ErrEmptyKey
|
|
}
|
|
// ensure this key is not in the store
|
|
if _, ok := data[string(key)]; ok {
|
|
return nil, fmt.Errorf("cannot create non-membership proof if key is in map")
|
|
}
|
|
|
|
keys := SortedKeys(data)
|
|
rightidx := sort.SearchStrings(keys, string(key))
|
|
|
|
var err error
|
|
nonexist := &ics23.NonExistenceProof{
|
|
Key: key,
|
|
}
|
|
|
|
// include left proof unless key is left of entire map
|
|
if rightidx >= 1 {
|
|
leftkey := keys[rightidx-1]
|
|
nonexist.Left, err = createExistenceProof(data, []byte(leftkey))
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
}
|
|
|
|
// include right proof unless key is right of entire map
|
|
if rightidx < len(keys) {
|
|
rightkey := keys[rightidx]
|
|
nonexist.Right, err = createExistenceProof(data, []byte(rightkey))
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
}
|
|
|
|
proof := &ics23.CommitmentProof{
|
|
Proof: &ics23.CommitmentProof_Nonexist{
|
|
Nonexist: nonexist,
|
|
},
|
|
}
|
|
return proof, nil
|
|
}
|
|
|
|
func createExistenceProof(data map[string][]byte, key []byte) (*ics23.ExistenceProof, error) {
|
|
for k := range data {
|
|
if k == "" {
|
|
return nil, ErrEmptyKeyInData
|
|
}
|
|
}
|
|
value, ok := data[string(key)]
|
|
if !ok {
|
|
return nil, fmt.Errorf("cannot make existence proof if key is not in map")
|
|
}
|
|
|
|
_, proofs, _ := sdkmaps.ProofsFromMap(data)
|
|
proof := proofs[string(key)]
|
|
if proof == nil {
|
|
return nil, fmt.Errorf("returned no proof for key")
|
|
}
|
|
|
|
return ConvertExistenceProof(proof, key, value)
|
|
}
|