feat: Add CalcualteFee in GRPC

Makefile

@@ -3,8 +3,12 @@ BUILD_LDFLAGS= -ldflags "-X github.com/pactus-project/pactus/version.build=`git
 
 ifneq (,$(filter $(OS),Windows_NT MINGW64))
 EXE = .exe
+RM = del /q
+else 
+RM = rm -rf
 endif
 
+
 all: build test
 
 ########################################
@@ -47,9 +51,9 @@ docker:
 ########################################
 ### proto
 proto:
-	cd www/grpc/ && rm -rf gen && buf generate proto
+	cd www/grpc/ && $(RM) gen && buf generate proto
 
-	# Generate static assets for Swagger-UI
+# Generate static assets for Swagger-UI
 	cd www/grpc/ && statik -m -f -src swagger-ui/
 
 ########################################

execution/execution.go

@@ -3,6 +3,7 @@ package execution
 import (
 	"github.com/pactus-project/pactus/execution/executor"
 	"github.com/pactus-project/pactus/sandbox"
+	"github.com/pactus-project/pactus/types/param"
 	"github.com/pactus-project/pactus/types/tx"
 	"github.com/pactus-project/pactus/types/tx/payload"
 	"github.com/pactus-project/pactus/util"
@@ -122,16 +123,15 @@ func (exe *Execution) checkFee(trx *tx.Tx, sb sandbox.Sandbox) error {
 			return errors.Errorf(errors.ErrInvalidTx, "fee is wrong, expected: 0, got: %v", trx.Fee())
 		}
 	} else {
-		fee := calculateFee(trx.Payload().Value(), sb)
+		fee := CalculateFee(trx.Payload().Value(), sb.Params())
 		if trx.Fee() != fee {
 			return errors.Errorf(errors.ErrInvalidFee, "fee is wrong, expected: %v, got: %v", fee, trx.Fee())
 		}
 	}
 	return nil
 }
 
