cosmos-sdk/store/tools/ics23/tendermint/cmd/testgen-simple/main.go

242 lines
5.3 KiB
Go
Raw Normal View History

feat: Add ics23 proof tools: `ics23-{iavl,tendermint,smt}` (#10802) Moves the separate repos for ICS23 proof tooling into `store/tools` I've set `github.com/confio/ics23/go` to version 0.7.0 in anticipation of https://github.com/confio/ics23/pull/61 being merged, as it's a dependency for SMT proofs, so this shouldn't be merged until that version exists. Closes: https://github.com/cosmos/cosmos-sdk/issues/10801 --- ### 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 - [x] 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) - [x] 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` - [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)
2022-02-22 03:39:08 -08:00
package main
import (
"encoding/hex"
"encoding/json"
"fmt"
"os"
"strconv"
tmproofs "github.com/cosmos/cosmos-sdk/store/internal/proofs"
ics23 "github.com/confio/ics23/go"
)
/**
testgen-simple will generate a json struct on stdout (meant to be saved to file for testdata).
this will be an auto-generated existence proof in the form:
{
"root": "<hex encoded root hash of tree>",
"key": "<hex encoded key to prove>",
"value": "<hex encoded value to prove> (empty on non-existence)",
"proof": "<hex encoded protobuf marshaling of a CommitmentProof>"
}
It accepts two or three arguments (optional size: default 400)
testgen-simple [exist|nonexist] [left|right|middle] <size>
If you make a batch, we have a different format:
{
"root": "<hex encoded root hash of tree>",
"proof": "<hex encoded protobuf marshaling of a CommitmentProof (Compressed Batch)>",
"items": [{
"key": "<hex encoded key to prove>",
"value": "<hex encoded value to prove> (empty on non-existence)",
}, ...]
}
The batch variant accepts 5 arguments:
testgen-simple [batch] [size] [num exist] [num nonexist]
**/
func main() {
if len(os.Args) < 2 {
fmt.Println("Usage: testgen-simple batch [size] [# exist] [# nonexist]")
fmt.Println(" testgen-simple [exist|nonexist] [left|right|middle] <size>")
os.Exit(1)
}
if os.Args[1] == "batch" {
err := doBatch(os.Args[2:])
if err != nil {
fmt.Printf("%+v\n", err)
fmt.Println("Usage: testgen-simple [batch] [size] [# exist] [# nonexist]")
os.Exit(1)
}
return
}
exist, loc, size, err := parseArgs(os.Args)
if err != nil {
fmt.Printf("%+v\n", err)
fmt.Println("Usage: testgen-simple [exist|nonexist] [left|right|middle] <size>")
os.Exit(1)
}
data := tmproofs.BuildMap(size)
allkeys := tmproofs.SortedKeys(data)
root := tmproofs.CalcRoot(data)
var key, value []byte
if exist {
key = []byte(tmproofs.GetKey(allkeys, loc))
value = data[string(key)]
} else {
key = []byte(tmproofs.GetNonKey(allkeys, loc))
}
var proof *ics23.CommitmentProof
if exist {
proof, err = tmproofs.CreateMembershipProof(data, key)
} else {
proof, err = tmproofs.CreateNonMembershipProof(data, key)
}
if err != nil {
fmt.Printf("Error: create proof: %+v\n", err)
os.Exit(1)
}
binary, err := proof.Marshal()
if err != nil {
fmt.Printf("Error: protobuf marshal: %+v\n", err)
os.Exit(1)
}
res := map[string]interface{}{
"root": hex.EncodeToString(root),
"key": hex.EncodeToString(key),
"value": hex.EncodeToString(value),
"proof": hex.EncodeToString(binary),
}
out, err := json.MarshalIndent(res, "", " ")
if err != nil {
fmt.Printf("Error: json encoding: %+v\n", err)
os.Exit(1)
}
fmt.Println(string(out))
}
func parseArgs(args []string) (exist bool, loc tmproofs.Where, size int, err error) {
if len(args) != 3 && len(args) != 4 {
err = fmt.Errorf("Insufficient args")
return
}
switch args[1] {
case "exist":
exist = true
case "nonexist":
exist = false
default:
err = fmt.Errorf("Invalid arg: %s", args[1])
return
}
switch args[2] {
case "left":
loc = tmproofs.Left
case "middle":
loc = tmproofs.Middle
case "right":
loc = tmproofs.Right
default:
err = fmt.Errorf("Invalid arg: %s", args[2])
return
}
size = 400
if len(args) == 4 {
size, err = strconv.Atoi(args[3])
}
return
}
type item struct {
Key string `json:"key"`
Value string `json:"value"`
}
func doBatch(args []string) error {
size, exist, nonexist, err := parseBatchArgs(args)
if err != nil {
return err
}
data := tmproofs.BuildMap(size)
allkeys := tmproofs.SortedKeys(data)
root := tmproofs.CalcRoot(data)
items := []item{}
proofs := []*ics23.CommitmentProof{}
for i := 0; i < exist; i++ {
key := []byte(tmproofs.GetKey(allkeys, tmproofs.Middle))
value := data[string(key)]
proof, err := tmproofs.CreateMembershipProof(data, key)
if err != nil {
return fmt.Errorf("create proof: %+v", err)
}
proofs = append(proofs, proof)
item := item{
Key: hex.EncodeToString(key),
Value: hex.EncodeToString(value),
}
items = append(items, item)
}
for i := 0; i < nonexist; i++ {
key := []byte(tmproofs.GetNonKey(allkeys, tmproofs.Middle))
proof, err := tmproofs.CreateNonMembershipProof(data, key)
if err != nil {
return fmt.Errorf("create proof: %+v", err)
}
proofs = append(proofs, proof)
item := item{
Key: hex.EncodeToString(key),
}
items = append(items, item)
}
// combine all proofs into batch and compress
proof, err := ics23.CombineProofs(proofs)
if err != nil {
fmt.Printf("Error: combine proofs: %+v\n", err)
os.Exit(1)
}
binary, err := proof.Marshal()
if err != nil {
fmt.Printf("Error: protobuf marshal: %+v\n", err)
os.Exit(1)
}
res := map[string]interface{}{
"root": hex.EncodeToString(root),
"items": items,
"proof": hex.EncodeToString(binary),
}
out, err := json.MarshalIndent(res, "", " ")
if err != nil {
fmt.Printf("Error: json encoding: %+v\n", err)
os.Exit(1)
}
fmt.Println(string(out))
return nil
}
func parseBatchArgs(args []string) (size int, exist int, nonexist int, err error) {
if len(args) != 3 {
err = fmt.Errorf("Insufficient args")
return
}
size, err = strconv.Atoi(args[0])
if err != nil {
return
}
exist, err = strconv.Atoi(args[1])
if err != nil {
return
}
nonexist, err = strconv.Atoi(args[2])
return
}