feat(orm)!: return ormerrors.NotFound for Get methods in codegen

orm/internal/codegen/table.go

@@ -64,6 +64,7 @@ func (t tableGen) genStoreInterface() {
 	t.P("Save(ctx ", contextPkg.Ident("Context"), ", ", t.param(t.msg.GoIdent.GoName), " *", t.QualifiedGoIdent(t.msg.GoIdent), ") error")
 	t.P("Delete(ctx ", contextPkg.Ident("Context"), ", ", t.param(t.msg.GoIdent.GoName), " *", t.QualifiedGoIdent(t.msg.GoIdent), ") error")
 	t.P("Has(ctx ", contextPkg.Ident("Context"), ", ", t.fieldsArgs(t.primaryKeyFields.Names()), ") (found bool, err error)")
+	t.P("// Get returns nil, ormerrors.NotFound if the record wasn't found.")
 	t.P("Get(ctx ", contextPkg.Ident("Context"), ", ", t.fieldsArgs(t.primaryKeyFields.Names()), ") (*", t.QualifiedGoIdent(t.msg.GoIdent), ", error)")
 
 	for _, idx := range t.uniqueIndexes {
@@ -80,7 +81,7 @@ func (t tableGen) genStoreInterface() {
 }
 
 // returns the has and get (in that order) function signature for unique indexes.
-func (t tableGen) uniqueIndexSig(idxFields string) (string, string) {
+func (t tableGen) uniqueIndexSig(idxFields string) (string, string, string) {
 	fieldsSlc := strings.Split(idxFields, ",")
 	camelFields := t.fieldsToCamelCase(idxFields)
 
@@ -90,12 +91,13 @@ func (t tableGen) uniqueIndexSig(idxFields string) (string, string) {
 
 	hasFuncSig := fmt.Sprintf("%s (ctx context.Context, %s) (found bool, err error)", hasFuncName, args)
 	getFuncSig := fmt.Sprintf("%s (ctx context.Context, %s) (*%s, error)", getFuncName, args, t.msg.GoIdent.GoName)
-	return hasFuncSig, getFuncSig
+	return hasFuncSig, getFuncSig, getFuncName
 }
 
 func (t tableGen) genUniqueIndexSig(idx *ormv1alpha1.SecondaryIndexDescriptor) {
-	hasSig, getSig := t.uniqueIndexSig(idx.Fields)
+	hasSig, getSig, getFuncName := t.uniqueIndexSig(idx.Fields)
 	t.P(hasSig)
+	t.P("// ", getFuncName, " returns nil, ormerrors.NotFound if the record wasn't found.")
 	t.P(getSig)
 }
 
@@ -191,16 +193,19 @@ func (t tableGen) genStoreImpl() {
 	t.P(receiver, "Get(ctx ", contextPkg.Ident("Context"), ", ", t.fieldsArgs(t.primaryKeyFields.Names()), ") (*", varTypeName, ", error) {")
 	t.P("var ", varName, " ", varTypeName)
 	t.P("found, err := ", receiverVar, ".table.PrimaryKey().Get(ctx, &", varName, ", ", t.primaryKeyFields.String(), ")")
-	t.P("if !found {")
+	t.P("if err != nil {")
 	t.P("return nil, err")
 	t.P("}")
-	t.P("return &", varName, ", err")
+	t.P("if !found {")
+	t.P("return nil, ", ormErrPkg.Ident("NotFound"))
+	t.P("}")
+	t.P("return &", varName, ", nil")
 	t.P("}")
 	t.P()
 
 	for _, idx := range t.uniqueIndexes {
 		fields := strings.Split(idx.Fields, ",")
-		hasName, getName := t.uniqueIndexSig(idx.Fields)
+		hasName, getName, _ := t.uniqueIndexSig(idx.Fields)
 
 		// has
 		t.P("func (", receiverVar, " ", t.messageStoreReceiverName(t.msg), ") ", hasName, "{")
@@ -224,9 +229,12 @@ func (t tableGen) genStoreImpl() {
 			t.P(field, ",")
 		}
 		t.P(")")
-		t.P("if !found {")
+		t.P("if err != nil {")
 		t.P("return nil, err")
 		t.P("}")
+		t.P("if !found {")
+		t.P("return nil, ", ormErrPkg.Ident("NotFound"))
+		t.P("}")
 		t.P("return &", varName, ", nil")
 		t.P("}")
 		t.P()

orm/model/ormdb/module_test.go

@@ -7,6 +7,10 @@ import (
 	"strings"
 	"testing"
 
+	"github.com/cosmos/cosmos-sdk/orm/types/ormerrors"
+
+	"github.com/cosmos/cosmos-sdk/errors"
+
 	"google.golang.org/protobuf/reflect/protoreflect"
 	"gotest.tools/v3/assert"
 	"gotest.tools/v3/golden"
@@ -41,7 +45,7 @@ func (k keeper) Send(ctx context.Context, from, to, denom string, amount uint64)
 
 func (k keeper) Mint(ctx context.Context, acct, denom string, amount uint64) error {
 	supply, err := k.store.SupplyStore().Get(ctx, denom)
-	if err != nil {
+	if err != nil && !errors.IsOf(err, ormerrors.NotFound) {
 		return err
 	}
 
@@ -66,10 +70,6 @@ func (k keeper) Burn(ctx context.Context, acct, denom string, amount uint64) err
 		return err
 	}
 
-	if supply == nil {
-		return fmt.Errorf("no supply for %s", denom)
-	}
-
 	if amount > supply.Amount {
 		return fmt.Errorf("insufficient supply")
 	}
@@ -90,7 +90,11 @@ func (k keeper) Burn(ctx context.Context, acct, denom string, amount uint64) err
 
 func (k keeper) Balance(ctx context.Context, acct, denom string) (uint64, error) {
 	balance, err := k.store.BalanceStore().Get(ctx, acct, denom)
-	if balance == nil {
+	if err != nil {
+		if errors.IsOf(err, ormerrors.NotFound) {
+			return 0, nil
+		}
+
 		return 0, err
 	}
 	return balance.Amount, err
@@ -99,14 +103,18 @@ func (k keeper) Balance(ctx context.Context, acct, denom string) (uint64, error)
 func (k keeper) Supply(ctx context.Context, denom string) (uint64, error) {
 	supply, err := k.store.SupplyStore().Get(ctx, denom)
 	if supply == nil {
+		if errors.IsOf(err, ormerrors.NotFound) {
+			return 0, nil
+		}
+
 		return 0, err
 	}
 	return supply.Amount, err
 }
 
 func (k keeper) addBalance(ctx context.Context, acct, denom string, amount uint64) error {
 	balance, err := k.store.BalanceStore().Get(ctx, acct, denom)
-	if err != nil {
+	if err != nil && !errors.IsOf(err, ormerrors.NotFound) {
 		return err
 	}
 
@@ -130,10 +138,6 @@ func (k keeper) safeSubBalance(ctx context.Context, acct, denom string, amount u
 		return err
 	}
 
-	if balance == nil {
-		return fmt.Errorf("acct %x has no balance for %s", acct, denom)
-	}
-
 	if amount > balance.Amount {
 		return fmt.Errorf("insufficient funds")
 	}

orm/types/ormerrors/errors.go

@@ -32,4 +32,5 @@ var (
 	InvalidTableDefinition        = errors.New(codespace, 25, "invalid table definition")
 	InvalidFileDescriptorID       = errors.New(codespace, 26, "invalid file descriptor ID")
 	TableNotFound                 = errors.New(codespace, 27, "table not found")
+	NotFound                      = errors.New(codespace, 28, "not found")
 )