viem 2.36.1 → 2.37.0

package/utils/signature/parseErc8010Signature.ts

@@ -0,0 +1,67 @@
+import type { Address } from 'abitype'
+import * as SignatureErc8010 from 'ox/erc8010/SignatureErc8010'
+import type { ErrorType } from '../../errors/utils.js'
+import type { SignedAuthorization } from '../../types/authorization.js'
+import type { Hex } from '../../types/misc.js'
+import type { OneOf, Prettify } from '../../types/utils.js'
+import { numberToHex } from '../encoding/toHex.js'
+import {
+  type IsErc8010SignatureErrorType,
+  isErc8010Signature,
+} from './isErc8010Signature.js'
+
+export type ParseErc8010SignatureParameters = Hex
+
+export type ParseErc8010SignatureReturnType = Prettify<
+  OneOf<
+    | {
+        /** Address of the initializer. */
+        address?: Address | undefined
+        /** Authorization signed by the delegatee. */
+        authorization: SignedAuthorization
+        /** Data to initialize the delegation. */
+        data?: Hex | undefined
+        /** The original signature. */
+        signature: Hex
+      }
+    | {
+        /** The original signature. */
+        signature: Hex
+      }
+  >
+>
+
+export type ParseErc8010SignatureErrorType =
+  | IsErc8010SignatureErrorType
+  | ErrorType
+
+/**
+ * @description Parses a hex-formatted ERC-8010 flavoured signature.
+ * If the signature is not in ERC-8010 format, then the underlying (original) signature is returned.
+ *
+ * @param signature ERC-8010 signature in hex format.
+ * @returns The parsed ERC-8010 signature.
+ */
+export function parseErc8010Signature(
+  signature: ParseErc8010SignatureParameters,
+): ParseErc8010SignatureReturnType {
+  if (!isErc8010Signature(signature)) return { signature }
+
+  const {
+    authorization: authorization_ox,
+    to,
+    ...rest
+  } = SignatureErc8010.unwrap(signature)
+  return {
+    authorization: {
+      address: authorization_ox.address,
+      chainId: authorization_ox.chainId,
+      nonce: Number(authorization_ox.nonce),
+      r: numberToHex(authorization_ox.r, { size: 32 }),
+      s: numberToHex(authorization_ox.s, { size: 32 }),
+      yParity: authorization_ox.yParity,
+    },
+    ...(to ? { address: to } : {}),
+    ...rest,
+  }
+}

package/utils/signature/serializeErc8010Signature.ts

@@ -0,0 +1,53 @@
+import type { Address } from 'abitype'
+import * as SignatureErc8010 from 'ox/erc8010/SignatureErc8010'
+import type { ErrorType } from '../../errors/utils.js'
+import type { SignedAuthorization } from '../../types/authorization.js'
+import type { ByteArray, Hex } from '../../types/misc.js'
+import { hexToBytes } from '../encoding/toBytes.js'
+
+type To = 'bytes' | 'hex'
+
+export type SerializeErc8010SignatureParameters<to extends To = 'hex'> = {
+  /** Address of the initializer. */
+  address?: Address | undefined
+  /** Authorization signed by the delegatee. */
+  authorization: SignedAuthorization
+  /** Data to initialize the delegation. */
+  data?: Hex | undefined
+  /** The original signature. */
+  signature: Hex
+  to?: to | To | undefined
+}
+
+export type SerializeErc8010SignatureReturnType<to extends To = 'hex'> =
+  | (to extends 'hex' ? Hex : never)
+  | (to extends 'bytes' ? ByteArray : never)
+
+export type SerializeErc8010SignatureErrorType = ErrorType
+
+/**
+ * @description Serializes a ERC-8010 flavoured signature into hex format.
+ *
+ * @param signature ERC-8010 signature in object format.
+ * @returns ERC-8010 signature in hex format.
+ */
+export function serializeErc8010Signature<to extends To = 'hex'>(
+  parameters: SerializeErc8010SignatureParameters<to>,
+): SerializeErc8010SignatureReturnType<to> {
+  const { address, data, signature, to = 'hex' } = parameters
+  const signature_ = SignatureErc8010.wrap({
+    authorization: {
+      address: parameters.authorization.address,
+      chainId: parameters.authorization.chainId,
+      nonce: BigInt(parameters.authorization.nonce),
+      r: BigInt(parameters.authorization.r),
+      s: BigInt(parameters.authorization.s),
+      yParity: parameters.authorization.yParity!,
+    },
+    data,
+    signature,
+    to: address,
+  })
+  if (to === 'hex') return signature_ as SerializeErc8010SignatureReturnType<to>
+  return hexToBytes(signature_) as SerializeErc8010SignatureReturnType<to>
+}