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
 )

go.work.sum

@@ -266,10 +266,6 @@ github.com/cespare/xxhash/v2 v2.1.2/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XL
 github.com/charithe/durationcheck v0.0.9/go.mod h1:SSbRIBVfMjCi/kEB6K65XEA83D6prSM8ap1UCpNKtgg=
 github.com/chavacava/garif v0.0.0-20220630083739-93517212f375/go.mod h1:4m1Rv7xfuwWPNKXlThldNuJvutYM6J95wNuuVmn55To=
 github.com/checkpoint-restore/go-criu/v5 v5.3.0/go.mod h1:E/eQpaFtUKGOOSEBZgmKAcn+zUUwWxqcaKZlF54wK8E=
-github.com/chzyer/logex v1.2.0/go.mod h1:9+9sk7u7pGNWYMkh0hdiL++6OeibzJccyQU4p4MedaY=
-github.com/chzyer/readline v1.5.0 h1:lSwwFrbNviGePhkewF1az4oLmcwqCZijQ2/Wi3BGHAI=
-github.com/chzyer/readline v1.5.0/go.mod h1:x22KAscuvRqlLoK9CsoYsmxoXZMMFVyOl86cAH8qUic=
-github.com/chzyer/test v0.0.0-20210722231415-061457976a23/go.mod h1:Q3SI9o4m/ZMnBNeIyt5eFwwo7qiLfzFZmjNmxjkiQlU=
 github.com/cilium/ebpf v0.7.0/go.mod h1:/oI2+1shJiTGAMgl6/RgJr36Eo1jzrRcAWbcXO2usCA=
 github.com/clbanning/mxj v1.8.4/go.mod h1:BVjHeAH+rl9rs6f+QIpeRl0tfu10SXn1pUSa5PVGJng=
 github.com/cloudflare/circl v1.1.0/go.mod h1:prBCrKB9DV4poKZY1l9zBXg2QJY7mvgRvtMxxK7fi4I=
@@ -600,8 +596,6 @@ github.com/prometheus/client_golang v1.11.1/go.mod h1:Z6t4BnS23TR94PD6BsDNk8yVqr
 github.com/prometheus/client_golang v1.12.0/go.mod h1:3Z9XVyYiZYEO+YQWt3RD2R3jrbd179Rt297l4aS6nDY=
 github.com/prometheus/client_golang v1.12.1/go.mod h1:3Z9XVyYiZYEO+YQWt3RD2R3jrbd179Rt297l4aS6nDY=
 github.com/prometheus/client_model v0.2.1-0.20210607210712-147c58e9608a/go.mod h1:LDGWKZIo7rky3hgvBe+caln+Dr3dPggB5dvjtD7w9+w=
-github.com/prometheus/client_model v0.4.0 h1:5lQXD3cAg1OXBf4Wq03gTrXHeaV0TQvGfUooCfx1yqY=
-github.com/prometheus/client_model v0.4.0/go.mod h1:oMQmHW1/JoDwqLtg57MGgP/Fb1CJEYF2imWWhWtMkYU=
 github.com/prometheus/common v0.26.0/go.mod h1:M7rCNAaPfAosfx8veZJCuw84e35h3Cfd9VFqTh1DIvc=
 github.com/prometheus/common v0.32.1/go.mod h1:vu+V0TpY+O6vW9J44gczi3Ap/oXXR10b+M/gUGO4Hls=
 github.com/prometheus/common v0.37.0/go.mod h1:phzohg0JFMnBEFGxTDbfu3QyL5GI8gTQJFhYO5B3mfA=
@@ -764,6 +758,7 @@ golang.org/x/net v0.11.0/go.mod h1:2L/ixqYpgIVXmeoSA/4Lu7BzTG4KIyPIryS4IsOd1oQ=
 golang.org/x/net v0.12.0/go.mod h1:zEVYFnQC7m/vmpQFELhcD1EWkZlX69l4oqgmer6hfKA=
 golang.org/x/net v0.14.0/go.mod h1:PpSgVXXLK0OxS0F31C1/tv6XNguvCrnXIDrFMspZIUI=
 golang.org/x/net v0.15.0/go.mod h1:idbUs1IY1+zTqbi8yxTbhexhEEk5ur9LInksu6HrEpk=
