multi: update GetInfoResponse response

ViktorTigerstrom · ViktorTigerstrom · commit e30ac3d0a862 · 2025-05-13T12:27:19.000+02:00
Add the `commit_hash` field to the GetInfoResponse. The `commit_hash` field will contain the most recent commit_hash that the build was based on. If the build had uncommitted changes, this field will contain the most recent commit hash, suffixed by "-dirty". The semantics of the `version` field is also updated to always contain the most recent semantic version of the litd node, following the semantic versioning 2.0.0 spec (http://semver.org/).
diff --git a/Makefile b/Makefile
@@ -16,6 +16,7 @@ GOIMPORTS_BIN := $(GO_BIN)/gosimports
 
 COMMIT := $(shell git describe --abbrev=40 --dirty --tags)
 COMMIT_HASH := $(shell git rev-parse HEAD)
+DIRTY := $(shell git diff-index --quiet HEAD -- || echo -dirty)
 PUBLIC_URL := 
 
 # GO_VERSION is the Go version used for the release build, docker files, and
@@ -69,6 +70,8 @@ make_ldflags = $(2) -X $(LND_PKG)/build.Commit=lightning-terminal-$(COMMIT) \
 	-X $(LND_PKG)/build.RawTags=$(shell echo $(1) | sed -e 's/ /,/g') \
 	-X $(PKG).appFilesPrefix=$(PUBLIC_URL) \
 	-X $(PKG).Commit=$(COMMIT) \
+	-X $(PKG).CommitHash=$(COMMIT_HASH) \
+	-X $(PKG).Dirty=$(DIRTY) \
 	-X $(LOOP_PKG).Commit=$(LOOP_COMMIT) \
 	-X $(POOL_PKG).Commit=$(POOL_COMMIT) \
 	-X $(TAP_PKG).Commit=$(TAP_COMMIT)
diff --git a/app/src/types/generated/proxy_pb.d.ts b/app/src/types/generated/proxy_pb.d.ts
diff --git a/app/src/types/generated/proxy_pb.js b/app/src/types/generated/proxy_pb.js
diff --git a/cmd/litcli/main.go b/cmd/litcli/main.go
@@ -73,7 +73,7 @@ var (
 func main() {
 	app := cli.NewApp()
 
-	app.Version = terminal.Version()
+	app.Version = terminal.RichVersion()
 	app.Name = "litcli"
 	app.Usage = "control plane for your Lightning Terminal (lit) daemon"
 	app.Flags = []cli.Flag{
diff --git a/config.go b/config.go
@@ -367,7 +367,7 @@ func loadAndValidateConfig(interceptor signal.Interceptor) (*Config, error) {
 	appName := filepath.Base(os.Args[0])
 	appName = strings.TrimSuffix(appName, filepath.Ext(appName))
 	if preCfg.ShowVersion {
-		fmt.Println(appName, "version", Version())
+		fmt.Println(appName, "version", RichVersion())
 		os.Exit(0)
 	}
 	if preCfg.Lnd.ShowVersion {
diff --git a/litrpc/proxy.pb.go b/litrpc/proxy.pb.go
diff --git a/litrpc/proxy.proto b/litrpc/proxy.proto
@@ -52,6 +52,13 @@ message GetInfoRequest {
 }
 
 message GetInfoResponse {
-    // The version of the LiTd software that the node is running.
+    // The application version of the LiTd software running on the node,
+    // following the Semantic Versioning 2.0.0 specification
+    // (http://semver.org/).
     string version = 1;
+
+    // The Git commit hash the LiTd binary build was based on. If the build had
+    // uncommited changes, this field will contain the most recent commit hash,
+    // suffixed by "-dirty".
+    string commit_hash = 2;
 }
diff --git a/litrpc/proxy.swagger.json b/litrpc/proxy.swagger.json
@@ -135,7 +135,11 @@
       "properties": {
         "version": {
           "type": "string",
-          "description": "The version of the LiTd software that the node is running."
+          "description": "The application version of the LiTd software running on the node,\nfollowing the Semantic Versioning 2.0.0 specification\n(http://semver.org/)."
+        },
+        "commit_hash": {
+          "type": "string",
+          "description": "The Git commit hash the LiTd binary build was based on. If the build had\nuncommited changes, this field will contain the most recent commit hash,\nsuffixed by \"-dirty\"."
         }
       }
     },
diff --git a/proto/proxy.proto b/proto/proxy.proto
@@ -52,6 +52,13 @@ message GetInfoRequest {
 }
 
 message GetInfoResponse {
-    // The version of the LiTd software that the node is running.
+    // The application version of the LiTd software running on the node,
+    // following the Semantic Versioning 2.0.0 specification
+    // (http://semver.org/).
     string version = 1;
+
+    // The Git commit hash the LiTd binary build was based on. If the build had
+    // uncommited changes, this field will contain the most recent commit hash,
+    // suffixed by "-dirty".
+    string commit_hash = 2;
 }
diff --git a/rpc_proxy.go b/rpc_proxy.go
@@ -240,7 +240,8 @@ func (p *rpcProxy) GetInfo(_ context.Context, _ *litrpc.GetInfoRequest) (
 	*litrpc.GetInfoResponse, error) {
 
 	return &litrpc.GetInfoResponse{
-		Version: Version(),
+		Version:    Version(),
+		CommitHash: CommitHash + Dirty,
 	}, nil
 }
 
diff --git a/terminal.go b/terminal.go
@@ -298,7 +298,7 @@ func (g *LightningTerminal) Run(ctx context.Context) error {
 	g.defaultImplCfg = g.cfg.Lnd.ImplementationConfig(shutdownInterceptor)
 
 	// Show version at startup.
-	log.Infof("LiT version: %s", Version())
+	log.Infof("LiT version: %s", RichVersion())
 
 	// This concurrent error queue can be used by every component that can
 	// raise runtime errors. Using a queue will prevent us from blocking on
@@ -2010,7 +2010,7 @@ func (g *LightningTerminal) showStartupInfo(ctx context.Context) error {
 		" Web interface           %s  			           \n" +
 		"----------------------------------------------------------\n"
 	fmt.Printf(str, info.mode, info.status, info.alias, info.version,
-		Version(), webInterfaceString)
+		RichVersion(), webInterfaceString)
 
 	return nil
 }
diff --git a/version.go b/version.go
@@ -11,10 +11,21 @@ import (
 	"strings"
 )
 
-// Commit stores the current commit hash of this build, this should be set
-// using the -ldflags during compilation.
+// Commit stores the current git tag of this build, when the build is based on
+// a tagged commit. If the build is based on an untagged commit or is a dirty
+// build, the Commit field stores the most recent tag suffixed by the commit
+// hash, and/or "-dirty". This should be set using the -ldflags during
+// compilation.
 var Commit string
 
+// CommitHash stores the current git commit hash of this build. This should be
+// set using the -ldflags during compilation.
+var CommitHash string
+
+// Dirty stores a "-dirty" string, if the build had uncommitted changes when
+// being built. This should be set using the -ldflags during compilation.
+var Dirty string
+
 // semanticAlphabet
 const semanticAlphabet = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-."
 
@@ -33,6 +44,21 @@ const (
 // Version returns the application version as a properly formed string per the
 // semantic versioning 2.0.0 spec (http://semver.org/).
 func Version() string {
+	return semanticVersion()
+}
+
+// RichVersion returns the application version as a properly formed string
+// per the semantic versioning 2.0.0 spec (http://semver.org/), the git tag it
+// was built on.
+func RichVersion() string {
+	// Append git tag of current build to version.
+	return fmt.Sprintf(
+		"%s commit=%s", semanticVersion(), Commit,
+	)
+}
+
+// semanticVersion returns the SemVer part of the version.
+func semanticVersion() string {
 	// Start with the major, minor, and patch versions.
 	version := fmt.Sprintf("%d.%d.%d", appMajor, appMinor, appPatch)
 
@@ -45,9 +71,6 @@ func Version() string {
 		version = fmt.Sprintf("%s-%s", version, preRelease)
 	}
 
-	// Append commit hash of current build to version.
-	version = fmt.Sprintf("%s commit=%s", version, Commit)
-
 	return version
 }
 

Original file line number	Diff line number	Diff line change
`@@ -367,7 +367,7 @@ func loadAndValidateConfig(interceptor signal.Interceptor) (*Config, error) {`
`367`	`367`	`appName := filepath.Base(os.Args[0])`
`368`	`368`	`appName = strings.TrimSuffix(appName, filepath.Ext(appName))`
`369`	`369`	`if preCfg.ShowVersion {`
`370`		`- fmt.Println(appName, "version", Version())`
	`370`	`+ fmt.Println(appName, "version", RichVersion())`
`371`	`371`	`os.Exit(0)`
`372`	`372`	`}`
`373`	`373`	`if preCfg.Lnd.ShowVersion {`
Original file line number	Diff line number	Diff line change
`@@ -52,6 +52,13 @@ message GetInfoRequest {`
`52`	`52`	`}`
`53`	`53`
`54`	`54`	`message GetInfoResponse {`
`55`		`- // The version of the LiTd software that the node is running.`
	`55`	`+ // The application version of the LiTd software running on the node,`
	`56`	`+ // following the Semantic Versioning 2.0.0 specification`
	`57`	`+ // (http://semver.org/).`
`56`	`58`	`string version = 1;`
	`59`	`+`
	`60`	`+ // The Git commit hash the LiTd binary build was based on. If the build had`
	`61`	`+ // uncommited changes, this field will contain the most recent commit hash,`
	`62`	`+ // suffixed by "-dirty".`
	`63`	`+ string commit_hash = 2;`
`57`	`64`	`}`
Original file line number	Diff line number	Diff line change
`@@ -135,7 +135,11 @@`
`135`	`135`	`"properties": {`
`136`	`136`	`"version": {`
`137`	`137`	`"type": "string",`
`138`		`- "description": "The version of the LiTd software that the node is running."`
	`138`	`+ "description": "The application version of the LiTd software running on the node,\nfollowing the Semantic Versioning 2.0.0 specification\n(http://semver.org/)."`
	`139`	`+ },`
	`140`	`+ "commit_hash": {`
	`141`	`+ "type": "string",`
	`142`	`+ "description": "The Git commit hash the LiTd binary build was based on. If the build had\nuncommited changes, this field will contain the most recent commit hash,\nsuffixed by \"-dirty\"."`
`139`	`143`	`}`
`140`	`144`	`}`
`141`	`145`	`},`
Original file line number	Diff line number	Diff line change
`@@ -240,7 +240,8 @@ func (p rpcProxy) GetInfo(_ context.Context, _ litrpc.GetInfoRequest) (`
`240`	`240`	`*litrpc.GetInfoResponse, error) {`
`241`	`241`
`242`	`242`	`return &litrpc.GetInfoResponse{`
`243`		`- Version: Version(),`
	`243`	`+ Version: Version(),`
	`244`	`+ CommitHash: CommitHash + Dirty,`
`244`	`245`	`}, nil`
`245`	`246`	`}`
`246`	`247`