feat: add xpub and cold wallet fields to keypair (#7407)

Added xpub (representing extended public key) and cold wallet (representing the cold wallet, StatusKeycard, Ledger, Trezor...) fields to keypair type and updated related database and migration files.

Author: saledjenic

Makefile

@@ -516,7 +516,7 @@ vendor-hash:
 	echo "Replaced vendorHash $${CURRENT_VENDOR_HASH} with $${NEW_VENDOR_HASH}"
 
 
-migration: DEFAULT_MIGRATION_PATH := appdatabase/migrations/sql
+migration: DEFAULT_MIGRATION_PATH := internal/db/appdatabase/migrations/sql
 migration:
 	touch $(DEFAULT_MIGRATION_PATH)/$$(date '+%s')_$(D).up.sql
 
@@ -534,7 +534,7 @@ version:
 tag-version:
 	bash scripts/tag_version.sh $(TARGET_COMMIT)
 
-migration-wallet: DEFAULT_WALLET_MIGRATION_PATH := walletdatabase/migrations/sql
+migration-wallet: DEFAULT_WALLET_MIGRATION_PATH := internal/db/walletdatabase/migrations/sql
 migration-wallet:
 	touch $(DEFAULT_WALLET_MIGRATION_PATH)/$$(date +%s)_$(D).up.sql
 

internal/accounts-management/persistence_operations.go

@@ -105,8 +105,8 @@ func (m *AccountsManager) CreateKeypairFromMnemonicAndStore(mnemonic string, pas
 	return
 }
 
-func (m *AccountsManager) AddKeypairStoredToKeycard(keyUID string, masterAddress string, name string,
-	walletAccounts []*types.Account, clock uint64) (keypair *types.Keypair, err error) {
+func (m *AccountsManager) AddKeypairStoredToKeycard(keyUID string, masterAddress string, name string, xpub string,
+	coldWallet types.ColdWalletType, walletAccounts []*types.Account, clock uint64) (keypair *types.Keypair, err error) {
 
 	if len(walletAccounts) == 0 {
 		err = ErrKeypairMustHaveAtLeastOneWalletAccount
@@ -141,6 +141,17 @@ func (m *AccountsManager) AddKeypairStoredToKeycard(keyUID string, masterAddress
 		return
 	}
 
+	position, err := m.persistence.GetPositionForNextNewAccount()
+	if err != nil {
+		return nil, err
+	}
+
+	for _, walletAccount := range walletAccounts {
+		walletAccount.Position = position
+		walletAccount.Operable = types.AccountFullyOperable
+		position++
+	}
+
 	// prepare keypair
 	keypair = &types.Keypair{
 		Name:                    name,
@@ -150,6 +161,8 @@ func (m *AccountsManager) AddKeypairStoredToKeycard(keyUID string, masterAddress
 		LastUsedDerivationIndex: 0,
 		Clock:                   clock,
 		Accounts:                walletAccounts,
+		XPub:                    xpub,
+		ColdWallet:              coldWallet,
 	}
 
 	// store keypair to db

internal/accounts-management/types/keypair.go

@@ -16,6 +16,7 @@ var (
 type KeypairType string
 type AccountType string
 type AccountOperable string
+type ColdWalletType string
 
 const (
 	KeypairTypeProfile KeypairType = "profile"
@@ -34,20 +35,28 @@ const (
 	AccountNonOperable       AccountOperable = "no"        // an account is non operable it is not a keycard account and there is no keystore file for it and no keystore file for the address it is derived from
 	AccountPartiallyOperable AccountOperable = "partially" // an account is partially operable if it is not a keycard account and there is created keystore file for the address it is derived from
 	AccountFullyOperable     AccountOperable = "fully"     // an account is fully operable if it is not a keycard account and there is a keystore file for it
+)
 
+const (
+	ColdWalletTypeNone          ColdWalletType = ""
+	ColdWalletTypeStatusKeycard ColdWalletType = "status-keycard"
+	ColdWalletTypeLedger        ColdWalletType = "ledger"
+	ColdWalletTypeTrezor        ColdWalletType = "trezor"
 )
 
 type Keypair struct {
-	KeyUID                  string      `json:"key-uid"`
-	Name                    string      `json:"name"`
-	Type                    KeypairType `json:"type"`
-	DerivedFrom             string      `json:"derived-from"`
-	LastUsedDerivationIndex uint64      `json:"last-used-derivation-index,omitempty"`
-	SyncedFrom              string      `json:"synced-from,omitempty"` // keeps an info which device this keypair is added from can be one of two values defined in constants or device name (custom)
-	Clock                   uint64      `json:"clock,omitempty"`
-	Accounts                []*Account  `json:"accounts,omitempty"`
-	Keycards                []*Keycard  `json:"keycards,omitempty"`
-	Removed                 bool        `json:"removed,omitempty"`
+	KeyUID                  string         `json:"key-uid"`
+	Name                    string         `json:"name"`
+	Type                    KeypairType    `json:"type"`
+	DerivedFrom             string         `json:"derived-from"`
+	LastUsedDerivationIndex uint64         `json:"last-used-derivation-index,omitempty"`
+	SyncedFrom              string         `json:"synced-from,omitempty"` // keeps an info which device this keypair is added from can be one of two values defined in constants or device name (custom)
+	Clock                   uint64         `json:"clock,omitempty"`
+	Accounts                []*Account     `json:"accounts,omitempty"`
+	Keycards                []*Keycard     `json:"keycards,omitempty"`
+	Removed                 bool           `json:"removed,omitempty"`
+	XPub                    string         `json:"xpub,omitempty"`
+	ColdWallet              ColdWalletType `json:"cold-wallet,omitempty"`
 }
 
 type AccountCreationDetails struct {
@@ -146,16 +155,18 @@ func (a *Account) MarshalJSON() ([]byte, error) {
 
 func (a *Keypair) MarshalJSON() ([]byte, error) {
 	item := struct {
-		KeyUID                  string      `json:"key-uid"`
-		Name                    string      `json:"name"`
-		Type                    KeypairType `json:"type"`
-		DerivedFrom             string      `json:"derived-from"`
-		LastUsedDerivationIndex uint64      `json:"last-used-derivation-index"`
-		SyncedFrom              string      `json:"synced-from"`
-		Clock                   uint64      `json:"clock"`
-		Accounts                []*Account  `json:"accounts"`
-		Keycards                []*Keycard  `json:"keycards"`
-		Removed                 bool        `json:"removed"`
+		KeyUID                  string         `json:"key-uid"`
+		Name                    string         `json:"name"`
+		Type                    KeypairType    `json:"type"`
+		DerivedFrom             string         `json:"derived-from"`
+		LastUsedDerivationIndex uint64         `json:"last-used-derivation-index"`
+		SyncedFrom              string         `json:"synced-from"`
+		Clock                   uint64         `json:"clock"`
+		Accounts                []*Account     `json:"accounts"`
+		Keycards                []*Keycard     `json:"keycards"`
+		Removed                 bool           `json:"removed"`
+		XPub                    string         `json:"xpub"`
+		ColdWallet              ColdWalletType `json:"cold-wallet"`
 	}{
 		KeyUID:                  a.KeyUID,
 		Name:                    a.Name,
@@ -167,6 +178,8 @@ func (a *Keypair) MarshalJSON() ([]byte, error) {
 		Accounts:                a.Accounts,
 		Keycards:                a.Keycards,
 		Removed:                 a.Removed,
+		XPub:                    a.XPub,
+		ColdWallet:              a.ColdWallet,
 	}
 
 	return json.Marshal(item)
@@ -184,6 +197,8 @@ func (a *Keypair) CopyKeypair() *Keypair {
 		Accounts:                make([]*Account, len(a.Accounts)),
 		Keycards:                make([]*Keycard, len(a.Keycards)),
 		Removed:                 a.Removed,
+		XPub:                    a.XPub,
+		ColdWallet:              a.ColdWallet,
 	}
 
 	for i, acc := range a.Accounts {

internal/db/appdatabase/migrations/sql/1775586970_add_xpub_to_keypair.up.sql

@@ -0,0 +1,2 @@
+ALTER TABLE keypairs ADD COLUMN xpub VARCHAR NOT NULL DEFAULT "";
+ALTER TABLE keypairs ADD COLUMN cold_wallet VARCHAR NOT NULL DEFAULT "";

internal/db/multiaccounts/accounts/database.go

@@ -105,6 +105,8 @@ func (db *Database) processRows(rows *sql.Rows) ([]*accsmanagementtypes.Keypair,
 		kpSyncedFrom              sql.NullString
 		kpClock                   sql.NullInt64
 		kpRemoved                 sql.NullBool
+		kpXPub                    sql.NullString
+		kpColdWallet              sql.NullString
 	)
 
 	var (
@@ -133,6 +135,7 @@ func (db *Database) processRows(rows *sql.Rows) ([]*accsmanagementtypes.Keypair,
 		pubkey := []byte{}
 		err := rows.Scan(
 			&kpKeyUID, &kpName, &kpType, &kpDerivedFrom, &kpLastUsedDerivationIndex, &kpSyncedFrom, &kpClock, &kpRemoved,
+			&kpXPub, &kpColdWallet,
 			&accAddress, &accKeyUID, &pubkey, &accPath, &accName, &accColorID, &accEmoji,
 			&accWallet, &accChat, &accHidden, &accOperable, &accClock, &accCreatedAt, &accPosition, &accRemoved,
 			&accProdPreferredChainIDs, &accTestPreferredChainIDs, &accAddressWasNotShown)
@@ -165,6 +168,12 @@ func (db *Database) processRows(rows *sql.Rows) ([]*accsmanagementtypes.Keypair,
 		if kpRemoved.Valid {
 			kp.Removed = kpRemoved.Bool
 		}
+		if kpXPub.Valid {
+			kp.XPub = kpXPub.String
+		}
+		if kpColdWallet.Valid {
+			kp.ColdWallet = accsmanagementtypes.ColdWalletType(kpColdWallet.String)
+		}
 		// check keypair accounts fields
 		if accAddress.Valid {
 			acc.Address = types2.BytesToAddress([]byte(accAddress.String))
@@ -924,11 +933,14 @@ func (db *Database) SaveOrUpdateKeypair(keypair *accsmanagementtypes.Keypair) er
 			last_used_derivation_index = ?,
 			synced_from = ?,
 			clock = ?,
-			removed = ?
+			removed = ?,
+			xpub = ?,
+			cold_wallet = ?
 		WHERE
 			key_uid = ?;
 	`, keypair.KeyUID, keypair.Type, keypair.DerivedFrom,
-		keypair.Name, keypair.LastUsedDerivationIndex, keypair.SyncedFrom, keypair.Clock, keypair.Removed, keypair.KeyUID)
+		keypair.Name, keypair.LastUsedDerivationIndex, keypair.SyncedFrom, keypair.Clock, keypair.Removed,
+		keypair.XPub, keypair.ColdWallet, keypair.KeyUID)
 	if err != nil {
 		return err
 	}

internal/db/multiaccounts/accounts/test_helper.go

@@ -397,6 +397,8 @@ func SameKeypairs(expected, real *accsmanagementtypes.Keypair) bool {
 		expected.DerivedFrom == real.DerivedFrom &&
 		expected.LastUsedDerivationIndex == real.LastUsedDerivationIndex &&
 		expected.Clock == real.Clock &&
+		expected.XPub == real.XPub &&
+		expected.ColdWallet == real.ColdWallet &&
 		len(expected.Accounts) == len(real.Accounts)
 
 	if same {
@@ -426,6 +428,8 @@ func SameKeypairsWithDifferentSyncedFrom(expected, real *accsmanagementtypes.Key
 		expected.DerivedFrom == real.DerivedFrom &&
 		expected.LastUsedDerivationIndex == real.LastUsedDerivationIndex &&
 		expected.Clock == real.Clock &&
+		expected.XPub == real.XPub &&
+		expected.ColdWallet == real.ColdWallet &&
 		len(expected.Accounts) == len(real.Accounts)
 
 	if same && !ignoreSyncedFrom {

protocol/accounts_manager_interface.go

@@ -20,7 +20,7 @@ type AccountsManager interface {
 	CreateKeypairFromMnemonicAndStore(mnemonic string, password string, keypairName string,
 		walletAccount *types.AccountCreationDetails, profile bool, clock uint64) (keypair *types.Keypair, err error)
 	AddKeypairStoredToKeycard(keyUID string, masterAddress string, name string,
-		walletAccounts []*types.Account, clock uint64) (keypair *types.Keypair, err error)
+		xpub string, coldWallet types.ColdWalletType, walletAccounts []*types.Account, clock uint64) (keypair *types.Keypair, err error)
 	CreateKeypairFromPrivateKeyAndStore(privateKey string, password string, keypairName string,
 		walletAccount *types.AccountCreationDetails, clock uint64) (keypair *types.Keypair, err error)
 	MigrateNonProfileKeycardKeypairToApp(mnemonic string, password string, clock uint64) (string, error)

protocol/messenger_handler.go

@@ -3185,6 +3185,8 @@ func (m *Messenger) handleSyncKeypair(message *protobuf.SyncKeypair, fromLocalPa
 		SyncedFrom:              message.SyncedFrom,
 		Clock:                   message.Clock,
 		Removed:                 message.Removed,
+		XPub:                    message.Xpub,
+		ColdWallet:              accsmanagementtypes.ColdWalletType(message.ColdWallet),
 	}
 
 	oldAddresses := make(map[types3.Address]bool)

protocol/messenger_wallet.go

@@ -128,10 +128,10 @@ func (m *Messenger) AddKeypairViaSeedPhrase(mnemonic string, password string, na
 }
 
 func (m *Messenger) AddKeypairStoredToKeycard(keyUID string, masterAddress string, name string,
-	walletAccounts []*accsmanagementtypes.Account) (*accsmanagementtypes.Keypair, error) {
+	xpub string, coldWallet accsmanagementtypes.ColdWalletType, walletAccounts []*accsmanagementtypes.Account) (*accsmanagementtypes.Keypair, error) {
 	clock, _ := m.getLastClockWithRelatedChat()
 
-	keypair, err := m.accountsManager.AddKeypairStoredToKeycard(keyUID, masterAddress, name, walletAccounts, clock)
+	keypair, err := m.accountsManager.AddKeypairStoredToKeycard(keyUID, masterAddress, name, xpub, coldWallet, walletAccounts, clock)
 	if err != nil {
 		return nil, err
 	}
@@ -343,6 +343,8 @@ func (m *Messenger) prepareSyncKeypairMessage(kp *accsmanagementtypes.Keypair) (
 		LastUsedDerivationIndex: kp.LastUsedDerivationIndex,
 		SyncedFrom:              kp.SyncedFrom,
 		Removed:                 kp.Removed,
+		Xpub:                    kp.XPub,
+		ColdWallet:              string(kp.ColdWallet),
 	}
 
 	if kp.SyncedFrom == "" {

protocol/protobuf/pairing.proto

@@ -306,6 +306,8 @@ message SyncKeypair {
   repeated SyncKeycard keycards = 9;
   bool removed = 10;
   bytes keycard_pairings = 11;
+  string xpub = 12;
+  string cold_wallet = 13;
 }
 
 // this message is used for syncing accounts positions only, for syncing any other info consider