Start refactoring into storeutils

Note that the files in `storeutils` now return generic `error` objects rather than `sdk.Error`s. This is done in an effort to decouple them from the DEX codebase. To transform the error objects back into `sdk.Error`s that are meaningful to the DEX, I've created some wrapper functions in `types/errs/errs.go` that convert the `error` objects into the DEC-appropriate `sdk.Error`.
tendermint · Jan 7, 2020 · 5396c82 · 5396c82
1 parent 209f9f9
commit 5396c82
Show file tree

Hide file tree

Showing 75 changed files with 782 additions and 1,013 deletions.
diff --git a/Makefile b/Makefile
@@ -105,7 +105,7 @@ test: all
 	UEX_TEST_BIN_DIR=$(shell pwd)/build go test -v ./...
 
 test-unit:
-	go test -v ./... -integration=false
+	go test -v ./...
 
 format:
 	find . -name '*.go' -type f -not -path "./vendor*" -not -path "*.git*" -not -path "./x/embedded/ui/a_ui-packr.go" | xargs gofmt -w -s

diff --git a/embedded/balance/routes.go b/embedded/balance/routes.go
@@ -6,8 +6,6 @@ import (
 
 	"github.com/gorilla/mux"
 
-	"github.com/tendermint/dex-demo/types/store"
-
 	"github.com/cosmos/cosmos-sdk/client/keys"
 
 	"github.com/tendermint/dex-demo/embedded"
@@ -106,7 +104,7 @@ func faucetHandler(ctx context.CLIContext, cdc *codec.Codec) http.HandlerFunc {
 	}
 }
 
