refactor(ecocredit/marketplace): BuyDirect

proto/regen/ecocredit/marketplace/v1/tx.proto

@@ -25,6 +25,9 @@ service Msg {
   // Buy creates credit buy orders.
   rpc Buy(MsgBuy) returns (MsgBuyResponse);
 
+  // BuyDirect purchases credits directly from the specified sell order.
+  rpc BuyDirect(MsgBuyDirect) returns (MsgBuyDirectResponse);
+
   // AllowAskDenom is a governance operation which authorizes a new ask denom to
   // be used in sell orders
   rpc AllowAskDenom(MsgAllowAskDenom) returns (MsgAllowAskDenomResponse);
@@ -135,24 +138,9 @@ message MsgBuy {
   // Order is a buy order.
   message Order {
 
-    // Selection defines a buy order selection.
-    message Selection {
-
-      // sum defines the type of selection.
-      oneof sum {
-        // sell_order_id is the sell order ID against which the buyer is trying
-        // to buy. When sell_order_id is set, this is known as a direct buy
-        // order because it is placed directly against a specific sell order.
-        uint64 sell_order_id = 1;
-
-        // filter selects credits to buy based upon the specified filter
-        // criteria.
-        Filter filter = 2;
-      }
-    }
-
-    // selection is the buy order selection.
-    Selection selection = 1;
+    // filter selects credits to buy based upon the specified filter
+    // criteria.
+    Filter filter = 1;
 
     // quantity is the quantity of credits to buy. If the quantity of credits
     // available is less than this amount the order will be partially filled
@@ -195,6 +183,43 @@ message MsgBuyResponse {
   repeated uint64 buy_order_ids = 1;
 }
 
+// MsgBuyDirect is the Msg/BuyDirect request type.
+message MsgBuyDirect {
+
+  // buyer is the address of the credit buyer.
+  string buyer = 1;
+
+  // orders is a list of orders for ecocredits.
+  repeated Order orders = 2;
+
+  // Order contains the information needed to purchase an ecocredit.
+  message Order {
+    // sell_order_id is the sell order ID against which the buyer is trying
+    // to buy.
+    uint64 sell_order_id = 2;
+
+    // quantity is the quantity of credits to buy.
+    string quantity = 3;
+
+    // bid_price is the price the buyer is willing to pay per credit.
+    cosmos.base.v1beta1.Coin bid_price = 4;
+
+    // disable_auto_retire allows auto-retirement to be disabled. If it is set
+    // to true the credits will not auto-retire and can be resold assuming that
+    // the corresponding sell order has auto-retirement disabled. If the sell
+    // order hasn't disabled auto-retirement and the buy order tries to disable
+    // it, that buy order will fail.
+    bool disable_auto_retire = 5;
+
+    // retirement_location is the optional retirement location for the credits
+    // which will be used only if disable_auto_retire is false.
+    string retirement_location = 6;
+  }
+}
+
+// MsgBuyDirectResponse is the Msg/BuyDirect response type.
+message MsgBuyDirectResponse {}
+
 // MsgAllowAskDenom is the Msg/AllowAskDenom request type.
 message MsgAllowAskDenom {
   // root_address is the address of the governance account which can authorize

types/math/dec.go

@@ -5,6 +5,7 @@ import (
 	"math/big"
 
 	"github.com/cockroachdb/apd/v2"
+
 	"github.com/cosmos/cosmos-sdk/types/errors"
 )
 

x/ecocredit/marketplace/msg_buy.go

@@ -25,6 +25,7 @@ func (m MsgBuy) GetSignBytes() []byte {
 
 // ValidateBasic does a sanity check on the provided data.
 func (m *MsgBuy) ValidateBasic() error {
+	return sdkerrors.ErrNotSupported.Wrap("filtered buy orders are not suported at this time")
 	if _, err := sdk.AccAddressFromBech32(m.Buyer); err != nil {
 		return sdkerrors.ErrInvalidAddress
 	}
@@ -49,7 +50,7 @@ func (m *MsgBuy) ValidateBasic() error {
 
 		if !order.DisableAutoRetire {
 			if err := core.ValidateLocation(order.RetirementLocation); err != nil {
-				// ValidateLocation returns an sdkerrors.ErrInvalidRequest, so we can just wrap it here
+				// ValidateLocation returns a sdkerrors.ErrInvalidRequest, so we can just wrap it here
 				return sdkerrors.Wrap(err, "a valid retirement location is required when DisableAutoRetire is false")
 			}
 		}

x/ecocredit/marketplace/msg_buy_direct.go

@@ -0,0 +1,53 @@
+package marketplace
+
+import (
+	"github.com/regen-network/regen-ledger/types/math"
+	"github.com/regen-network/regen-ledger/x/ecocredit"
+	"github.com/regen-network/regen-ledger/x/ecocredit/core"
+
+	"github.com/cosmos/cosmos-sdk/types"
+	sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
+	"github.com/cosmos/cosmos-sdk/x/auth/legacy/legacytx"
+)
+
+var _ legacytx.LegacyMsg = &MsgBuyDirect{}
+
+func (m MsgBuyDirect) ValidateBasic() error {
+	if _, err := types.AccAddressFromBech32(m.Buyer); err != nil {
+		return sdkerrors.ErrInvalidAddress.Wrap(err.Error())
+	}
+	for _, order := range m.Orders {
+		if order.SellOrderId == 0 {
+			return sdkerrors.ErrInvalidRequest.Wrap("0 is not a valid sell order id")
+		}
+		if _, err := math.NewDecFromString(order.Quantity); err != nil {
+			return sdkerrors.ErrInvalidRequest.Wrap(err.Error())
+		}
+		if !order.DisableAutoRetire {
+			if err := core.ValidateLocation(order.RetirementLocation); err != nil {
+				return sdkerrors.Wrapf(err, "when DisableAutoRetire is false, a valid retirement location must be provided")
+			}
+		}
+		if order.BidPrice == nil {
+			return sdkerrors.ErrInvalidRequest.Wrap("must specify price per credit")
+		}
+		if err := order.BidPrice.Validate(); err != nil {
+			return err
+		}
+	}
+
+	return nil
+}
+
+func (m MsgBuyDirect) GetSigners() []types.AccAddress {
+	addr, _ := types.AccAddressFromBech32(m.Buyer)
+	return []types.AccAddress{addr}
+}
+
+func (m MsgBuyDirect) GetSignBytes() []byte {
+	return types.MustSortJSON(ecocredit.ModuleCdc.MustMarshalJSON(&m))
+}
+
+func (m MsgBuyDirect) Route() string { return types.MsgTypeURL(&m) }
+
+func (m MsgBuyDirect) Type() string { return types.MsgTypeURL(&m) }

x/ecocredit/marketplace/msg_buy_direct_test.go

@@ -0,0 +1,101 @@
+package marketplace
+
+import (
+	"testing"
+
+	"gotest.tools/v3/assert"
+
+	"github.com/cosmos/cosmos-sdk/testutil/testdata"
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
+
+	"github.com/regen-network/regen-ledger/types/math"
+)
+
+func TestMsgBuyDirect_ValidateBasic(t *testing.T) {
+	type fields struct {
+		Buyer              string
+		SellOrderId        uint64
+		Quantity           string
+		PricePerCredit     *sdk.Coin
+		DisableAutoRetire  bool
+		RetirementLocation string
+	}
+	validCoin := sdk.NewInt64Coin("ufoo", 31)
+	_, _, addr := testdata.KeyTestPubAddr()
+	tests := []struct {
+		name   string
+		fields fields
+		errMsg string
+	}{
+		{
+			name: "valid",
+			fields: fields{
+				Buyer:             addr.String(),
+				SellOrderId:       1,
+				Quantity:          "45.32",
+				PricePerCredit:    &validCoin,
+				DisableAutoRetire: true,
+			},
+		},
+		{
+			name: "valid retirement location",
+			fields: fields{Buyer: addr.String(), SellOrderId: 1, Quantity: "45", PricePerCredit: &validCoin,
+				DisableAutoRetire: false, RetirementLocation: "US-NY"},
+		},
+		{
+			name:   "invalid addr",
+			fields: fields{Buyer: "foobar"},
+			errMsg: sdkerrors.ErrInvalidAddress.Error(),
+		},
+		{
+			name:   "invalid order id",
+			fields: fields{Buyer: addr.String(), SellOrderId: 0},
+			errMsg: "0 is not a valid sell order id",
+		},
+		{
+			name:   "invalid quantity",
+			fields: fields{Buyer: addr.String(), SellOrderId: 1, Quantity: "45.3xyz"},
+			errMsg: math.ErrInvalidDecString.Error(),
+		},
+		{
+			name:   "no price per credit",
+			fields: fields{Buyer: addr.String(), SellOrderId: 1, Quantity: "45", DisableAutoRetire: true, PricePerCredit: nil},
+			errMsg: "must specify price per credit",
+		},
+		{
+			name: "invalid coin",
+			fields: fields{Buyer: addr.String(), SellOrderId: 1, Quantity: "45", DisableAutoRetire: true,
+				PricePerCredit: &sdk.Coin{Denom: "foo3=21.", Amount: sdk.NewInt(3)}},
+			errMsg: "invalid denom",
+		},
+		{
+			name:   "no retirement location when AutoRetiring",
+			fields: fields{Buyer: addr.String(), SellOrderId: 1, Quantity: "45", PricePerCredit: &validCoin, DisableAutoRetire: false},
+			errMsg: "when DisableAutoRetire is false, a valid retirement location must be provided",
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			m := MsgBuyDirect{
+				Buyer: tt.fields.Buyer,
+				Orders: []*MsgBuyDirect_Order{
+					{
+						SellOrderId:        tt.fields.SellOrderId,
+						Quantity:           tt.fields.Quantity,
+						BidPrice:           tt.fields.PricePerCredit,
+						DisableAutoRetire:  tt.fields.DisableAutoRetire,
+						RetirementLocation: tt.fields.RetirementLocation,
+					},
+				},
+			}
+			err := m.ValidateBasic()
+			if len(tt.errMsg) == 0 {
+				assert.NilError(t, err)
+			} else {
+				assert.Check(t, err != nil)
+				assert.ErrorContains(t, err, tt.errMsg)
+			}
+		})
+	}
+}