@0xsequence/account 2.2.14 → 2.2.15

package/dist/0xsequence-account.cjs.dev.js

@@ -72,6 +72,25 @@ class AccountSigner {
   async getAddress() {
     return this.account.address;
   }
+
+  /**
+   * Signs a message.
+   * 
+   * This method will sign the message using the account associated with this signer
+   * and the specified chain ID. The message is already being prefixed with the EIP-191 prefix.
+   * 
+   * @param message - The message to sign. Can be a string or BytesLike.
+   * @returns A Promise that resolves to the signature as a hexadecimal string
+   * 
+   * @example
+   * ```typescript
+   * const signer = account.getSigner(chainId)
+   * 
+   * const message = "Hello, Sequence!";
+   * const signature = await signer.signMessage(message);
+   * console.log(signature);
+   * // => "0x123abc..." (hexadecimal signature)
+   */
   signMessage(message) {
     var _this$options$cantVal, _this$options;
     return this.account.signMessage(message, this.chainId, (_this$options$cantVal = (_this$options = this.options) == null ? void 0 : _this$options.cantValidateBehavior) != null ? _this$options$cantVal : 'throw');
@@ -781,8 +800,32 @@ class Account {
       chainId
     }), feeQuote);
   }
+
+  /**
+   * Signs a message.
+   * 
+   * This method will sign the message using the account associated with this signer
+   * and the specified chain ID. If the message is already prefixed with the EIP-191 
+   * prefix, it will be hashed directly. Otherwise, it will be prefixed before hashing.
+   * 
+   * @param message - The message to sign. Can be a string or BytesLike.
+   * @param chainId - The chain ID to use for signing
+   * @param cantValidateBehavior - Behavior when the wallet cannot validate on-chain
+   * @returns A Promise that resolves to the signature as a hexadecimal string
+   */
   signMessage(message, chainId, cantValidateBehavior = 'ignore') {
-    return this.signDigest(ethers.ethers.keccak256(message), chainId, true, cantValidateBehavior);
+    const messageHex = ethers.ethers.hexlify(message);
+    const prefixHex = ethers.ethers.hexlify(ethers.ethers.toUtf8Bytes(ethers.MessagePrefix));
+    let digest;
+
+    // We check if the message is already prefixed with EIP-191
+    // This will avoid breaking changes for codebases where the message is already prefixed
+    if (messageHex.substring(2).startsWith(prefixHex.substring(2))) {
+      digest = ethers.ethers.keccak256(message);
+    } else {
+      digest = ethers.ethers.hashMessage(message);
+    }
+    return this.signDigest(digest, chainId, true, cantValidateBehavior);
   }
   async signTransactions(txs, chainId, pstatus, options) {
     const status = pstatus || (await this.status(chainId));

package/dist/0xsequence-account.cjs.prod.js

@@ -72,6 +72,25 @@ class AccountSigner {
   async getAddress() {
     return this.account.address;
   }
+
+  /**
+   * Signs a message.
+   * 
+   * This method will sign the message using the account associated with this signer
+   * and the specified chain ID. The message is already being prefixed with the EIP-191 prefix.
+   * 
+   * @param message - The message to sign. Can be a string or BytesLike.
+   * @returns A Promise that resolves to the signature as a hexadecimal string
+   * 
+   * @example
+   * ```typescript
+   * const signer = account.getSigner(chainId)
+   * 
+   * const message = "Hello, Sequence!";
+   * const signature = await signer.signMessage(message);
+   * console.log(signature);
+   * // => "0x123abc..." (hexadecimal signature)
+   */
   signMessage(message) {
     var _this$options$cantVal, _this$options;
     return this.account.signMessage(message, this.chainId, (_this$options$cantVal = (_this$options = this.options) == null ? void 0 : _this$options.cantValidateBehavior) != null ? _this$options$cantVal : 'throw');
@@ -781,8 +800,32 @@ class Account {
       chainId
     }), feeQuote);
   }
