backend/accounts: load watch-only accounts at launch

Author: benma

backend/accounts.go

@@ -758,39 +758,56 @@ func (backend *Backend) persistETHAccountConfig(
 
 // The accountsAndKeystoreLock must be held when calling this function.
 func (backend *Backend) initPersistedAccounts() {
-	if backend.keystore == nil {
-		return
-	}
-	// Only load accounts which belong to connected keystores.
-	rootFingerprint, err := backend.keystore.RootFingerprint()
-	if err != nil {
-		backend.log.WithError(err).Error("Could not retrieve root fingerprint")
-		return
-	}
-	keystoreConnected := func(account *config.Account) bool {
+	// Only load accounts which belong to connected keystores or for which watchonly is enabled.
+	keystoreConnectedOrWatch := func(account *config.Account) bool {
+		if account.IsWatch() {
+			return true
+		}
+
+		if backend.keystore == nil {
+			return false
+		}
+		rootFingerprint, err := backend.keystore.RootFingerprint()
+		if err != nil {
+			backend.log.WithError(err).Error("Could not retrieve root fingerprint")
+			return false
+		}
+
 		return account.SigningConfigurations.ContainsRootFingerprint(rootFingerprint)
 	}
 
 	persistedAccounts := backend.config.AccountsConfig()
+
+	// In this loop, we add all accounts that match the filter, except for the ones whose signing
+	// configuration is not supported by the connected keystore. The latter can happen for example
+	// if a user connects a BitBox02 Multi edition first, which persists some altcoin accounts, and
+	// then connects a BitBox02 BTC-only with the same seed. In that case, the unsupported accounts
+	// will not be loaded, unless they have been marked as watch-only.
 outer:
-	for _, account := range backend.filterAccounts(&persistedAccounts, keystoreConnected) {
+	for _, account := range backend.filterAccounts(&persistedAccounts, keystoreConnectedOrWatch) {
 		account := account
 		coin, err := backend.Coin(account.CoinCode)
 		if err != nil {
 			backend.log.Errorf("skipping persisted account %s/%s, could not find coin",
 				account.CoinCode, account.Code)
 			continue
 		}
-		switch coin.(type) {
-		case *btc.Coin:
-			for _, cfg := range account.SigningConfigurations {
-				if !backend.keystore.SupportsAccount(coin, cfg.ScriptType()) {
-					continue outer
+
+		// Watch-only accounts are loaded regardless, and if later e.g. a BitBox02 BTC-only is
+		// inserted with the same seed as a Multi, we will need to catch that mismatch when the
+		// keystore will be used to e.g. display an Ethereum address etc.
+		if backend.keystore != nil && !account.IsWatch() {
+			switch coin.(type) {
+			case *btc.Coin:
+				for _, cfg := range account.SigningConfigurations {
+					if !backend.keystore.SupportsAccount(coin, cfg.ScriptType()) {
+						continue outer
+					}
+				}
+			default:
+				if !backend.keystore.SupportsAccount(coin, nil) {
+					continue
 				}
-			}
-		default:
-			if !backend.keystore.SupportsAccount(coin, nil) {
-				continue
 			}
 		}
 

backend/accounts_test.go

@@ -1050,8 +1050,31 @@ func TestAccountSupported(t *testing.T) {
 	b.registerKeystore(bb02Multi)
 	require.Len(t, b.Accounts(), 3)
 	require.Len(t, b.Config().AccountsConfig().Accounts, 3)
+	// Mark all as watch-only.
+	require.NoError(t, b.config.ModifyAccountsConfig(func(cfg *config.AccountsConfig) error {
+		for _, acct := range cfg.Accounts {
+			f := true
+			acct.Watch = &f
+		}
+		return nil
+	}))
 
 	b.DeregisterKeystore()
+	// Registering a Bitcoin-only like keystore loads also the altcoins that were persisted
+	// previously, because they are marked watch-only, so they should be visible.
+	b.registerKeystore(bb02BtcOnly)
+	require.Len(t, b.Accounts(), 3)
+	require.Len(t, b.Config().AccountsConfig().Accounts, 3)
+
+	b.DeregisterKeystore()
+	// If watch-only is disabled, then these will not be loaded if not supported by the keystore.
+	require.NoError(t, b.config.ModifyAccountsConfig(func(cfg *config.AccountsConfig) error {
+		for _, acct := range cfg.Accounts {
+			f := false
+			acct.Watch = &f
+		}
+		return nil
+	}))
 	// Registering a Bitcoin-only like keystore loads only the Bitcoin account, even though altcoins
 	// were persisted previously.
 	b.registerKeystore(bb02BtcOnly)

backend/backend_test.go

@@ -22,6 +22,7 @@ import (
 	accountsTypes "github.com/digitalbitbox/bitbox-wallet-app/backend/accounts/types"
 	"github.com/digitalbitbox/bitbox-wallet-app/backend/coins/btc"
 	coinpkg "github.com/digitalbitbox/bitbox-wallet-app/backend/coins/coin"
+	"github.com/digitalbitbox/bitbox-wallet-app/backend/config"
 	keystoremock "github.com/digitalbitbox/bitbox-wallet-app/backend/keystore/mocks"
 	"github.com/digitalbitbox/bitbox-wallet-app/backend/keystore/software"
 	"github.com/digitalbitbox/bitbox-wallet-app/backend/signing"
@@ -98,6 +99,9 @@ func TestRegisterKeystore(t *testing.T) {
 	require.NotNil(t, b.Config().AccountsConfig().Lookup("v0-55555555-btc-0"))
 	require.NotNil(t, b.Config().AccountsConfig().Lookup("v0-55555555-ltc-0"))
 	require.NotNil(t, b.Config().AccountsConfig().Lookup("v0-55555555-eth-0"))
+	require.NotNil(t, b.accounts.lookup("v0-55555555-btc-0"))
+	require.NotNil(t, b.accounts.lookup("v0-55555555-ltc-0"))
+	require.NotNil(t, b.accounts.lookup("v0-55555555-eth-0"))
 	require.Equal(t, "Bitcoin", b.Config().AccountsConfig().Accounts[0].Name)
 	require.Equal(t, "Litecoin", b.Config().AccountsConfig().Accounts[1].Name)
 	require.Equal(t, "Ethereum", b.Config().AccountsConfig().Accounts[2].Name)
@@ -113,32 +117,79 @@ func TestRegisterKeystore(t *testing.T) {
 	// tests, but we check that it was set and recent.
 	require.True(t, time.Since(b.Config().AccountsConfig().Keystores[0].LastConnected) < 10*time.Second)
 
-	// Deregistering the keystore removes the loaded accounts, but not the persisted accounts and
-	// keystores.
+	// Deregistering the keystore leaves the loaded accounts (watchonly), and leaves the persisted
+	// accounts and keystores.
+	// Mark accounts as watch-only.
+	require.NoError(t, b.config.ModifyAccountsConfig(func(cfg *config.AccountsConfig) error {
+		for _, acct := range cfg.Accounts {
+			f := true
+			acct.Watch = &f
+		}
+		return nil
+	}))
 	b.DeregisterKeystore()
-	require.Len(t, b.Accounts(), 0)
+	require.Len(t, b.Accounts(), 3)
 	require.Len(t, b.Config().AccountsConfig().Accounts, 3)
 	require.Len(t, b.Config().AccountsConfig().Keystores, 1)
 
 	// Registering the same keystore again loads the previously persisted accounts and does not
 	// automatically persist more accounts.
-	b.DeregisterKeystore()
 	b.registerKeystore(ks1)
 	require.Len(t, b.Accounts(), 3)
 	require.Len(t, b.Config().AccountsConfig().Accounts, 3)
 	require.Len(t, b.Config().AccountsConfig().Keystores, 1)
 
 	// Registering another keystore persists a set of initial default accounts and loads them.
+	// They are added to the previous set of watchonly accounts
 	b.DeregisterKeystore()
 	b.registerKeystore(ks2)
-	require.Len(t, b.Accounts(), 3)
+	require.Len(t, b.Accounts(), 6)
 	require.Len(t, b.Config().AccountsConfig().Accounts, 6)
 	require.NotNil(t, b.Config().AccountsConfig().Lookup("v0-66666666-btc-0"))
 	require.NotNil(t, b.Config().AccountsConfig().Lookup("v0-66666666-ltc-0"))
 	require.NotNil(t, b.Config().AccountsConfig().Lookup("v0-66666666-eth-0"))
+	require.NotNil(t, b.accounts.lookup("v0-66666666-btc-0"))
+	require.NotNil(t, b.accounts.lookup("v0-66666666-ltc-0"))
+	require.NotNil(t, b.accounts.lookup("v0-66666666-eth-0"))
 	require.Len(t, b.Config().AccountsConfig().Keystores, 2)
 	require.Equal(t, "Mock keystore 2", b.Config().AccountsConfig().Keystores[1].Name)
 	require.Equal(t, rootFingerprint2, []byte(b.Config().AccountsConfig().Keystores[1].RootFingerprint))
+
+	b.DeregisterKeystore()
+	// Enable watch-only for all but two accounts, one of each keystore. Now, all watch-only
+	// accounts plus the non-watch only accounts of the connected keystore will be loaded.
+	require.NoError(t, b.config.ModifyAccountsConfig(func(cfg *config.AccountsConfig) error {
+		for _, acct := range cfg.Accounts {
+			t := true
+			acct.Watch = &t
+		}
+
+		f := false
+		cfg.Lookup("v0-55555555-btc-0").Watch = &f
+		cfg.Lookup("v0-66666666-ltc-0").Watch = &f
+		return nil
+	}))
+	b.registerKeystore(ks1)
+	require.Len(t, b.Accounts(), 5)
+	// v0-55555555-btc-0 loaded even though watch=false, as the keystore is connected.
+	require.NotNil(t, b.accounts.lookup("v0-55555555-btc-0"))
+	require.NotNil(t, b.accounts.lookup("v0-55555555-ltc-0"))
+	require.NotNil(t, b.accounts.lookup("v0-55555555-eth-0"))
+	require.NotNil(t, b.accounts.lookup("v0-66666666-btc-0"))
+	// v0-66666666-ltc-0 not loaded (watch=false).
+	require.Nil(t, b.accounts.lookup("v0-66666666-ltc-0"))
+	require.NotNil(t, b.accounts.lookup("v0-66666666-eth-0"))
+
+	b.DeregisterKeystore()
+	require.Len(t, b.Accounts(), 4)
+	// v0-55555555-btc-0 not loaded (watch = false)
+	require.Nil(t, b.accounts.lookup("v0-55555555-btc-0"))
+	require.NotNil(t, b.accounts.lookup("v0-55555555-ltc-0"))
+	require.NotNil(t, b.accounts.lookup("v0-55555555-eth-0"))
+	require.NotNil(t, b.accounts.lookup("v0-66666666-btc-0"))
+	// v0-66666666-ltc-0 not loaded (watch=false).
+	require.Nil(t, b.accounts.lookup("v0-66666666-ltc-0"))
+	require.NotNil(t, b.accounts.lookup("v0-66666666-eth-0"))
 }
 
 func lookup(accts []accounts.Interface, code accountsTypes.Code) accounts.Interface {

backend/config/accounts.go

@@ -73,6 +73,11 @@ func (acct *Account) SetTokenActive(tokenCode string, active bool) error {
 	return nil
 }
 
+// IsWatchOnly returns true if the `Watch` setting is set to true.
+func (acct *Account) IsWatch() bool {
+	return acct.Watch != nil && *acct.Watch
+}
+
 // Keystore holds information related to keystores such as the BitBox02.
 type Keystore struct {
 	// The root fingerprint is the first 32 bits of the hash160 of the pubkey at the keypath m/.