viem 2.11.1 → 2.12.1

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: ['https://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/definitions/zkSync.ts

@@ -23,6 +23,10 @@ export const zkSync = /*#__PURE__*/ defineChain({
       url: 'https://era.zksync.network/',
       apiUrl: 'https://api-era.zksync.network/api',
     },
+    native: {
+      name: 'zkSync Explorer',
+      url: 'https://explorer.zksync.io/',
+    },
   },
   contracts: {
     multicall3: {

package/chains/definitions/zkSyncSepoliaTestnet.ts

@@ -15,7 +15,11 @@ export const zkSyncSepoliaTestnet = /*#__PURE__*/ defineChain({
   },
   blockExplorers: {
     default: {
-      name: 'zkExplorer',
+      name: 'Etherscan',
+      url: 'https://sepolia-era.zksync.network/',
+    },
+    native: {
+      name: 'zkSync Explorer',
       url: 'https://sepolia.explorer.zksync.io/',
     },
   },

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.1'

package/node/trustedSetups.ts

@@ -1,4 +1,12 @@
-import { resolve } from 'node:path'
+import { dirname, resolve } from 'node:path'
+import { fileURLToPath } from 'node:url'
+
+const __filename = fileURLToPath(
+  // import.meta' meta-property is only allowed when the '--module' option is 'es2020', 'es2022', 'esnext', 'system', 'node16', or 'nodenext'
+  // @ts-ignore
+  import.meta.url,
+)
+const __dirname = dirname(__filename)
 
 export const mainnetTrustedSetupPath = resolve(
   __dirname,

package/node/trustedSetups_cjs.ts

@@ -0,0 +1,11 @@
+import { resolve } from 'node:path'
+
+export const mainnetTrustedSetupPath = resolve(
+  __dirname,
+  '../trusted-setups/mainnet.json',
+)
+
+export const minimalTrustedSetupPath = resolve(
+  __dirname,
+  '../trusted-setups/mainnet.json',
+)

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "viem",
   "description": "TypeScript Interface for Ethereum",
-  "version": "2.11.1",
+  "version": "2.12.1",
   "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"
+}

package/utils/address/isAddress.ts

@@ -23,8 +23,9 @@ export function isAddress(
   options?: IsAddressOptions | undefined,
 ): address is Address {
   const { strict = true } = options ?? {}
+  const cacheKey = `${address}.${strict}`
 
-  if (isAddressCache.has(address)) return isAddressCache.get(address)!
+  if (isAddressCache.has(cacheKey)) return isAddressCache.get(cacheKey)!
 
   const result = (() => {
     if (!addressRegex.test(address)) return false
@@ -32,6 +33,6 @@ export function isAddress(
     if (strict) return checksumAddress(address as Address) === address
     return true
   })()
-  isAddressCache.set(address, result)
+  isAddressCache.set(cacheKey, result)
   return result
 }

package/utils/siwe/createSiweMessage.ts

@@ -0,0 +1,178 @@
+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) ||
+        ipRegex.test(domain) ||
+        localhostRegex.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][-a-zA-Z0-9]{0,61}[a-zA-Z0-9])\.[a-zA-Z]{2,}(:[0-9]{1,5})?$/
+const ipRegex =
+  /^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(:[0-9]{1,5})?$/
+const localhostRegex = /^localhost(:[0-9]{1,5})?$/
+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)
+}