@metamask-previews/eth-qr-keyring 0.0.0-a9b0f29

package/dist/qr-keyring.d.mts

@@ -0,0 +1,181 @@
+import { type TypedTransaction, type TypedTxData } from "@ethereumjs/tx";
+import type { TypedMessage, MessageTypes } from "@metamask/eth-sig-util";
+import type { Keyring } from "@metamask/keyring-utils";
+import { type Hex } from "@metamask/utils";
+import { type DeviceDetails, type IndexedAddress } from "./device.mjs";
+export declare const QR_KEYRING_TYPE = "QR Hardware Wallet Device";
+export declare enum QrScanRequestType {
+    /**
+     * Request a scan for a QR code containing a UR
+     * with information related to a hardware wallet.
+     */
+    PAIR = "pair",
+    /**
+     * Request a scan for a QR code containing a
+     * UR-encoded transaction signature.
+     */
+    SIGN = "sign"
+}
+export type QrSignatureRequest = {
+    requestId: string;
+    payload: SerializedUR;
+    requestTitle?: string;
+    requestDescription?: string;
+};
+export type QrScanRequest = {
+    type: QrScanRequestType;
+    request?: QrSignatureRequest;
+};
+export type SerializedUR = {
+    type: string;
+    cbor: string;
+};
+export type QrKeyringBridge = {
+    requestScan: (request: QrScanRequest) => Promise<SerializedUR>;
+};
+export type QrKeyringOptions = {
+    ur?: string;
+    bridge: QrKeyringBridge;
+};
+/**
+ * The state of the QrKeyring
+ *
+ * @property accounts - The accounts in the QrKeyring
+ */
+export type SerializedQrKeyringState = {
+    version?: number;
+    accounts?: string[];
+    currentAccount?: number;
+} & ({
+    initialized?: false;
+} | ({
+    initialized: true;
+} & DeviceDetails));
+/**
+ * Returns the default serialized state of the QrKeyring.
+ *
+ * @returns The default serialized state.
+ */
+export declare const getDefaultSerializedQrKeyringState: () => SerializedQrKeyringState;
+export declare class QrKeyring implements Keyring {
+    #private;
+    static type: string;
+    readonly type = "QR Hardware Wallet Device";
+    readonly bridge: QrKeyringBridge;
+    constructor(options: QrKeyringOptions);
+    /**
+     * Serializes the QrKeyring state
+     *
+     * @returns The serialized state
+     */
+    serialize(): Promise<SerializedQrKeyringState>;
+    /**
+     * Deserializes the QrKeyring state
+     *
+     * @param state - The serialized state to deserialize
+     */
+    deserialize(state: SerializedQrKeyringState): Promise<void>;
+    /**
+     * Adds accounts to the QrKeyring
+     *
+     * @param accountsToAdd - The number of accounts to add
+     * @returns The accounts added
+     */
+    addAccounts(accountsToAdd: number): Promise<Hex[]>;
+    /**
+     * Gets the accounts in the QrKeyring
+     *
+     * @returns The accounts in the QrKeyring
+     */
+    getAccounts(): Promise<Hex[]>;
+    /**
+     * Remove an account from the keyring
+     *
+     * @param address - The address of the account to remove
+     */
+    removeAccount(address: Hex): void;
+    /**
+     * Pair a QR-based Hardware Device from a CBOR encoded UR to the QrKeyring
+     *
+     * @param ur - The CBOR encoded UR
+     */
+    pairDevice(ur: string | SerializedUR): void;
+    /**
+     * Sets the next account index to unlock
+     *
+     * @param index - The index of the account to unlock
+     */
+    setAccountToUnlock(index: number): void;
+    /**
+     * Get the name of the paired device or the keyring type
+     * if unavailable.
+     *
+     * @returns The name of the paired device or the keyring type.
+     */
+    getName(): string;
+    /**
+     * Fetch the first page of accounts. If the keyring is not currently initialized,
+     * it will trigger a scan request to initialize it.
+     *
+     * @returns The first page of accounts as an array of Hex strings.
+     */
+    getFirstPage(): Promise<IndexedAddress[]>;
+    /**
+     * Fetch the next page of accounts. If the keyring is not currently initialized,
+     * it will trigger a scan request to initialize it.
+     *
+     * @returns The next page of accounts as an array of IndexedAddress objects.
+     */
+    getNextPage(): Promise<IndexedAddress[]>;
+    /**
+     * Fetch the previous page of accounts. If the keyring is not currently initialized,
+     * it will trigger a scan request to initialize it.
+     *
+     * @returns The previous page of accounts as an array of IndexedAddress objects.
+     */
+    getPreviousPage(): Promise<IndexedAddress[]>;
+    /**
+     * Fetch the current page of accounts. If the keyring is not currently initialized,
+     * it will trigger a scan request to initialize it.
+     *
+     * @returns The current page of accounts as an array of IndexedAddress objects.
+     */
+    getCurrentPage(): Promise<IndexedAddress[]>;
+    /**
+     * Clear the keyring state and forget any paired device or accounts.
+     */
+    forgetDevice(): Promise<void>;
+    /**
+     * Sign a transaction. This is equivalent to the `eth_signTransaction`
+     * Ethereum JSON-RPC method. See the Ethereum JSON-RPC API documentation for
+     * more details.
+     *
+     * @param address - The address of the account to use for signing.
+     * @param transaction - The transaction to sign.
+     * @returns The signed transaction.
+     */
+    signTransaction(address: Hex, transaction: TypedTransaction): Promise<TypedTxData>;
+    /**
+     * Sign a message. This is equivalent to the `eth_signTypedData` v4 Ethereum
+     * JSON-RPC method.
+     *
+     * @param address - The address of the account to use for signing.
+     * @param data - The data to sign.
+     * @returns The signed message.
+     */
+    signTypedData<Types extends MessageTypes>(address: Hex, data: TypedMessage<Types>): Promise<string>;
+    /**
+     * Sign a message. This is equivalent to the `eth_sign` Ethereum JSON-RPC
+     * method, which is exposed by MetaMask as the method `personal_sign`. See
+     * the Ethereum JSON-RPC API documentation for more details.
+     *
+     * For more information about this method and why we call it `personal_sign`,
+     * see the {@link https://docs.metamask.io/guide/signing-data.html|MetaMask Docs}.
+     *
+     * @param address - The address of the account to use for signing.
+     * @param message - The message to sign.
+     * @returns The signed message.
+     */
+    signPersonalMessage(address: Hex, message: Hex): Promise<string>;
+}
+//# sourceMappingURL=qr-keyring.d.mts.map

