feat: Add Table-Store (aka ORM) package - Table and Indexable (cosmos…

…#9751)

<!--
The default pull request template is for types feat, fix, or refactor.
For other templates, add one of the following parameters to the url:
- template=docs.md
- template=other.md
-->

## Description

ref: cosmos#9237, cosmos#9156

This is the first step towards the migration of the [Table-Store (ORM) package](https://github.com/regen-network/regen-ledger/tree/c99dbedd1ff6b5b08ae7da63eec8dd19bff8273e/orm) currently in regen-ledger into the SDK. This won't be exposed as a public API to start with but rather be internal to `x/group`.

This first PR brings these core concepts:
- `table` is the high level object for storage mapper functionality where entities are stored by an unique identifier called `RowID`
- `Indexable` types can be used to setup new tables.

There will be follow-up PRs for adding the following features:
- table types with auto-incrementing `uint64` primary keys and natural primary keys
- secondary indexes
- iterator and pagination
- import/export genesis


---

### 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) _not applicable_
- [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` _not applicable_
- [x] included comments for [documenting Go code](https://blog.golang.org/godoc)
- [x] updated the relevant documentation or specification
- [x] reviewed "Files changed" and left comments if necessary
- [x] 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)

testutil/testdata/table.go

@@ -0,0 +1,14 @@
+package testdata
+
+import "github.com/cosmos/cosmos-sdk/types/errors"
+
+var (
+	ErrTest = errors.Register("table_testdata", 2, "test")
+)
+
+func (g TableModel) ValidateBasic() error {
+	if g.Name == "" {
+		return errors.Wrap(ErrTest, "name")
+	}
+	return nil
+}

testutil/testdata/testdata.proto

@@ -35,3 +35,8 @@ message BadMultiSignature {
   repeated bytes signatures               = 1;
   bytes          malicious_field          = 5;
 }
+
+message TableModel {
+  uint64 id = 1;
+  string name = 2;
+}

types/errors/errors.go

@@ -16,6 +16,9 @@ const UndefinedCodespace = "undefined"
 // mathCodespace is the codespace for all errors defined in math package
 const mathCodespace = "math"
 
+// mathCodespace is the codespace for all errors defined in orm package
+const ormCodespace = "orm"
+
 var (
 	// errInternal should never be exposed, but we reserve this code for non-specified errors
 	errInternal = Register(UndefinedCodespace, 1, "internal")
@@ -153,6 +156,24 @@ var (
 
 	// ErrInvalidDecString defines an error for an invalid decimal string
 	ErrInvalidDecString = Register(mathCodespace, 41, "invalid decimal string")
+
+	// ErrORMIteratorDone defines an error when an iterator is done
+	ErrORMIteratorDone = Register(ormCodespace, 42, "iterator done")
+
+	// ErrORMInvalidIterator defines an error for an invalid iterator
+	ErrORMInvalidIterator = Register(ormCodespace, 43, "invalid iterator")
+
+	// ErrORMUniqueConstraint defines an error when a value already exists at a given key
+	ErrORMUniqueConstraint = Register(ormCodespace, 44, "unique constraint violation")
+
+	// ErrORMEmptyModel defines an error when an empty model is provided for building a table
+	ErrORMEmptyModel = Register(ormCodespace, 45, "invalid argument")
+
+	// ErrORMKeyMaxLength defines an error when a key exceeds max length
+	ErrORMKeyMaxLength = Register(ormCodespace, 46, "index key exceeds max length")
+
+	// ErrORMEmptyKey defines an error for an empty key
+	ErrORMEmptyKey = Register(ormCodespace, 47, "cannot use empty key")
 )
 
 // Register returns an error instance that should be used as the base for

x/group/go.mod

@@ -13,6 +13,8 @@ require (
 	pgregory.net/rapid v0.4.7
 )
 
+require github.com/tendermint/tm-db v0.6.4
+
 require (
 	github.com/DataDog/zstd v1.4.5 // indirect
 	github.com/armon/go-metrics v0.3.9 // indirect
@@ -22,6 +24,7 @@ require (
 	github.com/cespare/xxhash/v2 v2.1.1 // indirect
 	github.com/confio/ics23/go v0.6.6 // indirect
 	github.com/cosmos/btcutil v1.0.4 // indirect
+	github.com/cosmos/iavl v0.17.1 // indirect
 	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/dgraph-io/badger/v2 v2.2007.2 // indirect
 	github.com/dgraph-io/ristretto v0.0.3 // indirect
@@ -33,6 +36,7 @@ require (
 	github.com/golang/protobuf v1.5.2 // indirect
 	github.com/golang/snappy v0.0.3 // indirect
 	github.com/google/btree v1.0.0 // indirect
+	github.com/google/gofuzz v1.1.1-0.20200604201612-c04b05f3adfa // indirect
 	github.com/grpc-ecosystem/grpc-gateway v1.16.0 // indirect
 	github.com/gtank/merlin v0.1.1 // indirect
 	github.com/hashicorp/go-immutable-radix v1.0.0 // indirect
@@ -45,6 +49,7 @@ require (
 	github.com/matttproud/golang_protobuf_extensions v1.0.1 // indirect
 	github.com/mimoo/StrobeGo v0.0.0-20181016162300-f8f6d4d2b643 // indirect
 	github.com/mitchellh/mapstructure v1.4.2 // indirect
+	github.com/nxadm/tail v1.4.8 // indirect
 	github.com/pelletier/go-toml v1.9.4 // indirect
 	github.com/petermattis/goid v0.0.0-20180202154549-b0b1615b78e5 // indirect
 	github.com/pkg/errors v0.9.1 // indirect
@@ -65,7 +70,6 @@ require (
 	github.com/tecbot/gorocksdb v0.0.0-20191217155057-f0fad39f321c // indirect
 	github.com/tendermint/go-amino v0.16.0 // indirect
 	github.com/tendermint/tendermint v0.34.13 // indirect
-	github.com/tendermint/tm-db v0.6.4 // indirect
 	go.etcd.io/bbolt v1.3.5 // indirect
 	golang.org/x/crypto v0.0.0-20210817164053-32db794688a5 // indirect
 	golang.org/x/net v0.0.0-20210903162142-ad29c8ab022f // indirect