viem 0.0.0-main.20240521T214213 → 0.0.0-main.20240521T215546

package/_types/utils/siwe/types.d.ts

@@ -0,0 +1,61 @@
+import type { Address } from 'abitype';
+/**
+ * @description EIP-4361 message fields
+ *
+ * @see https://eips.ethereum.org/EIPS/eip-4361
+ */
+export type SiweMessage = {
+    /**
+     * The Ethereum address performing the signing.
+     */
+    address: Address;
+    /**
+     * The [EIP-155](https://eips.ethereum.org/EIPS/eip-155) Chain ID to which the session is bound,
+     */
+    chainId: number;
+    /**
+     * [RFC 3986](https://www.rfc-editor.org/rfc/rfc3986) authority that is requesting the signing.
+     */
+    domain: string;
+    /**
+     * Time when the signed authentication message is no longer valid.
+     */
+    expirationTime?: Date | undefined;
+    /**
+     * Time when the message was generated, typically the current time.
+     */
+    issuedAt?: Date | undefined;
+    /**
+     * A random string typically chosen by the relying party and used to prevent replay attacks.
+     */
+    nonce: string;
+    /**
+     * Time when the signed authentication message will become valid.
+     */
+    notBefore?: Date | undefined;
+    /**
+     * A system-specific identifier that may be used to uniquely refer to the sign-in request.
+     */
+    requestId?: string | undefined;
+    /**
+     * A list of information or references to information the user wishes to have resolved as part of authentication by the relying party.
+     */
+    resources?: string[] | undefined;
+    /**
+     * [RFC 3986](https://www.rfc-editor.org/rfc/rfc3986#section-3.1) URI scheme of the origin of the request.
+     */
+    scheme?: string | undefined;
+    /**
+     * A human-readable ASCII assertion that the user will sign.
+     */
+    statement?: string | undefined;
+    /**
+     * [RFC 3986](https://www.rfc-editor.org/rfc/rfc3986) URI referring to the resource that is the subject of the signing (as in the subject of a claim).
+     */
+    uri: string;
+    /**
+     * The current version of the SIWE Message.
+     */
+    version: '1';
+};
+//# sourceMappingURL=types.d.ts.map

package/_types/utils/siwe/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../utils/siwe/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,SAAS,CAAA;AAEtC;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAA;IAChB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IACf;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,cAAc,CAAC,EAAE,IAAI,GAAG,SAAS,CAAA;IACjC;;OAEG;IACH,QAAQ,CAAC,EAAE,IAAI,GAAG,SAAS,CAAA;IAC3B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,SAAS,CAAC,EAAE,IAAI,GAAG,SAAS,CAAA;IAC5B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC9B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAA;IAChC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC3B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC9B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAA;IACX;;OAEG;IACH,OAAO,EAAE,GAAG,CAAA;CACb,CAAA"}

package/_types/utils/siwe/utils.d.ts

@@ -0,0 +1,2 @@
+export declare function isUri(value: string): string | false;
+//# sourceMappingURL=utils.d.ts.map

package/_types/utils/siwe/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../utils/siwe/utils.ts"],"names":[],"mappings":"AAAA,wBAAgB,KAAK,CAAC,KAAK,EAAE,MAAM,kBA4ClC"}

package/_types/utils/siwe/validateSiweMessage.d.ts

@@ -0,0 +1,39 @@
+import type { Address } from 'abitype';
+import type { ExactPartial } from '../../types/utils.js';
+import type { SiweMessage } from './types.js';
+export type ValidateSiweMessageParameters = {
+    /**
+     * Ethereum address to check against.
+     */
+    address?: Address | undefined;
+    /**
+     * [RFC 3986](https://www.rfc-editor.org/rfc/rfc3986) authority to check against.
+     */
+    domain?: string | undefined;
+    /**
+     * EIP-4361 message fields.
+     */
+    message: ExactPartial<SiweMessage>;
+    /**
+     * Random string to check against.
+     */
+    nonce?: string | undefined;
+    /**
+     * [RFC 3986](https://www.rfc-editor.org/rfc/rfc3986#section-3.1) URI scheme to check against.
+     */
+    scheme?: string | undefined;
+    /**
+     * Current time to check optional `expirationTime` and `notBefore` fields.
+     *
+     * @default new Date()
+     */
+    time?: Date | undefined;
+};
+export type ValidateSiweMessageReturnType = boolean;
+/**
+ * @description Validates EIP-4361 message.
+ *
+ * @see https://eips.ethereum.org/EIPS/eip-4361
+ */
+export declare function validateSiweMessage(parameters: ValidateSiweMessageParameters): ValidateSiweMessageReturnType;
+//# sourceMappingURL=validateSiweMessage.d.ts.map