package/dist/qr-keyring.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"qr-keyring.d.mts","sourceRoot":"","sources":["../src/qr-keyring.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,gBAAgB,EAAE,KAAK,WAAW,EAAE,uBAAuB;AACzE,OAAO,KAAK,EAAE,YAAY,EAAE,YAAY,EAAE,+BAA+B;AACzE,OAAO,KAAK,EAAE,OAAO,EAAE,gCAAgC;AACvD,OAAO,EAAE,KAAK,GAAG,EAAqC,wBAAwB;AAE9E,OAAO,EACL,KAAK,aAAa,EAClB,KAAK,cAAc,EAGpB,qBAAiB;AAElB,eAAO,MAAM,eAAe,8BAA8B,CAAC;AAE3D,oBAAY,iBAAiB;IAC3B;;;OAGG;IACH,IAAI,SAAS;IACb;;;OAGG;IACH,IAAI,SAAS;CACd;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,YAAY,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,iBAAiB,CAAC;IACxB,OAAO,CAAC,EAAE,kBAAkB,CAAC;CAC9B,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,WAAW,EAAE,CAAC,OAAO,EAAE,aAAa,KAAK,OAAO,CAAC,YAAY,CAAC,CAAC;CAChE,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,eAAe,CAAC;CACzB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,GAAG,CACA;IACE,WAAW,CAAC,EAAE,KAAK,CAAC;CACrB,GACD,CAAC;IACC,WAAW,EAAE,IAAI,CAAC;CACnB,GAAG,aAAa,CAAC,CACrB,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,kCAAkC,QACzC,wBAGF,CAAC;AAYL,qBAAa,SAAU,YAAW,OAAO;;IACvC,MAAM,CAAC,IAAI,SAAmB;IAE9B,QAAQ,CAAC,IAAI,+BAAmB;IAEhC,QAAQ,CAAC,MAAM,EAAE,eAAe,CAAC;gBAUrB,OAAO,EAAE,gBAAgB;IAQrC;;;;OAIG;IACG,SAAS,IAAI,OAAO,CAAC,wBAAwB,CAAC;IAoBpD;;;;OAIG;IACG,WAAW,CAAC,KAAK,EAAE,wBAAwB,GAAG,OAAO,CAAC,IAAI,CAAC;IAcjE;;;;;OAKG;IACG,WAAW,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAuBxD;;;;OAIG;IACG,WAAW,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;IAInC;;;;OAIG;IACH,aAAa,CAAC,OAAO,EAAE,GAAG,GAAG,IAAI;IAOjC;;;;OAIG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,YAAY,GAAG,IAAI;IAO3C;;;;OAIG;IACH,kBAAkB,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAIvC;;;;;OAKG;IACH,OAAO,IAAI,MAAM;IAQjB;;;;;OAKG;IACG,YAAY,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;IAK/C;;;;;OAKG;IACG,WAAW,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;IAK9C;;;;;OAKG;IACG,eAAe,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;IASlD;;;;;OAKG;IACG,cAAc,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;IAWjD;;OAEG;IACG,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;IAOnC;;;;;;;;OAQG;IACG,eAAe,CACnB,OAAO,EAAE,GAAG,EACZ,WAAW,EAAE,gBAAgB,GAC5B,OAAO,CAAC,WAAW,CAAC;IAOvB;;;;;;;OAOG;IACG,aAAa,CAAC,KAAK,SAAS,YAAY,EAC5C,OAAO,EAAE,GAAG,EACZ,IAAI,EAAE,YAAY,CAAC,KAAK,CAAC,GACxB,OAAO,CAAC,MAAM,CAAC;IAOlB;;;;;;;;;;;OAWG;IACG,mBAAmB,CAAC,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC;CAgBvE"}

package/dist/qr-keyring.mjs

