Merge pull request #318 from oasisprotocol/matevz/feature/rofl-staking-thresholds

Add `oasis paratime show parameters` to show ROFL staking thresholds

Author: matevz

.github/workflows/ci-lint.yml

@@ -34,10 +34,10 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: '3.x'
-      - name: Set up Node.js 18
+      - name: Set up Node.js 20
         uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 20
       - name: Set up Go
         uses: actions/setup-go@v5
         with:

cmd/common/json.go

@@ -1,11 +1,18 @@
 package common
 
 import (
+	"context"
 	"encoding/json"
 	"fmt"
 	"strings"
 	"unicode/utf8"
 
+	"github.com/oasisprotocol/oasis-core/go/common"
+	coreSignature "github.com/oasisprotocol/oasis-core/go/common/crypto/signature"
+	consensusPretty "github.com/oasisprotocol/oasis-core/go/common/prettyprint"
+	"github.com/oasisprotocol/oasis-sdk/client-sdk/go/config"
+	"github.com/oasisprotocol/oasis-sdk/client-sdk/go/crypto/signature"
+	"github.com/oasisprotocol/oasis-sdk/client-sdk/go/types"
 	"github.com/spf13/cobra"
 
 	"github.com/oasisprotocol/oasis-core/go/common/cbor"
@@ -98,3 +105,59 @@ func JSONMarshalUniversalValue(v interface{}) []byte {
 	cobra.CheckErr(err)
 	return vJSON
 }
+
+// PrettyPrint transforms generic JSON-formatted data into a pretty-printed string.
+// For types implementing consensusPretty.PrettyPrinter, it uses the custom pretty printer.
+// For other types, it does basic JSON indentation and cleanup of common delimiters.
+func PrettyPrint(npa *NPASelection, prefix string, blob interface{}) string {
+	ret := ""
+	switch rtx := blob.(type) {
+	case consensusPretty.PrettyPrinter:
+		// Signed or unsigned consensus or runtime transaction.
+		var ns common.Namespace
+		if npa.ParaTime != nil {
+			ns = npa.ParaTime.Namespace()
+		}
+		sigCtx := signature.RichContext{
+			RuntimeID:    ns,
+			ChainContext: npa.Network.ChainContext,
+			Base:         types.SignatureContextBase,
+		}
+		ctx := context.Background()
+		ctx = context.WithValue(ctx, consensusPretty.ContextKeyTokenSymbol, npa.Network.Denomination.Symbol)
+		ctx = context.WithValue(ctx, consensusPretty.ContextKeyTokenValueExponent, npa.Network.Denomination.Decimals)
+		if npa.ParaTime != nil {
+			ctx = context.WithValue(ctx, config.ContextKeyParaTimeCfg, npa.ParaTime)
+		}
+		ctx = context.WithValue(ctx, signature.ContextKeySigContext, &sigCtx)
+		ctx = context.WithValue(ctx, types.ContextKeyAccountNames, GenAccountNames())
+
+		// Set up chain context for signature verification during pretty-printing.
+		coreSignature.UnsafeResetChainContext()
+		coreSignature.SetChainContext(npa.Network.ChainContext)
+		var pp strings.Builder
+		rtx.PrettyPrint(ctx, prefix, &pp)
+		ret = pp.String()
+	default:
+		pp, err := PrettyJSONMarshal(blob)
+		cobra.CheckErr(err)
+
+		out := string(pp)
+		out = strings.ReplaceAll(out, "{", "")
+		out = strings.ReplaceAll(out, "}", "")
+		out = strings.ReplaceAll(out, "[", "")
+		out = strings.ReplaceAll(out, "]", "")
+		out = strings.ReplaceAll(out, ",", "")
+		out = strings.ReplaceAll(out, "\"", "")
+
+		for _, line := range strings.Split(out, "\n") {
+			line = strings.TrimRight(line, " \n")
+			if len(line) == 0 {
+				continue
+			}
+			ret += line + "\n"
+		}
+	}
+
+	return ret
+}

cmd/common/transaction.go

@@ -10,7 +10,6 @@ import (
 	"github.com/spf13/cobra"
 	flag "github.com/spf13/pflag"
 
-	"github.com/oasisprotocol/oasis-core/go/common"
 	"github.com/oasisprotocol/oasis-core/go/common/cbor"
 	coreSignature "github.com/oasisprotocol/oasis-core/go/common/crypto/signature"
 	consensusPretty "github.com/oasisprotocol/oasis-core/go/common/prettyprint"
@@ -352,31 +351,9 @@ func SignParaTimeTransaction(
 
 // PrintTransactionRaw prints the transaction which can be either signed or unsigned.
 func PrintTransactionRaw(npa *NPASelection, tx interface{}) {
-	switch rtx := tx.(type) {
+	switch tx.(type) {
 	case consensusPretty.PrettyPrinter:
-		// Signed or unsigned consensus or runtime transaction.
-		var ns common.Namespace
-		if npa.ParaTime != nil {
-			ns = npa.ParaTime.Namespace()
-		}
-		sigCtx := signature.RichContext{
-			RuntimeID:    ns,
-			ChainContext: npa.Network.ChainContext,
-			Base:         types.SignatureContextBase,
-		}
-		ctx := context.Background()
-		ctx = context.WithValue(ctx, consensusPretty.ContextKeyTokenSymbol, npa.Network.Denomination.Symbol)
-		ctx = context.WithValue(ctx, consensusPretty.ContextKeyTokenValueExponent, npa.Network.Denomination.Decimals)
-		if npa.ParaTime != nil {
-			ctx = context.WithValue(ctx, config.ContextKeyParaTimeCfg, npa.ParaTime)
-		}
-		ctx = context.WithValue(ctx, signature.ContextKeySigContext, &sigCtx)
-		ctx = context.WithValue(ctx, types.ContextKeyAccountNames, GenAccountNames())
-
-		// Set up chain context for signature verification during pretty-printing.
-		coreSignature.UnsafeResetChainContext()
-		coreSignature.SetChainContext(npa.Network.ChainContext)
-		rtx.PrettyPrint(ctx, "", os.Stdout)
+		fmt.Print(PrettyPrint(npa, "", tx))
 	default:
 		fmt.Printf("[unsupported transaction type: %T]\n", tx)
 	}

cmd/network/show.go

@@ -253,7 +253,7 @@ var showCmd = &cobra.Command{
 				}
 				return
 			case selParameters:
-				showParameters(ctx, height, consensusConn)
+				showParameters(ctx, npa, height, consensusConn)
 				return
 
 			default:
@@ -390,31 +390,7 @@ func showNativeToken(ctx context.Context, height int64, npa *common.NPASelection
 	}
 }
 
-func PrettifyFromJSON(blob interface{}) string {
-	pp, err := json.MarshalIndent(blob, "", "  ")
-	cobra.CheckErr(err)
-
-	out := string(pp)
-	out = strings.ReplaceAll(out, "{", "")
-	out = strings.ReplaceAll(out, "}", "")
-	out = strings.ReplaceAll(out, "[", "")
-	out = strings.ReplaceAll(out, "]", "")
-	out = strings.ReplaceAll(out, ",", "")
-	out = strings.ReplaceAll(out, "\"", "")
-
-	ret := ""
-	for _, line := range strings.Split(out, "\n") {
-		line = strings.TrimRight(line, " \n")
-		if len(line) == 0 {
-			continue
-		}
-		ret += line + "\n"
-	}
-
-	return ret
-}
-
-func showParameters(ctx context.Context, height int64, cons consensus.ClientBackend) {
+func showParameters(ctx context.Context, npa *common.NPASelection, height int64, cons consensus.ClientBackend) {
 	checkErr := func(what string, err error) {
 		if err != nil {
 			cobra.CheckErr(fmt.Errorf("%s: %w", what, err))
@@ -456,7 +432,7 @@ func showParameters(ctx context.Context, height int64, cons consensus.ClientBack
 			doc[name] = params
 		} else {
 			fmt.Printf("=== %s PARAMETERS ===\n", strings.ToUpper(name))
-			out := PrettifyFromJSON(params)
+			out := common.PrettyPrint(npa, "  ", params)
 			fmt.Printf("%s\n", out)
 		}
 	}