+
+  /**
+   * Signs a message.
+   * 
+   * This method will sign the message using the account associated with this signer
+   * and the specified chain ID. If the message is already prefixed with the EIP-191 
+   * prefix, it will be hashed directly. Otherwise, it will be prefixed before hashing.
+   * 
+   * @param message - The message to sign. Can be a string or BytesLike.
+   * @param chainId - The chain ID to use for signing
+   * @param cantValidateBehavior - Behavior when the wallet cannot validate on-chain
+   * @returns A Promise that resolves to the signature as a hexadecimal string
+   */
   signMessage(message, chainId, cantValidateBehavior = 'ignore') {
-    return this.signDigest(ethers.ethers.keccak256(message), chainId, true, cantValidateBehavior);
+    const messageHex = ethers.ethers.hexlify(message);
+    const prefixHex = ethers.ethers.hexlify(ethers.ethers.toUtf8Bytes(ethers.MessagePrefix));
+    let digest;
+
+    // We check if the message is already prefixed with EIP-191
+    // This will avoid breaking changes for codebases where the message is already prefixed
+    if (messageHex.substring(2).startsWith(prefixHex.substring(2))) {
+      digest = ethers.ethers.keccak256(message);
+    } else {
+      digest = ethers.ethers.hashMessage(message);
+    }
+    return this.signDigest(digest, chainId, true, cantValidateBehavior);
   }
   async signTransactions(txs, chainId, pstatus, options) {
     const status = pstatus || (await this.status(chainId));

package/dist/0xsequence-account.esm.js

@@ -5,7 +5,7 @@ import { ChainId } from '@0xsequence/network';
 import { proto, isRelayer, RpcRelayer } from '@0xsequence/relayer';
 import { toHexString, getFetchRequest, encodeTypedDataDigest } from '@0xsequence/utils';
 import { Wallet } from '@0xsequence/wallet';
-import { ethers } from 'ethers';
+import { ethers, MessagePrefix } from 'ethers';
 
 function _extends() {
   return _extends = Object.assign ? Object.assign.bind() : function (n) {
@@ -68,6 +68,25 @@ class AccountSigner {
   async getAddress() {
     return this.account.address;
   }
+
+  /**
+   * Signs a message.
+   * 
+   * This method will sign the message using the account associated with this signer
+   * and the specified chain ID. The message is already being prefixed with the EIP-191 prefix.
+   * 
+   * @param message - The message to sign. Can be a string or BytesLike.
+   * @returns A Promise that resolves to the signature as a hexadecimal string
+   * 
+   * @example
+   * ```typescript
+   * const signer = account.getSigner(chainId)
+   * 
+   * const message = "Hello, Sequence!";
+   * const signature = await signer.signMessage(message);
+   * console.log(signature);
+   * // => "0x123abc..." (hexadecimal signature)
+   */
   signMessage(message) {
     var _this$options$cantVal, _this$options;
     return this.account.signMessage(message, this.chainId, (_this$options$cantVal = (_this$options = this.options) == null ? void 0 : _this$options.cantValidateBehavior) != null ? _this$options$cantVal : 'throw');
@@ -777,8 +796,32 @@ class Account {
       chainId
     }), feeQuote);
   }
+
+  /**
+   * Signs a message.
+   * 
+   * This method will sign the message using the account associated with this signer
+   * and the specified chain ID. If the message is already prefixed with the EIP-191 
+   * prefix, it will be hashed directly. Otherwise, it will be prefixed before hashing.
+   * 
+   * @param message - The message to sign. Can be a string or BytesLike.
+   * @param chainId - The chain ID to use for signing
+   * @param cantValidateBehavior - Behavior when the wallet cannot validate on-chain
+   * @returns A Promise that resolves to the signature as a hexadecimal string
+   */
   signMessage(message, chainId, cantValidateBehavior = 'ignore') {
-    return this.signDigest(ethers.keccak256(message), chainId, true, cantValidateBehavior);
+    const messageHex = ethers.hexlify(message);
+    const prefixHex = ethers.hexlify(ethers.toUtf8Bytes(MessagePrefix));
+    let digest;
+
+    // We check if the message is already prefixed with EIP-191
+    // This will avoid breaking changes for codebases where the message is already prefixed
+    if (messageHex.substring(2).startsWith(prefixHex.substring(2))) {
+      digest = ethers.keccak256(message);
+    } else {
+      digest = ethers.hashMessage(message);
+    }
+    return this.signDigest(digest, chainId, true, cantValidateBehavior);
   }
   async signTransactions(txs, chainId, pstatus, options) {
     const status = pstatus || (await this.status(chainId));

package/dist/declarations/src/account.d.ts

@@ -1,9 +1,9 @@
 import { commons } from '@0xsequence/core';
 import { migrator } from '@0xsequence/migration';
 import { ChainId, NetworkConfig } from '@0xsequence/network';
-import { FeeOption, FeeQuote, Relayer } from '@0xsequence/relayer';
-import { tracker } from '@0xsequence/sessions';
-import { SignatureOrchestrator } from '@0xsequence/signhub';
+import { type FeeOption, type FeeQuote, type Relayer } from '@0xsequence/relayer';
+import type { tracker } from '@0xsequence/sessions';
+import type { SignatureOrchestrator } from '@0xsequence/signhub';
 import { Wallet } from '@0xsequence/wallet';
 import { ethers } from 'ethers';
 import { AccountSigner, AccountSignerOptions } from "./signer.js";
@@ -114,6 +114,18 @@ export declare class Account {
     buildBootstrapTransactions(status: AccountStatus, chainId: ethers.BigNumberish): Promise<commons.transaction.IntendedTransactionBundle>;
     bootstrapTransactions(chainId: ethers.BigNumberish, prestatus?: AccountStatus): Promise<Omit<commons.transaction.IntendedTransactionBundle, 'chainId'>>;
     doBootstrap(chainId: ethers.BigNumberish, feeQuote?: FeeQuote, prestatus?: AccountStatus): Promise<commons.transaction.TransactionResponse<any>>;
+    /**
+     * Signs a message.
+     *
+     * This method will sign the message using the account associated with this signer
+     * and the specified chain ID. If the message is already prefixed with the EIP-191
+     * prefix, it will be hashed directly. Otherwise, it will be prefixed before hashing.
+     *
+     * @param message - The message to sign. Can be a string or BytesLike.
+     * @param chainId - The chain ID to use for signing
+     * @param cantValidateBehavior - Behavior when the wallet cannot validate on-chain
+     * @returns A Promise that resolves to the signature as a hexadecimal string
+     */
     signMessage(message: ethers.BytesLike, chainId: ethers.BigNumberish, cantValidateBehavior?: 'ignore' | 'eip6492' | 'throw'): Promise<string>;
     signTransactions(txs: commons.transaction.Transactionish, chainId: ethers.BigNumberish, pstatus?: AccountStatus, options?: {
         nonceSpace?: ethers.BigNumberish;

package/dist/declarations/src/signer.d.ts

@@ -16,6 +16,24 @@ export declare class AccountSigner implements ethers.AbstractSigner<ethers.Provi
     constructor(account: Account, chainId: ChainId, options?: AccountSignerOptions | undefined);
     get provider(): ethers.Provider;
     getAddress(): Promise<string>;
+    /**
+     * Signs a message.
+     *
+     * This method will sign the message using the account associated with this signer
+     * and the specified chain ID. The message is already being prefixed with the EIP-191 prefix.
+     *
+     * @param message - The message to sign. Can be a string or BytesLike.
+     * @returns A Promise that resolves to the signature as a hexadecimal string
+     *
+     * @example
+     * ```typescript
+     * const signer = account.getSigner(chainId)
+     *
+     * const message = "Hello, Sequence!";
+     * const signature = await signer.signMessage(message);
+     * console.log(signature);
+     * // => "0x123abc..." (hexadecimal signature)
+     */
     signMessage(message: string | ethers.BytesLike): Promise<string>;
     signTypedData(domain: ethers.TypedDataDomain, types: Record<string, Array<ethers.TypedDataField>>, value: Record<string, any>): Promise<string>;
     private defaultSelectFee;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@0xsequence/account",
-  "version": "2.2.14",
+  "version": "2.2.15",
   "description": "tools for migrating sequence wallets to new versions",
   "repository": "https://github.com/0xsequence/sequence.js/tree/master/packages/account",
   "source": "src/index.ts",
@@ -12,21 +12,21 @@
     "ethers": ">=6"
   },
   "dependencies": {
-    "@0xsequence/migration": "2.2.14",
-    "@0xsequence/abi": "2.2.14",
-    "@0xsequence/relayer": "2.2.14",
-    "@0xsequence/core": "2.2.14",
-    "@0xsequence/network": "2.2.14",
-    "@0xsequence/wallet": "2.2.14",
-    "@0xsequence/sessions": "2.2.14",
-    "@0xsequence/utils": "2.2.14"
+    "@0xsequence/abi": "2.2.15",
+    "@0xsequence/core": "2.2.15",
+    "@0xsequence/relayer": "2.2.15",
+    "@0xsequence/migration": "2.2.15",
+    "@0xsequence/network": "2.2.15",
+    "@0xsequence/sessions": "2.2.15",
+    "@0xsequence/utils": "2.2.15",
+    "@0xsequence/wallet": "2.2.15"
   },
   "devDependencies": {
     "@istanbuljs/nyc-config-typescript": "^1.0.2",
     "ethers": "6.13.4",
     "nyc": "^15.1.0",
-    "@0xsequence/tests": "2.2.14",
-    "@0xsequence/signhub": "2.2.14"
+    "@0xsequence/signhub": "2.2.15",
+    "@0xsequence/tests": "2.2.15"
   },
   "files": [
     "src",

package/src/account.ts

@@ -2,12 +2,12 @@ import { walletContracts } from '@0xsequence/abi'
 import { commons, universal } from '@0xsequence/core'
 import { migrator, defaults, version } from '@0xsequence/migration'
 import { ChainId, NetworkConfig } from '@0xsequence/network'
-import { FeeOption, FeeQuote, isRelayer, Relayer, RpcRelayer } from '@0xsequence/relayer'
-import { tracker } from '@0xsequence/sessions'
-import { SignatureOrchestrator } from '@0xsequence/signhub'
+import { type FeeOption, type FeeQuote, isRelayer, type Relayer, RpcRelayer } from '@0xsequence/relayer'
+import type { tracker } from '@0xsequence/sessions'
+import type { SignatureOrchestrator } from '@0xsequence/signhub'
 import { encodeTypedDataDigest, getFetchRequest } from '@0xsequence/utils'
 import { Wallet } from '@0xsequence/wallet'
-import { ethers } from 'ethers'
+import { ethers, MessagePrefix } from 'ethers'
 import { AccountSigner, AccountSignerOptions } from './signer'
 
 export type AccountStatus = {
@@ -788,12 +788,37 @@ export class Account {
     return this.relayer(chainId).relay({ ...bootstrapTxs, chainId }, feeQuote)
   }
 
+  /**
+   * Signs a message.
+   * 
+   * This method will sign the message using the account associated with this signer
+   * and the specified chain ID. If the message is already prefixed with the EIP-191 
+   * prefix, it will be hashed directly. Otherwise, it will be prefixed before hashing.
+   * 
+   * @param message - The message to sign. Can be a string or BytesLike.
+   * @param chainId - The chain ID to use for signing
+   * @param cantValidateBehavior - Behavior when the wallet cannot validate on-chain
+   * @returns A Promise that resolves to the signature as a hexadecimal string
+   */
   signMessage(
     message: ethers.BytesLike,
     chainId: ethers.BigNumberish,
     cantValidateBehavior: 'ignore' | 'eip6492' | 'throw' = 'ignore'
   ): Promise<string> {
-    return this.signDigest(ethers.keccak256(message), chainId, true, cantValidateBehavior)
+    const messageHex = ethers.hexlify(message);
+    const prefixHex = ethers.hexlify(ethers.toUtf8Bytes(MessagePrefix));
+    
+    let digest: string;
+    
+    // We check if the message is already prefixed with EIP-191
+    // This will avoid breaking changes for codebases where the message is already prefixed
+    if (messageHex.substring(2).startsWith(prefixHex.substring(2))) {
+      digest = ethers.keccak256(message);
+    } else {
+      digest = ethers.hashMessage(message);
+    }
+    
+    return this.signDigest(digest, chainId, true, cantValidateBehavior);
   }
 
   async signTransactions(

package/src/signer.ts

@@ -77,6 +77,24 @@ export class AccountSigner implements ethers.AbstractSigner<ethers.Provider> {
     return this.account.address
   }
 
+  /**
+   * Signs a message.
+   * 
+   * This method will sign the message using the account associated with this signer
+   * and the specified chain ID. The message is already being prefixed with the EIP-191 prefix.
+   * 
+   * @param message - The message to sign. Can be a string or BytesLike.
+   * @returns A Promise that resolves to the signature as a hexadecimal string
+   * 
+   * @example
+   * ```typescript
+   * const signer = account.getSigner(chainId)
+   * 
+   * const message = "Hello, Sequence!";
+   * const signature = await signer.signMessage(message);
+   * console.log(signature);
+   * // => "0x123abc..." (hexadecimal signature)
+   */
   signMessage(message: string | ethers.BytesLike): Promise<string> {
     return this.account.signMessage(message, this.chainId, this.options?.cantValidateBehavior ?? 'throw')
   }