viem 0.0.0-main.20240506T054257 → 0.0.0-main.20240506T074619

package/utils/signature/compactSignatureToSignature.ts

@@ -15,7 +15,7 @@ export type CompactSignatureToSignatureErrorType =
  * @returns The compact signature in signature format.
  *
  * @example
- * compactSignatureToHex({
+ * compactSignatureToSignature({
  *   r: '0x68a020a209d3d56c46f38cc50a33f704f4a9a10a59377f8dd762ac66910e9b90',
  *   yParityAndS: '0x7e865ad05c4035ab5792787d4a0297a43617ae897930a6fe4d822b8faea52064',
  * })

package/utils/signature/isErc6492Signature.ts

@@ -0,0 +1,15 @@
+import { erc6492MagicBytes } from '../../constants/bytes.js'
+import type { ErrorType } from '../../errors/utils.js'
+import type { Hex } from '../../types/misc.js'
+import { type SliceHexErrorType, sliceHex } from '../data/slice.js'
+
+export type IsErc6492SignatureParameters = Hex
+export type IsErc6492SignatureReturnType = boolean
+export type IsErc6492SignatureErrorType = SliceHexErrorType | ErrorType
+
+/** Whether or not the signature is an ERC-6492 formatted signature. */
+export function isErc6492Signature(
+  signature: IsErc6492SignatureParameters,
+): IsErc6492SignatureReturnType {
+  return sliceHex(signature, -32) === erc6492MagicBytes
+}

package/utils/signature/{hexToCompactSignature.ts → parseCompactSignature.ts}

@@ -2,12 +2,9 @@ import { secp256k1 } from '@noble/curves/secp256k1'
 
 import type { ErrorType } from '../../errors/utils.js'
 import type { CompactSignature, Hex } from '../../types/misc.js'
-import {
-  type NumberToHexErrorType,
-  numberToHex,
-} from '../../utils/encoding/toHex.js'
+import { type NumberToHexErrorType, numberToHex } from '../encoding/toHex.js'
 
-export type HexToCompactSignatureErrorType = NumberToHexErrorType | ErrorType
+export type ParseCompactSignatureErrorType = NumberToHexErrorType | ErrorType
 
 /**
  * @description Parses a hex formatted compact signature into a structured compact signature.
@@ -16,10 +13,10 @@ export type HexToCompactSignatureErrorType = NumberToHexErrorType | ErrorType
  * @returns The structured signature.
  *
  * @example
- * hexToCompactSignature('0x6e100a352ec6ad1b70802290e18aeed190704973570f3b8ed42cb9808e2ea6bf4a90a229a244495b41890987806fcbd2d5d23fc0dbe5f5256c2613c039d76db81c')
+ * parseCompactSignature('0x6e100a352ec6ad1b70802290e18aeed190704973570f3b8ed42cb9808e2ea6bf4a90a229a244495b41890987806fcbd2d5d23fc0dbe5f5256c2613c039d76db81c')
  * // { r: '0x...', yParityAndS: '0x...' }
  */
-export function hexToCompactSignature(signatureHex: Hex): CompactSignature {
+export function parseCompactSignature(signatureHex: Hex): CompactSignature {
   const { r, s } = secp256k1.Signature.fromCompact(signatureHex.slice(2, 130))
   return {
     r: numberToHex(r, { size: 32 }),

package/utils/signature/parseErc6492Signature.ts

@@ -0,0 +1,65 @@
+import type { Address } from 'abitype'
+import type { ErrorType } from '../../errors/utils.js'
+import type { Hex } from '../../types/misc.js'
+import type { OneOf, Prettify } from '../../types/utils.js'
+import {
+  type DecodeAbiParametersErrorType,
+  decodeAbiParameters,
+} from '../abi/decodeAbiParameters.js'
+import {
+  type IsErc6492SignatureErrorType,
+  isErc6492Signature,
+} from './isErc6492Signature.js'
+
+export type ParseErc6492SignatureParameters = Hex
+
+export type ParseErc6492SignatureReturnType = Prettify<
+  OneOf<
+    | {
+        /**
+         * The ERC-4337 Account Factory address to use for counterfactual verification.
+         * `undefined` if the signature is not in ERC-6492 format.
+         */
+        factoryAddress: Address
+        /**
+         * Calldata to pass to deploy account (if not deployed) for counterfactual verification.
+         * `undefined` if the signature is not in ERC-6492 format.
+         */
+        factoryData: Hex
+        /** The original signature. */
+        signature: Hex
+      }
+    | {
+        /** The original signature. */
+        signature: Hex
+      }
+  >
+>
+
+export type ParseErc6492SignatureErrorType =
+  | IsErc6492SignatureErrorType
+  | DecodeAbiParametersErrorType
+  | ErrorType
+
+/**
+ * @description Parses a hex-formatted ERC-6492 flavoured signature.
+ * If the signature is not in ERC-6492 format, then the underlying (original) signature is returned.
+ *
+ * @param signature ERC-6492 signature in hex format.
+ * @returns The parsed ERC-6492 signature.
+ *
+ * @example
+ * parseSignature('0x000000000000000000000000cafebabecafebabecafebabecafebabecafebabe000000000000000000000000000000000000000000000000000000000000006000000000000000000000000000000000000000000000000000000000000000a00000000000000000000000000000000000000000000000000000000000000004deadbeef000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000041a461f509887bd19e312c0c58467ce8ff8e300d3c1a90b608a760c5b80318eaf15fe57c96f9175d6cd4daad4663763baa7e78836e067d0163e9a2ccf2ff753f5b1b000000000000000000000000000000000000000000000000000000000000006492649264926492649264926492649264926492649264926492649264926492')
+ * // { address: '0x...', data: '0x...', signature: '0x...' }
+ */
+export function parseErc6492Signature(
+  signature: ParseErc6492SignatureParameters,
+): ParseErc6492SignatureReturnType {
+  if (!isErc6492Signature(signature)) return { signature }
+
+  const [factoryAddress, factoryData, signature_] = decodeAbiParameters(
+    [{ type: 'address' }, { type: 'bytes' }, { type: 'bytes' }],
+    signature,
+  )
+  return { factoryAddress, factoryData, signature: signature_ }
+}

package/utils/signature/{hexToSignature.ts → parseSignature.ts}

@@ -7,7 +7,7 @@ import {
   numberToHex,
 } from '../../utils/encoding/toHex.js'
 
-export type HexToSignatureErrorType = NumberToHexErrorType | ErrorType
+export type ParseSignatureErrorType = NumberToHexErrorType | ErrorType
 
 /**
  * @description Parses a hex formatted signature into a structured signature.
@@ -16,10 +16,10 @@ export type HexToSignatureErrorType = NumberToHexErrorType | ErrorType
  * @returns The structured signature.
  *
  * @example
- * hexToSignature('0x6e100a352ec6ad1b70802290e18aeed190704973570f3b8ed42cb9808e2ea6bf4a90a229a244495b41890987806fcbd2d5d23fc0dbe5f5256c2613c039d76db81c')
+ * parseSignature('0x6e100a352ec6ad1b70802290e18aeed190704973570f3b8ed42cb9808e2ea6bf4a90a229a244495b41890987806fcbd2d5d23fc0dbe5f5256c2613c039d76db81c')
  * // { r: '0x...', s: '0x...', v: 28n }
  */
-export function hexToSignature(signatureHex: Hex) {
+export function parseSignature(signatureHex: Hex) {
   const { r, s } = secp256k1.Signature.fromCompact(signatureHex.slice(2, 130))
   const yParityOrV = Number(`0x${signatureHex.slice(130)}`)
   const [v, yParity] = (() => {

package/utils/signature/recoverTransactionAddress.ts

@@ -12,7 +12,7 @@ import {
   type RecoverAddressErrorType,
   recoverAddress,
 } from './recoverAddress.js'
-import type { SignatureToHexErrorType } from './signatureToHex.js'
+import type { SerializeSignatureErrorType } from './serializeSignature.js'
 
 export type RecoverTransactionAddressParameters = {
   serializedTransaction: TransactionSerialized
@@ -25,7 +25,7 @@ export type RecoverTransactionAddressErrorType =
   | SerializeTransactionErrorType
   | RecoverAddressErrorType
   | Keccak256ErrorType
-  | SignatureToHexErrorType
+  | SerializeSignatureErrorType
   | ErrorType
 
 export async function recoverTransactionAddress(

package/utils/signature/{compactSignatureToHex.ts → serializeCompactSignature.ts}

@@ -3,7 +3,9 @@ import type { ErrorType } from '../../errors/utils.js'
 import type { CompactSignature, Hex } from '../../types/misc.js'
 import { type HexToBigIntErrorType, hexToBigInt } from '../encoding/fromHex.js'
 
-export type CompactSignatureToHexErrorType = HexToBigIntErrorType | ErrorType
+export type SerializeCompactSignatureErrorType =
+  | HexToBigIntErrorType
+  | ErrorType
 
 /**
  * @description Converts an [EIP-2098 compact signature](https://eips.ethereum.org/EIPS/eip-2098) into hex format.
@@ -12,13 +14,13 @@ export type CompactSignatureToHexErrorType = HexToBigIntErrorType | ErrorType
  * @returns The compact signature in hex format.
  *
  * @example
- * compactSignatureToHex({
+ * serializeCompactSignature({
  *   r: '0x68a020a209d3d56c46f38cc50a33f704f4a9a10a59377f8dd762ac66910e9b90',
  *   yParityAndS: '0x7e865ad05c4035ab5792787d4a0297a43617ae897930a6fe4d822b8faea52064',
  * })
  * // "0x6e100a352ec6ad1b70802290e18aeed190704973570f3b8ed42cb9808e2ea6bf4a90a229a244495b41890987806fcbd2d5d23fc0dbe5f5256c2613c039d76db81c"
  */
-export function compactSignatureToHex({
+export function serializeCompactSignature({
   r,
   yParityAndS,
 }: CompactSignature): Hex {

package/utils/signature/serializeErc6492Signature.ts

@@ -0,0 +1,42 @@
+import type { Address } from 'abitype'
+import { erc6492MagicBytes } from '../../constants/bytes.js'
+import type { ErrorType } from '../../errors/utils.js'
+import type { Hex } from '../../types/misc.js'
+import { encodeAbiParameters } from '../abi/encodeAbiParameters.js'
+import { concatHex } from '../data/concat.js'
+
+export type SerializeErc6492SignatureParameters = {
+  /** The ERC-4337 Account Factory address to use for counterfactual verification. */
+  factoryAddress: Address
+  /** Calldata to pass to deploy account (if not deployed) for counterfactual verification. */
+  factoryData: Hex
+  /** The original signature. */
+  signature: Hex
+}
+
+export type SerializeErc6492SignatureReturnType = Hex
+
+export type SerializeErc6492SignatureErrorType = ErrorType
+
+/**
+ * @description Serializes a ERC-6492 flavoured signature into hex format.
+ *
+ * @param signature ERC-6492 signature in object format.
+ * @returns ERC-6492 signature in hex format.
+ *
+ * @example
+ * serializeSignature({ address: '0x...', data: '0x...', signature: '0x...' })
+ * // '0x000000000000000000000000cafebabecafebabecafebabecafebabecafebabe000000000000000000000000000000000000000000000000000000000000006000000000000000000000000000000000000000000000000000000000000000a00000000000000000000000000000000000000000000000000000000000000004deadbeef000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000041a461f509887bd19e312c0c58467ce8ff8e300d3c1a90b608a760c5b80318eaf15fe57c96f9175d6cd4daad4663763baa7e78836e067d0163e9a2ccf2ff753f5b1b000000000000000000000000000000000000000000000000000000000000006492649264926492649264926492649264926492649264926492649264926492'
+ */
+export function serializeErc6492Signature(
+  parameters: SerializeErc6492SignatureParameters,
+): SerializeErc6492SignatureReturnType {
+  const { factoryAddress, factoryData, signature } = parameters
+  return concatHex([
+    encodeAbiParameters(
+      [{ type: 'address' }, { type: 'bytes' }, { type: 'bytes' }],
+      [factoryAddress, factoryData, signature],
+    ),
+    erc6492MagicBytes,
+  ])
+}

package/utils/signature/{signatureToHex.ts → serializeSignature.ts}

@@ -2,13 +2,10 @@ import { secp256k1 } from '@noble/curves/secp256k1'
 
 import type { ErrorType } from '../../errors/utils.js'
 import type { Hex, Signature } from '../../types/misc.js'
-import {
-  type HexToBigIntErrorType,
-  hexToBigInt,
-} from '../../utils/encoding/fromHex.js'
-import type { ToHexErrorType } from '../../utils/encoding/toHex.js'
+import { type HexToBigIntErrorType, hexToBigInt } from '../encoding/fromHex.js'
+import type { ToHexErrorType } from '../encoding/toHex.js'
 
-export type SignatureToHexErrorType =
+export type SerializeSignatureErrorType =
   | HexToBigIntErrorType
   | ToHexErrorType
   | ErrorType
@@ -20,14 +17,14 @@ export type SignatureToHexErrorType =
  * @returns The signature in hex format.
  *
  * @example
- * signatureToHex({
+ * serializeSignature({
  *   r: '0x6e100a352ec6ad1b70802290e18aeed190704973570f3b8ed42cb9808e2ea6bf',
  *   s: '0x4a90a229a244495b41890987806fcbd2d5d23fc0dbe5f5256c2613c039d76db8',
  *   yParity: 1
  * })
  * // "0x6e100a352ec6ad1b70802290e18aeed190704973570f3b8ed42cb9808e2ea6bf4a90a229a244495b41890987806fcbd2d5d23fc0dbe5f5256c2613c039d76db81c"
  */
-export function signatureToHex({ r, s, v, yParity }: Signature): Hex {
+export function serializeSignature({ r, s, v, yParity }: Signature): Hex {
   const yParity_ = (() => {
     if (yParity === 0 || yParity === 1) return yParity
     if (v && (v === 27n || v === 28n || v >= 35n)) return v % 2n === 0n ? 1 : 0

package/_cjs/utils/signature/compactSignatureToHex.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"compactSignatureToHex.js","sourceRoot":"","sources":["../../../utils/signature/compactSignatureToHex.ts"],"names":[],"mappings":";;;AAAA,uDAAmD;AAGnD,uDAA+E;AAiB/E,SAAgB,qBAAqB,CAAC,EACpC,CAAC,EACD,WAAW,GACM;IACjB,OAAO,KAAK,IAAI,qBAAS,CAAC,SAAS,CACjC,IAAA,wBAAW,EAAC,CAAC,CAAC,EACd,IAAA,wBAAW,EAAC,WAAW,CAAC,CACzB,CAAC,YAAY,EAAE,EAAE,CAAA;AACpB,CAAC;AARD,sDAQC"}

package/_cjs/utils/signature/signatureToHex.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"signatureToHex.js","sourceRoot":"","sources":["../../../utils/signature/signatureToHex.ts"],"names":[],"mappings":";;;AAAA,uDAAmD;AAInD,gEAGwC;AAsBxC,SAAgB,cAAc,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,OAAO,EAAa;IAC5D,MAAM,QAAQ,GAAG,CAAC,GAAG,EAAE;QACrB,IAAI,OAAO,KAAK,CAAC,IAAI,OAAO,KAAK,CAAC;YAAE,OAAO,OAAO,CAAA;QAClD,IAAI,CAAC,IAAI,CAAC,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,IAAI,GAAG,CAAC;YAAE,OAAO,CAAC,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;QAC3E,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAA;IACnD,CAAC,CAAC,EAAE,CAAA;IACJ,OAAO,KAAK,IAAI,qBAAS,CAAC,SAAS,CACjC,IAAA,wBAAW,EAAC,CAAC,CAAC,EACd,IAAA,wBAAW,EAAC,CAAC,CAAC,CACf,CAAC,YAAY,EAAE,GAAG,QAAQ,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,CAAA;AACnD,CAAC;AAVD,wCAUC"}

package/_esm/utils/signature/compactSignatureToHex.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"compactSignatureToHex.js","sourceRoot":"","sources":["../../../utils/signature/compactSignatureToHex.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AAGnD,OAAO,EAA6B,WAAW,EAAE,MAAM,wBAAwB,CAAA;AAI/E;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,qBAAqB,CAAC,EACpC,CAAC,EACD,WAAW,GACM;IACjB,OAAO,KAAK,IAAI,SAAS,CAAC,SAAS,CACjC,WAAW,CAAC,CAAC,CAAC,EACd,WAAW,CAAC,WAAW,CAAC,CACzB,CAAC,YAAY,EAAE,EAAE,CAAA;AACpB,CAAC"}

package/_esm/utils/signature/hexToCompactSignature.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"hexToCompactSignature.js","sourceRoot":"","sources":["../../../utils/signature/hexToCompactSignature.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AAInD,OAAO,EAEL,WAAW,GACZ,MAAM,+BAA+B,CAAA;AAItC;;;;;;;;;GASG;AACH,MAAM,UAAU,qBAAqB,CAAC,YAAiB;IACrD,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,SAAS,CAAC,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAA;IAC5E,OAAO;QACL,CAAC,EAAE,WAAW,CAAC,CAAC,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC;QAC/B,WAAW,EAAE,WAAW,CAAC,CAAC,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC;KAC1C,CAAA;AACH,CAAC"}

package/_esm/utils/signature/signatureToHex.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"signatureToHex.js","sourceRoot":"","sources":["../../../utils/signature/signatureToHex.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AAInD,OAAO,EAEL,WAAW,GACZ,MAAM,iCAAiC,CAAA;AAQxC;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,cAAc,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,OAAO,EAAa;IAC5D,MAAM,QAAQ,GAAG,CAAC,GAAG,EAAE;QACrB,IAAI,OAAO,KAAK,CAAC,IAAI,OAAO,KAAK,CAAC;YAAE,OAAO,OAAO,CAAA;QAClD,IAAI,CAAC,IAAI,CAAC,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,IAAI,GAAG,CAAC;YAAE,OAAO,CAAC,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;QAC3E,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAA;IACnD,CAAC,CAAC,EAAE,CAAA;IACJ,OAAO,KAAK,IAAI,SAAS,CAAC,SAAS,CACjC,WAAW,CAAC,CAAC,CAAC,EACd,WAAW,CAAC,CAAC,CAAC,CACf,CAAC,YAAY,EAAE,GAAG,QAAQ,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,CAAA;AACnD,CAAC"}

package/_types/utils/signature/compactSignatureToHex.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"compactSignatureToHex.d.ts","sourceRoot":"","sources":["../../../utils/signature/compactSignatureToHex.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAA;AACtD,OAAO,KAAK,EAAE,gBAAgB,EAAE,GAAG,EAAE,MAAM,qBAAqB,CAAA;AAChE,OAAO,EAAE,KAAK,oBAAoB,EAAe,MAAM,wBAAwB,CAAA;AAE/E,MAAM,MAAM,8BAA8B,GAAG,oBAAoB,GAAG,SAAS,CAAA;AAE7E;;;;;;;;;;;;GAYG;AACH,wBAAgB,qBAAqB,CAAC,EACpC,CAAC,EACD,WAAW,GACZ,EAAE,gBAAgB,GAAG,GAAG,CAKxB"}

package/_types/utils/signature/hexToCompactSignature.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"hexToCompactSignature.d.ts","sourceRoot":"","sources":["../../../utils/signature/hexToCompactSignature.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAA;AACtD,OAAO,KAAK,EAAE,gBAAgB,EAAE,GAAG,EAAE,MAAM,qBAAqB,CAAA;AAChE,OAAO,EACL,KAAK,oBAAoB,EAE1B,MAAM,+BAA+B,CAAA;AAEtC,MAAM,MAAM,8BAA8B,GAAG,oBAAoB,GAAG,SAAS,CAAA;AAE7E;;;;;;;;;GASG;AACH,wBAAgB,qBAAqB,CAAC,YAAY,EAAE,GAAG,GAAG,gBAAgB,CAMzE"}

package/_types/utils/signature/signatureToHex.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"signatureToHex.d.ts","sourceRoot":"","sources":["../../../utils/signature/signatureToHex.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAA;AACtD,OAAO,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AACzD,OAAO,EACL,KAAK,oBAAoB,EAE1B,MAAM,iCAAiC,CAAA;AACxC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAA;AAEnE,MAAM,MAAM,uBAAuB,GAC/B,oBAAoB,GACpB,cAAc,GACd,SAAS,CAAA;AAEb;;;;;;;;;;;;;GAaG;AACH,wBAAgB,cAAc,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,OAAO,EAAE,EAAE,SAAS,GAAG,GAAG,CAUnE"}