Start refactoring into storeutils #15

mslipper · 2019-12-20T20:45:22Z

Note that the files in storeutils now return generic error objects rather than sdk.Errors. This is done
in an effort to decouple them from the DEX codebase. To transform the error objects back into sdk.Errors
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.

storeutils/entity_id.go

storeutils/get_set.go

alessio

Good progress. We need doc strings though

alessio

EntityID could be replaced by sdk.Uint altogether

mslipper · 2019-12-31T23:03:02Z

Re: EntityID - I'm happy to remove it in favor of sdk.Uint, however I thought I'd bring up the original reasons why we created the EntityID type to make sure that removing it is something we want to do.

The goal of the EntityID type is to disambiguate regular sdk.Uint instances, which are used for things like prices and quantities, from sdk.Uint instances used as primary key equivalents in the store. Having a standalone type disambiguates these two uses at compile time, which in my view helps reduce the potential for errors. It also allows us to define EntityID specific utility methods, which are used by the methods in get_set.go.

Let me know if this isn't enough of a reason to keep the standalone type and I'll remove it.

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`.

alessio · 2020-01-08T09:37:51Z

storeutil/operations.go

+)
+
+var (
+	ErrNotFound      = errors.New("not found")


Suggested change

ErrNotFound = errors.New("not found")

ErrorStoreKeyNotFound = errors.New("key not found")

ErrorKeyNotFound would work too

alessio · 2020-01-08T09:38:42Z

storeutil/operations.go

+
+var (
+	ErrNotFound      = errors.New("not found")
+	ErrAlreadyExists = errors.New("already exists")


Suggested change

ErrAlreadyExists = errors.New("already exists")

ErrorKeyExists = errors.New("key exists")

alessio

Just a couple of variable renames then this is good to go