Merge pull request #3167 from oasisprotocol/tjanez/gas-amount-in-tokens

 Pretty print transaction's gas amount in token units

.changelog/3151.feature.md

@@ -0,0 +1 @@
+go/consensus/api/transaction: Pretty-print transaction's fee amount in tokens

.changelog/3167.feature.1.md

@@ -0,0 +1 @@
+go/staking/api/token: Initial implementation

.changelog/3167.feature.2.md

@@ -0,0 +1 @@
+go/consensus/api/transaction: Implement `PrettyPrinter` interface for `Fee`

go/common/prettyprint/context.go

@@ -1,7 +1,15 @@
 package prettyprint
 
-// ContextKeyGenesisHash is the key to retrieve the Genesis document's hash
-// value from a context.
-var ContextKeyGenesisHash = contextKey("genesis/hash")
+var (
+	// ContextKeyGenesisHash is the key to retrieve the Genesis document's hash
+	// value from a context.
+	ContextKeyGenesisHash = contextKey("genesis/hash")
+	// ContextKeyTokenSymbol is the key to retrieve the token's ticker symbol
+	// value from a context.
+	ContextKeyTokenSymbol = contextKey("staking/token-symbol")
+	// ContextKeyTokenValueExponent is the key to retrieve the token's value
+	// base-10 exponent from a context.
+	ContextKeyTokenValueExponent = contextKey("staking/token-value-exponent")
+)
 
 type contextKey string

go/consensus/api/transaction/gas.go

