Fee pooling SDK change (#216)

* update setfee to support fee pooling

* update unit test

* update unit tests

* update cucumber unit test and fee descriptions

* typo fix

Author: shiqizng

Makefile

@@ -13,7 +13,7 @@ build: generate
 
 unit:
 	go test $(TEST_SOURCES_NO_CUCUMBER)
-	cd test && go test --godog.strict=true --godog.format=pretty --godog.tags="@unit.offline,@unit.algod,@unit.indexer,@unit.rekey,@unit.tealsign,@unit.dryrun,@unit.responses,@unit.applications,@unit.transactions,@unit.indexer.rekey,@unit.responses.messagepack,@unit.responses.231,@unit.responses.messagepack.231,@unit.responses.genesis" --test.v .
+	cd test && go test --godog.strict=true --godog.format=pretty --godog.tags="@unit.offline,@unit.algod,@unit.indexer,@unit.rekey,@unit.tealsign,@unit.dryrun,@unit.responses,@unit.applications,@unit.transactions,@unit.indexer.rekey,@unit.responses.messagepack,@unit.responses.231,@unit.responses.messagepack.231,@unit.responses.genesis,@unit.feetest" --test.v .
 
 integration:
 	go test $(TEST_SOURCES_NO_CUCUMBER)

client/algod/models/models.go

@@ -558,8 +558,8 @@ type AssetList struct {
 type TransactionFee struct {
 	// Fee is transaction fee
 	// Fee is in units of micro-Algos per byte.
-	// Fee may fall to zero but transactions must still have a fee of
-	// at least MinTxnFee for the current network protocol.
+	// Fee may fall to zero but a group of N atomic transactions must
+	// still have a fee of at least N*MinTxnFee for the current network protocol.
 	//
 	// required: true
 	Fee uint64 `json:"fee"`
@@ -571,8 +571,8 @@ type TransactionFee struct {
 type TransactionParams struct {
 	// Fee is the suggested transaction fee
 	// Fee is in units of micro-Algos per byte.
-	// Fee may fall to zero but transactions must still have a fee of
-	// at least MinTxnFee for the current network protocol.
+	// Fee may fall to zero but a group of N atomic transactions must
+	// still have a fee of at least N*MinTxnFee for the current network protocol.
 	//
 	// required: true
 	Fee uint64 `json:"fee"`

client/v2/common/models/transaction_parameters_response.go

@@ -9,8 +9,8 @@ type TransactionParametersResponse struct {
 
 	// Fee fee is the suggested transaction fee
 	// Fee is in units of micro-Algos per byte.
-	// Fee may fall to zero but transactions must still have a fee of
-	// at least MinTxnFee for the current network protocol.
+	// Fee may fall to zero but a group of N atomic transactions must
+	// still have a fee of at least N*MinTxnFee for the current network protocol.
 	Fee uint64 `json:"fee,omitempty"`
 
 	// GenesisHash genesisHash is the hash of the genesis block.

future/transaction.go

@@ -18,14 +18,13 @@ func setFee(tx types.Transaction, params types.SuggestedParams) (types.Transacti
 			return types.Transaction{}, err
 		}
 		tx.Fee = types.MicroAlgos(eSize * uint64(params.Fee))
+		if tx.Fee < MinTxnFee {
+			tx.Fee = MinTxnFee
+		}
 	} else {
 		tx.Fee = params.Fee
 	}
 
-	if tx.Fee < MinTxnFee {
-		tx.Fee = MinTxnFee
-	}
-
 	return tx, nil
 }
 
@@ -518,7 +517,6 @@ func byte32FromBase64(in string) (out [32]byte, err error) {
 //                 A page is 1024 bytes. This field enables execution of app programs
 //                 larger than the default maximum program size.
 
-
 // MakeApplicationCreateTx makes a transaction for creating an application (see above for args desc.)
 // - optIn: true for opting in on complete, false for no-op.
 func MakeApplicationCreateTx(

future/transaction_test.go

@@ -2,13 +2,14 @@ package future
 
 import (
 	"encoding/base64"
+	"testing"
+
 	"github.com/algorand/go-algorand-sdk/crypto"
 	"github.com/algorand/go-algorand-sdk/encoding/msgpack"
 	"github.com/algorand/go-algorand-sdk/mnemonic"
 	"github.com/algorand/go-algorand-sdk/transaction"
 	"github.com/algorand/go-algorand-sdk/types"
 	"github.com/stretchr/testify/require"
-	"testing"
 )
 
 func byteFromBase64(s string) []byte {
@@ -741,17 +742,23 @@ func TestFee(t *testing.T) {
 			expected: 1001,
 		},
 		{
-			name:     "Flat fee overridden with min fee",
+			name:     "Flat fee does not get overridden with min fee",
 			flatFee:  true,
 			fee:      999,
-			expected: 1000,
+			expected: 999,
 		},
 		{
 			name:     "Estimated fee overridden with min fee",
 			flatFee:  false,
 			fee:      1,
 			expected: 1000,
 		},
+		{
+			name:     "Flat fee set to 0",
+			flatFee:  true,
+			fee:      0,
+			expected: 0,
+		},
 	}
 	addr := types.Address{}.String()
 	for _, testcase := range testcases {

test/applications_unit_test.go

@@ -14,6 +14,7 @@ import (
 	"github.com/algorand/go-algorand-sdk/client/v2/algod"
 	"github.com/algorand/go-algorand-sdk/client/v2/indexer"
 	"github.com/algorand/go-algorand-sdk/crypto"
+	"github.com/algorand/go-algorand-sdk/encoding/msgpack"
 	"github.com/algorand/go-algorand-sdk/future"
 	"github.com/algorand/go-algorand-sdk/mnemonic"
 	"github.com/algorand/go-algorand-sdk/types"
@@ -145,6 +146,30 @@ func signTheTransaction() error {
 	return err
 }
 
+func feeFieldIsInTxn() error {
+	var txn map[string]interface{}
+	err := msgpack.Decode(stx, &txn)
+	if err != nil {
+		return fmt.Errorf("Error while decoding txn. %v", err)
+	}
+	if _, ok := txn["txn"].(map[interface{}]interface{})["fee"]; !ok {
+		return fmt.Errorf("fee field missing. %v", err)
+	}
+	return nil
+}
+
+func feeFieldNotInTxn() error {
+	var txn map[string]interface{}
+	err := msgpack.Decode(stx, &txn)
+	if err != nil {
+		return fmt.Errorf("Error while decoding txn. %v", err)
+	}
+	if _, ok := txn["txn"].(map[interface{}]interface{})["fee"]; ok {
+		return fmt.Errorf("fee field found but it should have been omitted. %v", err)
+	}
+	return nil
+}
+
 func theBaseEncodedSignedTransactionShouldEqual(base int, golden string) error {
 	gold, err := base64.StdEncoding.DecodeString(golden)
 	if err != nil {
@@ -211,12 +236,15 @@ func weMakeALookupApplicationsCall(applicationID int) error {
 }
 
 func ApplicationsUnitContext(s *godog.Suite) {
-	// @unit.transactiosn
+	// @unit.transactions
 	s.Step(`^a signing account with address "([^"]*)" and mnemonic "([^"]*)"$`, aSigningAccountWithAddressAndMnemonic)
 	s.Step(`^I build an application transaction with operation "([^"]*)", application-id (\d+), sender "([^"]*)", approval-program "([^"]*)", clear-program "([^"]*)", global-bytes (\d+), global-ints (\d+), local-bytes (\d+), local-ints (\d+), app-args "([^"]*)", foreign-apps "([^"]*)", foreign-assets "([^"]*)", app-accounts "([^"]*)", fee (\d+), first-valid (\d+), last-valid (\d+), genesis-hash "([^"]*)", extra-pages (\d+)$`, iBuildAnApplicationTransactionUnit)
 	s.Step(`^sign the transaction$`, signTheTransaction)
 	s.Step(`^the base(\d+) encoded signed transaction should equal "([^"]*)"$`, theBaseEncodedSignedTransactionShouldEqual)
 
+	s.Step(`^fee field is in txn$`, feeFieldIsInTxn)
+	s.Step(`^fee field not in txn$`, feeFieldNotInTxn)
+
 	//@unit.applications
 	s.Step(`^we make a GetAssetByID call for assetID (\d+)$`, weMakeAGetAssetByIDCall)
 	s.Step(`^we make a GetApplicationByID call for applicationID (\d+)$`, weMakeAGetApplicationByIDCall)

test/steps_test.go

@@ -174,7 +174,8 @@ func FeatureContext(s *godog.Suite) {
 	s.Step(`mnemonic for private key "([^"]*)"`, mnForSk)
 	s.Step("I create the payment transaction", createTxn)
 	s.Step(`multisig addresses "([^"]*)"`, msigAddresses)
-	s.Step("I create the multisig payment transaction", createMsigTxn)
+	s.Step("I create the multisig payment transaction$", createMsigTxn)
+	s.Step("I create the multisig payment transaction with zero fee", createMsigTxnZeroFee)
 	s.Step("I sign the multisig transaction with the private key", signMsigTxn)
 	s.Step("I sign the transaction with the private key", signTxn)
 	s.Step(`^I add a rekeyTo field with address "([^"]*)"$`, iAddARekeyToFieldWithAddress)
@@ -508,6 +509,25 @@ func createMsigTxn() error {
 
 }
 
+func createMsigTxnZeroFee() error {
+	var err error
+	paramsToUse := types.SuggestedParams{
+		Fee:             types.MicroAlgos(fee),
+		GenesisID:       gen,
+		GenesisHash:     gh,
+		FirstRoundValid: types.Round(fv),
+		LastRoundValid:  types.Round(lv),
+		FlatFee:         true,
+	}
+	msigaddr, _ := msig.Address()
+	txn, err = future.MakePaymentTxn(msigaddr.String(), to, amt, note, close, paramsToUse)
+	if err != nil {
+		return err
+	}
+	return err
+
+}
+
 func signMsigTxn() error {
 	var err error
 	txid, stx, err = crypto.SignMultisigTransaction(account.PrivateKey, msig, txn)

types/transaction.go

@@ -162,8 +162,8 @@ type TxGroup struct {
 type SuggestedParams struct {
 	// Fee is the suggested transaction fee
 	// Fee is in units of micro-Algos per byte.
-	// Fee may fall to zero but transactions must still have a fee of
-	// at least MinTxnFee for the current network protocol.
+	// Fee may fall to zero but a group of N atomic transactions must
+	// still have a fee of at least N*MinTxnFee for the current network protocol.
 	Fee MicroAlgos
 
 	// Genesis ID
@@ -183,6 +183,7 @@ type SuggestedParams struct {
 	ConsensusVersion string
 
 	// FlatFee indicates whether the passed fee is per-byte or per-transaction
+	// If true, txn fee may fall below the MinTxnFee for the current network protocol.
 	FlatFee bool
 
 	// The minimum transaction fee (not per byte) required for the