-func calculateFee(amt int64, sb sandbox.Sandbox) int64 {
-	params := sb.Params()
+func CalculateFee(amt int64, params param.Params) int64 {
 	fee := int64(float64(amt) * params.FeeFraction)
 	fee = util.Max64(fee, params.MinimumFee)
 	fee = util.Min64(fee, params.MaximumFee)

execution/execution_test.go

@@ -246,7 +246,7 @@ func TestFee(t *testing.T) {
 		assert.Equal(t, errors.Code(err), test.expectedErrCode,
 			"test %v failed. unexpected error", i)
 
-		assert.Equal(t, calculateFee(test.amount, sb), test.expectedFee,
+		assert.Equal(t, CalculateFee(test.amount, sb.Params()), test.expectedFee,
 			"test %v failed. invalid fee", i)
 	}
 }

go.mod

@@ -19,7 +19,6 @@ require (
 	github.com/multiformats/go-multiaddr v0.9.0
 	github.com/pelletier/go-toml v1.9.5
 	github.com/pkg/errors v0.9.1
-	github.com/prometheus/client_golang v1.14.0
 	github.com/rakyll/statik v0.1.7
 	github.com/sirupsen/logrus v1.9.0
 	github.com/stretchr/testify v1.8.2
@@ -110,6 +109,7 @@ require (
 	github.com/pbnjay/memory v0.0.0-20210728143218-7b4eea64cf58 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
 	github.com/polydawn/refmt v0.89.0 // indirect
+	github.com/prometheus/client_golang v1.14.0 // indirect
 	github.com/prometheus/client_model v0.3.0 // indirect
 	github.com/prometheus/common v0.42.0 // indirect
 	github.com/prometheus/procfs v0.9.0 // indirect

node/node.go

@@ -42,7 +42,7 @@ func NewNode(genDoc *genesis.Genesis, conf *config.Config,
 	// Initialize the logger
 	logger.InitLogger(conf.Logger)
 
-	logger.Info("You are running a pactus Blockchain",
+	logger.Info("You are running a pactus block chain",
 		"version", version.Version(),
 		"network", genDoc.ChainType())
 

state/facade.go

@@ -11,6 +11,7 @@ import (
 	"github.com/pactus-project/pactus/types/block"
 	"github.com/pactus-project/pactus/types/param"
 	"github.com/pactus-project/pactus/types/tx"
+	"github.com/pactus-project/pactus/types/tx/payload"
 	"github.com/pactus-project/pactus/types/validator"
 )
 
@@ -49,4 +50,5 @@ type Facade interface {
 	Params() param.Params
 	Close() error
 	Fingerprint() string
+	CalcFee(amount int64, payloadType payload.Type) (int64, error)
 }

state/mock.go

@@ -15,6 +15,7 @@
 	"github.com/pactus-project/pactus/types/block"
 	"github.com/pactus-project/pactus/types/param"
 	"github.com/pactus-project/pactus/types/tx"
+	"github.com/pactus-project/pactus/types/tx/payload"
 	"github.com/pactus-project/pactus/types/validator"
 	"github.com/pactus-project/pactus/util"
 	"github.com/pactus-project/pactus/util/errors"
@@ -209,3 +210,7 @@
 func (m *MockState) Params() param.Params {
 	return m.TestParams
 }
+
+func (m *MockState) CalcFee(_ int64, payloadType payload.Type) (int64, error) {
+	return 0, nil
+}

state/state.go

@@ -19,6 +19,7 @@ import (
 	"github.com/pactus-project/pactus/types/block"
 	"github.com/pactus-project/pactus/types/param"
 	"github.com/pactus-project/pactus/types/tx"
+	"github.com/pactus-project/pactus/types/tx/payload"
 	"github.com/pactus-project/pactus/types/validator"
 	"github.com/pactus-project/pactus/util"
 	"github.com/pactus-project/pactus/util/errors"
@@ -703,3 +704,23 @@ func (st *state) publishEvents(height uint32, block *block.Block) {
 		st.eventCh <- TxEvent
 	}
 }
+
+func (st *state) CalcFee(amount int64, payloadType payload.Type) (int64, error) {
+	switch payloadType {
+	case payload.PayloadTypeTransfer,
+		payload.PayloadTypeBond,
+		payload.PayloadTypeWithdraw:
+		{
+			return execution.CalculateFee(amount, st.params), nil
+		}
+
+	case payload.PayloadTypeUnbond,
+		payload.PayloadTypeSortition:
+		{
+			return 0, nil
+		}
+
+	default:
+		return 0, errors.Errorf(errors.ErrInvalidTx, "unexpected tx type: %v", payloadType)
+	}
+}

state/state_test.go

@@ -18,6 +18,7 @@
 	"github.com/pactus-project/pactus/types/tx/payload"
 	"github.com/pactus-project/pactus/types/validator"
 	"github.com/pactus-project/pactus/util"
+	"github.com/pactus-project/pactus/util/errors"
 	"github.com/pactus-project/pactus/util/testsuite"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
@@ -728,3 +729,37 @@
 	// It is possible that the same block would be considered valid by td.state2.
 	assert.Error(t, td.state1.CommitBlock(2, b, c))
 }
+
+func TestCalcFee(t *testing.T) {
+	td := setup(t)
+	tests := []struct {
+		amount          int64
+		fee             int64
+		expectedFee     int64
+		expectedErrCode int
+	}{
+		{1, 1, td.state1.params.MinimumFee, errors.ErrInvalidFee},
+		{1, 1001, td.state1.params.MinimumFee, errors.ErrInvalidFee},
+		{1, 1000, td.state1.params.MinimumFee, errors.ErrNone},
+
+		{1 * 1e9, 1, 100000, errors.ErrInvalidFee},
+		{1 * 1e9, 100001, 100000, errors.ErrInvalidFee},
+		{1 * 1e9, 100000, 100000, errors.ErrNone},
+
+		{1 * 1e12, 1, 1000000, errors.ErrInvalidFee},
+		{1 * 1e12, 1000001, 1000000, errors.ErrInvalidFee},
+		{1 * 1e12, 1000000, 1000000, errors.ErrNone},
+	}
+	for _, test := range tests {
+		fee, err := td.state2.CalcFee(int64(test.amount), payload.PayloadTypeTransfer)
+		assert.NoError(t, err)
+		assert.Equal(t, int64(test.expectedFee), fee)
+
+		fee, err = td.state2.CalcFee(int64(test.amount), payload.PayloadTypeUnbond)
+		assert.NoError(t, err)
+		assert.Equal(t, int64(0), fee)
+
+		_, err = td.state2.CalcFee(int64(test.amount), 6)
+		assert.Error(t, err)
+	}
+}

wallet/client.go

@@ -6,6 +6,7 @@
 	"github.com/pactus-project/pactus/crypto"
 	"github.com/pactus-project/pactus/crypto/hash"
 	"github.com/pactus-project/pactus/types/tx"
+	"github.com/pactus-project/pactus/types/tx/payload"
 	pactus "github.com/pactus-project/pactus/www/grpc/gen/go"
 	"google.golang.org/grpc"
 	"google.golang.org/grpc/credentials/insecure"
@@ -73,6 +74,7 @@
 	return hash.FromBytes(res.Id)
 }
 
+// TODO: check the return value type
 func (c *grpcClient) getTransaction(id tx.ID) (*pactus.GetTransactionResponse, error) {
 	res, err := c.transactionClient.GetTransaction(context.Background(), &pactus.GetTransactionRequest{
 		Id:        id.Bytes(),
@@ -84,3 +86,11 @@
 
 	return res, nil
 }
+
+func (c *grpcClient) getFee(amount int64, payloadType payload.Type) (int64, error) {
+	res, err := c.transactionClient.CalculateFee(context.Background(), &pactus.CalculateFeeRequest{Amount: amount, PayloadType: pactus.PayloadType(payloadType)})
+	if err != nil {
+		return 0, err
+	}
+	return res.Fee, nil
+}

wallet/client_test.go

@@ -77,6 +77,18 @@ func (s *transactionServer) GetTransaction(_ context.Context,
 	return nil, nil
 }
 
+func (s *transactionServer) CalculateFee(_ context.Context,
+	_ *pactus.CalculateFeeRequest) (*pactus.CalculateFeeResponse, error) {
+
+	return &pactus.CalculateFeeResponse{Fee: 0}, nil
+}
+
+func (s *transactionServer) GetFee(_ context.Context,
+	_ *pactus.CalculateFeeRequest) (*pactus.CalculateFeeResponse, error) {
+
+	return &pactus.CalculateFeeResponse{Fee: 0}, nil
+}
+
 func (s *transactionServer) SendRawTransaction(_ context.Context,
 	req *pactus.SendRawTransactionRequest) (*pactus.SendRawTransactionResponse, error) {
 	trx, _ := tx.FromBytes(req.Data)

wallet/tx_builder.go

@@ -97,7 +97,10 @@
 		return nil, err
 	}
 
-	m.setFee()
+	err = m.setFee()
+	if err != nil {
+		return nil, err
+	}
 
 	var trx *tx.Tx
 	switch m.typ {
@@ -169,20 +172,16 @@
 	return nil
 }
 
-func (m *txBuilder) setFee() {
+func (m *txBuilder) setFee() error {
 	if m.fee == 0 {
-		switch m.typ {
-		case payload.PayloadTypeTransfer,
-			payload.PayloadTypeBond,
-			payload.PayloadTypeWithdraw:
-			{
-				m.fee = calcFee(m.amount)
-			}
-
-		case payload.PayloadTypeUnbond:
-			{
-				m.fee = 0
-			}
+		if m.client == nil {
+			return ErrOffline
 		}
+		fee, err := m.client.getFee(m.amount, m.typ)
+		if err != nil {
+			return err
+		}
+		m.fee = fee
 	}
+	return nil
 }

wallet/wallet.go

@@ -11,7 +11,6 @@ import (
 	"github.com/pactus-project/pactus/crypto"
 	"github.com/pactus-project/pactus/crypto/bls"
 	"github.com/pactus-project/pactus/genesis"
-	"github.com/pactus-project/pactus/types/param"
 	"github.com/pactus-project/pactus/types/tx"
 	"github.com/pactus-project/pactus/types/tx/payload"
 	"github.com/pactus-project/pactus/util"
@@ -406,17 +405,8 @@ func (w *Wallet) BroadcastTransaction(trx *tx.Tx) (string, error) {
 	return id.String(), nil
 }
 
-func calcFee(amount int64) int64 {
-	params := param.DefaultParams() // TODO: Get parameter from the node
-	fee := int64(float64(amount) * params.FeeFraction)
-	fee = util.Max64(fee, params.MinimumFee)
-	fee = util.Min64(fee, params.MaximumFee)
-	return fee
-}
-
-// TODO: query fee from grpc client
-func (w *Wallet) CalculateFee(amount int64) int64 {
-	return calcFee(amount)
+func (w *Wallet) CalculateFee(amount int64, payloadType payload.Type) (int64, error) {
+	return w.client.getFee(amount, payloadType)
 }
 
 func (w *Wallet) UpdatePassword(oldPassword, newPassword string) error {

wallet/wallet_test.go

@@ -305,7 +305,9 @@ func TestMakeTransferTx(t *testing.T) {
 		assert.NoError(t, err)
 		assert.Equal(t, trx.Sequence(), seq+1)
 		assert.Equal(t, trx.Payload().Value(), amount)
-		assert.Equal(t, trx.Fee(), td.wallet.CalculateFee(amount))
+		fee, err := td.wallet.CalculateFee(amount, payload.PayloadTypeTransfer)
+		assert.NoError(t, err)
+		assert.Equal(t, trx.Fee(), fee)
 		assert.Equal(t, trx.Stamp(), lastBlockHash.Stamp())
 	})
 
@@ -363,7 +365,9 @@ func TestMakeBondTx(t *testing.T) {
 		assert.Equal(t, trx.Sequence(), seq+1)
 		assert.True(t, trx.Payload().(*payload.BondPayload).PublicKey.EqualsTo(receiver.PublicKey()))
 		assert.Equal(t, trx.Payload().Value(), amount)
-		assert.Equal(t, trx.Fee(), td.wallet.CalculateFee(amount))
+		fee, err := td.wallet.CalculateFee(amount, payload.PayloadTypeBond)
+		assert.NoError(t, err)
+		assert.Equal(t, trx.Fee(), fee)
 		assert.Equal(t, trx.Stamp(), lastBlockHash.Stamp())
 	})
 
@@ -533,7 +537,9 @@ func TestMakeWithdrawTx(t *testing.T) {
 		assert.NoError(t, err)
 		assert.Equal(t, trx.Sequence(), seq+1)
 		assert.Equal(t, trx.Payload().Value(), amount)
-		assert.Equal(t, trx.Fee(), td.wallet.CalculateFee(amount))
+		fee, err := td.wallet.CalculateFee(amount, payload.PayloadTypeWithdraw)
+		assert.NoError(t, err)
+		assert.Equal(t, trx.Fee(), fee)
 		assert.Equal(t, trx.Stamp(), lastBlockHash.Stamp())
 	})