@@ -0,0 +1,283 @@
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var _QrKeyring_instances, _QrKeyring_device, _QrKeyring_accounts, _QrKeyring_accountToUnlock, _QrKeyring_currentPage, _QrKeyring_scanAndInitialize;
+import { add0x, assert, getChecksumAddress } from "@metamask/utils";
+import { Device, DeviceMode } from "./device.mjs";
+export const QR_KEYRING_TYPE = 'QR Hardware Wallet Device';
+export var QrScanRequestType;
+(function (QrScanRequestType) {
+    /**
+     * Request a scan for a QR code containing a UR
+     * with information related to a hardware wallet.
+     */
+    QrScanRequestType["PAIR"] = "pair";
+    /**
+     * Request a scan for a QR code containing a
+     * UR-encoded transaction signature.
+     */
+    QrScanRequestType["SIGN"] = "sign";
+})(QrScanRequestType || (QrScanRequestType = {}));
+/**
+ * Returns the default serialized state of the QrKeyring.
+ *
+ * @returns The default serialized state.
+ */
+export const getDefaultSerializedQrKeyringState = () => ({
+    initialized: false,
+    accounts: [],
+});
+/**
+ * Normalizes an address to a 0x-prefixed checksum address.
+ *
+ * @param address - The address to normalize.
+ * @returns The normalized address as a Hex string.
+ */
+function normalizeAddress(address) {
+    return getChecksumAddress(add0x(address));
+}
+export class QrKeyring {
+    constructor(options) {
+        _QrKeyring_instances.add(this);
+        this.type = QR_KEYRING_TYPE;
+        _QrKeyring_device.set(this, void 0);
+        _QrKeyring_accounts.set(this, []);
+        _QrKeyring_accountToUnlock.set(this, void 0);
+        _QrKeyring_currentPage.set(this, 0);
+        this.bridge = options.bridge;
+        if (options?.ur) {
+            this.pairDevice(options.ur);
+        }
+    }
+    /**
+     * Serializes the QrKeyring state
+     *
+     * @returns The serialized state
+     */
+    async serialize() {
+        const deviceDetails = __classPrivateFieldGet(this, _QrKeyring_device, "f")
+            ? __classPrivateFieldGet(this, _QrKeyring_device, "f").getDeviceDetails()
+            : undefined;
+        if (!deviceDetails ||
+            ![DeviceMode.HD, DeviceMode.ACCOUNT].includes(deviceDetails.keyringMode)) {
+            // the keyring has not initialized with a deviceDetails device yet
+            return getDefaultSerializedQrKeyringState();
+        }
+        return {
+            ...deviceDetails,
+            initialized: true,
+            accounts: __classPrivateFieldGet(this, _QrKeyring_accounts, "f").slice(),
+        };
+    }
+    /**
+     * Deserializes the QrKeyring state
+     *
+     * @param state - The serialized state to deserialize
+     */
+    async deserialize(state) {
+        if (!state.initialized) {
+            __classPrivateFieldSet(this, _QrKeyring_accounts, [], "f");
+            __classPrivateFieldSet(this, _QrKeyring_device, undefined, "f");
+            return;
+        }
+        __classPrivateFieldSet(this, _QrKeyring_device, new Device({
+            requestScan: this.bridge.requestScan.bind(this.bridge),
+            source: state,
+        }), "f");
+        __classPrivateFieldSet(this, _QrKeyring_accounts, (state.accounts ?? []).map(normalizeAddress), "f");
+    }
+    /**
+     * Adds accounts to the QrKeyring
+     *
+     * @param accountsToAdd - The number of accounts to add
+     * @returns The accounts added
+     */
+    async addAccounts(accountsToAdd) {
+        if (!__classPrivateFieldGet(this, _QrKeyring_device, "f")) {
+            throw new Error('No device paired.');
+        }
+        const newAccounts = [];
+        for (let i = 0; i < accountsToAdd; i++) {
+            const index = __classPrivateFieldGet(this, _QrKeyring_accountToUnlock, "f") ?? __classPrivateFieldGet(this, _QrKeyring_accounts, "f").length + i;
+            const address = __classPrivateFieldGet(this, _QrKeyring_device, "f").addressFromIndex(index);
+            if (__classPrivateFieldGet(this, _QrKeyring_accounts, "f").includes(address)) {
+                continue;
+            }
+            __classPrivateFieldGet(this, _QrKeyring_accounts, "f").push(address);
+            newAccounts.push(address);
+            this.setAccountToUnlock(index + 1);
+        }
+        return newAccounts;
+    }
+    /**
+     * Gets the accounts in the QrKeyring
+     *
+     * @returns The accounts in the QrKeyring
+     */
+    async getAccounts() {
+        return __classPrivateFieldGet(this, _QrKeyring_accounts, "f").slice();
+    }
+    /**
+     * Remove an account from the keyring
+     *
+     * @param address - The address of the account to remove
+     */
+    removeAccount(address) {
+        const normalizedAddress = normalizeAddress(address);
+        __classPrivateFieldSet(this, _QrKeyring_accounts, __classPrivateFieldGet(this, _QrKeyring_accounts, "f").filter((account) => account !== normalizedAddress), "f");
+    }
+    /**
+     * Pair a QR-based Hardware Device from a CBOR encoded UR to the QrKeyring
+     *
+     * @param ur - The CBOR encoded UR
+     */
+    pairDevice(ur) {
+        __classPrivateFieldSet(this, _QrKeyring_device, new Device({
+            requestScan: this.bridge.requestScan.bind(this.bridge),
+            source: ur,
+        }), "f");
+    }
+    /**
+     * Sets the next account index to unlock
+     *
+     * @param index - The index of the account to unlock
+     */
+    setAccountToUnlock(index) {
+        __classPrivateFieldSet(this, _QrKeyring_accountToUnlock, index, "f");
+    }
+    /**
+     * Get the name of the paired device or the keyring type
+     * if unavailable.
+     *
+     * @returns The name of the paired device or the keyring type.
+     */
+    getName() {
+        if (!__classPrivateFieldGet(this, _QrKeyring_device, "f")) {
+            return QR_KEYRING_TYPE;
+        }
+        const source = __classPrivateFieldGet(this, _QrKeyring_device, "f").getDeviceDetails();
+        return source.name;
+    }
+    /**
+     * Fetch the first page of accounts. If the keyring is not currently initialized,
+     * it will trigger a scan request to initialize it.
+     *
+     * @returns The first page of accounts as an array of Hex strings.
+     */
+    async getFirstPage() {
+        __classPrivateFieldSet(this, _QrKeyring_currentPage, 0, "f");
+        return this.getCurrentPage();
+    }
+    /**
+     * Fetch the next page of accounts. If the keyring is not currently initialized,
+     * it will trigger a scan request to initialize it.
+     *
+     * @returns The next page of accounts as an array of IndexedAddress objects.
+     */
+    async getNextPage() {
+        __classPrivateFieldSet(this, _QrKeyring_currentPage, __classPrivateFieldGet(this, _QrKeyring_currentPage, "f") + 1, "f");
+        return this.getCurrentPage();
+    }
+    /**
+     * Fetch the previous page of accounts. If the keyring is not currently initialized,
+     * it will trigger a scan request to initialize it.
+     *
+     * @returns The previous page of accounts as an array of IndexedAddress objects.
+     */
+    async getPreviousPage() {
+        if (__classPrivateFieldGet(this, _QrKeyring_currentPage, "f") > 0) {
+            __classPrivateFieldSet(this, _QrKeyring_currentPage, __classPrivateFieldGet(this, _QrKeyring_currentPage, "f") - 1, "f");
+        }
+        else {
+            __classPrivateFieldSet(this, _QrKeyring_currentPage, 0, "f");
+        }
+        return this.getCurrentPage();
+    }
+    /**
+     * Fetch the current page of accounts. If the keyring is not currently initialized,
+     * it will trigger a scan request to initialize it.
+     *
+     * @returns The current page of accounts as an array of IndexedAddress objects.
+     */
+    async getCurrentPage() {
+        if (!__classPrivateFieldGet(this, _QrKeyring_device, "f")) {
+            await __classPrivateFieldGet(this, _QrKeyring_instances, "m", _QrKeyring_scanAndInitialize).call(this);
+        }
+        assert(__classPrivateFieldGet(this, _QrKeyring_device, "f"), 'A device is expected to be paired before fetching accounts.');
+        return __classPrivateFieldGet(this, _QrKeyring_device, "f").getAddressesPage(__classPrivateFieldGet(this, _QrKeyring_currentPage, "f"));
+    }
+    /**
+     * Clear the keyring state and forget any paired device or accounts.
+     */
+    async forgetDevice() {
+        __classPrivateFieldSet(this, _QrKeyring_device, undefined, "f");
+        __classPrivateFieldSet(this, _QrKeyring_accounts, [], "f");
+        __classPrivateFieldSet(this, _QrKeyring_accountToUnlock, undefined, "f");
+        __classPrivateFieldSet(this, _QrKeyring_currentPage, 0, "f");
+    }
+    /**
+     * Sign a transaction. This is equivalent to the `eth_signTransaction`
+     * Ethereum JSON-RPC method. See the Ethereum JSON-RPC API documentation for
+     * more details.
+     *
+     * @param address - The address of the account to use for signing.
+     * @param transaction - The transaction to sign.
+     * @returns The signed transaction.
+     */
+    async signTransaction(address, transaction) {
+        if (!__classPrivateFieldGet(this, _QrKeyring_device, "f")) {
+            throw new Error('No device paired.');
+        }
+        return __classPrivateFieldGet(this, _QrKeyring_device, "f").signTransaction(address, transaction);
+    }
+    /**
+     * Sign a message. This is equivalent to the `eth_signTypedData` v4 Ethereum
+     * JSON-RPC method.
+     *
+     * @param address - The address of the account to use for signing.
+     * @param data - The data to sign.
+     * @returns The signed message.
+     */
+    async signTypedData(address, data) {
+        if (!__classPrivateFieldGet(this, _QrKeyring_device, "f")) {
+            throw new Error('No device paired.');
+        }
+        return __classPrivateFieldGet(this, _QrKeyring_device, "f").signTypedData(address, data);
+    }
+    /**
+     * Sign a message. This is equivalent to the `eth_sign` Ethereum JSON-RPC
+     * method, which is exposed by MetaMask as the method `personal_sign`. See
+     * the Ethereum JSON-RPC API documentation for more details.
+     *
+     * For more information about this method and why we call it `personal_sign`,
+     * see the {@link https://docs.metamask.io/guide/signing-data.html|MetaMask Docs}.
+     *
+     * @param address - The address of the account to use for signing.
+     * @param message - The message to sign.
+     * @returns The signed message.
+     */
+    async signPersonalMessage(address, message) {
+        if (!__classPrivateFieldGet(this, _QrKeyring_device, "f")) {
+            throw new Error('No device paired.');
+        }
+        return __classPrivateFieldGet(this, _QrKeyring_device, "f").signPersonalMessage(address, message);
+    }
+}
+_QrKeyring_device = new WeakMap(), _QrKeyring_accounts = new WeakMap(), _QrKeyring_accountToUnlock = new WeakMap(), _QrKeyring_currentPage = new WeakMap(), _QrKeyring_instances = new WeakSet(), _QrKeyring_scanAndInitialize = 
+/**
+ * Scan for a QR code and initialize the keyring with the
+ * scanned UR.
+ */
+async function _QrKeyring_scanAndInitialize() {
+    this.pairDevice(await this.bridge.requestScan({ type: QrScanRequestType.PAIR }));
+};
+QrKeyring.type = QR_KEYRING_TYPE;
+//# sourceMappingURL=qr-keyring.mjs.map

