feat: upgrademonitor

.gitignore

@@ -16,4 +16,6 @@ square/testdata
 **/*.html
 .release-env
 **/*.DS_Store
-vendor
+vendor
+tools/upgrademonitor/upgrademonitor
+tools/upgrademonitor/*.json

go.work

@@ -1,6 +1,7 @@
-go 1.21.1
+go 1.21.4
 
 use (
 	.
 	./test/testground
+	./tools/upgrademonitor
 )

tools/upgrademonitor/README.md

@@ -0,0 +1,68 @@
+# Upgrade Monitor
+
+Upgrade monitor is a stand-alone binary that monitors that status of upgrades on a Celestia network.
+
+## Build from source
+
+```shell
+go build .
+```
+
+## Prerequisites
+
+1. Determine which network you would like to monitor upgrades on.
+1. Get a GRPC endpoint for a consensus node on that network.
+
+**NOTE** This tool only works for consensus nodes that are running app version >= 2. At the time of writing, Celestia mainnet and testnets are on app version 1 so upgrademonitor can only be used on a local devnet.
+
+## Usage
+
+1. In one terminal tab, start a local devnet
+
+    ```shell
+    cd celestia-app
+
+    # Upgrade monitor can only be run on app version >= 2 so checkout main and install celestia-appd.
+    git checkout main
+    make install
+
+    # This will start a GRPC server at 0.0.0.0:9000
+    ./scripts/single-node.sh
+    ```
+
+1. In a new terminal tab, prepare the try upgrade transaction
+
+    ```shell
+    # Export environment variables. Modify these based on your needs.
+    export CHAIN_ID="private"
+    export KEY_NAME="validator"
+    export KEYRING_BACKEND="test"
+    export FROM=$(celestia-appd keys show $KEY_NAME --address --keyring-backend $KEYRING_BACKEND)
+
+    # Prepare the unsigned transaction
+    celestia-appd tx upgrade try-upgrade --from $FROM --keyring-backend $KEYRING_BACKEND --fees 420utia --generate-only > unsigned_tx.json
+
+    # Verify the unsigned transaction
+    cat unsigned_tx.json
+
+    # Sign the unsigned transaction.
+    celestia-appd tx sign unsigned_tx.json --from $FROM --keyring-backend $KEYRING_BACKEND --chain-id $CHAIN_ID --output-document signed_tx.json
+
+    # Verify the signed transaction
+    cat signed_tx.json
+    ```
+
+1. Run the upgrademonitor.
+
+    ```shell
+    cd celestia-app/tools/upgrademonitor
+
+    # Build the binary
+    go build .
+
+    # Run the binary without auto publishing
+    ./upgrademonitor
+
+    # Run the binary with auto publishing
+    ./upgrademonitor --auto-publish signed_tx.json
+    ```

tools/upgrademonitor/cmd/flags.go

@@ -0,0 +1,32 @@
+package cmd
+
+// Flags
+var (
+	// version is the version number that should be monitored.
+	version uint64
+	// grpcEndpoint is the endpoint of a consensus full node.
+	grpcEndpoint string
+	// pollFrequency is the frequency in seconds that upgrade monitor polls the
+	// GRPC endpoint.
+	pollFrequency int64
+	// pathToTransaction is the file path to a signed transaction that will be
+	// auto-published when the network is upgradeable.
+	pathToTransaction string
+)
+
+// Defaults
+var (
+	// defaultVersion is the value used if the version flag isn't provided. Since
+	// v2 is coordinated via an upgrade-height, v3 is the first version that this
+	// tool supports.
+	// TODO (@rootulp) consider making this 3 after development.
+	defaultVersion = uint64(2)
+	// defaultGrpcEndpoint is the value used if the grpc-endpoint flag isn't provided.
+	// This endpoint is the one enabled by default when you run ./scripts/single-node.sh
+	defaultGrpcEndpoint = "0.0.0.0:9090"
+	// defaultPollFrequency is the value used if the poll-frequency flag isn't provided.
+	// TODO (@rootulp) consider making this 10 seconds
+	defaultPollFrequency = int64(1) // 1 second
+	// defaultPathToTransaction is the value used if the auto-publish flag isn't provided.
+	defaultPathToTransaction = ""
+)

tools/upgrademonitor/cmd/root.go

@@ -0,0 +1,64 @@
+package cmd
+
+import (
+	"fmt"
+	"os"
+	"time"
+
+	"github.com/celestiaorg/celestia-app/tools/upgrademonitor/internal"
+	"github.com/spf13/cobra"
+	"google.golang.org/grpc"
+	"google.golang.org/grpc/credentials/insecure"
+)
+
+var rootCmd = &cobra.Command{
+	Use:   "upgrademonitor",
+	Short: "upgrademonitor monitors that status of upgrades on a Celestia network.",
+	RunE: func(cmd *cobra.Command, args []string) error {
+		conn, err := grpc.Dial(grpcEndpoint, grpc.WithTransportCredentials(insecure.NewCredentials()))
+		if err != nil {
+			return fmt.Errorf("could not connect: %v", err)
+		}
+		defer conn.Close()
+
+		ticker := time.NewTicker(time.Duration(pollFrequency) * time.Second)
+		defer ticker.Stop()
+
+		for {
+			select {
+			case <-ticker.C:
+				resp, err := internal.QueryVersionTally(conn, version)
+				if err != nil {
+					return err
+				}
+				fmt.Printf("version: %v, voting: %v, threshold: %v, total: %v\n", version, resp.GetVotingPower(), resp.GetThresholdPower(), resp.GetTotalVotingPower())
+
+				if internal.IsUpgradeable(resp) {
+					fmt.Printf("the network is upgradeable so publishing %v\n", pathToTransaction)
+					resp, err := internal.Publish(conn, pathToTransaction)
+					if err != nil {
+						return err
+					}
+					fmt.Printf("published transaction: %v\n", resp.TxHash)
+					return nil // stop the upgrademonitor
+				}
+			}
+		}
+	},
+}
+
+func Execute() {
+	// Bind the version variable to the --version flag
+	rootCmd.Flags().Uint64Var(&version, "version", defaultVersion, "version to monitor")
+	// Bind the grpcEndpoint variable to the --grpc-endpoint flag
+	rootCmd.Flags().StringVar(&grpcEndpoint, "grpc-endpoint", defaultGrpcEndpoint, "GRPC endpoint of a consensus node")
+	// Bind the pollFrequency variable to the --poll-frequency flag
+	rootCmd.Flags().Int64Var(&pollFrequency, "poll-frequency", defaultPollFrequency, "poll frequency in seconds")
+	// Bind the pathToTransaction variable to the value provided for the --auto-publish flag
+	rootCmd.Flags().StringVar(&pathToTransaction, "auto-publish", defaultPathToTransaction, "auto publish a signed transaction when the network is upgradeable")
+
+	if err := rootCmd.Execute(); err != nil {
+		fmt.Println(err)
+		os.Exit(1)
+	}
+}

tools/upgrademonitor/go.mod

@@ -0,0 +1,13 @@
+module github.com/celestiaorg/celestia-app/tools/upgrademonitor
+
+go 1.21.4
+
+require (
+	github.com/inconshreveable/mousetrap v1.1.0 // indirect
+	github.com/spf13/cobra v1.8.0 // indirect
+	github.com/spf13/pflag v1.0.5 // indirect
+)
+
+replace (
+	github.com/cosmos/cosmos-sdk => github.com/celestiaorg/cosmos-sdk v1.20.0-sdk-v0.46.16
+)

tools/upgrademonitor/go.sum

@@ -0,0 +1,10 @@
+github.com/cpuguy83/go-md2man/v2 v2.0.3/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
+github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8=
+github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw=
+github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
+github.com/spf13/cobra v1.8.0 h1:7aJaZx1B85qltLMc546zn58BxxfZdR/W22ej9CFoEf0=
+github.com/spf13/cobra v1.8.0/go.mod h1:WXLWApfZ71AjXPya3WOlMsY9yMs7YeiHhFVlvLyhcho=
+github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA=
+github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

tools/upgrademonitor/internal/grpc.go

@@ -0,0 +1,60 @@
+package internal
+
+import (
+	"context"
+	"fmt"
+	"os"
+	"time"
+
+	"github.com/celestiaorg/celestia-app/app"
+	"github.com/celestiaorg/celestia-app/app/encoding"
+	upgradetypes "github.com/celestiaorg/celestia-app/x/upgrade/types"
+
+	"github.com/cosmos/cosmos-sdk/types"
+	"github.com/cosmos/cosmos-sdk/types/tx"
+	"google.golang.org/grpc"
+)
+
+func QueryVersionTally(conn *grpc.ClientConn, version uint64) (*upgradetypes.QueryVersionTallyResponse, error) {
+	client := upgradetypes.NewQueryClient(conn)
+	ctx, cancel := context.WithTimeout(context.Background(), time.Second)
+	defer cancel()
+
+	resp, err := client.VersionTally(ctx, &upgradetypes.QueryVersionTallyRequest{Version: version})
+	if err != nil {
+		return nil, fmt.Errorf("could not query version tally: %v", err)
+	}
+	return resp, nil
+}
+
+func Publish(conn *grpc.ClientConn, pathToTransaction string) (*types.TxResponse, error) {
+	signedTx, err := os.ReadFile(pathToTransaction)
+	if err != nil {
+		return nil, fmt.Errorf("failed to read file %v. %v", pathToTransaction, err)
+	}
+
+	encCfg := encoding.MakeConfig(app.ModuleEncodingRegisters...)
+	decoded, err := encCfg.TxConfig.TxJSONDecoder()(signedTx)
+	if err != nil {
+		return nil, fmt.Errorf("failed to decode transaction: %v", err)
+	}
+
+	txBytes, err := encCfg.TxConfig.TxEncoder()(decoded)
+	if err != nil {
+		return nil, fmt.Errorf("failed to encode transaction: %v", err)
+	}
+
+	client := tx.NewServiceClient(conn)
+	res, err := client.BroadcastTx(context.Background(), &tx.BroadcastTxRequest{
+		Mode:    tx.BroadcastMode_BROADCAST_MODE_BLOCK,
+		TxBytes: txBytes,
+	})
+	if err != nil {
+		return nil, fmt.Errorf("failed to broadcast transaction: %v", err)
+	}
+	return res.GetTxResponse(), nil
+}
+
+func IsUpgradeable(response *upgradetypes.QueryVersionTallyResponse) bool {
+	return response.GetVotingPower() > response.ThresholdPower
+}

tools/upgrademonitor/main.go

@@ -0,0 +1,9 @@
+package main
+
+import (
+	"github.com/celestiaorg/celestia-app/tools/upgrademonitor/cmd"
+)
+
+func main() {
+	cmd.Execute()
+}