feat(x/ecocredit/marketplace): implement buyer and seller fees

x/ecocredit/marketplace/keeper/features/msg_buy_direct.feature

@@ -51,7 +51,7 @@ Feature: Msg/BuyDirect
     Background:
       Given a credit type
       And alice created a sell order with ask denom "regen"
-      And bob has a bank balance with denom "regen"
+      And bob has bank balance "100regen"
 
     Scenario: bid denom matches sell denom
       When bob attempts to buy credits with bid denom "regen"
@@ -68,35 +68,35 @@ Feature: Msg/BuyDirect
 
     Scenario Outline: buyer bank balance is greater than or equal to total cost (single buy order)
       Given alice created a sell order with quantity "10" and ask amount "10"
-      And bob has a bank balance with amount "<balance-amount>"
+      And bob has bank balance "<balance-amount>"
       When bob attempts to buy credits with quantity "10" and bid amount "10"
       Then expect no error
 
       Examples:
         | description  | balance-amount |
-        | greater than | 200            |
-        | equal to     | 100            |
+        | greater than | 200regen       |
+        | equal to     | 100regen       |
 
     Scenario Outline: buyer bank balance is greater than or equal to total cost (multiple buy orders)
       Given alice created two sell orders each with quantity "10" and ask amount "10"
-      And bob has a bank balance with amount "<balance-amount>"
+      And bob has bank balance "<balance-amount>"
       When bob attempts to buy credits in two orders each with quantity "10" and bid amount "10"
       Then expect no error
 
       Examples:
         | description  | balance-amount |
-        | greater than | 400            |
-        | equal to     | 200            |
+        | greater than | 400regen       |
+        | equal to     | 200regen       |
 
     Scenario: buyer bank balance is less than total cost (single buy order)
       Given alice created a sell order with quantity "10" and ask amount "10"
-      And bob has a bank balance with amount "50"
+      And bob has bank balance "50regen"
       When bob attempts to buy credits with quantity "10" and bid amount "10"
       Then expect the error "orders[0]: quantity: 10, ask price: 10regen, total price: 100regen, bank balance: 50regen: insufficient funds"
 
     Scenario: buyer bank balance is less than total cost (multiple buy orders)
       Given alice created two sell orders each with quantity "10" and ask amount "10"
-      And bob has a bank balance with amount "150"
+      And bob has bank balance "150regen"
       When bob attempts to buy credits in two orders each with quantity "10" and bid amount "10"
       Then expect the error "orders[1]: quantity: 10, ask price: 10regen, total price: 100regen, bank balance: 50regen: insufficient funds"
 
@@ -105,7 +105,7 @@ Feature: Msg/BuyDirect
     Background:
       Given a credit type
       And alice created a sell order with ask amount "10"
-      And bob has a bank balance with amount "100"
+      And bob has bank balance "100regen"
 
     Scenario Outline: bid price greater than or equal to ask price
       When bob attempts to buy credits with quantity "10" and bid amount "<bid-amount>"
@@ -125,7 +125,7 @@ Feature: Msg/BuyDirect
     Background:
       Given a credit type
       And alice created a sell order with quantity "10"
-      And bob has a bank balance with amount "150"
+      And bob has bank balance "150regen"
 
     Scenario Outline: quantity less than or equal to sell order quantity
       When bob attempts to buy credits with quantity "<quantity>"
@@ -220,7 +220,7 @@ Feature: Msg/BuyDirect
 
     Scenario: buyer bank balance updated
       Given alice created a sell order with quantity "10" and ask price "10regen"
-      And bob has the bank balance "100regen"
+      And bob has bank balance "100regen"
       When bob attempts to buy credits with quantity "10" and bid price "10regen"
       Then expect bob bank balance "0regen"
 
@@ -344,12 +344,15 @@ Feature: Msg/BuyDirect
     Background:
       Given a credit type
       And alice's address "regen1nzh226hxrsvf4k69sa8v0nfuzx5vgwkczk8j68"
