Merge branch 'develop' into jkan2/test-lstn

.github/actions/upgrade-testing/action.yml

@@ -14,7 +14,7 @@ runs:
       with:
         python-version: 'pypy3.9'
 
-    - uses: actions/download-artifact@v3
+    - uses: actions/download-artifact@v4 #v3 reaches deprecation on November 30, 2024
       with:
         name: binaries-${{ github.sha }}
         path: ./

.github/workflows/publish-release.yml

@@ -94,38 +94,6 @@ jobs:
         run: |
           echo "continue"
 
-  check-upgrade-handler-updated:
-    needs:
-      - check-branch
-    runs-on: ubuntu-22.04
-    timeout-minutes: 10
-    steps:
-
-      - uses: actions/checkout@v4
-        if: inputs.skip_checks != true
-        with:
-          fetch-depth: 0
-
-      - name: Major Version in Upgrade Handler Must Match Tag
-        if: inputs.skip_checks != true
-        run: |
-          UPGRADE_HANDLER_MAJOR_VERSION=$(cat app/setup_handlers.go | grep "const releaseVersion" | cut -d ' ' -f4 | tr -d '"' | cut -d '.' -f 1 | tr -d '\n')
-          USER_INPUT_VERSION=$(echo "${{ inputs.version }}" | cut -d '.' -f 1 | tr -d '\n')
-          echo "Upgrade Handler Major Version: ${UPGRADE_HANDLER_MAJOR_VERSION}"
-          echo "User Inputted Release Version: ${USER_INPUT_VERSION}"
-          if [ ${USER_INPUT_VERSION} != $UPGRADE_HANDLER_MAJOR_VERSION ]; then
-            echo "ERROR: The input version doesn't match the release handler for the branch selected. Please ensure the upgrade handler of the branch you selected when you ran the pipeline matches the input version."
-            echo "Did you forget to update the 'releaseVersion' in app/setup_handlers.go?" 
-            exit 1
-          fi
-          echo "The major version found in 'releaseVersion' in app/setup_handlers.go matches this tagged release - Moving Forward!"
-
-      - name: Mark Job Complete Skipped
-        if: inputs.skip_checks == true
-        shell: bash
-        run: |
-          echo "continue"
-
   publish-release:
     permissions:
       id-token: write
@@ -134,7 +102,6 @@ jobs:
     if: inputs.skip_release != true
     needs:
       - check-changelog
-      - check-upgrade-handler-updated
       - check-branch
       - check-goreleaser
     runs-on: ${{ vars.RELEASE_RUNNER }}

app/setup_handlers.go

@@ -7,10 +7,28 @@ import (
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	"github.com/cosmos/cosmos-sdk/types/module"
 	"github.com/cosmos/cosmos-sdk/x/upgrade/types"
+	"golang.org/x/mod/semver"
 
 	"github.com/zeta-chain/node/pkg/constant"
 )
 
