node: unify environment config with common/mode.go

node/cmd/guardiand/node.go

@@ -797,6 +797,21 @@ func runNode(cmd *cobra.Command, args []string) {
 		logger.Fatal("Please do not specify both --telemetryKey and --telemetryServiceAccountFile")
 	}
 
+	// Determine execution mode
+	// TODO: refactor usage of these variables elsewhere. *unsafeDevMode and *testnetMode should not be accessed directly.
+	var env common.Environment
+	if *unsafeDevMode {
+		env = common.UnsafeDevNet
+	} else if *testnetMode {
+		env = common.TestNet
+	} else {
+		env = common.MainNet
+	}
+
+	if *unsafeDevMode && *testnetMode {
+		logger.Fatal("Cannot be in unsafeDevMode and testnetMode at the same time.")
+	}
+
 	// Complain about Infura on mainnet.
 	//
 	// As it turns out, Infura has a bug where it would sometimes incorrectly round
@@ -1096,12 +1111,6 @@ func runNode(cmd *cobra.Command, args []string) {
 		} else {
 			acctLogger.Info("accountant is enabled but will not be enforced")
 		}
-		env := accountant.MainNetMode
-		if *testnetMode {
-			env = accountant.TestNetMode
-		} else if *unsafeDevMode {
-			env = accountant.DevNetMode
-		}
 		acct = accountant.NewAccountant(
 			rootCtx,
 			logger,
@@ -1123,12 +1132,6 @@ func runNode(cmd *cobra.Command, args []string) {
 	var gov *governor.ChainGovernor
 	if *chainGovernorEnabled {
 		logger.Info("chain governor is enabled")
-		env := governor.MainNetMode
-		if *testnetMode {
-			env = governor.TestNetMode
-		} else if *unsafeDevMode {
-			env = governor.DevNetMode
-		}
 		gov = governor.NewChainGovernor(logger, db, env)
 	} else {
 		logger.Info("chain governor is disabled")

node/pkg/accountant/accountant.go

@@ -28,14 +28,6 @@ import (
 	"go.uber.org/zap"
 )
 
-const (
-	MainNetMode = 1
-	TestNetMode = 2
-	DevNetMode  = 3
-	GoTestMode  = 4
-	MockMode    = 5
-)
-
 // MsgChannelCapacity specifies the capacity of the message channel used to publish messages released from the accountant.
 // This channel should not back up, but if it does, the accountant will start dropping messages, which would require reobservations.
 const MsgChannelCapacity = 5 * batchSize
@@ -98,7 +90,7 @@ type Accountant struct {
 	pendingTransfersLock sync.Mutex
 	pendingTransfers     map[string]*pendingEntry // Key is the message ID (emitterChain/emitterAddr/seqNo)
 	subChan              chan *common.MessagePublication
-	env                  int
+	env                  common.Environment
 }
 
 // On startup, there can be a large number of re-submission requests.
@@ -117,7 +109,7 @@ func NewAccountant(
 	gk *ecdsa.PrivateKey, // the guardian key used for signing observation requests
 	gst *common.GuardianSetState, // used to get the current guardian set index when sending observation requests
 	msgChan chan<- *common.MessagePublication, // the channel where transfers received by the accountant runnable should be published
-	env int, // Controls the set of token bridges to be monitored
+	env common.Environment, // Controls the set of token bridges to be monitored
 ) *Accountant {
 	return &Accountant{
 		ctx:              ctx,
@@ -146,9 +138,9 @@ func (acct *Accountant) Start(ctx context.Context) error {
 	defer acct.pendingTransfersLock.Unlock()
 
 	emitterMap := sdk.KnownTokenbridgeEmitters
-	if acct.env == TestNetMode {
+	if acct.env == common.TestNet {
 		emitterMap = sdk.KnownTestnetTokenbridgeEmitters
-	} else if acct.env == DevNetMode || acct.env == GoTestMode || acct.env == MockMode {
+	} else if acct.env == common.UnsafeDevNet || acct.env == common.GoTest || acct.env == common.AccountantMock {
 		emitterMap = sdk.KnownDevnetTokenbridgeEmitters
 	}
 
@@ -176,12 +168,12 @@ func (acct *Accountant) Start(ctx context.Context) error {
 	}
 
 	// Start the watcher to listen to transfer events from the smart contract.
-	if acct.env == MockMode {
+	if acct.env == common.AccountantMock {
 		// We're not in a runnable context, so we can't use supervisor.
 		go func() {
 			_ = acct.worker(ctx)
 		}()
-	} else if acct.env != GoTestMode {
+	} else if acct.env != common.GoTest {
 		if err := supervisor.Run(ctx, "acctworker", common.WrapWithScissors(acct.worker, "acctworker")); err != nil {
 			return fmt.Errorf("failed to start submit observation worker: %w", err)
 		}
@@ -275,7 +267,7 @@ func (acct *Accountant) SubmitObservation(msg *common.MessagePublication) (bool,
 	}
 
 	// This transaction may take a while. Pass it off to the worker so we don't block the processor.
-	if acct.env != GoTestMode {
+	if acct.env != common.GoTest {
 		acct.logger.Info("submitting transfer to accountant for approval", zap.String("msgID", msgId), zap.Bool("canPublish", !acct.enforceFlag))
 		_ = acct.submitObservation(pe)
 	}

node/pkg/accountant/accountant_test.go

@@ -106,9 +106,9 @@ func newAccountantForTest(
 	gs := &common.GuardianSet{Keys: []ethCommon.Address{ethCommon.HexToAddress("0xbeFA429d57cD18b7F8A4d91A2da9AB4AF05d0FBe")}}
 	gst.Set(gs)
 
-	env := GoTestMode
+	env := common.GoTest
 	if wormchainConn != nil {
-		env = MockMode
+		env = common.AccountantMock
 	}
 
 	acct := NewAccountant(

node/pkg/common/mode.go

@@ -0,0 +1,11 @@
+package common
+
+type Environment string
+
+const (
+	MainNet        Environment = "prod"
+	UnsafeDevNet   Environment = "dev"  // local devnet; Keys are deterministic and many security controls are disabled
+	TestNet        Environment = "test" // public testnet (needs to be reliable, but run with less Guardians and faster finality)
+	GoTest         Environment = "unit-test"
+	AccountantMock Environment = "accountant-mock" // Used for mocking accountant with a Wormchain connection
+)

node/pkg/governor/governor.go

@@ -43,11 +43,6 @@ import (
 )
 
 const (
-	MainNetMode = 1
-	TestNetMode = 2
-	DevNetMode  = 3
-	GoTestMode  = 4
-
 	transferComplete = true
 	transferEnqueued = false
 )
@@ -127,7 +122,7 @@ type ChainGovernor struct {
 	msgsToPublish         []*common.MessagePublication // protected by `mutex`
 	dayLengthInMinutes    int
 	coinGeckoQueries      []string
-	env                   int
+	env                   common.Environment
 	nextStatusPublishTime time.Time
 	nextConfigPublishTime time.Time
 	statusPublishCounter  int64
@@ -137,7 +132,7 @@ type ChainGovernor struct {
 func NewChainGovernor(
 	logger *zap.Logger,
 	db db.GovernorDB,
-	env int,
+	env common.Environment,
 ) *ChainGovernor {
 	return &ChainGovernor{
 		db:                  db,
@@ -157,7 +152,7 @@ func (gov *ChainGovernor) Run(ctx context.Context) error {
 		return err
 	}
 
-	if gov.env != GoTestMode {
+	if gov.env != common.GoTest {
 		if err := gov.loadFromDB(); err != nil {
 			return err
 		}
@@ -178,9 +173,9 @@ func (gov *ChainGovernor) initConfig() error {
 	configTokens := tokenList()
 	configChains := chainList()
 
-	if gov.env == DevNetMode {
+	if gov.env == common.UnsafeDevNet {
 		configTokens, configChains = gov.initDevnetConfig()
-	} else if gov.env == TestNetMode {
+	} else if gov.env == common.TestNet {
 		configTokens, configChains = gov.initTestnetConfig()
 	}
 
@@ -239,9 +234,9 @@ func (gov *ChainGovernor) initConfig() error {
 	}
 
 	emitterMap := &sdk.KnownTokenbridgeEmitters
-	if gov.env == TestNetMode {
+	if gov.env == common.TestNet {
 		emitterMap = &sdk.KnownTestnetTokenbridgeEmitters
-	} else if gov.env == DevNetMode {
+	} else if gov.env == common.UnsafeDevNet {
 		emitterMap = &sdk.KnownDevnetTokenbridgeEmitters
 	}
 

node/pkg/governor/governor_monitoring_test.go

@@ -3,6 +3,7 @@ package governor
 import (
 	"testing"
 
+	"github.com/certusone/wormhole/node/pkg/common"
 	"github.com/stretchr/testify/assert"
 	"github.com/test-go/testify/require"
 	"go.uber.org/zap"
@@ -10,7 +11,7 @@ import (
 
 func TestIsVAAEnqueuedNilMessageID(t *testing.T) {
 	logger, _ := zap.NewProduction()
-	gov := NewChainGovernor(logger, nil, GoTestMode)
+	gov := NewChainGovernor(logger, nil, common.GoTest)
 	enqueued, err := gov.IsVAAEnqueued(nil)
 	require.EqualError(t, err, "no message ID specified")
 	assert.Equal(t, false, enqueued)

node/pkg/governor/governor_prices.go

@@ -19,6 +19,7 @@ import (
 
 	"go.uber.org/zap"
 
+	"github.com/certusone/wormhole/node/pkg/common"
 	"github.com/certusone/wormhole/node/pkg/db"
 	"github.com/certusone/wormhole/node/pkg/supervisor"
 )
@@ -279,7 +280,7 @@ func CheckQuery(logger *zap.Logger) error {
 	logger.Info("Instantiating governor.")
 	ctx := context.Background()
 	var db db.MockGovernorDB
-	gov := NewChainGovernor(logger, &db, MainNetMode)
+	gov := NewChainGovernor(logger, &db, common.MainNet)
 
 	if err := gov.initConfig(); err != nil {
 		return err

node/pkg/governor/governor_test.go

@@ -250,7 +250,7 @@ func newChainGovernorForTest(ctx context.Context) (*ChainGovernor, error) {
 
 	logger := zap.NewNop()
 	var db db.MockGovernorDB
-	gov := NewChainGovernor(logger, &db, GoTestMode)
+	gov := NewChainGovernor(logger, &db, common.GoTest)
 
 	err := gov.Run(ctx)
 	if err != nil {
@@ -1024,9 +1024,9 @@ func TestSmallerPendingTransfersAfterBigOneShouldGetReleased(t *testing.T) {
 func TestMainnetConfigIsValid(t *testing.T) {
 	logger := zap.NewNop()
 	var db db.MockGovernorDB
-	gov := NewChainGovernor(logger, &db, GoTestMode)
+	gov := NewChainGovernor(logger, &db, common.GoTest)
 
-	gov.env = MainNetMode
+	gov.env = common.TestNet
 	err := gov.initConfig()
 	require.NoError(t, err)
 }
@@ -1034,9 +1034,9 @@ func TestMainnetConfigIsValid(t *testing.T) {
 func TestTestnetConfigIsValid(t *testing.T) {
 	logger := zap.NewNop()
 	var db db.MockGovernorDB
-	gov := NewChainGovernor(logger, &db, GoTestMode)
+	gov := NewChainGovernor(logger, &db, common.GoTest)
 
-	gov.env = TestNetMode
+	gov.env = common.TestNet
 	err := gov.initConfig()
 	require.NoError(t, err)
 }

node/pkg/publicrpc/publicrpcserver_test.go

@@ -4,6 +4,7 @@ import (
 	"context"
 	"testing"
 
+	"github.com/certusone/wormhole/node/pkg/common"
 	"github.com/certusone/wormhole/node/pkg/governor"
 	publicrpcv1 "github.com/certusone/wormhole/node/pkg/proto/publicrpc/v1"
 	"github.com/stretchr/testify/assert"
@@ -68,7 +69,7 @@ func TestGetSignedVAABadAddress(t *testing.T) {
 func TestGovernorIsVAAEnqueuedNoMessage(t *testing.T) {
 	ctx := context.Background()
 	logger, _ := zap.NewProduction()
-	gov := governor.NewChainGovernor(logger, nil, governor.GoTestMode)
+	gov := governor.NewChainGovernor(logger, nil, common.GoTest)
 	server := &PublicrpcServer{logger: logger, gov: gov}
 
 	// A message without the messageId set should not panic but return an error instead.