+golang.org/x/net v0.16.0/go.mod h1:NxSsAGuq816PNPmqtQdLE42eU2Fs7NoRIZrHJAlaCOE=
 golang.org/x/oauth2 v0.4.0/go.mod h1:RznEsdpjGAINPTOF0UH/t+xJ75L18YO3Ho6Pyn+uRec=
 golang.org/x/oauth2 v0.5.0/go.mod h1:9/XBHVqLaWO3/BRHs5jbpYCnOZVjj5V0ndyaAM7KB4I=
 golang.org/x/oauth2 v0.6.0/go.mod h1:ycmewcwgD4Rpr3eZJLSB4Kyyljb3qDh40vJ8STE5HKw=
@@ -788,7 +783,6 @@ golang.org/x/sys v0.0.0-20211025201205-69cdffdb9359/go.mod h1:oPkhp1MJrh7nUepCBc
 golang.org/x/sys v0.0.0-20211105183446-c75c47738b0c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20211116061358-0a5406a5449c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20220114195835-da31bd327af9/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.0.0-20220310020820-b874c991c1a5/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20220702020025-31831981b65f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20220825204002-c680a09ffe64/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.2.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
@@ -860,6 +854,7 @@ google.golang.org/genproto v0.0.0-20230706204954-ccb25ca9f130/go.mod h1:O9kGHb51
 google.golang.org/genproto v0.0.0-20230711160842-782d3b101e98/go.mod h1:S7mY02OqCJTD0E1OiQy1F72PWFB4bZJ87cAtLPYgDR0=
 google.golang.org/genproto v0.0.0-20230822172742-b8732ec3820d/go.mod h1:yZTlhN0tQnXo3h00fuXNCxJdLdIdnVFVBaRJ5LWBbw4=
 google.golang.org/genproto v0.0.0-20230913181813-007df8e322eb/go.mod h1:yZTlhN0tQnXo3h00fuXNCxJdLdIdnVFVBaRJ5LWBbw4=
+google.golang.org/genproto v0.0.0-20230920204549-e6e6cdab5c13/go.mod h1:CCviP9RmpZ1mxVr8MUjCnSiY09IbAXZxhLE6EhHIdPU=
 google.golang.org/genproto/googleapis/api v0.0.0-20230525234035-dd9d682886f9/go.mod h1:vHYtlOoi6TsQ3Uk2yxR7NI5z8uoV+3pZtR4jmHIkRig=
 google.golang.org/genproto/googleapis/api v0.0.0-20230530153820-e85fd2cbaebc/go.mod h1:vHYtlOoi6TsQ3Uk2yxR7NI5z8uoV+3pZtR4jmHIkRig=
 google.golang.org/genproto/googleapis/api v0.0.0-20230711160842-782d3b101e98/go.mod h1:rsr7RhLuwsDKL7RmgDDCUc6yaGr1iqceVb5Wv6f6YvQ=
@@ -873,6 +868,7 @@ google.golang.org/genproto/googleapis/rpc v0.0.0-20230731190214-cbb8c96f2d6d/go.
 google.golang.org/genproto/googleapis/rpc v0.0.0-20230822172742-b8732ec3820d/go.mod h1:+Bk1OCOj40wS2hwAMA+aCW9ypzm63QTBBHp6lQ3p+9M=
 google.golang.org/genproto/googleapis/rpc v0.0.0-20230920183334-c177e329c48b/go.mod h1:+Bk1OCOj40wS2hwAMA+aCW9ypzm63QTBBHp6lQ3p+9M=
 google.golang.org/genproto/googleapis/rpc v0.0.0-20230920204549-e6e6cdab5c13/go.mod h1:KSqppvjFjtoCI+KGd4PELB0qLNxdJHRGqRI09mB6pQA=
+google.golang.org/genproto/googleapis/rpc v0.0.0-20231002182017-d307bd883b97/go.mod h1:v7nGkzlmW8P3n/bKmWBn2WpBjpOEx8Q6gMueudAmKfY=
 google.golang.org/grpc v1.12.0/go.mod h1:yo6s7OP7yaDglbqo1J04qKzAhqBH6lvTonzMVmEdcZw=
 google.golang.org/grpc v1.41.0/go.mod h1:U3l9uK9J0sini8mHphKoXyaqDA/8VyGnDee1zzIUK6k=
 google.golang.org/grpc v1.42.0/go.mod h1:k+4IHHFw41K8+bbowsex27ge2rCb65oeWqe4jJ590SU=