package/dist/qr-keyring.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"qr-keyring.mjs","sourceRoot":"","sources":["../src/qr-keyring.ts"],"names":[],"mappings":";;;;;;;;;;;;AAGA,OAAO,EAAY,KAAK,EAAE,MAAM,EAAE,kBAAkB,EAAE,wBAAwB;AAE9E,OAAO,EAGL,MAAM,EACN,UAAU,EACX,qBAAiB;AAElB,MAAM,CAAC,MAAM,eAAe,GAAG,2BAA2B,CAAC;AAE3D,MAAM,CAAN,IAAY,iBAWX;AAXD,WAAY,iBAAiB;IAC3B;;;OAGG;IACH,kCAAa,CAAA;IACb;;;OAGG;IACH,kCAAa,CAAA;AACf,CAAC,EAXW,iBAAiB,KAAjB,iBAAiB,QAW5B;AA8CD;;;;GAIG;AACH,MAAM,CAAC,MAAM,kCAAkC,GAC7C,GAA6B,EAAE,CAAC,CAAC;IAC/B,WAAW,EAAE,KAAK;IAClB,QAAQ,EAAE,EAAE;CACb,CAAC,CAAC;AAEL;;;;;GAKG;AACH,SAAS,gBAAgB,CAAC,OAAe;IACvC,OAAO,kBAAkB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;AAC5C,CAAC;AAED,MAAM,OAAO,SAAS;IAepB,YAAY,OAAyB;;QAZ5B,SAAI,GAAG,eAAe,CAAC;QAIhC,oCAA6B;QAE7B,8BAAmB,EAAE,EAAC;QAEtB,6CAAsC;QAEtC,iCAAuB,CAAC,EAAC;QAGvB,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QAE7B,IAAI,OAAO,EAAE,EAAE,EAAE,CAAC;YAChB,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAC9B,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,SAAS;QACb,MAAM,aAAa,GAAG,uBAAA,IAAI,yBAAQ;YAChC,CAAC,CAAC,uBAAA,IAAI,yBAAQ,CAAC,gBAAgB,EAAE;YACjC,CAAC,CAAC,SAAS,CAAC;QAEd,IACE,CAAC,aAAa;YACd,CAAC,CAAC,UAAU,CAAC,EAAE,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,WAAW,CAAC,EACxE,CAAC;YACD,kEAAkE;YAClE,OAAO,kCAAkC,EAAE,CAAC;QAC9C,CAAC;QAED,OAAO;YACL,GAAG,aAAa;YAChB,WAAW,EAAE,IAAI;YACjB,QAAQ,EAAE,uBAAA,IAAI,2BAAU,CAAC,KAAK,EAAE;SACjC,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,WAAW,CAAC,KAA+B;QAC/C,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;YACvB,uBAAA,IAAI,uBAAa,EAAE,MAAA,CAAC;YACpB,uBAAA,IAAI,qBAAW,SAAS,MAAA,CAAC;YACzB,OAAO;QACT,CAAC;QAED,uBAAA,IAAI,qBAAW,IAAI,MAAM,CAAC;YACxB,WAAW,EAAE,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC;YACtD,MAAM,EAAE,KAAK;SACd,CAAC,MAAA,CAAC;QACH,uBAAA,IAAI,uBAAa,CAAC,KAAK,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,gBAAgB,CAAC,MAAA,CAAC;IAChE,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,WAAW,CAAC,aAAqB;QACrC,IAAI,CAAC,uBAAA,IAAI,yBAAQ,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;QACvC,CAAC;QAED,MAAM,WAAW,GAAU,EAAE,CAAC;QAE9B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,aAAa,EAAE,CAAC,EAAE,EAAE,CAAC;YACvC,MAAM,KAAK,GAAG,uBAAA,IAAI,kCAAiB,IAAI,uBAAA,IAAI,2BAAU,CAAC,MAAM,GAAG,CAAC,CAAC;YACjE,MAAM,OAAO,GAAG,uBAAA,IAAI,yBAAQ,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;YAErD,IAAI,uBAAA,IAAI,2BAAU,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;gBACrC,SAAS;YACX,CAAC;YAED,uBAAA,IAAI,2BAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAC7B,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAC1B,IAAI,CAAC,kBAAkB,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;QACrC,CAAC;QAED,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,WAAW;QACf,OAAO,uBAAA,IAAI,2BAAU,CAAC,KAAK,EAAE,CAAC;IAChC,CAAC;IAED;;;;OAIG;IACH,aAAa,CAAC,OAAY;QACxB,MAAM,iBAAiB,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpD,uBAAA,IAAI,uBAAa,uBAAA,IAAI,2BAAU,CAAC,MAAM,CACpC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,KAAK,iBAAiB,CAC3C,MAAA,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,UAAU,CAAC,EAAyB;QAClC,uBAAA,IAAI,qBAAW,IAAI,MAAM,CAAC;YACxB,WAAW,EAAE,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC;YACtD,MAAM,EAAE,EAAE;SACX,CAAC,MAAA,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,kBAAkB,CAAC,KAAa;QAC9B,uBAAA,IAAI,8BAAoB,KAAK,MAAA,CAAC;IAChC,CAAC;IAED;;;;;OAKG;IACH,OAAO;QACL,IAAI,CAAC,uBAAA,IAAI,yBAAQ,EAAE,CAAC;YAClB,OAAO,eAAe,CAAC;QACzB,CAAC;QACD,MAAM,MAAM,GAAG,uBAAA,IAAI,yBAAQ,CAAC,gBAAgB,EAAE,CAAC;QAC/C,OAAO,MAAM,CAAC,IAAI,CAAC;IACrB,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,YAAY;QAChB,uBAAA,IAAI,0BAAgB,CAAC,MAAA,CAAC;QACtB,OAAO,IAAI,CAAC,cAAc,EAAE,CAAC;IAC/B,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,WAAW;QACf,iHAAqB,CAAC,MAAA,CAAC;QACvB,OAAO,IAAI,CAAC,cAAc,EAAE,CAAC;IAC/B,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,eAAe;QACnB,IAAI,uBAAA,IAAI,8BAAa,GAAG,CAAC,EAAE,CAAC;YAC1B,iHAAqB,CAAC,MAAA,CAAC;QACzB,CAAC;aAAM,CAAC;YACN,uBAAA,IAAI,0BAAgB,CAAC,MAAA,CAAC;QACxB,CAAC;QACD,OAAO,IAAI,CAAC,cAAc,EAAE,CAAC;IAC/B,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,cAAc;QAClB,IAAI,CAAC,uBAAA,IAAI,yBAAQ,EAAE,CAAC;YAClB,MAAM,uBAAA,IAAI,0DAAmB,MAAvB,IAAI,CAAqB,CAAC;QAClC,CAAC;QACD,MAAM,CACJ,uBAAA,IAAI,yBAAQ,EACZ,6DAA6D,CAC9D,CAAC;QACF,OAAO,uBAAA,IAAI,yBAAQ,CAAC,gBAAgB,CAAC,uBAAA,IAAI,8BAAa,CAAC,CAAC;IAC1D,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,YAAY;QAChB,uBAAA,IAAI,qBAAW,SAAS,MAAA,CAAC;QACzB,uBAAA,IAAI,uBAAa,EAAE,MAAA,CAAC;QACpB,uBAAA,IAAI,8BAAoB,SAAS,MAAA,CAAC;QAClC,uBAAA,IAAI,0BAAgB,CAAC,MAAA,CAAC;IACxB,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,eAAe,CACnB,OAAY,EACZ,WAA6B;QAE7B,IAAI,CAAC,uBAAA,IAAI,yBAAQ,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;QACvC,CAAC;QACD,OAAO,uBAAA,IAAI,yBAAQ,CAAC,eAAe,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,aAAa,CACjB,OAAY,EACZ,IAAyB;QAEzB,IAAI,CAAC,uBAAA,IAAI,yBAAQ,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;QACvC,CAAC;QACD,OAAO,uBAAA,IAAI,yBAAQ,CAAC,aAAa,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IACnD,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,mBAAmB,CAAC,OAAY,EAAE,OAAY;QAClD,IAAI,CAAC,uBAAA,IAAI,yBAAQ,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;QACvC,CAAC;QACD,OAAO,uBAAA,IAAI,yBAAQ,CAAC,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;;;AAED;;;GAGG;AACH,KAAK;IACH,IAAI,CAAC,UAAU,CACb,MAAM,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,IAAI,EAAE,iBAAiB,CAAC,IAAI,EAAE,CAAC,CAChE,CAAC;AACJ,CAAC;AAvRM,cAAI,GAAG,eAAe,AAAlB,CAAmB","sourcesContent":["import { type TypedTransaction, type TypedTxData } from '@ethereumjs/tx';\nimport type { TypedMessage, MessageTypes } from '@metamask/eth-sig-util';\nimport type { Keyring } from '@metamask/keyring-utils';\nimport { type Hex, add0x, assert, getChecksumAddress } from '@metamask/utils';\n\nimport {\n  type DeviceDetails,\n  type IndexedAddress,\n  Device,\n  DeviceMode,\n} from './device';\n\nexport const QR_KEYRING_TYPE = 'QR Hardware Wallet Device';\n\nexport enum QrScanRequestType {\n  /**\n   * Request a scan for a QR code containing a UR\n   * with information related to a hardware wallet.\n   */\n  PAIR = 'pair',\n  /**\n   * Request a scan for a QR code containing a\n   * UR-encoded transaction signature.\n   */\n  SIGN = 'sign',\n}\n\nexport type QrSignatureRequest = {\n  requestId: string;\n  payload: SerializedUR;\n  requestTitle?: string;\n  requestDescription?: string;\n};\n\nexport type QrScanRequest = {\n  type: QrScanRequestType;\n  request?: QrSignatureRequest;\n};\n\nexport type SerializedUR = {\n  type: string;\n  cbor: string;\n};\n\nexport type QrKeyringBridge = {\n  requestScan: (request: QrScanRequest) => Promise<SerializedUR>;\n};\n\nexport type QrKeyringOptions = {\n  ur?: string;\n  bridge: QrKeyringBridge;\n};\n\n/**\n * The state of the QrKeyring\n *\n * @property accounts - The accounts in the QrKeyring\n */\nexport type SerializedQrKeyringState = {\n  version?: number;\n  accounts?: string[];\n  currentAccount?: number;\n} & (\n  | {\n      initialized?: false;\n    }\n  | ({\n      initialized: true;\n    } & DeviceDetails)\n);\n\n/**\n * Returns the default serialized state of the QrKeyring.\n *\n * @returns The default serialized state.\n */\nexport const getDefaultSerializedQrKeyringState =\n  (): SerializedQrKeyringState => ({\n    initialized: false,\n    accounts: [],\n  });\n\n/**\n * Normalizes an address to a 0x-prefixed checksum address.\n *\n * @param address - The address to normalize.\n * @returns The normalized address as a Hex string.\n */\nfunction normalizeAddress(address: string): Hex {\n  return getChecksumAddress(add0x(address));\n}\n\nexport class QrKeyring implements Keyring {\n  static type = QR_KEYRING_TYPE;\n\n  readonly type = QR_KEYRING_TYPE;\n\n  readonly bridge: QrKeyringBridge;\n\n  #device?: Device | undefined;\n\n  #accounts: Hex[] = [];\n\n  #accountToUnlock?: number | undefined;\n\n  #currentPage: number = 0;\n\n  constructor(options: QrKeyringOptions) {\n    this.bridge = options.bridge;\n\n    if (options?.ur) {\n      this.pairDevice(options.ur);\n    }\n  }\n\n  /**\n   * Serializes the QrKeyring state\n   *\n   * @returns The serialized state\n   */\n  async serialize(): Promise<SerializedQrKeyringState> {\n    const deviceDetails = this.#device\n      ? this.#device.getDeviceDetails()\n      : undefined;\n\n    if (\n      !deviceDetails ||\n      ![DeviceMode.HD, DeviceMode.ACCOUNT].includes(deviceDetails.keyringMode)\n    ) {\n      // the keyring has not initialized with a deviceDetails device yet\n      return getDefaultSerializedQrKeyringState();\n    }\n\n    return {\n      ...deviceDetails,\n      initialized: true,\n      accounts: this.#accounts.slice(),\n    };\n  }\n\n  /**\n   * Deserializes the QrKeyring state\n   *\n   * @param state - The serialized state to deserialize\n   */\n  async deserialize(state: SerializedQrKeyringState): Promise<void> {\n    if (!state.initialized) {\n      this.#accounts = [];\n      this.#device = undefined;\n      return;\n    }\n\n    this.#device = new Device({\n      requestScan: this.bridge.requestScan.bind(this.bridge),\n      source: state,\n    });\n    this.#accounts = (state.accounts ?? []).map(normalizeAddress);\n  }\n\n  /**\n   * Adds accounts to the QrKeyring\n   *\n   * @param accountsToAdd - The number of accounts to add\n   * @returns The accounts added\n   */\n  async addAccounts(accountsToAdd: number): Promise<Hex[]> {\n    if (!this.#device) {\n      throw new Error('No device paired.');\n    }\n\n    const newAccounts: Hex[] = [];\n\n    for (let i = 0; i < accountsToAdd; i++) {\n      const index = this.#accountToUnlock ?? this.#accounts.length + i;\n      const address = this.#device.addressFromIndex(index);\n\n      if (this.#accounts.includes(address)) {\n        continue;\n      }\n\n      this.#accounts.push(address);\n      newAccounts.push(address);\n      this.setAccountToUnlock(index + 1);\n    }\n\n    return newAccounts;\n  }\n\n  /**\n   * Gets the accounts in the QrKeyring\n   *\n   * @returns The accounts in the QrKeyring\n   */\n  async getAccounts(): Promise<Hex[]> {\n    return this.#accounts.slice();\n  }\n\n  /**\n   * Remove an account from the keyring\n   *\n   * @param address - The address of the account to remove\n   */\n  removeAccount(address: Hex): void {\n    const normalizedAddress = normalizeAddress(address);\n    this.#accounts = this.#accounts.filter(\n      (account) => account !== normalizedAddress,\n    );\n  }\n\n  /**\n   * Pair a QR-based Hardware Device from a CBOR encoded UR to the QrKeyring\n   *\n   * @param ur - The CBOR encoded UR\n   */\n  pairDevice(ur: string | SerializedUR): void {\n    this.#device = new Device({\n      requestScan: this.bridge.requestScan.bind(this.bridge),\n      source: ur,\n    });\n  }\n\n  /**\n   * Sets the next account index to unlock\n   *\n   * @param index - The index of the account to unlock\n   */\n  setAccountToUnlock(index: number): void {\n    this.#accountToUnlock = index;\n  }\n\n  /**\n   * Get the name of the paired device or the keyring type\n   * if unavailable.\n   *\n   * @returns The name of the paired device or the keyring type.\n   */\n  getName(): string {\n    if (!this.#device) {\n      return QR_KEYRING_TYPE;\n    }\n    const source = this.#device.getDeviceDetails();\n    return source.name;\n  }\n\n  /**\n   * Fetch the first page of accounts. If the keyring is not currently initialized,\n   * it will trigger a scan request to initialize it.\n   *\n   * @returns The first page of accounts as an array of Hex strings.\n   */\n  async getFirstPage(): Promise<IndexedAddress[]> {\n    this.#currentPage = 0;\n    return this.getCurrentPage();\n  }\n\n  /**\n   * Fetch the next page of accounts. If the keyring is not currently initialized,\n   * it will trigger a scan request to initialize it.\n   *\n   * @returns The next page of accounts as an array of IndexedAddress objects.\n   */\n  async getNextPage(): Promise<IndexedAddress[]> {\n    this.#currentPage += 1;\n    return this.getCurrentPage();\n  }\n\n  /**\n   * Fetch the previous page of accounts. If the keyring is not currently initialized,\n   * it will trigger a scan request to initialize it.\n   *\n   * @returns The previous page of accounts as an array of IndexedAddress objects.\n   */\n  async getPreviousPage(): Promise<IndexedAddress[]> {\n    if (this.#currentPage > 0) {\n      this.#currentPage -= 1;\n    } else {\n      this.#currentPage = 0;\n    }\n    return this.getCurrentPage();\n  }\n\n  /**\n   * Fetch the current page of accounts. If the keyring is not currently initialized,\n   * it will trigger a scan request to initialize it.\n   *\n   * @returns The current page of accounts as an array of IndexedAddress objects.\n   */\n  async getCurrentPage(): Promise<IndexedAddress[]> {\n    if (!this.#device) {\n      await this.#scanAndInitialize();\n    }\n    assert(\n      this.#device,\n      'A device is expected to be paired before fetching accounts.',\n    );\n    return this.#device.getAddressesPage(this.#currentPage);\n  }\n\n  /**\n   * Clear the keyring state and forget any paired device or accounts.\n   */\n  async forgetDevice(): Promise<void> {\n    this.#device = undefined;\n    this.#accounts = [];\n    this.#accountToUnlock = undefined;\n    this.#currentPage = 0;\n  }\n\n  /**\n   * Sign a transaction. This is equivalent to the `eth_signTransaction`\n   * Ethereum JSON-RPC method. See the Ethereum JSON-RPC API documentation for\n   * more details.\n   *\n   * @param address - The address of the account to use for signing.\n   * @param transaction - The transaction to sign.\n   * @returns The signed transaction.\n   */\n  async signTransaction(\n    address: Hex,\n    transaction: TypedTransaction,\n  ): Promise<TypedTxData> {\n    if (!this.#device) {\n      throw new Error('No device paired.');\n    }\n    return this.#device.signTransaction(address, transaction);\n  }\n\n  /**\n   * Sign a message. This is equivalent to the `eth_signTypedData` v4 Ethereum\n   * JSON-RPC method.\n   *\n   * @param address - The address of the account to use for signing.\n   * @param data - The data to sign.\n   * @returns The signed message.\n   */\n  async signTypedData<Types extends MessageTypes>(\n    address: Hex,\n    data: TypedMessage<Types>,\n  ): Promise<string> {\n    if (!this.#device) {\n      throw new Error('No device paired.');\n    }\n    return this.#device.signTypedData(address, data);\n  }\n\n  /**\n   * Sign a message. This is equivalent to the `eth_sign` Ethereum JSON-RPC\n   * method, which is exposed by MetaMask as the method `personal_sign`. See\n   * the Ethereum JSON-RPC API documentation for more details.\n   *\n   * For more information about this method and why we call it `personal_sign`,\n   * see the {@link https://docs.metamask.io/guide/signing-data.html|MetaMask Docs}.\n   *\n   * @param address - The address of the account to use for signing.\n   * @param message - The message to sign.\n   * @returns The signed message.\n   */\n  async signPersonalMessage(address: Hex, message: Hex): Promise<string> {\n    if (!this.#device) {\n      throw new Error('No device paired.');\n    }\n    return this.#device.signPersonalMessage(address, message);\n  }\n\n  /**\n   * Scan for a QR code and initialize the keyring with the\n   * scanned UR.\n   */\n  async #scanAndInitialize(): Promise<void> {\n    this.pairDevice(\n      await this.bridge.requestScan({ type: QrScanRequestType.PAIR }),\n    );\n  }\n}\n"]}