@@ -1,8 +1,14 @@
 package transaction
 
 import (
+	"context"
+	"fmt"
+	"io"
+
 	"github.com/oasisprotocol/oasis-core/go/common/errors"
+	"github.com/oasisprotocol/oasis-core/go/common/prettyprint"
 	"github.com/oasisprotocol/oasis-core/go/common/quantity"
+	"github.com/oasisprotocol/oasis-core/go/staking/api/token"
 )
 
 var (
@@ -12,6 +18,8 @@ var (
 
 	// ErrGasPriceTooLow is the error returned when the gas price is too low.
 	ErrGasPriceTooLow = errors.New(moduleName, 3, "transaction: gas price too low")
+
+	_ prettyprint.PrettyPrinter = (*Fee)(nil)
 )
 
 // Gas is the consensus gas representation.
@@ -26,6 +34,25 @@ type Fee struct {
 	Gas Gas `json:"gas"`
 }
 
+// PrettyPrint writes a pretty-printed representation of the fee to the given
+// writer.
+func (f Fee) PrettyPrint(ctx context.Context, prefix string, w io.Writer) {
+	fmt.Fprintf(w, "%sAmount: ", prefix)
+	token.PrettyPrintAmount(ctx, f.Amount, w)
+	fmt.Fprintln(w)
+
+	fmt.Fprintf(w, "%sGas limit: %d\n", prefix, f.Gas)
+	fmt.Fprintf(w, "%s(gas price: ", prefix)
+	token.PrettyPrintAmount(ctx, *f.GasPrice(), w)
+	fmt.Fprintln(w, " per gas unit)")
+}
+
+// PrettyType returns a representation of Fee that can be used for pretty
+// printing.
+func (f Fee) PrettyType() (interface{}, error) {
+	return f, nil
+}
+
 // GasPrice returns the gas price implied by the amount and gas.
 func (f Fee) GasPrice() *quantity.Quantity {
 	if f.Amount.IsZero() || f.Gas == 0 {

go/consensus/api/transaction/transaction.go

@@ -83,7 +83,8 @@ func (t Transaction) PrettyPrintBody(ctx context.Context, prefix string, w io.Wr
 func (t Transaction) PrettyPrint(ctx context.Context, prefix string, w io.Writer) {
 	fmt.Fprintf(w, "%sNonce:  %d\n", prefix, t.Nonce)
 	if t.Fee != nil {
-		fmt.Fprintf(w, "%sFee:    %s (gas limit: %d, gas price: %s)\n", prefix, t.Fee.Amount, t.Fee.Gas, t.Fee.GasPrice())
+		fmt.Fprintf(w, "%sFee:\n", prefix)
+		t.Fee.PrettyPrint(ctx, prefix+"  ", w)
 	} else {
 		fmt.Fprintf(w, "%sFee:   none\n", prefix)
 	}

go/genesis/genesis_test.go

@@ -30,6 +30,7 @@ import (
 	roothashAPI "github.com/oasisprotocol/oasis-core/go/roothash/api"
 	scheduler "github.com/oasisprotocol/oasis-core/go/scheduler/api"
 	staking "github.com/oasisprotocol/oasis-core/go/staking/api"
+	"github.com/oasisprotocol/oasis-core/go/staking/api/token"
 	stakingTests "github.com/oasisprotocol/oasis-core/go/staking/tests/debug"
 	storage "github.com/oasisprotocol/oasis-core/go/storage/api"
 )
@@ -670,7 +671,7 @@ func TestGenesisSanityCheck(t *testing.T) {
 	d.Staking.TokenSymbol = "foo"
 	require.EqualError(
 		d.SanityCheck(),
-		fmt.Sprintf("staking: sanity check failed: token symbol should match '%s'", staking.TokenSymbolRegexp),
+		fmt.Sprintf("staking: sanity check failed: token symbol should match '%s'", token.TokenSymbolRegexp),
 		"lower case token symbol should be rejected",
 	)
 

go/oasis-node/cmd/consensus/consensus.go

@@ -21,7 +21,6 @@ import (
 	cmdConsensus "github.com/oasisprotocol/oasis-core/go/oasis-node/cmd/common/consensus"
 	cmdFlags "github.com/oasisprotocol/oasis-core/go/oasis-node/cmd/common/flags"
 	cmdGrpc "github.com/oasisprotocol/oasis-core/go/oasis-node/cmd/common/grpc"
-	staking "github.com/oasisprotocol/oasis-core/go/staking/api"
 )
 
 const (
@@ -137,8 +136,8 @@ func doShowTx(cmd *cobra.Command, args []string) {
 	genesis := cmdConsensus.InitGenesis()
 
 	ctx := context.Background()
-	ctx = context.WithValue(ctx, staking.PrettyPrinterContextKeyTokenSymbol, genesis.Staking.TokenSymbol)
-	ctx = context.WithValue(ctx, staking.PrettyPrinterContextKeyTokenValueExponent, genesis.Staking.TokenValueExponent)
+	ctx = context.WithValue(ctx, prettyprint.ContextKeyTokenSymbol, genesis.Staking.TokenSymbol)
+	ctx = context.WithValue(ctx, prettyprint.ContextKeyTokenValueExponent, genesis.Staking.TokenValueExponent)
 	ctx = context.WithValue(ctx, prettyprint.ContextKeyGenesisHash, genesis.Hash())
 
 	sigTx := loadTx()

go/oasis-node/cmd/stake/account.go

@@ -17,7 +17,6 @@ import (
 	cmdFlags "github.com/oasisprotocol/oasis-core/go/oasis-node/cmd/common/flags"
 	cmdGrpc "github.com/oasisprotocol/oasis-core/go/oasis-node/cmd/common/grpc"
 	"github.com/oasisprotocol/oasis-core/go/staking/api"
-	staking "github.com/oasisprotocol/oasis-core/go/staking/api"
 )
 
 const (
@@ -98,8 +97,8 @@ var (
 // information (ticker symbol, value base-10 exponent, genesis document's hash).
 func getCtxWithInfo(genesis *genesisAPI.Document) context.Context {
 	ctx := context.Background()
-	ctx = context.WithValue(ctx, staking.PrettyPrinterContextKeyTokenSymbol, genesis.Staking.TokenSymbol)
-	ctx = context.WithValue(ctx, staking.PrettyPrinterContextKeyTokenValueExponent, genesis.Staking.TokenValueExponent)
+	ctx = context.WithValue(ctx, prettyprint.ContextKeyTokenSymbol, genesis.Staking.TokenSymbol)
+	ctx = context.WithValue(ctx, prettyprint.ContextKeyTokenValueExponent, genesis.Staking.TokenValueExponent)
 	ctx = context.WithValue(ctx, prettyprint.ContextKeyGenesisHash, genesis.Hash())
 	return ctx
 }
@@ -109,7 +108,7 @@ func doAccountInfo(cmd *cobra.Command, args []string) {
 		cmdCommon.EarlyLogAndExit(err)
 	}
 
-	var addr staking.Address
+	var addr api.Address
 	if err := addr.UnmarshalText([]byte(viper.GetString(CfgAccountAddr))); err != nil {
 		logger.Error("failed to parse account address",
 			"err", err,
@@ -124,8 +123,8 @@ func doAccountInfo(cmd *cobra.Command, args []string) {
 	acct := getAccount(ctx, cmd, addr, client)
 	symbol := getTokenSymbol(ctx, cmd, client)
 	exp := getTokenValueExponent(ctx, cmd, client)
-	ctx = context.WithValue(ctx, api.PrettyPrinterContextKeyTokenSymbol, symbol)
-	ctx = context.WithValue(ctx, api.PrettyPrinterContextKeyTokenValueExponent, exp)
+	ctx = context.WithValue(ctx, prettyprint.ContextKeyTokenSymbol, symbol)
+	ctx = context.WithValue(ctx, prettyprint.ContextKeyTokenValueExponent, exp)
 	acct.PrettyPrint(ctx, "", os.Stdout)
 }
 
@@ -137,7 +136,7 @@ func doAccountTransfer(cmd *cobra.Command, args []string) {
 	genesis := cmdConsensus.InitGenesis()
 	cmdConsensus.AssertTxFileOK()
 
-	var xfer staking.Transfer
+	var xfer api.Transfer
 	if err := xfer.To.UnmarshalText([]byte(viper.GetString(CfgTransferDestination))); err != nil {
 		logger.Error("failed to parse transfer destination account address",
 			"err", err,
@@ -152,7 +151,7 @@ func doAccountTransfer(cmd *cobra.Command, args []string) {
 	}
 
 	nonce, fee := cmdConsensus.GetTxNonceAndFee()
-	tx := staking.NewTransferTx(nonce, fee, &xfer)
+	tx := api.NewTransferTx(nonce, fee, &xfer)
 
 	cmdConsensus.SignAndSaveTx(getCtxWithInfo(genesis), tx)
 }
@@ -165,7 +164,7 @@ func doAccountBurn(cmd *cobra.Command, args []string) {
 	genesis := cmdConsensus.InitGenesis()
 	cmdConsensus.AssertTxFileOK()
 
-	var burn staking.Burn
+	var burn api.Burn
 	if err := burn.Amount.UnmarshalText([]byte(viper.GetString(CfgAmount))); err != nil {
 		logger.Error("failed to parse burn amount",
 			"err", err,
@@ -174,7 +173,7 @@ func doAccountBurn(cmd *cobra.Command, args []string) {
 	}
 
 	nonce, fee := cmdConsensus.GetTxNonceAndFee()
-	tx := staking.NewBurnTx(nonce, fee, &burn)
+	tx := api.NewBurnTx(nonce, fee, &burn)
 
 	cmdConsensus.SignAndSaveTx(getCtxWithInfo(genesis), tx)
 }
@@ -187,7 +186,7 @@ func doAccountEscrow(cmd *cobra.Command, args []string) {
 	genesis := cmdConsensus.InitGenesis()
 	cmdConsensus.AssertTxFileOK()
 
-	var escrow staking.Escrow
+	var escrow api.Escrow
 	if err := escrow.Account.UnmarshalText([]byte(viper.GetString(CfgEscrowAccount))); err != nil {
 		logger.Error("failed to parse escrow account",
 			"err", err,
@@ -202,7 +201,7 @@ func doAccountEscrow(cmd *cobra.Command, args []string) {
 	}
 
 	nonce, fee := cmdConsensus.GetTxNonceAndFee()
-	tx := staking.NewAddEscrowTx(nonce, fee, &escrow)
+	tx := api.NewAddEscrowTx(nonce, fee, &escrow)
 
 	cmdConsensus.SignAndSaveTx(getCtxWithInfo(genesis), tx)
 }
@@ -215,7 +214,7 @@ func doAccountReclaimEscrow(cmd *cobra.Command, args []string) {
 	genesis := cmdConsensus.InitGenesis()
 	cmdConsensus.AssertTxFileOK()
 
-	var reclaim staking.ReclaimEscrow
+	var reclaim api.ReclaimEscrow
 	if err := reclaim.Account.UnmarshalText([]byte(viper.GetString(CfgEscrowAccount))); err != nil {
 		logger.Error("failed to parse escrow account",
 			"err", err,
@@ -230,12 +229,12 @@ func doAccountReclaimEscrow(cmd *cobra.Command, args []string) {
 	}
 
 	nonce, fee := cmdConsensus.GetTxNonceAndFee()
-	tx := staking.NewReclaimEscrowTx(nonce, fee, &reclaim)
+	tx := api.NewReclaimEscrowTx(nonce, fee, &reclaim)
 
 	cmdConsensus.SignAndSaveTx(getCtxWithInfo(genesis), tx)
 }
 
-func scanRateStep(dst *staking.CommissionRateStep, raw string) error {
+func scanRateStep(dst *api.CommissionRateStep, raw string) error {
 	var rateBI big.Int
 	n, err := fmt.Sscanf(raw, "%d/%d", &dst.Start, &rateBI)
 	if err != nil {
@@ -250,7 +249,7 @@ func scanRateStep(dst *staking.CommissionRateStep, raw string) error {
 	return nil
 }
 
-func scanBoundStep(dst *staking.CommissionRateBoundStep, raw string) error {
+func scanBoundStep(dst *api.CommissionRateBoundStep, raw string) error {
 	var rateMinBI big.Int
 	var rateMaxBI big.Int
 	n, err := fmt.Sscanf(raw, "%d/%d/%d", &dst.Start, &rateMinBI, &rateMaxBI)
@@ -277,10 +276,10 @@ func doAccountAmendCommissionSchedule(cmd *cobra.Command, args []string) {
 	genesis := cmdConsensus.InitGenesis()
 	cmdConsensus.AssertTxFileOK()
 
-	var amendCommissionSchedule staking.AmendCommissionSchedule
+	var amendCommissionSchedule api.AmendCommissionSchedule
 	rawRates := viper.GetStringSlice(CfgCommissionScheduleRates)
 	if rawRates != nil {
-		amendCommissionSchedule.Amendment.Rates = make([]staking.CommissionRateStep, len(rawRates))
+		amendCommissionSchedule.Amendment.Rates = make([]api.CommissionRateStep, len(rawRates))
 		for i, rawRate := range rawRates {
 			if err := scanRateStep(&amendCommissionSchedule.Amendment.Rates[i], rawRate); err != nil {
 				logger.Error("failed to parse commission schedule rate step",
@@ -294,7 +293,7 @@ func doAccountAmendCommissionSchedule(cmd *cobra.Command, args []string) {
 	}
 	rawBounds := viper.GetStringSlice(CfgCommissionScheduleBounds)
 	if rawBounds != nil {
-		amendCommissionSchedule.Amendment.Bounds = make([]staking.CommissionRateBoundStep, len(rawBounds))
+		amendCommissionSchedule.Amendment.Bounds = make([]api.CommissionRateBoundStep, len(rawBounds))
 		for i, rawBound := range rawBounds {
 			if err := scanBoundStep(&amendCommissionSchedule.Amendment.Bounds[i], rawBound); err != nil {
 				logger.Error("failed to parse commission schedule bound step",
@@ -308,7 +307,7 @@ func doAccountAmendCommissionSchedule(cmd *cobra.Command, args []string) {
 	}
 
 	nonce, fee := cmdConsensus.GetTxNonceAndFee()
-	tx := staking.NewAmendCommissionScheduleTx(nonce, fee, &amendCommissionSchedule)
+	tx := api.NewAmendCommissionScheduleTx(nonce, fee, &amendCommissionSchedule)
 
 	cmdConsensus.SignAndSaveTx(getCtxWithInfo(genesis), tx)
 }
@@ -364,13 +363,13 @@ func init() {
 	commissionScheduleFlags.StringSlice(CfgCommissionScheduleRates, nil, fmt.Sprintf(
 		"commission rate step. Multiple of this flag is allowed. "+
 			"Each step is in the format start_epoch/rate_numerator. "+
-			"The rate is rate_numerator divided by %v", staking.CommissionRateDenominator,
+			"The rate is rate_numerator divided by %v", api.CommissionRateDenominator,
 	))
 	commissionScheduleFlags.StringSlice(CfgCommissionScheduleBounds, nil, fmt.Sprintf(
 		"commission rate bound step. Multiple of this flag is allowed. "+
 			"Each step is in the format start_epoch/rate_min_numerator/rate_max_numerator. "+
 			"The minimum rate is rate_min_numerator divided by %v, and the maximum rate is "+
-			"rate_max_numerator divided by %v", staking.CommissionRateDenominator, staking.CommissionRateDenominator,
+			"rate_max_numerator divided by %v", api.CommissionRateDenominator, api.CommissionRateDenominator,
 	))
 	_ = viper.BindPFlags(commissionScheduleFlags)
 	commissionScheduleFlags.AddFlagSet(cmdConsensus.TxFlags)

go/oasis-node/cmd/stake/stake.go

@@ -15,12 +15,13 @@ import (
 	"github.com/oasisprotocol/oasis-core/go/common/crypto/signature"
 	"github.com/oasisprotocol/oasis-core/go/common/errors"
 	"github.com/oasisprotocol/oasis-core/go/common/logging"
+	"github.com/oasisprotocol/oasis-core/go/common/prettyprint"
 	consensus "github.com/oasisprotocol/oasis-core/go/consensus/api"
 	cmdCommon "github.com/oasisprotocol/oasis-core/go/oasis-node/cmd/common"
 	cmdFlags "github.com/oasisprotocol/oasis-core/go/oasis-node/cmd/common/flags"
 	cmdGrpc "github.com/oasisprotocol/oasis-core/go/oasis-node/cmd/common/grpc"
 	"github.com/oasisprotocol/oasis-core/go/staking/api"
-	staking "github.com/oasisprotocol/oasis-core/go/staking/api"
+	"github.com/oasisprotocol/oasis-core/go/staking/api/token"
 )
 
 // CfgPublicKey configures the public key.
@@ -120,8 +121,8 @@ func doInfo(cmd *cobra.Command, args []string) {
 	exp := getTokenValueExponent(ctx, cmd, client)
 	fmt.Printf("Token's value base-10 exponent: %d\n", exp)
 
-	ctx = context.WithValue(ctx, api.PrettyPrinterContextKeyTokenSymbol, symbol)
-	ctx = context.WithValue(ctx, api.PrettyPrinterContextKeyTokenValueExponent, exp)
+	ctx = context.WithValue(ctx, prettyprint.ContextKeyTokenSymbol, symbol)
+	ctx = context.WithValue(ctx, prettyprint.ContextKeyTokenValueExponent, exp)
 
 	totalSupply, err := client.TotalSupply(ctx, consensus.HeightLatest)
 	if err != nil {
@@ -131,7 +132,7 @@ func doInfo(cmd *cobra.Command, args []string) {
 		os.Exit(1)
 	}
 	fmt.Print("Total supply: ")
-	api.PrettyPrintAmount(ctx, *totalSupply, os.Stdout)
+	token.PrettyPrintAmount(ctx, *totalSupply, os.Stdout)
 	fmt.Println()
 
 	commonPool, err := client.CommonPool(ctx, consensus.HeightLatest)
@@ -142,7 +143,7 @@ func doInfo(cmd *cobra.Command, args []string) {
 		os.Exit(1)
 	}
 	fmt.Print("Common pool: ")
-	api.PrettyPrintAmount(ctx, *commonPool, os.Stdout)
+	token.PrettyPrintAmount(ctx, *commonPool, os.Stdout)
 	fmt.Println()
 
 	lastBlockFees, err := client.LastBlockFees(ctx, consensus.HeightLatest)
@@ -153,7 +154,7 @@ func doInfo(cmd *cobra.Command, args []string) {
 		os.Exit(1)
 	}
 	fmt.Print("Last block fees: ")
-	api.PrettyPrintAmount(ctx, *lastBlockFees, os.Stdout)
+	token.PrettyPrintAmount(ctx, *lastBlockFees, os.Stdout)
 	fmt.Println()
 
 	thresholdsToQuery := []api.ThresholdKind{
@@ -178,7 +179,7 @@ func doInfo(cmd *cobra.Command, args []string) {
 			os.Exit(1)
 		}
 		fmt.Printf("Staking threshold (%s): ", kind)
-		api.PrettyPrintAmount(ctx, *thres, os.Stdout)
+		token.PrettyPrintAmount(ctx, *thres, os.Stdout)
 		fmt.Println()
 	}
 }
@@ -238,7 +239,7 @@ func doPubkey2Address(cmd *cobra.Command, args []string) {
 		os.Exit(1)
 	}
 
-	fmt.Printf("%v\n", staking.NewAddress(pk))
+	fmt.Printf("%v\n", api.NewAddress(pk))
 }
 
 // Register registers the stake sub-command and all of it's children.

go/oasis-test-runner/scenario/e2e/stake_cli.go

@@ -11,6 +11,7 @@ import (
 
 	"github.com/oasisprotocol/oasis-core/go/common/crypto/signature"
 	"github.com/oasisprotocol/oasis-core/go/common/entity"
+	"github.com/oasisprotocol/oasis-core/go/common/prettyprint"
 	"github.com/oasisprotocol/oasis-core/go/common/quantity"
 	"github.com/oasisprotocol/oasis-core/go/consensus/api/transaction"
 	genesisTestHelpers "github.com/oasisprotocol/oasis-core/go/genesis/tests"
@@ -96,12 +97,12 @@ func contextWithTokenInfo() context.Context {
 	ctx := context.Background()
 	ctx = context.WithValue(
 		ctx,
-		api.PrettyPrinterContextKeyTokenSymbol,
+		prettyprint.ContextKeyTokenSymbol,
 		genesisTestHelpers.TestStakingTokenSymbol,
 	)
 	ctx = context.WithValue(
 		ctx,
-		api.PrettyPrinterContextKeyTokenValueExponent,
+		prettyprint.ContextKeyTokenValueExponent,
 		genesisTestHelpers.TestStakingTokenValueExponent,
 	)
 	return ctx