-func doTransfer(kb *auth.Keybase, ctx context.CLIContext, w http.ResponseWriter, cdc *codec.Codec, to sdk.AccAddress, amount sdk.Uint, assetID store.EntityID, passphrase string) {
+func doTransfer(kb *auth.Keybase, ctx context.CLIContext, w http.ResponseWriter, cdc *codec.Codec, to sdk.AccAddress, amount sdk.Uint, assetID sdk.Uint, passphrase string) {
 	owner := kb.GetAddr()
 	ctx = ctx.WithFromAddress(owner)
 	msg := types.NewMsgTransfer(assetID, owner, to, amount)

diff --git a/embedded/balance/types.go b/embedded/balance/types.go
@@ -1,22 +1,20 @@
 package balance
 
 import (
-	"github.com/tendermint/dex-demo/embedded"
-	"github.com/tendermint/dex-demo/types/store"
-
 	sdk "github.com/cosmos/cosmos-sdk/types"
+	"github.com/tendermint/dex-demo/embedded"
 )
 
 type GetQueryRequest struct {
 	Address sdk.AccAddress
 }
 
 type GetQueryResponseBalance struct {
-	AssetID store.EntityID `json:"asset_id"`
-	Name    string         `json:"name"`
-	Symbol  string         `json:"symbol"`
-	Liquid  sdk.Uint       `json:"liquid"`
-	AtRisk  sdk.Uint       `json:"at_risk"`
+	AssetID sdk.Uint `json:"asset_id"`
+	Name    string   `json:"name"`
+	Symbol  string   `json:"symbol"`
+	Liquid  sdk.Uint `json:"liquid"`
+	AtRisk  sdk.Uint `json:"at_risk"`
 }
 
 type GetQueryResponse struct {
@@ -25,7 +23,7 @@ type GetQueryResponse struct {
 
 type TransferBalanceRequest struct {
 	To      sdk.AccAddress `json:"to"`
-	AssetID store.EntityID `json:"asset_id"`
+	AssetID sdk.Uint       `json:"asset_id"`
 	Amount  sdk.Uint       `json:"amount"`
 }
 

diff --git a/embedded/batch/keeper.go b/embedded/batch/keeper.go
@@ -1,11 +1,12 @@
 package batch
 
 import (
+	"github.com/tendermint/dex-demo/storeutil"
 	dbm "github.com/tendermint/tm-db"
 
+	"github.com/tendermint/dex-demo/embedded/store"
 	"github.com/tendermint/dex-demo/types"
 	"github.com/tendermint/dex-demo/types/errs"
-	"github.com/tendermint/dex-demo/types/store"
 
 	"github.com/cosmos/cosmos-sdk/codec"
 	sdk "github.com/cosmos/cosmos-sdk/types"
@@ -29,7 +30,7 @@ func NewKeeper(db dbm.DB, cdc *codec.Codec) Keeper {
 	}
 }
 
-func (k Keeper) LatestByMarket(marketID store.EntityID) (Batch, sdk.Error) {
+func (k Keeper) LatestByMarket(marketID sdk.Uint) (Batch, sdk.Error) {
 	var res Batch
 	var found bool
 	k.as.ReversePrefixIterator(batchIterKey(marketID), func(_ []byte, v []byte) bool {
@@ -66,10 +67,10 @@ func (k Keeper) OnEvent(event interface{}) error {
 	return nil
 }
 
-func batchKey(marketID store.EntityID, blkNum int64) []byte {
-	return store.PrefixKeyBytes(batchIterKey(marketID), store.Int64Subkey(blkNum))
+func batchKey(marketID sdk.Uint, blkNum int64) []byte {
+	return storeutil.PrefixKeyBytes(batchIterKey(marketID), storeutil.Int64Subkey(blkNum))
 }
 
-func batchIterKey(marketID store.EntityID) []byte {
-	return store.PrefixKeyString(batchKeyPrefix, marketID.Bytes())
+func batchIterKey(marketID sdk.Uint) []byte {
+	return storeutil.PrefixKeyString(batchKeyPrefix, storeutil.SDKUintSubkey(marketID))
 }
diff --git a/embedded/batch/querier.go b/embedded/batch/querier.go
@@ -3,11 +3,9 @@ package batch
 import (
 	abci "github.com/tendermint/tendermint/abci/types"
 
-	"github.com/tendermint/dex-demo/types/errs"
-	"github.com/tendermint/dex-demo/types/store"
-
 	"github.com/cosmos/cosmos-sdk/codec"
 	sdk "github.com/cosmos/cosmos-sdk/types"
+	"github.com/tendermint/dex-demo/types/errs"
 )
 
 const (
@@ -30,7 +28,7 @@ func queryLatest(path []string, keeper Keeper) ([]byte, sdk.Error) {
 		return nil, errs.ErrInvalidArgument("must specify a market ID")
 	}
 
-	marketID := store.NewEntityIDFromString(path[0])
+	marketID := sdk.NewUintFromString(path[0])
 	res, sdkErr := keeper.LatestByMarket(marketID)
 	if sdkErr != nil {
 		if sdkErr.Code() == errs.CodeNotFound {

diff --git a/embedded/batch/types.go b/embedded/batch/types.go
@@ -3,16 +3,14 @@ package batch
 import (
 	"time"
 
-	"github.com/tendermint/dex-demo/pkg/matcheng"
-	"github.com/tendermint/dex-demo/types/store"
-
 	sdk "github.com/cosmos/cosmos-sdk/types"
+	"github.com/tendermint/dex-demo/pkg/matcheng"
 )
 
 type Batch struct {
 	BlockNumber   int64                     `json:"block_number"`
 	BlockTime     time.Time                 `json:"block_time"`
-	MarketID      store.EntityID            `json:"market_id"`
+	MarketID      sdk.Uint                  `json:"market_id"`
 	ClearingPrice sdk.Uint                  `json:"clearing_price"`
 	Bids          []matcheng.AggregatePrice `json:"bids"`
 	Asks          []matcheng.AggregatePrice `json:"asks"`

diff --git a/embedded/book/querier.go b/embedded/book/querier.go
@@ -3,12 +3,10 @@ package book
 import (
 	abci "github.com/tendermint/tendermint/abci/types"
 
-	"github.com/tendermint/dex-demo/embedded/order"
-	"github.com/tendermint/dex-demo/types/errs"
-	"github.com/tendermint/dex-demo/types/store"
-
 	"github.com/cosmos/cosmos-sdk/codec"
 	sdk "github.com/cosmos/cosmos-sdk/types"
+	"github.com/tendermint/dex-demo/embedded/order"
+	"github.com/tendermint/dex-demo/types/errs"
 )
 
 const (
@@ -31,7 +29,7 @@ func queryGet(path []string, keeper order.Keeper) ([]byte, sdk.Error) {
 		return nil, errs.ErrInvalidArgument("must specify a market ID")
 	}
 
-	mktId := store.NewEntityIDFromString(path[0])
+	mktId := sdk.NewUintFromString(path[0])
 	res := keeper.OpenOrdersByMarket(mktId)
 	b, err := codec.MarshalJSONIndent(codec.New(), res)
 	if err != nil {

diff --git a/embedded/book/routes.go b/embedded/book/routes.go
@@ -13,11 +13,11 @@ import (
 	"github.com/cosmos/cosmos-sdk/codec"
 	"github.com/cosmos/cosmos-sdk/types/rest"
 
+	sdk "github.com/cosmos/cosmos-sdk/types"
 	"github.com/tendermint/dex-demo/embedded/auth"
 	"github.com/tendermint/dex-demo/embedded/node"
 	"github.com/tendermint/dex-demo/embedded/order"
 	"github.com/tendermint/dex-demo/pkg/matcheng"
-	"github.com/tendermint/dex-demo/types/store"
 )
 
 func RegisterRoutes(ctx context.CLIContext, r *mux.Router, cdc *codec.Codec) {
@@ -50,7 +50,7 @@ func bookHandler(ctx context.CLIContext, cdc *codec.Codec) http.HandlerFunc {
 		cdc.MustUnmarshalJSON(resJSON, &orders)
 
 		qRes := QueryResult{
-			MarketID:    store.NewEntityIDFromString(mktId),
+			MarketID:    sdk.NewUintFromString(mktId),
 			BlockNumber: block.Block.Height,
 			Bids:        make([]QueryResultEntry, 0),
 			Asks:        make([]QueryResultEntry, 0),

diff --git a/embedded/book/types.go b/embedded/book/types.go
@@ -1,10 +1,8 @@
 package book
 
 import (
-	"github.com/tendermint/dex-demo/pkg/matcheng"
-	"github.com/tendermint/dex-demo/types/store"
-
 	sdk "github.com/cosmos/cosmos-sdk/types"
+	"github.com/tendermint/dex-demo/pkg/matcheng"
 )
 
 type Book struct {
@@ -18,7 +16,7 @@ type QueryResultEntry struct {
 }
 
 type QueryResult struct {
-	MarketID    store.EntityID     `json:"market_id"`
+	MarketID    sdk.Uint           `json:"market_id"`
 	BlockNumber int64              `json:"block_number"`
 	Bids        []QueryResultEntry `json:"bids"`
 	Asks        []QueryResultEntry `json:"asks"`

diff --git a/embedded/exchange/routes.go b/embedded/exchange/routes.go
@@ -8,7 +8,6 @@ import (
 
 	"github.com/tendermint/dex-demo/embedded"
 	"github.com/tendermint/dex-demo/embedded/auth"
-	"github.com/tendermint/dex-demo/types/store"
 	"github.com/tendermint/dex-demo/x/order/types"
 
 	"github.com/cosmos/cosmos-sdk/client/context"
@@ -73,7 +72,7 @@ func postOrderHandler(ctx context.CLIContext, cdc *codec.Codec) http.HandlerFunc
 				break
 			}
 		}
-		orderID := store.NewEntityIDFromString(orderIDStr)
+		orderID := sdk.NewUintFromString(orderIDStr)
 		res := OrderCreationResponse{
 			BlockInclusion: embedded.BlockInclusion{
 				BlockNumber:     broadcastRes.Height,

diff --git a/embedded/exchange/types.go b/embedded/exchange/types.go
@@ -1,15 +1,13 @@
 package exchange
 
 import (
+	sdk "github.com/cosmos/cosmos-sdk/types"
 	"github.com/tendermint/dex-demo/embedded"
 	"github.com/tendermint/dex-demo/pkg/matcheng"
-	"github.com/tendermint/dex-demo/types/store"
-
-	sdk "github.com/cosmos/cosmos-sdk/types"
 )
 
 type OrderCreationRequest struct {
-	MarketID    store.EntityID     `json:"market_id"`
+	MarketID    sdk.Uint           `json:"market_id"`
 	Direction   matcheng.Direction `json:"direction"`
 	Price       sdk.Uint           `json:"price"`
 	Quantity    sdk.Uint           `json:"quantity"`
@@ -19,8 +17,8 @@ type OrderCreationRequest struct {
 
 type OrderCreationResponse struct {
 	BlockInclusion embedded.BlockInclusion `json:"block_inclusion"`
-	ID             store.EntityID          `json:"id"`
-	MarketID       store.EntityID          `json:"market_id"`
+	ID             sdk.Uint                `json:"id"`
+	MarketID       sdk.Uint                `json:"market_id"`
 	Direction      matcheng.Direction      `json:"direction"`
 	Price          sdk.Uint                `json:"price"`
 	Quantity       sdk.Uint                `json:"quantity"`

diff --git a/embedded/fill/keeper.go b/embedded/fill/keeper.go
@@ -1,12 +1,14 @@
 package fill
 
 import (
+	"github.com/tendermint/dex-demo/storeutil"
 	dbm "github.com/tendermint/tm-db"
 
+	"github.com/tendermint/dex-demo/embedded/store"
 	"github.com/tendermint/dex-demo/types"
-	"github.com/tendermint/dex-demo/types/store"
 
 	"github.com/cosmos/cosmos-sdk/codec"
+	sdk "github.com/cosmos/cosmos-sdk/types"
 )
 
 const (
@@ -60,9 +62,9 @@ func (k Keeper) OnEvent(event interface{}) error {
 }
 
 func fillIterKey(blockNum int64) []byte {
-	return store.PrefixKeyBytes(store.Int64Subkey(blockNum))
+	return storeutil.PrefixKeyBytes(storeutil.Int64Subkey(blockNum))
 }
 
-func fillKey(blockNum int64, orderId store.EntityID) []byte {
-	return store.PrefixKeyBytes(fillIterKey(blockNum), orderId.Bytes())
+func fillKey(blockNum int64, orderId sdk.Uint) []byte {
+	return storeutil.PrefixKeyBytes(fillIterKey(blockNum), storeutil.SDKUintSubkey(orderId))
 }
diff --git a/embedded/fill/types.go b/embedded/fill/types.go
@@ -1,15 +1,13 @@
 package fill
 
 import (
+	sdk "github.com/cosmos/cosmos-sdk/types"
 	"github.com/tendermint/dex-demo/embedded"
 	"github.com/tendermint/dex-demo/pkg/matcheng"
-	"github.com/tendermint/dex-demo/types/store"
-
-	sdk "github.com/cosmos/cosmos-sdk/types"
 )
 
 type Fill struct {
-	OrderID     store.EntityID     `json:"order_id"`
+	OrderID     sdk.Uint           `json:"order_id"`
 	Owner       sdk.AccAddress     `json:"owner"`
 	Pair        string             `json:"pair"`
 	Direction   matcheng.Direction `json:"direction"`
@@ -38,7 +36,7 @@ type RESTFill struct {
 	QuantityFilled   sdk.Uint                `json:"quantity_filled"`
 	QuantityUnfilled sdk.Uint                `json:"quantity_unfilled"`
 	Direction        matcheng.Direction      `json:"direction"`
-	OrderID          store.EntityID          `json:"order_id"`
+	OrderID          sdk.Uint                `json:"order_id"`
 	Pair             string                  `json:"pair"`
 	Price            sdk.Uint                `json:"price"`
 	Owner            sdk.AccAddress          `json:"owner"`