package/package.json

@@ -0,0 +1,96 @@
+{
+  "name": "@metamask-previews/eth-qr-keyring",
+  "version": "0.0.0-a9b0f29",
+  "description": "A simple standard interface for a series of Ethereum private keys.",
+  "keywords": [
+    "ethereum",
+    "keyring",
+    "qr",
+    "metamask"
+  ],
+  "homepage": "https://github.com/MetaMask/accounts/packages/keyring-eth-qr#readme",
+  "bugs": {
+    "url": "https://github.com/MetaMask/accounts/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MetaMask/accounts.git"
+  },
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    }
+  },
+  "main": "./dist/index.cjs",
+  "types": "./dist/index.d.cts",
+  "files": [
+    "dist/"
+  ],
+  "scripts": {
+    "build": "tsc --build tsconfig.build.json",
+    "build:clean": "rimraf dist && yarn build",
+    "build:docs": "typedoc",
+    "build:force": "tsc --build tsconfig.build.json --force",
+    "changelog:update": "../../scripts/update-changelog.sh @metamask/eth-qr-keyring",
+    "changelog:validate": "../../scripts/validate-changelog.sh @metamask/eth-qr-keyring",
+    "publish:preview": "yarn npm publish --tag preview",
+    "sample": "ts-node src/sample.ts",
+    "test": "jest",
+    "test:clean": "jest --clearCache",
+    "test:verbose": "jest --verbose",
+    "test:watch": "jest --watch"
+  },
+  "dependencies": {
+    "@ethereumjs/rlp": "^5.0.2",
+    "@ethereumjs/tx": "^5.4.0",
+    "@ethereumjs/util": "^9.1.0",
+    "@keystonehq/bc-ur-registry-eth": "^0.19.1",
+    "@metamask/eth-sig-util": "^8.2.0",
+    "@metamask/keyring-utils": "3.0.0",
+    "@metamask/utils": "^11.1.0",
+    "hdkey": "^2.1.0",
+    "uuid": "^9.0.1"
+  },
+  "devDependencies": {
+    "@ethereumjs/common": "^4.4.0",
+    "@keystonehq/metamask-airgapped-keyring": "^0.15.2",
+    "@lavamoat/allow-scripts": "^3.2.1",
+    "@metamask/auto-changelog": "^3.4.4",
+    "@types/hdkey": "^2.0.1",
+    "@types/jest": "^29.5.12",
+    "@types/node": "^20.12.12",
+    "deepmerge": "^4.2.2",
+    "depcheck": "^1.4.7",
+    "jest": "^29.5.0",
+    "ts-jest": "^29.0.5",
+    "ts-node": "^10.9.2",
+    "typedoc": "^0.25.13",
+    "typescript": "~5.6.3"
+  },
+  "engines": {
+    "node": "^18.18 || >=20"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "lavamoat": {
+    "allowScripts": {
+      "keccak": true,
+      "secp256k1": true,
+      "@lavamoat/preinstall-always-fail": false,
+      "ethereumjs-tx>ethereumjs-util>ethereum-cryptography>keccak": false,
+      "ethereumjs-tx>ethereumjs-util>ethereum-cryptography>secp256k1": false,
+      "@keystonehq/ur-decoder>@keystonehq/bc-ur-registry-eth>ethereumjs-util>ethereum-cryptography>keccak": false,
+      "@lavamoat/allow-scripts>@lavamoat/preinstall-always-fail": false,
+      "hdkey>secp256k1": false
+    }
+  }
+}