package/_types/utils/siwe/validateSiweMessage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validateSiweMessage.d.ts","sourceRoot":"","sources":["../../../utils/siwe/validateSiweMessage.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,SAAS,CAAA;AAEtC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAA;AAExD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAA;AAE7C,MAAM,MAAM,6BAA6B,GAAG;IAC1C;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAC7B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC3B;;OAEG;IACH,OAAO,EAAE,YAAY,CAAC,WAAW,CAAC,CAAA;IAClC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC1B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC3B;;;;OAIG;IACH,IAAI,CAAC,EAAE,IAAI,GAAG,SAAS,CAAA;CACxB,CAAA;AAED,MAAM,MAAM,6BAA6B,GAAG,OAAO,CAAA;AAEnD;;;;GAIG;AACH,wBAAgB,mBAAmB,CACjC,UAAU,EAAE,6BAA6B,GACxC,6BAA6B,CAyB/B"}

package/actions/public/verifyMessage.ts

@@ -10,6 +10,7 @@ import type {
   SignableMessage,
   Signature,
 } from '../../types/misc.js'
+import type { Prettify } from '../../types/utils.js'
 import { hashMessage } from '../../utils/signature/hashMessage.js'
 import type { HashMessageErrorType } from '../../utils/signature/hashMessage.js'
 import {
@@ -18,14 +19,16 @@ import {
   verifyHash,
 } from './verifyHash.js'
 
-export type VerifyMessageParameters = Omit<VerifyHashParameters, 'hash'> & {
-  /** The address that signed the original message. */
-  address: Address
-  /** The message to be verified. */
-  message: SignableMessage
-  /** The signature that was generated by signing the message with the address's private key. */
-  signature: Hex | ByteArray | Signature
-}
+export type VerifyMessageParameters = Prettify<
+  Omit<VerifyHashParameters, 'hash'> & {
+    /** The address that signed the original message. */
+    address: Address
+    /** The message to be verified. */
+    message: SignableMessage
+    /** The signature that was generated by signing the message with the address's private key. */
+    signature: Hex | ByteArray | Signature
+  }
+>
 
 export type VerifyMessageReturnType = boolean
 

package/actions/siwe/verifySiweMessage.ts

@@ -0,0 +1,90 @@
+import type { Client } from '../../clients/createClient.js'
+import type { Transport } from '../../clients/transports/createTransport.js'
+import type { ErrorType } from '../../errors/utils.js'
+import type { Chain } from '../../types/chain.js'
+import type { Hex } from '../../types/misc.js'
+import type { Prettify } from '../../types/utils.js'
+import { hashMessage } from '../../utils/signature/hashMessage.js'
+import type { HashMessageErrorType } from '../../utils/signature/hashMessage.js'
+import { parseSiweMessage } from '../../utils/siwe/parseSiweMessage.js'
+import {
+  type ValidateSiweMessageParameters,
+  validateSiweMessage,
+} from '../../utils/siwe/validateSiweMessage.js'
+import {
+  type VerifyHashErrorType,
+  type VerifyHashParameters,
+  verifyHash,
+} from '../public/verifyHash.js'
+
+export type VerifySiweMessageParameters = Prettify<
+  Pick<VerifyHashParameters, 'blockNumber' | 'blockTag'> &
+    Pick<
+      ValidateSiweMessageParameters,
+      'address' | 'domain' | 'nonce' | 'scheme' | 'time'
+    > & {
+      /**
+       * EIP-4361 formatted message.
+       */
+      message: string
+      /**
+       * Signature to check against.
+       */
+      signature: Hex
+    }
+>
+
+export type VerifySiweMessageReturnType = boolean
+
+export type VerifySiweMessageErrorType =
+  | HashMessageErrorType
+  | VerifyHashErrorType
+  | ErrorType
+
+/**
+ * Verifies [EIP-4361](https://eips.ethereum.org/EIPS/eip-4361) formatted message was signed.
+ *
+ * Compatible with Smart Contract Accounts & Externally Owned Accounts via [ERC-6492](https://eips.ethereum.org/EIPS/eip-6492).
+ *
+ * - Docs {@link https://viem.sh/docs/siwe/actions/verifySiweMessage}
+ *
+ * @param client - Client to use.
+ * @param parameters - {@link VerifySiweMessageParameters}
+ * @returns Whether or not the signature is valid. {@link VerifySiweMessageReturnType}
+ */
+export async function verifySiweMessage<chain extends Chain | undefined>(
+  client: Client<Transport, chain>,
+  parameters: VerifySiweMessageParameters,
+): Promise<VerifySiweMessageReturnType> {
+  const {
+    address,
+    domain,
+    message,
+    nonce,
+    scheme,
+    signature,
+    time = new Date(),
+    ...callRequest
+  } = parameters
+
+  const parsed = parseSiweMessage(message)
+  if (!parsed.address) return false
+
+  const isValid = validateSiweMessage({
+    address,
+    domain,
+    message: parsed,
+    nonce,
+    scheme,
+    time,
+  })
+  if (!isValid) return false
+
+  const hash = hashMessage(message)
+  return verifyHash(client, {
+    address: parsed.address,
+    hash,
+    signature,
+    ...callRequest,
+  })
+}

package/chains/definitions/flowPreviewnet.ts

@@ -21,7 +21,7 @@ export const flowPreviewnet = /*#__PURE__*/ defineChain({
   },
   contracts: {
     multicall3: {
-      address: "0xca11bde05977b3631167028862be2a173976ca11",
+      address: '0xca11bde05977b3631167028862be2a173976ca11',
       blockCreated: 6205,
     },
   },

package/chains/definitions/metis.ts

@@ -15,7 +15,8 @@ export const metis = /*#__PURE__*/ defineChain({
     default: {
       name: 'Metis Explorer',
       url: 'https://explorer.metis.io',
-      apiUrl: 'https://api.routescan.io/v2/network/mainnet/evm/43114/etherscan/api',
+      apiUrl:
+        'https://api.routescan.io/v2/network/mainnet/evm/43114/etherscan/api',
     },
     blockscout: {
       name: 'Andromeda Explorer',

package/clients/decorators/public.ts

@@ -220,6 +220,11 @@ import {
   type WatchPendingTransactionsReturnType,
   watchPendingTransactions,
 } from '../../actions/public/watchPendingTransactions.js'
+import {
+  type VerifySiweMessageParameters,
+  type VerifySiweMessageReturnType,
+  verifySiweMessage,
+} from '../../actions/siwe/verifySiweMessage.js'
 import {
   type PrepareTransactionRequestParameters,
   type PrepareTransactionRequestRequest,
@@ -1511,9 +1516,40 @@ export type PublicActions<
       accountOverride
     >
   >
+  /**
+   * Verify that a message was signed by the provided address.
+   *
+   * Compatible with Smart Contract Accounts & Externally Owned Accounts via [ERC-6492](https://eips.ethereum.org/EIPS/eip-6492).
+   *
+   * - Docs {@link https://viem.sh/docs/actions/public/verifyMessage}
+   *
+   * @param parameters - {@link VerifyMessageParameters}
+   * @returns Whether or not the signature is valid. {@link VerifyMessageReturnType}
+   */
   verifyMessage: (
     args: VerifyMessageParameters,
   ) => Promise<VerifyMessageReturnType>
+  /**
+   * Verifies [EIP-4361](https://eips.ethereum.org/EIPS/eip-4361) formatted message was signed.
+   *
+   * Compatible with Smart Contract Accounts & Externally Owned Accounts via [ERC-6492](https://eips.ethereum.org/EIPS/eip-6492).
+   *
+   * - Docs {@link https://viem.sh/docs/siwe/actions/verifySiweMessage}
+   *
+   * @param parameters - {@link VerifySiweMessageParameters}
+   * @returns Whether or not the signature is valid. {@link VerifySiweMessageReturnType}
+   */
+  verifySiweMessage: (
+    args: VerifySiweMessageParameters,
+  ) => Promise<VerifySiweMessageReturnType>
+  /**
+   * Verify that typed data was signed by the provided address.
+   *
+   * - Docs {@link https://viem.sh/docs/actions/public/verifyTypedData}
+   *
+   * @param parameters - {@link VerifyTypedDataParameters}
+   * @returns Whether or not the signature is valid. {@link VerifyTypedDataReturnType}
+   */
   verifyTypedData: (
     args: VerifyTypedDataParameters,
   ) => Promise<VerifyTypedDataReturnType>
@@ -1807,6 +1843,7 @@ export function publicActions<
     sendRawTransaction: (args) => sendRawTransaction(client, args),
     simulateContract: (args) => simulateContract(client, args),
     verifyMessage: (args) => verifyMessage(client, args),
+    verifySiweMessage: (args) => verifySiweMessage(client, args),
     verifyTypedData: (args) => verifyTypedData(client, args),
     uninstallFilter: (args) => uninstallFilter(client, args),
     waitForTransactionReceipt: (args) =>

package/errors/siwe.ts

@@ -0,0 +1,20 @@
+import { BaseError } from './base.js'
+
+export type SiweInvalidMessageFieldErrorType = SiweInvalidMessageFieldError & {
+  name: 'SiweInvalidMessageFieldError'
+}
+export class SiweInvalidMessageFieldError extends BaseError {
+  override name = 'SiweInvalidMessageFieldError'
+  constructor(parameters: {
+    docsPath?: string | undefined
+    field: string
+    metaMessages?: string[] | undefined
+  }) {
+    const { docsPath, field, metaMessages } = parameters
+    super(`Invalid Sign-In with Ethereum message field "${field}".`, {
+      docsPath,
+      docsSlug: 'TODO',
+      metaMessages,
+    })
+  }
+}

package/errors/version.ts

@@ -1 +1 @@
-export const version = '0.0.0-main.20240521T214213'
+export const version = '0.0.0-main.20240521T215546'

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "viem",
   "description": "TypeScript Interface for Ethereum",
-  "version": "0.0.0-main.20240521T214213",
+  "version": "0.0.0-main.20240521T215546",
   "type": "module",
   "main": "./_cjs/index.js",
   "module": "./_esm/index.js",
@@ -69,6 +69,11 @@
       "import": "./_esm/op-stack/index.js",
       "default": "./_cjs/op-stack/index.js"
     },
+    "./siwe": {
+      "types": "./_types/siwe/index.d.ts",
+      "import": "./_esm/siwe/index.js",
+      "default": "./_cjs/siwe/index.js"
+    },
     "./utils": {
       "types": "./_types/utils/index.d.ts",
       "import": "./_esm/utils/index.js",
@@ -115,6 +120,9 @@
       "op-stack": [
         "./_types/op-stack/index.d.ts"
       ],
+      "siwe": [
+        "./_types/siwe/index.d.ts"
+      ],
       "utils": [
         "./_types/utils/index.d.ts"
       ],

package/siwe/index.ts

@@ -0,0 +1,29 @@
+export {
+  verifySiweMessage,
+  type VerifySiweMessageParameters,
+  type VerifySiweMessageReturnType,
+  type VerifySiweMessageErrorType,
+} from '../actions/siwe/verifySiweMessage.js'
+
+export {
+  createSiweMessage,
+  type CreateSiweMessageParameters,
+  type CreateSiweMessageReturnType,
+  type CreateSiweMessageErrorType,
+} from '../utils/siwe/createSiweMessage.js'
+
+export { generateSiweNonce } from '../utils/siwe/generateSiweNonce.js'
+export { parseSiweMessage } from '../utils/siwe/parseSiweMessage.js'
+
+export {
+  validateSiweMessage,
+  type ValidateSiweMessageParameters,
+  type ValidateSiweMessageReturnType,
+} from '../utils/siwe/validateSiweMessage.js'
+
+export type { SiweMessage } from '../utils/siwe/types.js'
+
+export {
+  type SiweInvalidMessageFieldErrorType,
+  SiweInvalidMessageFieldError,
+} from '../errors/siwe.js'

package/siwe/package.json

@@ -0,0 +1,6 @@
+{
+  "type": "module",
+  "types": "../_types/siwe/index.d.ts",
+  "module": "../_esm/siwe/index.js",
+  "main": "../_cjs/siwe/index.js"
+}

package/utils/siwe/createSiweMessage.ts

@@ -0,0 +1,168 @@
+import {
+  SiweInvalidMessageFieldError,
+  type SiweInvalidMessageFieldErrorType,
+} from '../../errors/siwe.js'
+import type { ErrorType } from '../../errors/utils.js'
+import { type GetAddressErrorType, getAddress } from '../address/getAddress.js'
+import type { SiweMessage } from './types.js'
+import { isUri } from './utils.js'
+
+export type CreateSiweMessageParameters = SiweMessage
+
+export type CreateSiweMessageReturnType = string
+
+export type CreateSiweMessageErrorType =
+  | GetAddressErrorType
+  | SiweInvalidMessageFieldErrorType
+  | ErrorType
+
+/**
+ * @description Creates EIP-4361 formatted message.
+ *
+ * @example
+ * const message = createMessage({
+ *   address: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
+ *   chainId: 1,
+ *   domain: 'example.com',
+ *   nonce: 'foobarbaz',
+ *   uri: 'https://example.com/path',
+ *   version: '1',
+ * })
+ *
+ * @see https://eips.ethereum.org/EIPS/eip-4361
+ */
+export function createSiweMessage(
+  parameters: CreateSiweMessageParameters,
+): CreateSiweMessageReturnType {
+  const {
+    chainId,
+    domain,
+    expirationTime,
+    issuedAt = new Date(),
+    nonce,
+    notBefore,
+    requestId,
+    resources,
+    scheme,
+    uri,
+    version,
+  } = parameters
+
+  // Validate fields
+  {
+    // Required fields
+    if (chainId !== Math.floor(chainId))
+      throw new SiweInvalidMessageFieldError({
+        field: 'chainId',
+        metaMessages: [
+          '- Chain ID must be a EIP-155 chain ID.',
+          '- See https://eips.ethereum.org/EIPS/eip-155',
+          '',
+          `Provided value: ${chainId}`,
+        ],
+      })
+    if (!domainRegex.test(domain))
+      throw new SiweInvalidMessageFieldError({
+        field: 'domain',
+        metaMessages: [
+          '- Domain must be an RFC 3986 authority.',
+          '- See https://www.rfc-editor.org/rfc/rfc3986',
+          '',
+          `Provided value: ${domain}`,
+        ],
+      })
+    if (!nonceRegex.test(nonce))
+      throw new SiweInvalidMessageFieldError({
+        field: 'nonce',
+        metaMessages: [
+          '- Nonce must be at least 8 characters.',
+          '- Nonce must be alphanumeric.',
+          '',
+          `Provided value: ${nonce}`,
+        ],
+      })
+    if (!isUri(uri))
+      throw new SiweInvalidMessageFieldError({
+        field: 'uri',
+        metaMessages: [
+          '- URI must be a RFC 3986 URI referring to the resource that is the subject of the signing.',
+          '- See https://www.rfc-editor.org/rfc/rfc3986',
+          '',
+          `Provided value: ${uri}`,
+        ],
+      })
+    if (version !== '1')
+      throw new SiweInvalidMessageFieldError({
+        field: 'version',
+        metaMessages: [
+          "- Version must be '1'.",
+          '',
+          `Provided value: ${version}`,
+        ],
+      })
+
+    // Optional fields
+    if (scheme && !schemeRegex.test(scheme))
+      throw new SiweInvalidMessageFieldError({
+        field: 'scheme',
+        metaMessages: [
+          '- Scheme must be an RFC 3986 URI scheme.',
+          '- See https://www.rfc-editor.org/rfc/rfc3986#section-3.1',
+          '',
+          `Provided value: ${scheme}`,
+        ],
+      })
+    const statement = parameters.statement
+    if (statement?.includes('\n'))
+      throw new SiweInvalidMessageFieldError({
+        field: 'statement',
+        metaMessages: [
+          "- Statement must not include '\\n'.",
+          '',
+          `Provided value: ${statement}`,
+        ],
+      })
+  }
+
+  // Construct message
+  const address = getAddress(parameters.address)
+  const origin = (() => {
+    if (scheme) return `${scheme}://${domain}`
+    return domain
+  })()
+  const statement = (() => {
+    if (!parameters.statement) return ''
+    return `\n${parameters.statement}\n`
+  })()
+  const prefix = `${origin} wants you to sign in with your Ethereum account:\n${address}\n${statement}`
+
+  let suffix = `URI: ${uri}\nVersion: ${version}\nChain ID: ${chainId}\nNonce: ${nonce}\nIssued At: ${issuedAt.toISOString()}`
+
+  if (expirationTime)
+    suffix += `\nExpiration Time: ${expirationTime.toISOString()}`
+  if (notBefore) suffix += `\nNot Before: ${notBefore.toISOString()}`
+  if (requestId) suffix += `\nRequest ID: ${requestId}`
+  if (resources) {
+    let content = '\nResources:'
+    for (const resource of resources) {
+      if (!isUri(resource))
+        throw new SiweInvalidMessageFieldError({
+          field: 'resources',
+          metaMessages: [
+            '- Every resource must be a RFC 3986 URI.',
+            '- See https://www.rfc-editor.org/rfc/rfc3986',
+            '',
+            `Provided value: ${resource}`,
+          ],
+        })
+      content += `\n- ${resource}`
+    }
+    suffix += content
+  }
+
+  return `${prefix}\n${suffix}`
+}
+
+const domainRegex = /^(?:(?:(?!-)[a-zA-Z0-9-]{1,63}(?<!-)\.)+[a-zA-Z]{2,63})$/
+const nonceRegex = /^[a-zA-Z0-9]{8,}$/
+const schemeRegex = /^([a-zA-Z][a-zA-Z0-9+-.]*)$/

package/utils/siwe/generateSiweNonce.ts

@@ -0,0 +1,15 @@
+import { uid } from '../../utils/uid.js'
+
+/**
+ * @description Generates random EIP-4361 nonce.
+ *
+ * @example
+ * const nonce = generateNonce()
+ *
+ * @see https://eips.ethereum.org/EIPS/eip-4361
+ *
+ * @returns A randomly generated EIP-4361 nonce.
+ */
+export function generateSiweNonce(): string {
+  return uid(96)
+}

package/utils/siwe/parseSiweMessage.ts

@@ -0,0 +1,55 @@
+import type { Address } from 'abitype'
+
+import type { ExactPartial, Prettify } from '../../types/utils.js'
+import type { SiweMessage } from './types.js'
+
+/**
+ * @description Parses EIP-4361 formatted message into message fields object.
+ *
+ * @see https://eips.ethereum.org/EIPS/eip-4361
+ *
+ * @returns EIP-4361 fields object
+ */
+export function parseSiweMessage(
+  message: string,
+): Prettify<ExactPartial<SiweMessage>> {
+  const { scheme, statement, ...prefix } = (message.match(prefixRegex)
+    ?.groups ?? {}) as {
+    address: Address
+    domain: string
+    scheme?: string
+    statement?: string
+  }
+  const { chainId, expirationTime, issuedAt, notBefore, requestId, ...suffix } =
+    (message.match(suffixRegex)?.groups ?? {}) as {
+      chainId: string
+      expirationTime?: string
+      issuedAt?: string
+      nonce: string
+      notBefore?: string
+      requestId?: string
+      uri: string
+      version: '1'
+    }
+  const resources = message.split('Resources:')[1]?.split('\n- ').slice(1)
+  return {
+    ...prefix,
+    ...suffix,
+    ...(chainId ? { chainId: Number(chainId) } : {}),
+    ...(expirationTime ? { expirationTime: new Date(expirationTime) } : {}),
+    ...(issuedAt ? { issuedAt: new Date(issuedAt) } : {}),
+    ...(notBefore ? { notBefore: new Date(notBefore) } : {}),
+    ...(requestId ? { requestId } : {}),
+    ...(resources ? { resources } : {}),
+    ...(scheme ? { scheme } : {}),
+    ...(statement ? { statement } : {}),
+  }
+}
+
+// https://regexr.com/80gdj
+const prefixRegex =
+  /^(?:(?<scheme>[a-zA-Z][a-zA-Z0-9+-.]*):\/\/)?(?<domain>[a-zA-Z0-9+-.]*) (?:wants you to sign in with your Ethereum account:\n)(?<address>0x[a-fA-F0-9]{40})\n\n(?:(?<statement>.*)\n\n)?/
+
+// https://regexr.com/80gf9
+const suffixRegex =
+  /(?:URI: (?<uri>.+))\n(?:Version: (?<version>.+))\n(?:Chain ID: (?<chainId>\d+))\n(?:Nonce: (?<nonce>[a-zA-Z0-9]+))\n(?:Issued At: (?<issuedAt>.+))(?:\nExpiration Time: (?<expirationTime>.+))?(?:\nNot Before: (?<notBefore>.+))?(?:\nRequest ID: (?<requestId>.+))?/