+// GetDefaultUpgradeHandlerVersion prints the default upgrade handler version
+//
+// There may be multiple upgrade handlers configured on some releases if different
+// migrations needto be run in different environment
+func GetDefaultUpgradeHandlerVersion() string {
+	// semver must have v prefix, but we store without prefix
+	vVersion := "v" + constant.Version
+
+	// development builds always use the full version in the release handlers
+	if semver.Build(vVersion) != "" || semver.Prerelease(vVersion) != "" {
+		return constant.Version
+	}
+
+	// release builds use just the major version (v22.0.0 -> v22)
+	return semver.Major(vVersion)
+}
+
 func SetupHandlers(app *App) {
 	allUpgrades := upgradeTracker{
 		upgrades: []upgradeTrackerItem{
@@ -50,10 +68,12 @@ func SetupHandlers(app *App) {
 		upgradeHandlerFns, storeUpgrades = allUpgrades.mergeAllUpgrades()
 	}
 
+	upgradeHandlerVersion := GetDefaultUpgradeHandlerVersion()
+
 	app.UpgradeKeeper.SetUpgradeHandler(
-		constant.Version,
+		upgradeHandlerVersion,
 		func(ctx sdk.Context, _ types.Plan, vm module.VersionMap) (module.VersionMap, error) {
-			app.Logger().Info("Running upgrade handler for " + constant.Version)
+			app.Logger().Info("Running upgrade handler for " + upgradeHandlerVersion)
 
 			var err error
 			for _, upgradeHandler := range upgradeHandlerFns {
@@ -71,7 +91,7 @@ func SetupHandlers(app *App) {
 	if err != nil {
 		panic(err)
 	}
-	if upgradeInfo.Name == constant.Version && !app.UpgradeKeeper.IsSkipHeight(upgradeInfo.Height) {
+	if upgradeInfo.Name == upgradeHandlerVersion && !app.UpgradeKeeper.IsSkipHeight(upgradeInfo.Height) {
 		// Use upgrade store loader for the initial loading of all stores when app starts,
 		// it checks if version == upgradeHeight and applies store upgrades before loading the stores,
 		// so that new stores start with the correct version (the current height of chain),

changelog.md

@@ -6,20 +6,28 @@
 * [2984](https://github.com/zeta-chain/node/pull/2984) - add Whitelist message ability to whitelist SPL tokens on Solana
 * [3091](https://github.com/zeta-chain/node/pull/3091) - improve build reproducability. `make release{,-build-only}` checksums should now be stable.
 * [3124](https://github.com/zeta-chain/node/pull/3124) - integrate SPL deposits
+* [3134](https://github.com/zeta-chain/node/pull/3134) - integrate SPL tokens withdraw to Solana
 
 ### Tests
 
 * [3075](https://github.com/zeta-chain/node/pull/3075) - ton: withdraw concurrent, deposit & revert.
 * [3105](https://github.com/zeta-chain/node/pull/3105) - split Bitcoin E2E tests into two runners for deposit and withdraw
+* [3154](https://github.com/zeta-chain/node/pull/3154) - configure Solana gateway program id for E2E tests
 
 ### Refactor
 * [3118](https://github.com/zeta-chain/node/pull/3118) - zetaclient: remove hsm signer
 * [3122](https://github.com/zeta-chain/node/pull/3122) - improve & refactor zetaclientd cli
 * [3125](https://github.com/zeta-chain/node/pull/3125) - drop support for header proofs
+* [3131](https://github.com/zeta-chain/node/pull/3131) - move app context update from zetacore client
+* [3137](https://github.com/zeta-chain/node/pull/3137) - remove chain.Chain from zetaclientd config
 
 ### Fixes
+* [3117](https://github.com/zeta-chain/node/pull/3117) - register messages for emissions module to legacy amino codec.
 * [3041](https://github.com/zeta-chain/node/pull/3041) - replace libp2p public DHT with private gossip peer discovery and connection gater for inbound connections
 * [3106](https://github.com/zeta-chain/node/pull/3106) - prevent blocked CCTX on out of gas during omnichain calls
+* [3139](https://github.com/zeta-chain/node/pull/3139) - fix config resolution in orchestrator
+* [3149](https://github.com/zeta-chain/node/pull/3149) - abort the cctx if dust amount is detected in the revert outbound
+* [3162](https://github.com/zeta-chain/node/pull/3162) - skip depositor fee calculation if transaction does not involve TSS address
 
 ## v21.0.0
 

cmd/zetaclientd/inbound.go

@@ -22,6 +22,7 @@ import (
 	"github.com/zeta-chain/node/zetaclient/config"
 	zctx "github.com/zeta-chain/node/zetaclient/context"
 	"github.com/zeta-chain/node/zetaclient/keys"
+	"github.com/zeta-chain/node/zetaclient/orchestrator"
 	"github.com/zeta-chain/node/zetaclient/zetacore"
 )
 
@@ -69,7 +70,8 @@ func InboundGetBallot(_ *cobra.Command, args []string) error {
 	appContext := zctx.New(cfg, nil, zerolog.Nop())
 	ctx := zctx.WithAppContext(context.Background(), appContext)
 
-	if err := client.UpdateAppContext(ctx, appContext, zerolog.Nop()); err != nil {
+	err = orchestrator.UpdateAppContext(ctx, appContext, client, zerolog.Nop())
+	if err != nil {
 		return errors.Wrap(err, "failed to update app context")
 	}
 

cmd/zetaclientd/start.go

@@ -27,6 +27,7 @@ import (
 	"github.com/zeta-chain/node/pkg/chains"
 	"github.com/zeta-chain/node/pkg/constant"
 	zetaos "github.com/zeta-chain/node/pkg/os"
+	"github.com/zeta-chain/node/pkg/ticker"
 	observerTypes "github.com/zeta-chain/node/x/observer/types"
 	"github.com/zeta-chain/node/zetaclient/chains/base"
 	"github.com/zeta-chain/node/zetaclient/config"
@@ -55,7 +56,7 @@ func Start(_ *cobra.Command, _ []string) error {
 		chains.Network_solana.String(): solanaKeyPass,
 	}
 
-	//Load Config file given path
+	// Load Config file given path
 	cfg, err := config.Load(globalOpts.ZetacoreHome)
 	if err != nil {
 		return err
@@ -100,7 +101,7 @@ func Start(_ *cobra.Command, _ []string) error {
 	}
 
 	// Wait until zetacore is ready to create blocks
-	if err = zetacoreClient.WaitForZetacoreToCreateBlocks(ctx); err != nil {
+	if err = waitForZetacoreToCreateBlocks(ctx, zetacoreClient, startLogger); err != nil {
 		startLogger.Error().Err(err).Msg("WaitForZetacoreToCreateBlocks error")
 		return err
 	}
@@ -141,14 +142,12 @@ func Start(_ *cobra.Command, _ []string) error {
 	startLogger.Debug().Msgf("createAuthzSigner is ready")
 
 	// Initialize core parameters from zetacore
-	if err = zetacoreClient.UpdateAppContext(ctx, appContext, startLogger); err != nil {
+	if err = orchestrator.UpdateAppContext(ctx, appContext, zetacoreClient, startLogger); err != nil {
 		return errors.Wrap(err, "unable to update app context")
 	}
 
 	startLogger.Info().Msgf("Config is updated from zetacore\n %s", cfg.StringMasked())
 
-	go zetacoreClient.UpdateAppContextWorker(ctx, appContext)
-
 	// Generate TSS address . The Tss address is generated through Keygen ceremony. The TSS key is used to sign all outbound transactions .
 	// The hotkeyPk is private key for the Hotkey. The Hotkey is used to sign all inbound transactions
 	// Each node processes a portion of the key stored in ~/.tss by default . Custom location can be specified in config file during init.
@@ -201,33 +200,36 @@ func Start(_ *cobra.Command, _ []string) error {
 	}
 
 	// Create TSS server
-	server, err := mc.SetupTSSServer(peers, priKey, preParams, appContext.Config(), tssKeyPass, true, whitelistedPeers)
+	tssServer, err := mc.SetupTSSServer(
+		peers,
+		priKey,
+		preParams,
+		appContext.Config(),
+		tssKeyPass,
+		true,
+		whitelistedPeers,
+	)
 	if err != nil {
 		return fmt.Errorf("SetupTSSServer error: %w", err)
 	}
+
 	// Set P2P ID for telemetry
-	telemetryServer.SetP2PID(server.GetLocalPeerID())
+	telemetryServer.SetP2PID(tssServer.GetLocalPeerID())
 
 	// Creating a channel to listen for os signals (or other signals)
 	signalChannel := make(chan os.Signal, 1)
 	signal.Notify(signalChannel, syscall.SIGINT, syscall.SIGTERM)
 
-	// Maintenance workers ============
-	maintenance.NewTSSListener(zetacoreClient, masterLogger).Listen(ctx, func() {
-		masterLogger.Info().Msg("TSS listener received an action to shutdown zetaclientd.")
-		signalChannel <- syscall.SIGTERM
-	})
-
 	go func() {
 		for {
 			time.Sleep(30 * time.Second)
-			ps := server.GetKnownPeers()
+			ps := tssServer.GetKnownPeers()
 			metrics.NumConnectedPeers.Set(float64(len(ps)))
 			telemetryServer.SetConnectedPeers(ps)
 		}
 	}()
 	go func() {
-		host := server.GetP2PHost()
+		host := tssServer.GetP2PHost()
 		pingRTT := make(map[peer.ID]int64)
 		for {
 			var wg sync.WaitGroup
@@ -254,7 +256,7 @@ func Start(_ *cobra.Command, _ []string) error {
 
 	// Generate a new TSS if keygen is set and add it into the tss server
 	// If TSS has already been generated, and keygen was successful ; we use the existing TSS
-	err = mc.Generate(ctx, masterLogger, zetacoreClient, server)
+	err = mc.Generate(ctx, zetacoreClient, tssServer, masterLogger)
 	if err != nil {
 		return err
 	}
@@ -264,7 +266,7 @@ func Start(_ *cobra.Command, _ []string) error {
 		zetacoreClient,
 		tssHistoricalList,
 		hotkeyPass,
-		server,
+		tssServer,
 	)
 	if err != nil {
 		startLogger.Error().Err(err).Msg("NewTSS error")
@@ -279,23 +281,26 @@ func Start(_ *cobra.Command, _ []string) error {
 
 	// Wait for TSS keygen to be successful before proceeding, This is a blocking thread only for a new keygen.
 	// For existing keygen, this should directly proceed to the next step
-	ticker := time.NewTicker(time.Second * 1)
-	for range ticker.C {
-		keyGen := appContext.GetKeygen()
-		if keyGen.Status != observerTypes.KeygenStatus_KeyGenSuccess {
-			startLogger.Info().Msgf("Waiting for TSS Keygen to be a success, current status %s", keyGen.Status)
-			continue
+	_ = ticker.Run(ctx, time.Second, func(ctx context.Context, t *ticker.Ticker) error {
+		keygen, err = zetacoreClient.GetKeyGen(ctx)
+		switch {
+		case err != nil:
+			startLogger.Warn().Err(err).Msg("Waiting for TSS Keygen to be a success, got error")
+		case keygen.Status != observerTypes.KeygenStatus_KeyGenSuccess:
+			startLogger.Warn().Msgf("Waiting for TSS Keygen to be a success, current status %s", keygen.Status)
+		default:
+			t.Stop()
 		}
-		break
-	}
+
+		return nil
+	})
 
 	// Update Current TSS value from zetacore, if TSS keygen is successful, the TSS address is set on zeta-core
 	// Returns err if the RPC call fails as zeta client needs the current TSS address to be set
 	// This is only needed in case of a new Keygen , as the TSS address is set on zetacore only after the keygen is successful i.e enough votes have been broadcast
 	currentTss, err := zetacoreClient.GetTSS(ctx)
 	if err != nil {
-		startLogger.Error().Err(err).Msg("GetCurrentTSS error")
-		return err
+		return errors.Wrap(err, "unable to get current TSS")
 	}
 
 	// Filter supported BTC chain IDs
@@ -314,6 +319,13 @@ func Start(_ *cobra.Command, _ []string) error {
 		return err
 	}
 
+	// Starts various background TSS listeners.
+	// Shuts down zetaclientd if any is triggered.
+	maintenance.NewTSSListener(zetacoreClient, masterLogger).Listen(ctx, func() {
+		masterLogger.Info().Msg("TSS listener received an action to shutdown zetaclientd.")
+		signalChannel <- syscall.SIGTERM
+	})
+
 	if len(appContext.ListChainIDs()) == 0 {
 		startLogger.Error().Interface("config", cfg).Msgf("No chains in updated config")
 	}
@@ -348,12 +360,12 @@ func Start(_ *cobra.Command, _ []string) error {
 	// Each chain observer is responsible for observing events on the chain and processing them.
 	observerMap, err := orchestrator.CreateChainObserverMap(ctx, zetacoreClient, tss, dbpath, logger, telemetryServer)
 	if err != nil {
-		startLogger.Err(err).Msg("CreateChainObserverMap")
-		return err
+		return errors.Wrap(err, "unable to create chain observer map")
 	}
 
 	// Orchestrator wraps the zetacore client and adds the observers and signer maps to it.
 	// This is the high level object used for CCTX interactions
+	// It also handles background configuration updates from zetacore
 	maestro, err := orchestrator.New(
 		ctx,
 		zetacoreClient,
@@ -365,14 +377,12 @@ func Start(_ *cobra.Command, _ []string) error {
 		telemetryServer,
 	)
 	if err != nil {
-		startLogger.Error().Err(err).Msg("Unable to create orchestrator")
-		return err
+		return errors.Wrap(err, "unable to create orchestrator")
 	}
 
 	// Start orchestrator with all observers and signers
-	if err := maestro.Start(ctx); err != nil {
-		startLogger.Error().Err(err).Msg("Unable to start orchestrator")
-		return err
+	if err = maestro.Start(ctx); err != nil {
+		return errors.Wrap(err, "unable to start orchestrator")
 	}
 
 	// start zeta supply checker
@@ -389,12 +399,12 @@ func Start(_ *cobra.Command, _ []string) error {
 	//	defer zetaSupplyChecker.Stop()
 	//}
 
-	startLogger.Info().Msgf("Zetaclientd is running")
+	startLogger.Info().Msg("zetaclientd is running")
 
 	sig := <-signalChannel
-	startLogger.Info().Msgf("Stop signal received: %q", sig)
+	startLogger.Info().Msgf("Stop signal received: %q. Stopping zetaclientd", sig)
 
-	zetacoreClient.Stop()
+	maestro.Stop()
 
 	return nil
 }