viem 2.11.1 → 2.12.0

package/_types/errors/version.d.ts

@@ -1,2 +1,2 @@
-export declare const version = "2.11.1";
+export declare const version = "2.12.0";
 //# sourceMappingURL=version.d.ts.map

package/_types/siwe/index.d.ts

@@ -0,0 +1,8 @@
+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';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../siwe/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,EACjB,KAAK,2BAA2B,EAChC,KAAK,2BAA2B,EAChC,KAAK,0BAA0B,GAChC,MAAM,sCAAsC,CAAA;AAE7C,OAAO,EACL,iBAAiB,EACjB,KAAK,2BAA2B,EAChC,KAAK,2BAA2B,EAChC,KAAK,0BAA0B,GAChC,MAAM,oCAAoC,CAAA;AAE3C,OAAO,EAAE,iBAAiB,EAAE,MAAM,oCAAoC,CAAA;AACtE,OAAO,EAAE,gBAAgB,EAAE,MAAM,mCAAmC,CAAA;AAEpE,OAAO,EACL,mBAAmB,EACnB,KAAK,6BAA6B,EAClC,KAAK,6BAA6B,GACnC,MAAM,sCAAsC,CAAA;AAE7C,YAAY,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AAEzD,OAAO,EACL,KAAK,gCAAgC,EACrC,4BAA4B,GAC7B,MAAM,mBAAmB,CAAA"}

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

@@ -0,0 +1,24 @@
+import { type SiweInvalidMessageFieldErrorType } from '../../errors/siwe.js';
+import type { ErrorType } from '../../errors/utils.js';
+import { type GetAddressErrorType } from '../address/getAddress.js';
+import type { SiweMessage } from './types.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 declare function createSiweMessage(parameters: CreateSiweMessageParameters): CreateSiweMessageReturnType;
+//# sourceMappingURL=createSiweMessage.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"createSiweMessage.d.ts","sourceRoot":"","sources":["../../../utils/siwe/createSiweMessage.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,gCAAgC,EACtC,MAAM,sBAAsB,CAAA;AAC7B,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAA;AACtD,OAAO,EAAE,KAAK,mBAAmB,EAAc,MAAM,0BAA0B,CAAA;AAC/E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAA;AAG7C,MAAM,MAAM,2BAA2B,GAAG,WAAW,CAAA;AAErD,MAAM,MAAM,2BAA2B,GAAG,MAAM,CAAA;AAEhD,MAAM,MAAM,0BAA0B,GAClC,mBAAmB,GACnB,gCAAgC,GAChC,SAAS,CAAA;AAEb;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,iBAAiB,CAC/B,UAAU,EAAE,2BAA2B,GACtC,2BAA2B,CAgI7B"}

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

@@ -0,0 +1,12 @@
+/**
+ * @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 declare function generateSiweNonce(): string;
+//# sourceMappingURL=generateSiweNonce.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"generateSiweNonce.d.ts","sourceRoot":"","sources":["../../../utils/siwe/generateSiweNonce.ts"],"names":[],"mappings":"AAEA;;;;;;;;;GASG;AACH,wBAAgB,iBAAiB,IAAI,MAAM,CAE1C"}

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

@@ -0,0 +1,11 @@
+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 declare function parseSiweMessage(message: string): Prettify<ExactPartial<SiweMessage>>;
+//# sourceMappingURL=parseSiweMessage.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"parseSiweMessage.d.ts","sourceRoot":"","sources":["../../../utils/siwe/parseSiweMessage.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAA;AAClE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAA;AAE7C;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAC9B,OAAO,EAAE,MAAM,GACd,QAAQ,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC,CAgCrC"}

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

@@ -19,4 +19,10 @@ export const flowPreviewnet = /*#__PURE__*/ defineChain({
       url: 'https://previewnet.flowdiver.io',
     },
   },
+  contracts: {
+    multicall3: {
+      address: '0xca11bde05977b3631167028862be2a173976ca11',
+      blockCreated: 6205,
+    },
+  },
 })

package/chains/definitions/jbcTestnet.ts