@@ -893,7 +889,6 @@ gopkg.in/go-playground/validator.v8 v8.18.2/go.mod h1:RX2a/7Ha8BgOhfk7j780h4/u/R
 gopkg.in/mgo.v2 v2.0.0-20180705113604-9856a29383ce/go.mod h1:yeKp02qBN3iKW1OzL3MGk2IdtZzaj7SFntXj72NppTA=
 gopkg.in/square/go-jose.v2 v2.5.1/go.mod h1:M9dMgbHiYLoDGQrXy7OpJDJWiKiU//h+vD76mk0e1AI=
 gotest.tools/v3 v3.0.2/go.mod h1:3SzNCllyD9/Y+b5r9JIKQ474KzkZyqLqEfYqMsX94Bk=
-gotest.tools/v3 v3.5.1/go.mod h1:isy3WKz7GK6uNw/sbHzfKBLvlvXwUyV06n6brMxxopU=
 honnef.co/go/tools v0.3.3/go.mod h1:jzwdWgg7Jdq75wlfblQxO4neNaFFSvgc1tD5Wv8U0Yw=
 k8s.io/apiserver v0.22.5/go.mod h1:s2WbtgZAkTKt679sYtSudEQrTGWUSQAPe6MupLnlmaQ=
 k8s.io/component-base v0.22.5/go.mod h1:VK3I+TjuF9eaa+Ln67dKxhGar5ynVbwnGrUiNF4MqCI=

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,24 @@
+package cmd
+
+// Flags
+var (
+	// 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 (
+	// 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.
+	defaultPollFrequency = int64(10) // 10 seconds
+	// defaultPathToTransaction is the value used if the auto-publish flag isn't provided.
+	defaultPathToTransaction = ""
+)

tools/upgrademonitor/cmd/root.go

@@ -0,0 +1,76 @@
+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()
+
+		if err := internal.ValidateTransaction(pathToTransaction); err != nil {
+			return fmt.Errorf("invalid transaction: %v", err)
+		}
+
+		currentVersion, err := internal.QueryCurrentVersion(conn)
+		if err != nil {
+			return err
+		}
+		nextVersion := currentVersion + 1
+		fmt.Printf("currentVersion: %v, nextVersion: %v\n", currentVersion, nextVersion)
+
+		for {
+			select {
+			case <-ticker.C:
+				resp, err := internal.QueryVersionTally(conn, nextVersion)
+				if err != nil {
+					return err
+				}
+				fmt.Printf("nextVersion: %v, voting: %v, threshold: %v, total: %v\n", nextVersion, 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
+					}
+					if resp.Code != 0 {
+						return fmt.Errorf("failed to publish transaction: %v\n", resp.RawLog)
+					}
+					fmt.Printf("published transaction: %v\n", resp.TxHash)
+					return nil // stop the upgrademonitor
+				}
+			}
+		}
+	},
+}
+
+func Execute() {
+	// 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,51 @@
+package internal
+
+import (
+	"context"
+	"fmt"
+	"time"
+
+	upgradetypes "github.com/celestiaorg/celestia-app/x/upgrade/types"
+
+	"github.com/cosmos/cosmos-sdk/client/grpc/tmservice"
+	"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) {
+	client := tx.NewServiceClient(conn)
+	txBytes, err := getTxBytes(pathToTransaction)
+	if err != nil {
+		return nil, err
+	}
+	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 QueryCurrentVersion(conn *grpc.ClientConn) (uint64, error) {
+	client := tmservice.NewServiceClient(conn)
+	resp, err := client.GetLatestBlock(context.Background(), &tmservice.GetLatestBlockRequest{})
+	if err != nil {
+		return 0, err
+	}
+	return resp.GetBlock().GetHeader().Version.App, nil
+}

tools/upgrademonitor/internal/tx.go

@@ -0,0 +1,36 @@
+package internal
+
+import (
+	"fmt"
+	"os"
+
+	"github.com/celestiaorg/celestia-app/app"
+	"github.com/celestiaorg/celestia-app/app/encoding"
+)
+
+func ValidateTransaction(pathToTransaction string) error {
+	_, err := getTxBytes(pathToTransaction)
+	if err != nil {
+		return err
+	}
+	return nil
+}
+
+func getTxBytes(pathToTransaction string) ([]byte, 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)
+	}
+	return txBytes, nil
+}

tools/upgrademonitor/internal/upgrade.go

@@ -0,0 +1,10 @@
+package internal
+
+import upgradetypes "github.com/celestiaorg/celestia-app/x/upgrade/types"
+
+func IsUpgradeable(response *upgradetypes.QueryVersionTallyResponse) bool {
+	if response == nil {
+		return false
+	}
+	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()
+}