+      And alice has bank balance "100regen"
       And bob's address "regen1depk54cuajgkzea6zpgkq36tnjwdzv4ak663u6"
+      And bob has bank balance "100regen"
 
     Scenario: EventTransfer is emitted
       Given alice created a sell order with id "1"
       When bob attempts to buy credits with quantity "10"
-      Then expect event transfer with properties
+      Then expect no error
+      And expect event transfer with properties
       """
       {
         "sender": "regen1nzh226hxrsvf4k69sa8v0nfuzx5vgwkczk8j68",
@@ -363,7 +366,8 @@ Feature: Msg/BuyDirect
     Scenario: EventRetire is emitted
       Given alice created a sell order with id "1"
       When bob attempts to buy credits with sell order id "1" and retirement reason "offsetting electricity consumption"
-      Then expect event retire with properties
+      Then expect no error
+      And expect event retire with properties
       """
       {
         "owner": "regen1depk54cuajgkzea6zpgkq36tnjwdzv4ak663u6",
@@ -376,9 +380,54 @@ Feature: Msg/BuyDirect
     Scenario: EventBuyDirect is emitted
       Given alice created a sell order with id "1"
       When bob attempts to buy credits with sell order id "1"
-      Then expect event buy direct with properties
+      Then expect no error
+      And expect event buy direct with properties
       """
       {
         "sell_order_id": 1
       }
       """
+
+  Rule: buyer fees are deducted from buyer, seller fees are deducted from seller, and both go to fee pool
+    Background:
+      Given a credit type
+
+    Scenario: fees go to fee pool
+      Given alice created a sell order with quantity "10" and ask price "10foo"
+      * bob has bank balance "110foo"
+      * alice has bank balance "0foo"
+      * buyer fees are 0.1 and seller fees are 0.05
+      When bob attempts to buy credits with quantity "10" and bid price "10foo"
+      Then expect no error
+      * expect alice bank balance "95foo"
+      * expect bob bank balance "0foo"
+      * expect fee pool balance "15foo"
+
+    Scenario: fees get burned
+      Given alice created a sell order with quantity "10" and ask price "20uregen"
+      * bob has bank balance "240uregen"
+      * alice has bank balance "0regen"
+      * buyer fees are 0.2 and seller fees are 0.1
+      When bob attempts to buy credits with quantity "10" and bid price "20uregen"
+      Then expect no error
+      * expect alice bank balance "180uregen"
+      * expect bob bank balance "0uregen"
+      * expect fee pool balance "0uregen"
+
+  Rule: max_fee_amount is enforced
+    Scenario Outline: max_fee_amount is enforced
+      Given a credit type
+      * alice created a sell order with quantity "10" and ask price "10foo"
+      * buyer fees are 0.2 and seller fees are 0.1
+      * bob has bank balance "200foo"
+      * bob sets a max fee of <max_fee_amount>
+      When bob attempts to buy credits with quantity "10" and bid price "20foo"
+      Then expect error contains "<error>"
+
+      Examples:
+        | max_fee_amount | error   |
+        | 10             | max fee |
+        | 20             |         |
+        | 30             |         |
+
+

x/ecocredit/marketplace/keeper/keeper.go

@@ -15,18 +15,20 @@ var (
 )
 
 type Keeper struct {
-	stateStore marketapi.StateStore
-	baseStore  baseapi.StateStore
-	bankKeeper ecocredit.BankKeeper
-	authority  sdk.AccAddress
+	stateStore  marketapi.StateStore
+	baseStore   baseapi.StateStore
+	bankKeeper  ecocredit.BankKeeper
+	authority   sdk.AccAddress
+	feePoolName string
 }
 
 func NewKeeper(ss marketapi.StateStore, cs baseapi.StateStore, bk ecocredit.BankKeeper,
-	authority sdk.AccAddress) Keeper {
+	authority sdk.AccAddress, feePoolName string) Keeper {
 	return Keeper{
-		baseStore:  cs,
-		stateStore: ss,
-		bankKeeper: bk,
-		authority:  authority,
+		baseStore:   cs,
+		stateStore:  ss,
+		bankKeeper:  bk,
+		authority:   authority,
+		feePoolName: feePoolName,
 	}
 }

x/ecocredit/marketplace/keeper/keeper_test.go

@@ -76,7 +76,7 @@ func setupBase(t gocuke.TestingT, numAddresses int) *baseSuite {
 
 	authority, err := sdk.AccAddressFromBech32("regen1nzh226hxrsvf4k69sa8v0nfuzx5vgwkczk8j68")
 	assert.NilError(s.t, err)
-	s.k = NewKeeper(s.marketStore, s.baseStore, s.bankKeeper, authority)
+	s.k = NewKeeper(s.marketStore, s.baseStore, s.bankKeeper, authority, ecocredit.ModuleName)
 
 	// set test accounts
 	for i := 0; i < numAddresses; i++ {

x/ecocredit/marketplace/keeper/msg_buy_direct.go

@@ -92,13 +92,36 @@ func (k Keeper) BuyDirect(ctx context.Context, req *types.MsgBuyDirect) (*types.
 			)
 		}
 
-		// check address has the total cost (price per * order quantity)
-		buyerBalance := k.bankKeeper.GetBalance(sdkCtx, buyerAcc, order.BidPrice.Denom)
-		cost, err := getTotalCost(sellOrderAskAmount, buyQuantity)
+		// calc sub-total (price per * order quantity)
+		subtotal, err := getSubTotalCost(sellOrderAskAmount, buyQuantity)
+		if err != nil {
+			return nil, err
+		}
+
+		// add buyer fees
+		feeParams, err := k.stateStore.FeeParamsTable().Get(ctx)
 		if err != nil {
 			return nil, err
 		}
-		totalCost := sdk.Coin{Amount: cost, Denom: market.BankDenom}
+		total, buyerFee, err := getTotalCostAndBuyerFee(subtotal, feeParams)
+		totalCost := sdk.Coin{Amount: total.SdkIntTrim(), Denom: market.BankDenom}
+
+		// check max fee
+		if maxFee := order.MaxFeeAmount; maxFee != "" {
+			maxFeeInt, ok := sdk.NewIntFromString(maxFee)
+			if !ok {
+				return nil, sdkerrors.ErrInvalidType.Wrapf("could not convert %s to %T", maxFee, sdkmath.Int{})
+			}
+			if maxFeeInt.LT(buyerFee.SdkIntTrim()) {
+				return nil, sdkerrors.ErrInvalidRequest.Wrapf(
+					"%s: max fee: %s, required fee: %s",
+					orderIndex, maxFee, buyerFee,
+				)
+			}
+		}
+
+		// check address has the total cost
+		buyerBalance := k.bankKeeper.GetBalance(sdkCtx, buyerAcc, order.BidPrice.Denom)
 		if buyerBalance.IsLT(totalCost) {
 			return nil, sdkerrors.ErrInsufficientFunds.Wrapf(
 				"%s: quantity: %s, ask price: %s%s, total price: %v, bank balance: %v",
@@ -113,11 +136,15 @@ func (k Keeper) BuyDirect(ctx context.Context, req *types.MsgBuyDirect) (*types.
 			sellOrder:    sellOrder,
 			buyerAcc:     buyerAcc,
 			buyQuantity:  buyQuantity,
-			totalCost:    totalCost,
+			totalCost:    total,
+			subTotalCost: subtotal,
+			buyerFee:     buyerFee,
 			autoRetire:   !order.DisableAutoRetire,
 			batchDenom:   batch.Denom,
+			bankDenom:    market.BankDenom,
 			jurisdiction: order.RetirementJurisdiction,
 			reason:       order.RetirementReason,
+			feeParams:    feeParams,
 		}); err != nil {
 			return nil, err
 		}