@@ -3,15 +3,11 @@ import { defineChain } from '../../utils/chain/defineChain.js'
 export const jbcTestnet = /*#__PURE__*/ defineChain({
   id: 88991,
   name: 'Jibchain Testnet',
-  network: 'jbcTestnet',
   nativeCurrency: { name: 'tJBC', symbol: 'tJBC', decimals: 18 },
   rpcUrls: {
     default: {
       http: ['https://rpc.testnet.jibchain.net'],
     },
-    public: {
-      http: ['https://rpc.testnet.jibchain.net'],
-    },
   },
   blockExplorers: {
     default: {

package/chains/definitions/l3x.ts

@@ -0,0 +1,21 @@
+import { defineChain } from '../../utils/chain/defineChain.js'
+
+export const l3x = /*#__PURE__*/ defineChain({
+  id: 12324,
+  name: 'L3X Protocol',
+  nativeCurrency: { name: 'Ether', symbol: 'ETH', decimals: 18 },
+  rpcUrls: {
+    default: {
+      http: ['https://rpc-mainnet.l3x.com'],
+      webSocket: ['wss://rpc-mainnet.l3x.com'],
+    },
+  },
+  blockExplorers: {
+    default: {
+      name: 'L3X Mainnet Explorer',
+      url: 'https://explorer.l3x.com',
+      apiUrl: 'https://explorer.l3x.com/api/v2',
+    },
+  },
+  testnet: false,
+})

package/chains/definitions/l3xTestnet.ts

@@ -0,0 +1,21 @@
+import { defineChain } from '../../utils/chain/defineChain.js'
+
+export const l3xTestnet = /*#__PURE__*/ defineChain({
+  id: 12325,
+  name: 'L3X Protocol Testnet',
+  nativeCurrency: { name: 'Ether', symbol: 'ETH', decimals: 18 },
+  rpcUrls: {
+    default: {
+      http: ['https://rpc-testnet.l3x.com'],
+      webSocket: ['wss://rpc-testnet.l3x.com'],
+    },
+  },
+  blockExplorers: {
+    default: {
+      name: 'L3X Testnet Explorer',
+      url: 'https://explorer-testnet.l3x.com',
+      apiUrl: 'https://explorer-testnet.l3x.com/api/v2',
+    },
+  },
+  testnet: true,
+})

package/chains/definitions/metis.ts

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

package/chains/definitions/thaiChain.ts

@@ -0,0 +1,26 @@
+import { defineChain } from '../../utils/chain/defineChain.js'
+
+export const thaiChain = /*#__PURE__*/ defineChain({
+  id: 7,
+  name: 'ThaiChain',
+  nativeCurrency: { name: 'TCH', symbol: 'TCH', decimals: 18 },
+  rpcUrls: {
+    default: {
+      http: ['hhttps://rpc.thaichain.org'],
+    },
+  },
+  blockExplorers: {
+    default: {
+      name: 'Blockscout',
+      url: 'https://exp.thaichain.org',
+      apiUrl: 'https://exp.thaichain.org/api',
+    },
+  },
+  contracts: {
+    multicall3: {
+      address: '0x0DaD6130e832c21719C5CE3bae93454E16A84826',
+      blockCreated: 4806386,
+    },
+  },
+  testnet: false,
+})

package/chains/index.ts

@@ -124,6 +124,8 @@ export { klaytn } from './definitions/klaytn.js'
 export { klaytnBaobab } from './definitions/klaytnBaobab.js'
 export { kroma } from './definitions/kroma.js'
 export { kromaSepolia } from './definitions/kromaSepolia.js'
+export { l3x } from './definitions/l3x.js'
+export { l3xTestnet } from './definitions/l3xTestnet.js'
 export { lightlinkPegasus } from './definitions/lightlinkPegasus.js'
 export { lightlinkPhoenix } from './definitions/lightlinkPhoenix.js'
 export { linea } from './definitions/linea.js'
@@ -246,6 +248,7 @@ export { telcoinTestnet } from './definitions/telcoinTestnet.js'
 export { telos } from './definitions/telos.js'
 export { telosTestnet } from './definitions/telosTestnet.js'
 export { tenet } from './definitions/tenet.js'
+export { thaiChain } from './definitions/thaiChain.js'
 export { thunderTestnet } from './definitions/thunderTestnet.js'
 export { vechain } from './definitions/vechain.js'
 export { wanchain } from './definitions/wanchain.js'

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 = '2.11.1'
+export const version = '2.12.0'

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "viem",
   "description": "TypeScript Interface for Ethereum",
-  "version": "2.11.1",
+  "version": "2.12.0",
   "main": "./_cjs/index.js",
   "module": "./_esm/index.js",
   "types": "./_types/index.d.ts",
@@ -68,6 +68,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",
@@ -114,6 +119,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"
+}