@onekeyfe/hwk-keystone-adapter 1.2.5-alpha.0 → 1.2.5-alpha.1

package/dist/index.d.mts

@@ -174,17 +174,15 @@ declare class KeystoneUrEngine {
 }
 
 declare const KEYSTONE_WALLET_CONNECT_ID_PREFIX = "keystone-wallet:";
-/** Fixed public source used to derive a collision-resistant wallet id. */
-declare const KEYSTONE_WALLET_ID_PATH = "m/44'/60'/0'";
-declare function walletConnectId(walletId: string): string;
+/** Account a QR cold start requests when the caller named no path; any path returns the mfp. */
+declare const KEYSTONE_COLD_START_PATH = "m/44'/60'/0'";
+declare function walletConnectId(masterFingerprint: string): string;
 interface KeystoneAccountEntry extends KeystoneParsedAccount {
     hwkChain: ChainCapability;
 }
 declare function accountKey(hwkChain: ChainCapability, path: string): string;
 interface KeystoneDeviceRecord {
-    /** SHA-256 id derived from the fixed account-level identity xpub. */
-    walletId: string;
-    /** Lowercase 8-char BIP32 fingerprint used by BC-UR as xfp, never as identity. */
+    /** Lowercase 8-char BIP32 master fingerprint: the wallet identity and the BC-UR xfp. */
     masterFingerprint: string;
     connectId: string;
     /** Optional physical-device id exposed by some Keystone QR export menus. */
@@ -203,8 +201,7 @@ interface KeystoneDeviceRecord {
     /** True after one QR round trip; on USB disconnect it decides demote-to-QR versus drop. */
     qrSynced?: boolean;
 }
-declare function deriveKeystoneWalletId(accounts: KeystoneParsedAccount[]): string;
-declare function createDeviceRecord(walletId: string, masterFingerprint: string): KeystoneDeviceRecord;
+declare function createDeviceRecord(masterFingerprint: string): KeystoneDeviceRecord;
 declare function toDeviceInfo(record: KeystoneDeviceRecord): DeviceInfo;
 /** Device row for a not-yet-synced wallet during a cold-start round trip. */
 declare function placeholderDeviceInfo(): DeviceInfo;
@@ -213,13 +210,13 @@ declare function placeholderDeviceInfo(): DeviceInfo;
 type AccountBook = Map<string, KeystoneAccountEntry>;
 interface ImportFromQrOptions {
     /**
-     * 'request' asks the device for the identity xpub; 'scan' waits for whatever export it already
-     * shows. Only the wallet identity is learned either way.
+     * 'request' asks the device for one account; 'scan' waits for whatever export it already shows.
+     * Only the wallet's master fingerprint is learned either way.
      */
     mode?: 'request' | 'scan';
 }
 /**
- * QR and USB behind one `IHardwareWallet`, keyed by a wallet id derived from the identity xpub.
+ * QR and USB behind one `IHardwareWallet`, keyed by the wallet's BIP32 master fingerprint.
  * Key material is fetched per operation and never retained.
  */
 declare class KeystoneAdapter implements IHardwareWallet {
@@ -323,10 +320,7 @@ declare class KeystoneAdapter implements IHardwareWallet {
      * request because the device limits that channel.
      */
     private _prefetchAllNetworkAccounts;
-    /**
-     * Resolve only the stable 64-hex wallet identity. The 8-hex BIP32 master
-     * fingerprint is protocol metadata and is never accepted as a lookup key.
-     */
+    /** Resolve the wallet's master fingerprint from the connectId and/or deviceId the caller passed. */
     private _resolveTarget;
     private _assertParsedIdentity;
     /**
@@ -335,8 +329,8 @@ declare class KeystoneAdapter implements IHardwareWallet {
      */
     private _upsertDeviceRecord;
     /**
-     * Opens a permitted USB Keystone, reads its mfp, and derives the wallet id from the identity
-     * xpub. A known wallet gains USB in place (`device-changed`); an unseen one becomes USB-only.
+     * Opens a permitted USB Keystone and takes its mfp as the wallet identity. A known wallet gains
+     * USB in place (`device-changed`); an unseen one becomes USB-only.
      */
     private _connectUsb;
     private _connectUsbExclusive;
@@ -368,7 +362,7 @@ declare class KeystoneAdapter implements IHardwareWallet {
      * through the operation route; a cold start returns undefined.
      */
     private _activeOperationId;
-    /** Routes are keyed by connectId; a job key may be the bare wallet id. */
+    /** Routes are keyed by connectId; a job key may be the bare master fingerprint. */
     private _operationRouteForIdentifier;
     /**
      * A QR prompt has no transport to interrupt; releasing the registry slot on abort is what lets
@@ -401,4 +395,4 @@ declare function splitAccountPath(path: string): {
 /** BIP-44/49/84/86 purpose to script type; undefined for any other purpose. */
 declare function btcScriptTypeFromPath(path: string): BtcScriptType | undefined;
 
-export { type BtcScriptType, type ImportFromQrOptions, KEYSTONE_WALLET_CONNECT_ID_PREFIX, KEYSTONE_WALLET_ID_PATH, type KeystoneAccountEntry, KeystoneAdapter, type KeystoneBtcSignRequestAccount, type KeystoneBtcSignatureResult, type KeystoneDerivationCurve, type KeystoneDeviceRecord, type KeystoneEthSignRequestInput, type KeystoneEthSignatureResult, type KeystoneKeyDerivationRequestInput, type KeystoneKeySchema, type KeystoneParsedAccount, type KeystoneParsedMultiAccounts, type KeystoneSolSignRequestInput, type KeystoneSolSignatureResult, type KeystoneTronSignRequestInput, type KeystoneTronSignatureResult, type KeystoneUr, KeystoneUrEngine, accountKey, btcScriptTypeFromPath, createDeviceRecord, deriveKeystoneWalletId, normalizePath, placeholderDeviceInfo, splitAccountPath, toDeviceInfo, walletConnectId };
+export { type BtcScriptType, type ImportFromQrOptions, KEYSTONE_COLD_START_PATH, KEYSTONE_WALLET_CONNECT_ID_PREFIX, type KeystoneAccountEntry, KeystoneAdapter, type KeystoneBtcSignRequestAccount, type KeystoneBtcSignatureResult, type KeystoneDerivationCurve, type KeystoneDeviceRecord, type KeystoneEthSignRequestInput, type KeystoneEthSignatureResult, type KeystoneKeyDerivationRequestInput, type KeystoneKeySchema, type KeystoneParsedAccount, type KeystoneParsedMultiAccounts, type KeystoneSolSignRequestInput, type KeystoneSolSignatureResult, type KeystoneTronSignRequestInput, type KeystoneTronSignatureResult, type KeystoneUr, KeystoneUrEngine, accountKey, btcScriptTypeFromPath, createDeviceRecord, normalizePath, placeholderDeviceInfo, splitAccountPath, toDeviceInfo, walletConnectId };

package/dist/index.d.ts

@@ -174,17 +174,15 @@ declare class KeystoneUrEngine {
 }
 
 declare const KEYSTONE_WALLET_CONNECT_ID_PREFIX = "keystone-wallet:";
-/** Fixed public source used to derive a collision-resistant wallet id. */
-declare const KEYSTONE_WALLET_ID_PATH = "m/44'/60'/0'";
-declare function walletConnectId(walletId: string): string;
+/** Account a QR cold start requests when the caller named no path; any path returns the mfp. */
+declare const KEYSTONE_COLD_START_PATH = "m/44'/60'/0'";
+declare function walletConnectId(masterFingerprint: string): string;
 interface KeystoneAccountEntry extends KeystoneParsedAccount {
     hwkChain: ChainCapability;
 }
 declare function accountKey(hwkChain: ChainCapability, path: string): string;
 interface KeystoneDeviceRecord {
-    /** SHA-256 id derived from the fixed account-level identity xpub. */
-    walletId: string;
-    /** Lowercase 8-char BIP32 fingerprint used by BC-UR as xfp, never as identity. */
+    /** Lowercase 8-char BIP32 master fingerprint: the wallet identity and the BC-UR xfp. */
     masterFingerprint: string;
     connectId: string;
     /** Optional physical-device id exposed by some Keystone QR export menus. */
@@ -203,8 +201,7 @@ interface KeystoneDeviceRecord {
     /** True after one QR round trip; on USB disconnect it decides demote-to-QR versus drop. */
     qrSynced?: boolean;
 }
-declare function deriveKeystoneWalletId(accounts: KeystoneParsedAccount[]): string;
-declare function createDeviceRecord(walletId: string, masterFingerprint: string): KeystoneDeviceRecord;
+declare function createDeviceRecord(masterFingerprint: string): KeystoneDeviceRecord;
 declare function toDeviceInfo(record: KeystoneDeviceRecord): DeviceInfo;
 /** Device row for a not-yet-synced wallet during a cold-start round trip. */
 declare function placeholderDeviceInfo(): DeviceInfo;
@@ -213,13 +210,13 @@ declare function placeholderDeviceInfo(): DeviceInfo;
 type AccountBook = Map<string, KeystoneAccountEntry>;
 interface ImportFromQrOptions {
     /**
-     * 'request' asks the device for the identity xpub; 'scan' waits for whatever export it already
-     * shows. Only the wallet identity is learned either way.
+     * 'request' asks the device for one account; 'scan' waits for whatever export it already shows.
+     * Only the wallet's master fingerprint is learned either way.
      */
     mode?: 'request' | 'scan';
 }
 /**
- * QR and USB behind one `IHardwareWallet`, keyed by a wallet id derived from the identity xpub.
+ * QR and USB behind one `IHardwareWallet`, keyed by the wallet's BIP32 master fingerprint.
  * Key material is fetched per operation and never retained.
  */
 declare class KeystoneAdapter implements IHardwareWallet {
@@ -323,10 +320,7 @@ declare class KeystoneAdapter implements IHardwareWallet {
      * request because the device limits that channel.
      */
     private _prefetchAllNetworkAccounts;
-    /**
-     * Resolve only the stable 64-hex wallet identity. The 8-hex BIP32 master
-     * fingerprint is protocol metadata and is never accepted as a lookup key.
-     */
+    /** Resolve the wallet's master fingerprint from the connectId and/or deviceId the caller passed. */
     private _resolveTarget;
     private _assertParsedIdentity;
     /**
@@ -335,8 +329,8 @@ declare class KeystoneAdapter implements IHardwareWallet {
      */
     private _upsertDeviceRecord;
     /**
-     * Opens a permitted USB Keystone, reads its mfp, and derives the wallet id from the identity
-     * xpub. A known wallet gains USB in place (`device-changed`); an unseen one becomes USB-only.
+     * Opens a permitted USB Keystone and takes its mfp as the wallet identity. A known wallet gains
+     * USB in place (`device-changed`); an unseen one becomes USB-only.
      */
     private _connectUsb;
     private _connectUsbExclusive;
@@ -368,7 +362,7 @@ declare class KeystoneAdapter implements IHardwareWallet {
      * through the operation route; a cold start returns undefined.
      */
     private _activeOperationId;
-    /** Routes are keyed by connectId; a job key may be the bare wallet id. */
+    /** Routes are keyed by connectId; a job key may be the bare master fingerprint. */
     private _operationRouteForIdentifier;
     /**
      * A QR prompt has no transport to interrupt; releasing the registry slot on abort is what lets
@@ -401,4 +395,4 @@ declare function splitAccountPath(path: string): {
 /** BIP-44/49/84/86 purpose to script type; undefined for any other purpose. */
 declare function btcScriptTypeFromPath(path: string): BtcScriptType | undefined;
 
-export { type BtcScriptType, type ImportFromQrOptions, KEYSTONE_WALLET_CONNECT_ID_PREFIX, KEYSTONE_WALLET_ID_PATH, type KeystoneAccountEntry, KeystoneAdapter, type KeystoneBtcSignRequestAccount, type KeystoneBtcSignatureResult, type KeystoneDerivationCurve, type KeystoneDeviceRecord, type KeystoneEthSignRequestInput, type KeystoneEthSignatureResult, type KeystoneKeyDerivationRequestInput, type KeystoneKeySchema, type KeystoneParsedAccount, type KeystoneParsedMultiAccounts, type KeystoneSolSignRequestInput, type KeystoneSolSignatureResult, type KeystoneTronSignRequestInput, type KeystoneTronSignatureResult, type KeystoneUr, KeystoneUrEngine, accountKey, btcScriptTypeFromPath, createDeviceRecord, deriveKeystoneWalletId, normalizePath, placeholderDeviceInfo, splitAccountPath, toDeviceInfo, walletConnectId };
+export { type BtcScriptType, type ImportFromQrOptions, KEYSTONE_COLD_START_PATH, KEYSTONE_WALLET_CONNECT_ID_PREFIX, type KeystoneAccountEntry, KeystoneAdapter, type KeystoneBtcSignRequestAccount, type KeystoneBtcSignatureResult, type KeystoneDerivationCurve, type KeystoneDeviceRecord, type KeystoneEthSignRequestInput, type KeystoneEthSignatureResult, type KeystoneKeyDerivationRequestInput, type KeystoneKeySchema, type KeystoneParsedAccount, type KeystoneParsedMultiAccounts, type KeystoneSolSignRequestInput, type KeystoneSolSignatureResult, type KeystoneTronSignRequestInput, type KeystoneTronSignatureResult, type KeystoneUr, KeystoneUrEngine, accountKey, btcScriptTypeFromPath, createDeviceRecord, normalizePath, placeholderDeviceInfo, splitAccountPath, toDeviceInfo, walletConnectId };