@metamask-previews/eth-sig-util 0.0.0-stage → 9.0.0-preview-06c1d7a06

package/CHANGELOG.md

@@ -0,0 +1,23 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Changed
+
+- **BREAKING:** Drop CommonJS support ([#11349](https://github.com/MetaMask/core/pull/11349), [#11362](https://github.com/MetaMask/core/pull/11362))
+  - This package is now ESM-only, but can still be used in CommonJS projects via `require(esm)` in modern Node.js versions (22+), or dynamic imports in older Node.js versions.
+- **BREAKING:** Bump TypeScript target to ES2022 ([#11348](https://github.com/MetaMask/core/pull/11348))
+- Bump `@metamask/utils` from `^11.0.1` to `^12.0.1` ([#11349](https://github.com/MetaMask/core/pull/11349))
+- Bump `ethereum-cryptography` from `^2.1.2` to `^3.2.0` ([#11349](https://github.com/MetaMask/core/pull/11349))
+- Bump `@scure/base` from `~1.1.3` to `^1.2.6` ([#11349](https://github.com/MetaMask/core/pull/11349))
+- This package was migrated from `MetaMask/eth-sig-util` to the
+  `MetaMask/core` monorepo ([#11327](https://github.com/MetaMask/core/pull/11327))
+  - See [`MetaMask/eth-sig-util`](https://github.com/MetaMask/eth-sig-util/blob/73725fc31a51e4d5f6b72d8e5f470c0b10c9d57f/CHANGELOG.md)
+    for the original changelog.
+
+[Unreleased]: https://github.com/MetaMask/core/

package/LICENSE

@@ -0,0 +1,15 @@
+ISC License
+
+Copyright (c) 2020 MetaMask
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -1,3 +1,19 @@
-# Temporary Holding Version
+# `@metamask/eth-sig-util`
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+A small collection of Ethereum signing functions.
+
+## Installation
+
+`yarn add @metamask/eth-sig-util`
+
+or
+
+`npm install @metamask/eth-sig-util`
+
+## API
+
+The full API documentation for the latest published version of this library is [available here](https://metamask.github.io/eth-sig-util/latest/index.html).
+
+## Contributing
+
+This package is part of a monorepo. Instructions for contributing can be found in the [monorepo README](https://github.com/MetaMask/core#readme).

package/dist/encryption.d.ts

@@ -0,0 +1,69 @@
+export type EthEncryptedData = {
+    version: string;
+    nonce: string;
+    ephemPublicKey: string;
+    ciphertext: string;
+};
+/**
+ * Encrypt a message.
+ *
+ * @param options - The encryption options.
+ * @param options.publicKey - The public key of the message recipient.
+ * @param options.data - The message data.
+ * @param options.version - The type of encryption to use.
+ * @returns The encrypted data.
+ */
+export declare function encrypt({ publicKey, data, version, }: {
+    publicKey: string;
+    data: unknown;
+    version: string;
+}): EthEncryptedData;
+/**
+ * Encrypt a message in a way that obscures the message length.
+ *
+ * The message is padded to a multiple of 2048 before being encrypted so that the length of the
+ * resulting encrypted message can't be used to guess the exact length of the original message.
+ *
+ * @param options - The encryption options.
+ * @param options.publicKey - The public key of the message recipient.
+ * @param options.data - The message data.
+ * @param options.version - The type of encryption to use.
+ * @returns The encrypted data.
+ */
+export declare function encryptSafely({ publicKey, data, version, }: {
+    publicKey: string;
+    data: unknown;
+    version: string;
+}): EthEncryptedData;
+/**
+ * Decrypt a message.
+ *
+ * @param options - The decryption options.
+ * @param options.encryptedData - The encrypted data.
+ * @param options.privateKey - The private key to decrypt with.
+ * @returns The decrypted message.
+ */
+export declare function decrypt({ encryptedData, privateKey, }: {
+    encryptedData: EthEncryptedData;
+    privateKey: string;
+}): string;
+/**
+ * Decrypt a message that has been encrypted using `encryptSafely`.
+ *
+ * @param options - The decryption options.
+ * @param options.encryptedData - The encrypted data.
+ * @param options.privateKey - The private key to decrypt with.
+ * @returns The decrypted message.
+ */
+export declare function decryptSafely({ encryptedData, privateKey, }: {
+    encryptedData: EthEncryptedData;
+    privateKey: string;
+}): string;
+/**
+ * Get the encryption public key for the given key.
+ *
+ * @param privateKey - The private key to generate the encryption public key with.
+ * @returns The encryption public key.
+ */
+export declare function getEncryptionPublicKey(privateKey: string): string;
+//# sourceMappingURL=encryption.d.ts.map

package/dist/encryption.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"encryption.d.ts","sourceRoot":"","sources":["../src/encryption.ts"],"names":[],"mappings":"AAKA,MAAM,MAAM,gBAAgB,GAAG;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,cAAc,EAAE,MAAM,CAAC;IACvB,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;;;;;;;GAQG;AACH,wBAAgB,OAAO,CAAC,EACtB,SAAS,EACT,IAAI,EACJ,OAAO,GACR,EAAE;IACD,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,OAAO,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;CACjB,GAAG,gBAAgB,CAkDnB;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,aAAa,CAAC,EAC5B,SAAS,EACT,IAAI,EACJ,OAAO,GACR,EAAE;IACD,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,OAAO,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;CACjB,GAAG,gBAAgB,CAyCnB;AAED;;;;;;;GAOG;AACH,wBAAgB,OAAO,CAAC,EACtB,aAAa,EACb,UAAU,GACX,EAAE;IACD,aAAa,EAAE,gBAAgB,CAAC;IAChC,UAAU,EAAE,MAAM,CAAC;CACpB,GAAG,MAAM,CAiDT;AAED;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAAC,EAC5B,aAAa,EACb,UAAU,GACX,EAAE;IACD,aAAa,EAAE,gBAAgB,CAAC;IAChC,UAAU,EAAE,MAAM,CAAC;CACpB,GAAG,MAAM,CAST;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAKjE"}

package/dist/encryption.js

@@ -0,0 +1,179 @@
+import { base64, utf8 } from '@scure/base';
+import * as nacl from 'tweetnacl';
+import { isNullish } from './utils.js';
+/**
+ * Encrypt a message.
+ *
+ * @param options - The encryption options.
+ * @param options.publicKey - The public key of the message recipient.
+ * @param options.data - The message data.
+ * @param options.version - The type of encryption to use.
+ * @returns The encrypted data.
+ */
+export function encrypt({ publicKey, data, version, }) {
+    if (isNullish(publicKey)) {
+        throw new Error('Missing publicKey parameter');
+    }
+    else if (isNullish(data)) {
+        throw new Error('Missing data parameter');
+    }
+    else if (isNullish(version)) {
+        throw new Error('Missing version parameter');
+    }
+    switch (version) {
+        case 'x25519-xsalsa20-poly1305': {
+            if (typeof data !== 'string') {
+                throw new Error('Message data must be given as a string');
+            }
+            // generate ephemeral keypair
+            const ephemeralKeyPair = nacl.box.keyPair();
+            // assemble encryption parameters - from string to UInt8
+            let pubKeyUInt8Array;
+            try {
+                pubKeyUInt8Array = base64.decode(publicKey);
+            }
+            catch {
+                throw new Error('Bad public key');
+            }
+            const msgParamsUInt8Array = utf8.decode(data);
+            const nonce = nacl.randomBytes(nacl.box.nonceLength);
+            // encrypt
+            const encryptedMessage = nacl.box(msgParamsUInt8Array, nonce, pubKeyUInt8Array, ephemeralKeyPair.secretKey);
+            // handle encrypted data
+            const output = {
+                version: 'x25519-xsalsa20-poly1305',
+                nonce: base64.encode(nonce),
+                ephemPublicKey: base64.encode(ephemeralKeyPair.publicKey),
+                ciphertext: base64.encode(encryptedMessage),
+            };
+            // return encrypted msg data
+            return output;
+        }
+        default:
+            throw new Error('Encryption type/version not supported');
+    }
+}
+/**
+ * Encrypt a message in a way that obscures the message length.
+ *
+ * The message is padded to a multiple of 2048 before being encrypted so that the length of the
+ * resulting encrypted message can't be used to guess the exact length of the original message.
+ *
+ * @param options - The encryption options.
+ * @param options.publicKey - The public key of the message recipient.
+ * @param options.data - The message data.
+ * @param options.version - The type of encryption to use.
+ * @returns The encrypted data.
+ */
+export function encryptSafely({ publicKey, data, version, }) {
+    if (isNullish(publicKey)) {
+        throw new Error('Missing publicKey parameter');
+    }
+    else if (isNullish(data)) {
+        throw new Error('Missing data parameter');
+    }
+    else if (isNullish(version)) {
+        throw new Error('Missing version parameter');
+    }
+    const DEFAULT_PADDING_LENGTH = 2 ** 11;
+    const NACL_EXTRA_BYTES = 16;
+    if (typeof data === 'object' && data && 'toJSON' in data) {
+        // remove toJSON attack vector
+        // TODO, check all possible children
+        throw new Error('Cannot encrypt with toJSON property.  Please remove toJSON property');
+    }
+    // add padding
+    const dataWithPadding = {
+        data,
+        padding: '',
+    };
+    // calculate padding
+    const dataLength = Buffer.byteLength(JSON.stringify(dataWithPadding), 'utf-8');
+    const modVal = dataLength % DEFAULT_PADDING_LENGTH;
+    let padLength = 0;
+    // Only pad if necessary
+    if (modVal > 0) {
+        padLength = DEFAULT_PADDING_LENGTH - modVal - NACL_EXTRA_BYTES; // nacl extra bytes
+    }
+    dataWithPadding.padding = '0'.repeat(padLength);
+    const paddedMessage = JSON.stringify(dataWithPadding);
+    return encrypt({ publicKey, data: paddedMessage, version });
+}
+/**
+ * Decrypt a message.
+ *
+ * @param options - The decryption options.
+ * @param options.encryptedData - The encrypted data.
+ * @param options.privateKey - The private key to decrypt with.
+ * @returns The decrypted message.
+ */
+export function decrypt({ encryptedData, privateKey, }) {
+    if (isNullish(encryptedData)) {
+        throw new Error('Missing encryptedData parameter');
+    }
+    else if (isNullish(privateKey)) {
+        throw new Error('Missing privateKey parameter');
+    }
+    switch (encryptedData.version) {
+        case 'x25519-xsalsa20-poly1305': {
+            const receiverPrivateKeyUint8Array = Buffer.from(privateKey, 'hex');
+            const receiverEncryptionPrivateKey = nacl.box.keyPair.fromSecretKey(receiverPrivateKeyUint8Array).secretKey;
+            // assemble decryption parameters
+            const nonce = base64.decode(encryptedData.nonce);
+            const ciphertext = base64.decode(encryptedData.ciphertext);
+            const ephemPublicKey = base64.decode(encryptedData.ephemPublicKey);
+            // decrypt
+            const decryptedMessage = nacl.box.open(ciphertext, nonce, ephemPublicKey, receiverEncryptionPrivateKey);
+            // return decrypted msg data
+            try {
+                if (!decryptedMessage) {
+                    throw new Error();
+                }
+                const output = utf8.encode(decryptedMessage);
+                // TODO: This is probably extraneous but was kept to minimize changes during refactor
+                if (!output) {
+                    throw new Error();
+                }
+                return output;
+            }
+            catch (error) {
+                if (error instanceof Error && error.message.length) {
+                    throw new Error(`Decryption failed: ${error.message}`);
+                }
+                throw new Error(`Decryption failed.`);
+            }
+        }
+        default:
+            throw new Error('Encryption type/version not supported.');
+    }
+}
+/**
+ * Decrypt a message that has been encrypted using `encryptSafely`.
+ *
+ * @param options - The decryption options.
+ * @param options.encryptedData - The encrypted data.
+ * @param options.privateKey - The private key to decrypt with.
+ * @returns The decrypted message.
+ */
+export function decryptSafely({ encryptedData, privateKey, }) {
+    if (isNullish(encryptedData)) {
+        throw new Error('Missing encryptedData parameter');
+    }
+    else if (isNullish(privateKey)) {
+        throw new Error('Missing privateKey parameter');
+    }
+    const dataWithPadding = JSON.parse(decrypt({ encryptedData, privateKey }));
+    return dataWithPadding.data;
+}
+/**
+ * Get the encryption public key for the given key.
+ *
+ * @param privateKey - The private key to generate the encryption public key with.
+ * @returns The encryption public key.
+ */
+export function getEncryptionPublicKey(privateKey) {
+    const privateKeyUint8Array = Buffer.from(privateKey, 'hex');
+    const encryptionPublicKey = nacl.box.keyPair.fromSecretKey(privateKeyUint8Array).publicKey;
+    return base64.encode(encryptionPublicKey);
+}
+//# sourceMappingURL=encryption.js.map

package/dist/encryption.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"encryption.js","sourceRoot":"","sources":["../src/encryption.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAElC,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AASvC;;;;;;;;GAQG;AACH,MAAM,UAAU,OAAO,CAAC,EACtB,SAAS,EACT,IAAI,EACJ,OAAO,GAKR;IACC,IAAI,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC;QACzB,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;IACjD,CAAC;SAAM,IAAI,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;QAC3B,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;IAC5C,CAAC;SAAM,IAAI,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC;QAC9B,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;IAC/C,CAAC;IAED,QAAQ,OAAO,EAAE,CAAC;QAChB,KAAK,0BAA0B,EAAE,CAAC;YAChC,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;gBAC7B,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;YAC5D,CAAC;YACD,6BAA6B;YAC7B,MAAM,gBAAgB,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;YAE5C,wDAAwD;YACxD,IAAI,gBAA4B,CAAC;YACjC,IAAI,CAAC;gBACH,gBAAgB,GAAG,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;YAC9C,CAAC;YAAC,MAAM,CAAC;gBACP,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC;YACpC,CAAC;YAED,MAAM,mBAAmB,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YAC9C,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;YAErD,UAAU;YACV,MAAM,gBAAgB,GAAG,IAAI,CAAC,GAAG,CAC/B,mBAAmB,EACnB,KAAK,EACL,gBAAgB,EAChB,gBAAgB,CAAC,SAAS,CAC3B,CAAC;YAEF,wBAAwB;YACxB,MAAM,MAAM,GAAG;gBACb,OAAO,EAAE,0BAA0B;gBACnC,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC;gBAC3B,cAAc,EAAE,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC,SAAS,CAAC;gBACzD,UAAU,EAAE,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC;aAC5C,CAAC;YACF,4BAA4B;YAC5B,OAAO,MAAM,CAAC;QAChB,CAAC;QAED;YACE,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;IAC7D,CAAC;AACH,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,aAAa,CAAC,EAC5B,SAAS,EACT,IAAI,EACJ,OAAO,GAKR;IACC,IAAI,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC;QACzB,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;IACjD,CAAC;SAAM,IAAI,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;QAC3B,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;IAC5C,CAAC;SAAM,IAAI,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC;QAC9B,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;IAC/C,CAAC;IAED,MAAM,sBAAsB,GAAG,CAAC,IAAI,EAAE,CAAC;IACvC,MAAM,gBAAgB,GAAG,EAAE,CAAC;IAE5B,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;QACzD,8BAA8B;QAC9B,oCAAoC;QACpC,MAAM,IAAI,KAAK,CACb,qEAAqE,CACtE,CAAC;IACJ,CAAC;IAED,cAAc;IACd,MAAM,eAAe,GAAG;QACtB,IAAI;QACJ,OAAO,EAAE,EAAE;KACZ,CAAC;IAEF,oBAAoB;IACpB,MAAM,UAAU,GAAG,MAAM,CAAC,UAAU,CAClC,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,EAC/B,OAAO,CACR,CAAC;IACF,MAAM,MAAM,GAAG,UAAU,GAAG,sBAAsB,CAAC;IACnD,IAAI,SAAS,GAAG,CAAC,CAAC;IAClB,wBAAwB;IACxB,IAAI,MAAM,GAAG,CAAC,EAAE,CAAC;QACf,SAAS,GAAG,sBAAsB,GAAG,MAAM,GAAG,gBAAgB,CAAC,CAAC,mBAAmB;IACrF,CAAC;IACD,eAAe,CAAC,OAAO,GAAG,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAEhD,MAAM,aAAa,GAAG,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;IACtD,OAAO,OAAO,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,aAAa,EAAE,OAAO,EAAE,CAAC,CAAC;AAC9D,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,OAAO,CAAC,EACtB,aAAa,EACb,UAAU,GAIX;IACC,IAAI,SAAS,CAAC,aAAa,CAAC,EAAE,CAAC;QAC7B,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;IACrD,CAAC;SAAM,IAAI,SAAS,CAAC,UAAU,CAAC,EAAE,CAAC;QACjC,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;IAClD,CAAC;IAED,QAAQ,aAAa,CAAC,OAAO,EAAE,CAAC;QAC9B,KAAK,0BAA0B,EAAE,CAAC;YAChC,MAAM,4BAA4B,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;YACpE,MAAM,4BAA4B,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,aAAa,CACjE,4BAA4B,CAC7B,CAAC,SAAS,CAAC;YAEZ,iCAAiC;YACjC,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;YACjD,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;YAC3D,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;YAEnE,UAAU;YACV,MAAM,gBAAgB,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CACpC,UAAU,EACV,KAAK,EACL,cAAc,EACd,4BAA4B,CAC7B,CAAC;YAEF,4BAA4B;YAC5B,IAAI,CAAC;gBACH,IAAI,CAAC,gBAAgB,EAAE,CAAC;oBACtB,MAAM,IAAI,KAAK,EAAE,CAAC;gBACpB,CAAC;gBACD,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC;gBAC7C,qFAAqF;gBACrF,IAAI,CAAC,MAAM,EAAE,CAAC;oBACZ,MAAM,IAAI,KAAK,EAAE,CAAC;gBACpB,CAAC;gBACD,OAAO,MAAM,CAAC;YAChB,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,KAAK,YAAY,KAAK,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;oBACnD,MAAM,IAAI,KAAK,CAAC,sBAAsB,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;gBACzD,CAAC;gBACD,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;YACxC,CAAC;QACH,CAAC;QAED;YACE,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;IAC9D,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,aAAa,CAAC,EAC5B,aAAa,EACb,UAAU,GAIX;IACC,IAAI,SAAS,CAAC,aAAa,CAAC,EAAE,CAAC;QAC7B,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;IACrD,CAAC;SAAM,IAAI,SAAS,CAAC,UAAU,CAAC,EAAE,CAAC;QACjC,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;IAClD,CAAC;IAED,MAAM,eAAe,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,aAAa,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC;IAC3E,OAAO,eAAe,CAAC,IAAI,CAAC;AAC9B,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,sBAAsB,CAAC,UAAkB;IACvD,MAAM,oBAAoB,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;IAC5D,MAAM,mBAAmB,GACvB,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,aAAa,CAAC,oBAAoB,CAAC,CAAC,SAAS,CAAC;IACjE,OAAO,MAAM,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAAC;AAC5C,CAAC","sourcesContent":["import { base64, utf8 } from '@scure/base';\nimport * as nacl from 'tweetnacl';\n\nimport { isNullish } from './utils.js';\n\nexport type EthEncryptedData = {\n  version: string;\n  nonce: string;\n  ephemPublicKey: string;\n  ciphertext: string;\n};\n\n/**\n * Encrypt a message.\n *\n * @param options - The encryption options.\n * @param options.publicKey - The public key of the message recipient.\n * @param options.data - The message data.\n * @param options.version - The type of encryption to use.\n * @returns The encrypted data.\n */\nexport function encrypt({\n  publicKey,\n  data,\n  version,\n}: {\n  publicKey: string;\n  data: unknown;\n  version: string;\n}): EthEncryptedData {\n  if (isNullish(publicKey)) {\n    throw new Error('Missing publicKey parameter');\n  } else if (isNullish(data)) {\n    throw new Error('Missing data parameter');\n  } else if (isNullish(version)) {\n    throw new Error('Missing version parameter');\n  }\n\n  switch (version) {\n    case 'x25519-xsalsa20-poly1305': {\n      if (typeof data !== 'string') {\n        throw new Error('Message data must be given as a string');\n      }\n      // generate ephemeral keypair\n      const ephemeralKeyPair = nacl.box.keyPair();\n\n      // assemble encryption parameters - from string to UInt8\n      let pubKeyUInt8Array: Uint8Array;\n      try {\n        pubKeyUInt8Array = base64.decode(publicKey);\n      } catch {\n        throw new Error('Bad public key');\n      }\n\n      const msgParamsUInt8Array = utf8.decode(data);\n      const nonce = nacl.randomBytes(nacl.box.nonceLength);\n\n      // encrypt\n      const encryptedMessage = nacl.box(\n        msgParamsUInt8Array,\n        nonce,\n        pubKeyUInt8Array,\n        ephemeralKeyPair.secretKey,\n      );\n\n      // handle encrypted data\n      const output = {\n        version: 'x25519-xsalsa20-poly1305',\n        nonce: base64.encode(nonce),\n        ephemPublicKey: base64.encode(ephemeralKeyPair.publicKey),\n        ciphertext: base64.encode(encryptedMessage),\n      };\n      // return encrypted msg data\n      return output;\n    }\n\n    default:\n      throw new Error('Encryption type/version not supported');\n  }\n}\n\n/**\n * Encrypt a message in a way that obscures the message length.\n *\n * The message is padded to a multiple of 2048 before being encrypted so that the length of the\n * resulting encrypted message can't be used to guess the exact length of the original message.\n *\n * @param options - The encryption options.\n * @param options.publicKey - The public key of the message recipient.\n * @param options.data - The message data.\n * @param options.version - The type of encryption to use.\n * @returns The encrypted data.\n */\nexport function encryptSafely({\n  publicKey,\n  data,\n  version,\n}: {\n  publicKey: string;\n  data: unknown;\n  version: string;\n}): EthEncryptedData {\n  if (isNullish(publicKey)) {\n    throw new Error('Missing publicKey parameter');\n  } else if (isNullish(data)) {\n    throw new Error('Missing data parameter');\n  } else if (isNullish(version)) {\n    throw new Error('Missing version parameter');\n  }\n\n  const DEFAULT_PADDING_LENGTH = 2 ** 11;\n  const NACL_EXTRA_BYTES = 16;\n\n  if (typeof data === 'object' && data && 'toJSON' in data) {\n    // remove toJSON attack vector\n    // TODO, check all possible children\n    throw new Error(\n      'Cannot encrypt with toJSON property.  Please remove toJSON property',\n    );\n  }\n\n  // add padding\n  const dataWithPadding = {\n    data,\n    padding: '',\n  };\n\n  // calculate padding\n  const dataLength = Buffer.byteLength(\n    JSON.stringify(dataWithPadding),\n    'utf-8',\n  );\n  const modVal = dataLength % DEFAULT_PADDING_LENGTH;\n  let padLength = 0;\n  // Only pad if necessary\n  if (modVal > 0) {\n    padLength = DEFAULT_PADDING_LENGTH - modVal - NACL_EXTRA_BYTES; // nacl extra bytes\n  }\n  dataWithPadding.padding = '0'.repeat(padLength);\n\n  const paddedMessage = JSON.stringify(dataWithPadding);\n  return encrypt({ publicKey, data: paddedMessage, version });\n}\n\n/**\n * Decrypt a message.\n *\n * @param options - The decryption options.\n * @param options.encryptedData - The encrypted data.\n * @param options.privateKey - The private key to decrypt with.\n * @returns The decrypted message.\n */\nexport function decrypt({\n  encryptedData,\n  privateKey,\n}: {\n  encryptedData: EthEncryptedData;\n  privateKey: string;\n}): string {\n  if (isNullish(encryptedData)) {\n    throw new Error('Missing encryptedData parameter');\n  } else if (isNullish(privateKey)) {\n    throw new Error('Missing privateKey parameter');\n  }\n\n  switch (encryptedData.version) {\n    case 'x25519-xsalsa20-poly1305': {\n      const receiverPrivateKeyUint8Array = Buffer.from(privateKey, 'hex');\n      const receiverEncryptionPrivateKey = nacl.box.keyPair.fromSecretKey(\n        receiverPrivateKeyUint8Array,\n      ).secretKey;\n\n      // assemble decryption parameters\n      const nonce = base64.decode(encryptedData.nonce);\n      const ciphertext = base64.decode(encryptedData.ciphertext);\n      const ephemPublicKey = base64.decode(encryptedData.ephemPublicKey);\n\n      // decrypt\n      const decryptedMessage = nacl.box.open(\n        ciphertext,\n        nonce,\n        ephemPublicKey,\n        receiverEncryptionPrivateKey,\n      );\n\n      // return decrypted msg data\n      try {\n        if (!decryptedMessage) {\n          throw new Error();\n        }\n        const output = utf8.encode(decryptedMessage);\n        // TODO: This is probably extraneous but was kept to minimize changes during refactor\n        if (!output) {\n          throw new Error();\n        }\n        return output;\n      } catch (error) {\n        if (error instanceof Error && error.message.length) {\n          throw new Error(`Decryption failed: ${error.message}`);\n        }\n        throw new Error(`Decryption failed.`);\n      }\n    }\n\n    default:\n      throw new Error('Encryption type/version not supported.');\n  }\n}\n\n/**\n * Decrypt a message that has been encrypted using `encryptSafely`.\n *\n * @param options - The decryption options.\n * @param options.encryptedData - The encrypted data.\n * @param options.privateKey - The private key to decrypt with.\n * @returns The decrypted message.\n */\nexport function decryptSafely({\n  encryptedData,\n  privateKey,\n}: {\n  encryptedData: EthEncryptedData;\n  privateKey: string;\n}): string {\n  if (isNullish(encryptedData)) {\n    throw new Error('Missing encryptedData parameter');\n  } else if (isNullish(privateKey)) {\n    throw new Error('Missing privateKey parameter');\n  }\n\n  const dataWithPadding = JSON.parse(decrypt({ encryptedData, privateKey }));\n  return dataWithPadding.data;\n}\n\n/**\n * Get the encryption public key for the given key.\n *\n * @param privateKey - The private key to generate the encryption public key with.\n * @returns The encryption public key.\n */\nexport function getEncryptionPublicKey(privateKey: string): string {\n  const privateKeyUint8Array = Buffer.from(privateKey, 'hex');\n  const encryptionPublicKey =\n    nacl.box.keyPair.fromSecretKey(privateKeyUint8Array).publicKey;\n  return base64.encode(encryptionPublicKey);\n}\n"]}

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+export * from './personal-sign.js';
+export * from './sign-typed-data.js';
+export * from './encryption.js';
+export * from './sign-eip7702-authorization.js';
+export { concatSig, normalize } from './utils.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,iBAAiB,CAAC;AAChC,cAAc,iCAAiC,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC"}

package/dist/index.js

@@ -0,0 +1,6 @@
+export * from './personal-sign.js';
+export * from './sign-typed-data.js';
+export * from './encryption.js';
+export * from './sign-eip7702-authorization.js';
+export { concatSig, normalize } from './utils.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,iBAAiB,CAAC;AAChC,cAAc,iCAAiC,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC","sourcesContent":["export * from './personal-sign.js';\nexport * from './sign-typed-data.js';\nexport * from './encryption.js';\nexport * from './sign-eip7702-authorization.js';\nexport { concatSig, normalize } from './utils.js';\n"]}

package/dist/personal-sign.d.ts

@@ -0,0 +1,43 @@
+import { ToBufferInputTypes } from '@ethereumjs/util';
+/**
+ * Create an Ethereum-specific signature for a message.
+ *
+ * This function is equivalent to the `eth_sign` Ethereum JSON-RPC method as specified in EIP-1417,
+ * as well as the MetaMask's `personal_sign` method.
+ *
+ * @param options - The personal sign options.
+ * @param options.privateKey - The key to sign with.
+ * @param options.data - The hex data to sign.
+ * @returns The '0x'-prefixed hex encoded signature.
+ */
+export declare function personalSign({ privateKey, data, }: {
+    privateKey: Buffer;
+    data: ToBufferInputTypes;
+}): string;
+/**
+ * Recover the address of the account used to create the given Ethereum signature. The message
+ * must have been signed using the `personalSign` function, or an equivalent function.
+ *
+ * @param options - The signature recovery options.
+ * @param options.data - The hex data that was signed.
+ * @param options.signature - The '0x'-prefixed hex encoded message signature.
+ * @returns The '0x'-prefixed hex encoded address of the message signer.
+ */
+export declare function recoverPersonalSignature({ data, signature, }: {
+    data: ToBufferInputTypes;
+    signature: string;
+}): string;
+/**
+ * Recover the public key of the account used to create the given Ethereum signature. The message
+ * must have been signed using the `personalSign` function, or an equivalent function.
+ *
+ * @param options - The public key recovery options.
+ * @param options.data - The hex data that was signed.
+ * @param options.signature - The '0x'-prefixed hex encoded message signature.
+ * @returns The '0x'-prefixed hex encoded public key of the message signer.
+ */
+export declare function extractPublicKey({ data, signature, }: {
+    data: ToBufferInputTypes;
+    signature: string;
+}): string;
+//# sourceMappingURL=personal-sign.d.ts.map

package/dist/personal-sign.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"personal-sign.d.ts","sourceRoot":"","sources":["../src/personal-sign.ts"],"names":[],"mappings":"AAAA,OAAO,EAML,kBAAkB,EACnB,MAAM,kBAAkB,CAAC;AAS1B;;;;;;;;;;GAUG;AACH,wBAAgB,YAAY,CAAC,EAC3B,UAAU,EACV,IAAI,GACL,EAAE;IACD,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,kBAAkB,CAAC;CAC1B,GAAG,MAAM,CAWT;AAED;;;;;;;;GAQG;AACH,wBAAgB,wBAAwB,CAAC,EACvC,IAAI,EACJ,SAAS,GACV,EAAE;IACD,IAAI,EAAE,kBAAkB,CAAC;IACzB,SAAS,EAAE,MAAM,CAAC;CACnB,GAAG,MAAM,CAWT;AAED;;;;;;;;GAQG;AACH,wBAAgB,gBAAgB,CAAC,EAC/B,IAAI,EACJ,SAAS,GACV,EAAE;IACD,IAAI,EAAE,kBAAkB,CAAC;IACzB,SAAS,EAAE,MAAM,CAAC;CACnB,GAAG,MAAM,CAST"}

package/dist/personal-sign.js

@@ -0,0 +1,77 @@
+import { bufferToHex, ecsign, hashPersonalMessage, publicToAddress, toBuffer, } from '@ethereumjs/util';
+import { concatSig, isNullish, legacyToBuffer, recoverPublicKey, } from './utils.js';
+/**
+ * Create an Ethereum-specific signature for a message.
+ *
+ * This function is equivalent to the `eth_sign` Ethereum JSON-RPC method as specified in EIP-1417,
+ * as well as the MetaMask's `personal_sign` method.
+ *
+ * @param options - The personal sign options.
+ * @param options.privateKey - The key to sign with.
+ * @param options.data - The hex data to sign.
+ * @returns The '0x'-prefixed hex encoded signature.
+ */
+export function personalSign({ privateKey, data, }) {
+    if (isNullish(data)) {
+        throw new Error('Missing data parameter');
+    }
+    else if (isNullish(privateKey)) {
+        throw new Error('Missing privateKey parameter');
+    }
+    const message = legacyToBuffer(data);
+    const msgHash = hashPersonalMessage(message);
+    const signature = ecsign(msgHash, privateKey);
+    return concatSig(toBuffer(signature.v), signature.r, signature.s);
+}
+/**
+ * Recover the address of the account used to create the given Ethereum signature. The message
+ * must have been signed using the `personalSign` function, or an equivalent function.
+ *
+ * @param options - The signature recovery options.
+ * @param options.data - The hex data that was signed.
+ * @param options.signature - The '0x'-prefixed hex encoded message signature.
+ * @returns The '0x'-prefixed hex encoded address of the message signer.
+ */
+export function recoverPersonalSignature({ data, signature, }) {
+    if (isNullish(data)) {
+        throw new Error('Missing data parameter');
+    }
+    else if (isNullish(signature)) {
+        throw new Error('Missing signature parameter');
+    }
+    const publicKey = getPublicKeyFor(data, signature);
+    const sender = publicToAddress(publicKey);
+    const senderHex = bufferToHex(sender);
+    return senderHex;
+}
+/**
+ * Recover the public key of the account used to create the given Ethereum signature. The message
+ * must have been signed using the `personalSign` function, or an equivalent function.
+ *
+ * @param options - The public key recovery options.
+ * @param options.data - The hex data that was signed.
+ * @param options.signature - The '0x'-prefixed hex encoded message signature.
+ * @returns The '0x'-prefixed hex encoded public key of the message signer.
+ */
+export function extractPublicKey({ data, signature, }) {
+    if (isNullish(data)) {
+        throw new Error('Missing data parameter');
+    }
+    else if (isNullish(signature)) {
+        throw new Error('Missing signature parameter');
+    }
+    const publicKey = getPublicKeyFor(data, signature);
+    return `0x${publicKey.toString('hex')}`;
+}
+/**
+ * Get the public key for the given signature and message.
+ *
+ * @param message - The message that was signed.
+ * @param signature - The '0x'-prefixed hex encoded message signature.
+ * @returns The public key of the signer.
+ */
+function getPublicKeyFor(message, signature) {
+    const messageHash = hashPersonalMessage(legacyToBuffer(message));
+    return recoverPublicKey(messageHash, signature);
+}
+//# sourceMappingURL=personal-sign.js.map

package/dist/personal-sign.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"personal-sign.js","sourceRoot":"","sources":["../src/personal-sign.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,MAAM,EACN,mBAAmB,EACnB,eAAe,EACf,QAAQ,GAET,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EACL,SAAS,EACT,SAAS,EACT,cAAc,EACd,gBAAgB,GACjB,MAAM,YAAY,CAAC;AAEpB;;;;;;;;;;GAUG;AACH,MAAM,UAAU,YAAY,CAAC,EAC3B,UAAU,EACV,IAAI,GAIL;IACC,IAAI,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;QACpB,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;IAC5C,CAAC;SAAM,IAAI,SAAS,CAAC,UAAU,CAAC,EAAE,CAAC;QACjC,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;IAClD,CAAC;IAED,MAAM,OAAO,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC;IACrC,MAAM,OAAO,GAAG,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAC7C,MAAM,SAAS,GAAG,MAAM,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;IAC9C,OAAO,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;AACpE,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,wBAAwB,CAAC,EACvC,IAAI,EACJ,SAAS,GAIV;IACC,IAAI,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;QACpB,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;IAC5C,CAAC;SAAM,IAAI,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC;QAChC,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;IACjD,CAAC;IAED,MAAM,SAAS,GAAG,eAAe,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;IACnD,MAAM,MAAM,GAAG,eAAe,CAAC,SAAS,CAAC,CAAC;IAC1C,MAAM,SAAS,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC;IACtC,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,gBAAgB,CAAC,EAC/B,IAAI,EACJ,SAAS,GAIV;IACC,IAAI,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;QACpB,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;IAC5C,CAAC;SAAM,IAAI,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC;QAChC,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;IACjD,CAAC;IAED,MAAM,SAAS,GAAG,eAAe,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;IACnD,OAAO,KAAK,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;AAC1C,CAAC;AAED;;;;;;GAMG;AACH,SAAS,eAAe,CACtB,OAA2B,EAC3B,SAAiB;IAEjB,MAAM,WAAW,GAAG,mBAAmB,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC;IACjE,OAAO,gBAAgB,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;AAClD,CAAC","sourcesContent":["import {\n  bufferToHex,\n  ecsign,\n  hashPersonalMessage,\n  publicToAddress,\n  toBuffer,\n  ToBufferInputTypes,\n} from '@ethereumjs/util';\n\nimport {\n  concatSig,\n  isNullish,\n  legacyToBuffer,\n  recoverPublicKey,\n} from './utils.js';\n\n/**\n * Create an Ethereum-specific signature for a message.\n *\n * This function is equivalent to the `eth_sign` Ethereum JSON-RPC method as specified in EIP-1417,\n * as well as the MetaMask's `personal_sign` method.\n *\n * @param options - The personal sign options.\n * @param options.privateKey - The key to sign with.\n * @param options.data - The hex data to sign.\n * @returns The '0x'-prefixed hex encoded signature.\n */\nexport function personalSign({\n  privateKey,\n  data,\n}: {\n  privateKey: Buffer;\n  data: ToBufferInputTypes;\n}): string {\n  if (isNullish(data)) {\n    throw new Error('Missing data parameter');\n  } else if (isNullish(privateKey)) {\n    throw new Error('Missing privateKey parameter');\n  }\n\n  const message = legacyToBuffer(data);\n  const msgHash = hashPersonalMessage(message);\n  const signature = ecsign(msgHash, privateKey);\n  return concatSig(toBuffer(signature.v), signature.r, signature.s);\n}\n\n/**\n * Recover the address of the account used to create the given Ethereum signature. The message\n * must have been signed using the `personalSign` function, or an equivalent function.\n *\n * @param options - The signature recovery options.\n * @param options.data - The hex data that was signed.\n * @param options.signature - The '0x'-prefixed hex encoded message signature.\n * @returns The '0x'-prefixed hex encoded address of the message signer.\n */\nexport function recoverPersonalSignature({\n  data,\n  signature,\n}: {\n  data: ToBufferInputTypes;\n  signature: string;\n}): string {\n  if (isNullish(data)) {\n    throw new Error('Missing data parameter');\n  } else if (isNullish(signature)) {\n    throw new Error('Missing signature parameter');\n  }\n\n  const publicKey = getPublicKeyFor(data, signature);\n  const sender = publicToAddress(publicKey);\n  const senderHex = bufferToHex(sender);\n  return senderHex;\n}\n\n/**\n * Recover the public key of the account used to create the given Ethereum signature. The message\n * must have been signed using the `personalSign` function, or an equivalent function.\n *\n * @param options - The public key recovery options.\n * @param options.data - The hex data that was signed.\n * @param options.signature - The '0x'-prefixed hex encoded message signature.\n * @returns The '0x'-prefixed hex encoded public key of the message signer.\n */\nexport function extractPublicKey({\n  data,\n  signature,\n}: {\n  data: ToBufferInputTypes;\n  signature: string;\n}): string {\n  if (isNullish(data)) {\n    throw new Error('Missing data parameter');\n  } else if (isNullish(signature)) {\n    throw new Error('Missing signature parameter');\n  }\n\n  const publicKey = getPublicKeyFor(data, signature);\n  return `0x${publicKey.toString('hex')}`;\n}\n\n/**\n * Get the public key for the given signature and message.\n *\n * @param message - The message that was signed.\n * @param signature - The '0x'-prefixed hex encoded message signature.\n * @returns The public key of the signer.\n */\nfunction getPublicKeyFor(\n  message: ToBufferInputTypes,\n  signature: string,\n): Buffer {\n  const messageHash = hashPersonalMessage(legacyToBuffer(message));\n  return recoverPublicKey(messageHash, signature);\n}\n"]}

package/dist/sign-eip7702-authorization.d.ts

@@ -0,0 +1,46 @@
+/**
+ * The authorization struct as defined in EIP-7702.
+ *
+ * @property chainId - The chain ID or 0 for any chain.
+ * @property contractAddress - The address of the contract being authorized.
+ * @property nonce - The nonce of the signing account (at the time of submission).
+ */
+export type EIP7702Authorization = [
+    chainId: number,
+    contractAddress: string,
+    nonce: number
+];
+/**
+ * Sign an authorization message with the provided private key.
+ *
+ * @param options - The signing options.
+ * @param options.privateKey - The private key to sign with.
+ * @param options.authorization - The authorization data to sign.
+ * @returns The '0x'-prefixed hex encoded signature.
+ */
+export declare function signEIP7702Authorization({ privateKey, authorization, }: {
+    privateKey: Buffer;
+    authorization: EIP7702Authorization;
+}): string;
+/**
+ * Recover the address of the account that created the given authorization
+ * signature.
+ *
+ * @param options - The signature recovery options.
+ * @param options.signature - The '0x'-prefixed hex encoded message signature.
+ * @param options.authorization - The authorization data that was signed.
+ * @returns The '0x'-prefixed hex address of the signer.
+ */
+export declare function recoverEIP7702Authorization({ signature, authorization, }: {
+    signature: string;
+    authorization: EIP7702Authorization;
+}): string;
+/**
+ * Hash an authorization message according to the signing scheme.
+ * The message is encoded according to EIP-7702.
+ *
+ * @param authorization - The authorization data to hash.
+ * @returns The hash of the authorization message as a Buffer.
+ */
+export declare function hashEIP7702Authorization(authorization: EIP7702Authorization): Buffer;
+//# sourceMappingURL=sign-eip7702-authorization.d.ts.map

package/dist/sign-eip7702-authorization.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sign-eip7702-authorization.d.ts","sourceRoot":"","sources":["../src/sign-eip7702-authorization.ts"],"names":[],"mappings":"AAWA;;;;;;GAMG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,OAAO,EAAE,MAAM;IACf,eAAe,EAAE,MAAM;IACvB,KAAK,EAAE,MAAM;CACd,CAAC;AAEF;;;;;;;GAOG;AACH,wBAAgB,wBAAwB,CAAC,EACvC,UAAU,EACV,aAAa,GACd,EAAE;IACD,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,EAAE,oBAAoB,CAAC;CACrC,GAAG,MAAM,CAeT;AAED;;;;;;;;GAQG;AACH,wBAAgB,2BAA2B,CAAC,EAC1C,SAAS,EACT,aAAa,GACd,EAAE;IACD,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,oBAAoB,CAAC;CACrC,GAAG,MAAM,CAcT;AAED;;;;;;GAMG;AACH,wBAAgB,wBAAwB,CACtC,aAAa,EAAE,oBAAoB,GAClC,MAAM,CAWR"}

package/dist/sign-eip7702-authorization.js

@@ -0,0 +1,97 @@
+import { encode } from '@ethereumjs/rlp';
+import { ecsign, publicToAddress, toBuffer } from '@ethereumjs/util';
+import { bytesToHex, isValidHexAddress } from '@metamask/utils';
+import { keccak256 } from 'ethereum-cryptography/keccak';
+import { concatSig, isNullish, recoverPublicKey } from './utils.js';
+const CHAIN_ID_MAX_BITLENGTH = 256;
+const NONCE_MAX_BITLENGTH = 64;
+const ADDRESS_BYTE_LENGTH = 20;
+/**
+ * Sign an authorization message with the provided private key.
+ *
+ * @param options - The signing options.
+ * @param options.privateKey - The private key to sign with.
+ * @param options.authorization - The authorization data to sign.
+ * @returns The '0x'-prefixed hex encoded signature.
+ */
+export function signEIP7702Authorization({ privateKey, authorization, }) {
+    validateEIP7702Authorization(authorization);
+    if (isNullish(privateKey)) {
+        throw new Error('Missing privateKey parameter');
+    }
+    const messageHash = hashEIP7702Authorization(authorization);
+    const { r, s, v } = ecsign(messageHash, privateKey);
+    // v is either 27n or 28n so is guaranteed to be a single byte
+    const vBuffer = toBuffer(v);
+    return concatSig(vBuffer, r, s);
+}
+/**
+ * Recover the address of the account that created the given authorization
+ * signature.
+ *
+ * @param options - The signature recovery options.
+ * @param options.signature - The '0x'-prefixed hex encoded message signature.
+ * @param options.authorization - The authorization data that was signed.
+ * @returns The '0x'-prefixed hex address of the signer.
+ */
+export function recoverEIP7702Authorization({ signature, authorization, }) {
+    validateEIP7702Authorization(authorization);
+    if (isNullish(signature)) {
+        throw new Error('Missing signature parameter');
+    }
+    const messageHash = hashEIP7702Authorization(authorization);
+    const publicKey = recoverPublicKey(messageHash, signature);
+    const sender = publicToAddress(publicKey);
+    return bytesToHex(sender);
+}
+/**
+ * Hash an authorization message according to the signing scheme.
+ * The message is encoded according to EIP-7702.
+ *
+ * @param authorization - The authorization data to hash.
+ * @returns The hash of the authorization message as a Buffer.
+ */
+export function hashEIP7702Authorization(authorization) {
+    validateEIP7702Authorization(authorization);
+    const encodedAuthorization = encode(authorization);
+    const message = Buffer.concat([
+        Buffer.from('05', 'hex'),
+        encodedAuthorization,
+    ]);
+    return Buffer.from(keccak256(message));
+}
+/**
+ * Validates an authorization object to ensure all required parameters are present.
+ *
+ * @param authorization - The authorization object to validate.
+ * @throws {Error} If the authorization object or any of its required parameters are missing.
+ */
+function validateEIP7702Authorization(authorization) {
+    if (isNullish(authorization)) {
+        throw new Error('Missing authorization parameter');
+    }
+    const [chainId, contractAddress, nonce] = authorization;
+    if (isNullish(chainId)) {
+        throw new Error('Missing chainId parameter');
+    }
+    if (isNullish(contractAddress)) {
+        throw new Error('Missing contractAddress parameter');
+    }
+    if (isNullish(nonce)) {
+        throw new Error('Missing nonce parameter');
+    }
+    if (typeof chainId !== 'number' ||
+        chainId >= 2 ** CHAIN_ID_MAX_BITLENGTH ||
+        chainId < 0) {
+        throw new Error(`Invalid chainId: must be a non-negative number less than 2^${CHAIN_ID_MAX_BITLENGTH}`);
+    }
+    if (typeof nonce !== 'number' ||
+        nonce >= 2 ** NONCE_MAX_BITLENGTH ||
+        nonce < 0) {
+        throw new Error(`Invalid nonce: must be a non-negative number less than 2^${NONCE_MAX_BITLENGTH}`);
+    }
+    if (!isValidHexAddress(contractAddress)) {
+        throw new Error(`Invalid contractAddress: must be a ${ADDRESS_BYTE_LENGTH} byte hex string`);
+    }
+}
+//# sourceMappingURL=sign-eip7702-authorization.js.map