viem 2.11.0 → 2.12.0

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

package/package.json

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

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>.+))?/

package/utils/siwe/types.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'
+}

package/utils/siwe/utils.ts

@@ -0,0 +1,51 @@
+export function isUri(value: string) {
+  // based on https://github.com/ogt/valid-url
+
+  // check for illegal characters
+  if (/[^a-z0-9\:\/\?\#\[\]\@\!\$\&\'\(\)\*\+\,\;\=\.\-\_\~\%]/i.test(value))
+    return false
+
+  // check for hex escapes that aren't complete
+  if (/%[^0-9a-f]/i.test(value)) return false
+  if (/%[0-9a-f](:?[^0-9a-f]|$)/i.test(value)) return false
+
+  // from RFC 3986
+  const splitted = splitUri(value)
+  const scheme = splitted[1]
+  const authority = splitted[2]
+  const path = splitted[3]
+  const query = splitted[4]
+  const fragment = splitted[5]
+
+  // scheme and path are required, though the path can be empty
+  if (!(scheme?.length && path.length >= 0)) return false
+
+  // if authority is present, the path must be empty or begin with a /
+  if (authority?.length) {
+    if (!(path.length === 0 || /^\//.test(path))) return false
+  } else {
+    // if authority is not present, the path must not start with //
+    if (/^\/\//.test(path)) return false
+  }
+
+  // scheme must begin with a letter, then consist of letters, digits, +, ., or -
+  if (!/^[a-z][a-z0-9\+\-\.]*$/.test(scheme.toLowerCase())) return false
+
+  let out = ''
+  // re-assemble the URL per section 5.3 in RFC 3986
+  out += `${scheme}:`
+  if (authority?.length) out += `//${authority}`
+
+  out += path
+
+  if (query?.length) out += `?${query}`
+  if (fragment?.length) out += `#${fragment}`
+
+  return out
+}
+
+function splitUri(value: string) {
+  return value.match(
+    /(?:([^:\/?#]+):)?(?:\/\/([^\/?#]*))?([^?#]*)(?:\?([^#]*))?(?:#(.*))?/,
+  )!
+}