141 lines
4.1 KiB
Go
141 lines
4.1 KiB
Go
package store
|
|
|
|
import (
|
|
"bytes"
|
|
"fmt"
|
|
|
|
"github.com/tendermint/iavl"
|
|
"github.com/tendermint/tendermint/crypto/merkle"
|
|
cmn "github.com/tendermint/tendermint/libs/common"
|
|
)
|
|
|
|
// MultiStoreProof defines a collection of store proofs in a multi-store
|
|
type MultiStoreProof struct {
|
|
StoreInfos []storeInfo
|
|
}
|
|
|
|
func NewMultiStoreProof(storeInfos []storeInfo) *MultiStoreProof {
|
|
return &MultiStoreProof{StoreInfos: storeInfos}
|
|
}
|
|
|
|
// ComputeRootHash returns the root hash for a given multi-store proof.
|
|
func (proof *MultiStoreProof) ComputeRootHash() []byte {
|
|
ci := commitInfo{
|
|
Version: -1, // TODO: Not needed; improve code.
|
|
StoreInfos: proof.StoreInfos,
|
|
}
|
|
return ci.Hash()
|
|
}
|
|
|
|
// RequireProof returns whether proof is required for the subpath.
|
|
func RequireProof(subpath string) bool {
|
|
// XXX: create a better convention.
|
|
// Currently, only when query subpath is "/key", will proof be included in
|
|
// response. If there are some changes about proof building in iavlstore.go,
|
|
// we must change code here to keep consistency with iavlStore#Query.
|
|
if subpath == "/key" {
|
|
return true
|
|
}
|
|
|
|
return false
|
|
}
|
|
|
|
//-----------------------------------------------------------------------------
|
|
|
|
var _ merkle.ProofOperator = MultiStoreProofOp{}
|
|
|
|
// the multi-store proof operation constant value
|
|
const ProofOpMultiStore = "multistore"
|
|
|
|
// TODO: document
|
|
type MultiStoreProofOp struct {
|
|
// Encoded in ProofOp.Key
|
|
key []byte
|
|
|
|
// To encode in ProofOp.Data.
|
|
Proof *MultiStoreProof `json:"proof"`
|
|
}
|
|
|
|
func NewMultiStoreProofOp(key []byte, proof *MultiStoreProof) MultiStoreProofOp {
|
|
return MultiStoreProofOp{
|
|
key: key,
|
|
Proof: proof,
|
|
}
|
|
}
|
|
|
|
// MultiStoreProofOpDecoder returns a multi-store merkle proof operator from a
|
|
// given proof operation.
|
|
func MultiStoreProofOpDecoder(pop merkle.ProofOp) (merkle.ProofOperator, error) {
|
|
if pop.Type != ProofOpMultiStore {
|
|
return nil, cmn.NewError("unexpected ProofOp.Type; got %v, want %v", pop.Type, ProofOpMultiStore)
|
|
}
|
|
|
|
// XXX: a bit strange as we'll discard this, but it works
|
|
var op MultiStoreProofOp
|
|
|
|
err := cdc.UnmarshalBinaryLengthPrefixed(pop.Data, &op)
|
|
if err != nil {
|
|
return nil, cmn.ErrorWrap(err, "decoding ProofOp.Data into MultiStoreProofOp")
|
|
}
|
|
|
|
return NewMultiStoreProofOp(pop.Key, op.Proof), nil
|
|
}
|
|
|
|
// ProofOp return a merkle proof operation from a given multi-store proof
|
|
// operation.
|
|
func (op MultiStoreProofOp) ProofOp() merkle.ProofOp {
|
|
bz := cdc.MustMarshalBinaryLengthPrefixed(op)
|
|
return merkle.ProofOp{
|
|
Type: ProofOpMultiStore,
|
|
Key: op.key,
|
|
Data: bz,
|
|
}
|
|
}
|
|
|
|
// String implements the Stringer interface for a mult-store proof operation.
|
|
func (op MultiStoreProofOp) String() string {
|
|
return fmt.Sprintf("MultiStoreProofOp{%v}", op.GetKey())
|
|
}
|
|
|
|
// GetKey returns the key for a multi-store proof operation.
|
|
func (op MultiStoreProofOp) GetKey() []byte {
|
|
return op.key
|
|
}
|
|
|
|
// Run executes a multi-store proof operation for a given value. It returns
|
|
// the root hash if the value matches all the store's commitID's hash or an
|
|
// error otherwise.
|
|
func (op MultiStoreProofOp) Run(args [][]byte) ([][]byte, error) {
|
|
if len(args) != 1 {
|
|
return nil, cmn.NewError("Value size is not 1")
|
|
}
|
|
|
|
value := args[0]
|
|
root := op.Proof.ComputeRootHash()
|
|
|
|
for _, si := range op.Proof.StoreInfos {
|
|
if si.Name == string(op.key) {
|
|
if bytes.Equal(value, si.Core.CommitID.Hash) {
|
|
return [][]byte{root}, nil
|
|
}
|
|
|
|
return nil, cmn.NewError("hash mismatch for substore %v: %X vs %X", si.Name, si.Core.CommitID.Hash, value)
|
|
}
|
|
}
|
|
|
|
return nil, cmn.NewError("key %v not found in multistore proof", op.key)
|
|
}
|
|
|
|
//-----------------------------------------------------------------------------
|
|
|
|
// XXX: This should be managed by the rootMultiStore which may want to register
|
|
// more proof ops?
|
|
func DefaultProofRuntime() (prt *merkle.ProofRuntime) {
|
|
prt = merkle.NewProofRuntime()
|
|
prt.RegisterOpDecoder(merkle.ProofOpSimpleValue, merkle.SimpleValueOpDecoder)
|
|
prt.RegisterOpDecoder(iavl.ProofOpIAVLValue, iavl.IAVLValueOpDecoder)
|
|
prt.RegisterOpDecoder(iavl.ProofOpIAVLAbsence, iavl.IAVLAbsenceOpDecoder)
|
|
prt.RegisterOpDecoder(ProofOpMultiStore, MultiStoreProofOpDecoder)
|
|
return
|
|
}
|