viem 2.7.2 → 2.7.5

package/_test/generated.ts

@@ -0,0 +1,350 @@
+// Generated by @wagmi/cli@0.1.6 on 11/09/2023 at 9:45:29 am
+
+//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+// IERC1271Wallet
+//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+
+export const ierc1271WalletABI = [
+  {
+    stateMutability: 'view',
+    type: 'function',
+    inputs: [
+      { name: 'hash', internalType: 'bytes32', type: 'bytes32' },
+      { name: 'signature', internalType: 'bytes', type: 'bytes' },
+    ],
+    name: 'isValidSignature',
+    outputs: [{ name: 'magicValue', internalType: 'bytes4', type: 'bytes4' }],
+  },
+] as const
+
+//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+// VerifySig
+//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+
+export const verifySigABI = [
+  {
+    stateMutability: 'nonpayable',
+    type: 'constructor',
+    inputs: [
+      { name: '_signer', internalType: 'address', type: 'address' },
+      { name: '_hash', internalType: 'bytes32', type: 'bytes32' },
+      { name: '_signature', internalType: 'bytes', type: 'bytes' },
+    ],
+  },
+  {
+    stateMutability: 'nonpayable',
+    type: 'function',
+    inputs: [
+      { name: '_signer', internalType: 'address', type: 'address' },
+      { name: '_hash', internalType: 'bytes32', type: 'bytes32' },
+      { name: '_signature', internalType: 'bytes', type: 'bytes' },
+    ],
+    name: 'isValidUniversalSig',
+    outputs: [{ name: '', internalType: 'bool', type: 'bool' }],
+  },
+] as const
+
+//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+// ERC20InvalidTransferEvent
+//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+
+export const erc20InvalidTransferEventABI = [
+  {
+    type: 'event',
+    anonymous: false,
+    inputs: [
+      { name: 'from', internalType: 'address', type: 'address', indexed: true },
+      { name: 'to', internalType: 'address', type: 'address', indexed: false },
+      {
+        name: 'value',
+        internalType: 'uint256',
+        type: 'uint256',
+        indexed: false,
+      },
+    ],
+    name: 'Transfer',
+  },
+  {
+    stateMutability: 'nonpayable',
+    type: 'function',
+    inputs: [
+      { name: 'recipient', internalType: 'address', type: 'address' },
+      { name: 'amount', internalType: 'uint256', type: 'uint256' },
+    ],
+    name: 'transfer',
+    outputs: [],
+  },
+] as const
+
+//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+// GH434
+//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+
+export const gh434ABI = [
+  {
+    stateMutability: 'pure',
+    type: 'function',
+    inputs: [],
+    name: 'bar',
+    outputs: [{ name: '', internalType: 'string', type: 'string' }],
+  },
+  {
+    stateMutability: 'pure',
+    type: 'function',
+    inputs: [],
+    name: 'baz',
+    outputs: [{ name: '', internalType: 'uint256', type: 'uint256' }],
+  },
+  {
+    stateMutability: 'pure',
+    type: 'function',
+    inputs: [],
+    name: 'foo',
+    outputs: [
+      { name: 'a', internalType: 'uint256', type: 'uint256' },
+      { name: 'b', internalType: 'bool', type: 'bool' },
+    ],
+  },
+] as const
+
+//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+// EnsAvatarTokenUri
+//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+
+export const ensAvatarTokenUriABI = [
+  {
+    stateMutability: 'view',
+    type: 'function',
+    inputs: [{ name: 'tokenId', internalType: 'uint256', type: 'uint256' }],
+    name: 'ownerOf',
+    outputs: [{ name: '', internalType: 'address', type: 'address' }],
+  },
+  {
+    stateMutability: 'view',
+    type: 'function',
+    inputs: [{ name: 'tokenId', internalType: 'uint256', type: 'uint256' }],
+    name: 'tokenURI',
+    outputs: [{ name: '', internalType: 'string', type: 'string' }],
+  },
+] as const
+
+//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+// ErrorsExample
+//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+
+export const errorsExampleABI = [
+  {
+    type: 'error',
+    inputs: [
+      {
+        name: 'foo',
+        internalType: 'struct ErrorsExample.Foo',
+        type: 'tuple',
+        components: [
+          { name: 'sender', internalType: 'address', type: 'address' },
+          { name: 'bar', internalType: 'uint256', type: 'uint256' },
+        ],
+      },
+      { name: 'message', internalType: 'string', type: 'string' },
+      { name: 'number', internalType: 'uint256', type: 'uint256' },
+    ],
+    name: 'ComplexError',
+  },
+  {
+    type: 'error',
+    inputs: [{ name: 'message', internalType: 'string', type: 'string' }],
+    name: 'SimpleError',
+  },
+  { type: 'error', inputs: [], name: 'SimpleErrorNoArgs' },
+  {
+    stateMutability: 'pure',
+    type: 'function',
+    inputs: [],
+    name: 'assertRead',
+    outputs: [],
+  },
+  {
+    stateMutability: 'nonpayable',
+    type: 'function',
+    inputs: [],
+    name: 'assertWrite',
+    outputs: [],
+  },
+  {
+    stateMutability: 'pure',
+    type: 'function',
+    inputs: [],
+    name: 'complexCustomRead',
+    outputs: [],
+  },
+  {
+    stateMutability: 'nonpayable',
+    type: 'function',
+    inputs: [],
+    name: 'complexCustomWrite',
+    outputs: [],
+  },
+  {
+    stateMutability: 'pure',
+    type: 'function',
+    inputs: [],
+    name: 'divideByZeroRead',
+    outputs: [{ name: '', internalType: 'uint256', type: 'uint256' }],
+  },
+  {
+    stateMutability: 'nonpayable',
+    type: 'function',
+    inputs: [],
+    name: 'divideByZeroWrite',
+    outputs: [{ name: '', internalType: 'uint256', type: 'uint256' }],
+  },
+  {
+    stateMutability: 'pure',
+    type: 'function',
+    inputs: [],
+    name: 'overflowRead',
+    outputs: [{ name: '', internalType: 'uint256', type: 'uint256' }],
+  },
+  {
+    stateMutability: 'nonpayable',
+    type: 'function',
+    inputs: [],
+    name: 'overflowWrite',
+    outputs: [{ name: '', internalType: 'uint256', type: 'uint256' }],
+  },
+  {
+    stateMutability: 'pure',
+    type: 'function',
+    inputs: [],
+    name: 'requireRead',
+    outputs: [],
+  },
+  {
+    stateMutability: 'nonpayable',
+    type: 'function',
+    inputs: [],
+    name: 'requireWrite',
+    outputs: [],
+  },
+  {
+    stateMutability: 'pure',
+    type: 'function',
+    inputs: [],
+    name: 'revertRead',
+    outputs: [],
+  },
+  {
+    stateMutability: 'nonpayable',
+    type: 'function',
+    inputs: [],
+    name: 'revertWrite',
+    outputs: [],
+  },
+  {
+    stateMutability: 'pure',
+    type: 'function',
+    inputs: [],
+    name: 'simpleCustomRead',
+    outputs: [],
+  },
+  {
+    stateMutability: 'pure',
+    type: 'function',
+    inputs: [],
+    name: 'simpleCustomReadNoArgs',
+    outputs: [],
+  },
+  {
+    stateMutability: 'nonpayable',
+    type: 'function',
+    inputs: [],
+    name: 'simpleCustomWrite',
+    outputs: [],
+  },
+] as const
+
+//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+// OffchainLookupExample
+//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+
+export const offchainLookupExampleABI = [
+  {
+    stateMutability: 'nonpayable',
+    type: 'constructor',
+    inputs: [{ name: 'urls_', internalType: 'string[]', type: 'string[]' }],
+  },
+  {
+    type: 'error',
+    inputs: [
+      { name: 'sender', internalType: 'address', type: 'address' },
+      { name: 'urls', internalType: 'string[]', type: 'string[]' },
+      { name: 'callData', internalType: 'bytes', type: 'bytes' },
+      { name: 'callbackFunction', internalType: 'bytes4', type: 'bytes4' },
+      { name: 'extraData', internalType: 'bytes', type: 'bytes' },
+    ],
+    name: 'OffchainLookup',
+  },
+  {
+    stateMutability: 'view',
+    type: 'function',
+    inputs: [{ name: 'name', internalType: 'string', type: 'string' }],
+    name: 'getAddress',
+    outputs: [{ name: '', internalType: 'address', type: 'address' }],
+  },
+  {
+    stateMutability: 'view',
+    type: 'function',
+    inputs: [
+      { name: 'result', internalType: 'bytes', type: 'bytes' },
+      { name: 'extraData', internalType: 'bytes', type: 'bytes' },
+    ],
+    name: 'getAddressWithProof',
+    outputs: [{ name: '', internalType: 'address', type: 'address' }],
+  },
+  {
+    stateMutability: 'pure',
+    type: 'function',
+    inputs: [
+      {
+        name: '_ethSignedMessageHash',
+        internalType: 'bytes32',
+        type: 'bytes32',
+      },
+      { name: '_signature', internalType: 'bytes', type: 'bytes' },
+    ],
+    name: 'recoverSigner',
+    outputs: [{ name: '', internalType: 'address', type: 'address' }],
+  },
+  {
+    stateMutability: 'pure',
+    type: 'function',
+    inputs: [{ name: 'sig', internalType: 'bytes', type: 'bytes' }],
+    name: 'splitSignature',
+    outputs: [
+      { name: 'r', internalType: 'bytes32', type: 'bytes32' },
+      { name: 's', internalType: 'bytes32', type: 'bytes32' },
+      { name: 'v', internalType: 'uint8', type: 'uint8' },
+    ],
+  },
+  {
+    stateMutability: 'view',
+    type: 'function',
+    inputs: [{ name: '', internalType: 'uint256', type: 'uint256' }],
+    name: 'urls',
+    outputs: [{ name: '', internalType: 'string', type: 'string' }],
+  },
+] as const
+
+//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+// Payable
+//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+
+export const payableABI = [
+  {
+    stateMutability: 'payable',
+    type: 'function',
+    inputs: [],
+    name: 'pay',
+    outputs: [],
+  },
+] as const

package/actions/public/call.ts

@@ -9,6 +9,10 @@ import type { Client } from '../../clients/createClient.js'
 import type { Transport } from '../../clients/transports/createTransport.js'
 import { multicall3Abi } from '../../constants/abis.js'
 import { aggregate3Signature } from '../../constants/contract.js'
+import {
+  InvalidAddressError,
+  type InvalidAddressErrorType,
+} from '../../errors/address.js'
 import { BaseError } from '../../errors/base.js'
 import {
   ChainDoesNotSupportContract,
@@ -18,11 +22,27 @@ import {
   RawContractError,
   type RawContractErrorType,
 } from '../../errors/contract.js'
+import {
+  InvalidBytesLengthError,
+  type InvalidBytesLengthErrorType,
+} from '../../errors/data.js'
+import {
+  AccountStateConflictError,
+  type AccountStateConflictErrorType,
+  StateAssignmentConflictError,
+  type StateAssignmentConflictErrorType,
+} from '../../errors/stateOverride.js'
 import type { ErrorType } from '../../errors/utils.js'
 import type { BlockTag } from '../../types/block.js'
 import type { Chain } from '../../types/chain.js'
 import type { Hex } from '../../types/misc.js'
-import type { RpcTransactionRequest } from '../../types/rpc.js'
+import type {
+  RpcAccountStateOverride,
+  RpcStateMapping,
+  RpcStateOverride,
+  RpcTransactionRequest,
+} from '../../types/rpc.js'
+import type { StateMapping, StateOverride } from '../../types/stateOverride.js'
 import type { TransactionRequest } from '../../types/transaction.js'
 import type { UnionOmit } from '../../types/utils.js'
 import {
@@ -33,6 +53,7 @@ import {
   type EncodeFunctionDataErrorType,
   encodeFunctionData,
 } from '../../utils/abi/encodeFunctionData.js'
+import { isAddress } from '../../utils/address/isAddress.js'
 import type { RequestErrorType } from '../../utils/buildRequest.js'
 import {
   type GetChainContractAddressErrorType,
@@ -85,12 +106,15 @@ export type CallParameters<
          */
         blockTag?: BlockTag
       }
-  )
+  ) & {
+    stateOverride?: StateOverride
+  }
 
 export type CallReturnType = { data: Hex | undefined }
 
 export type CallErrorType = GetCallErrorReturnType<
   | ParseAccountErrorType
+  | ParseStateOverrideErrorType
   | AssertRequestErrorType
   | NumberToHexErrorType
   | FormatTransactionRequestErrorType
@@ -141,6 +165,7 @@ export async function call<TChain extends Chain | undefined>(
     nonce,
     to,
     value,
+    stateOverride,
     ...rest
   } = args
   const account = account_ ? parseAccount(account_) : undefined
@@ -151,6 +176,8 @@ export async function call<TChain extends Chain | undefined>(
     const blockNumberHex = blockNumber ? numberToHex(blockNumber) : undefined
     const block = blockNumberHex || blockTag
 
+    const rpcStateOverride = parseStateOverride(stateOverride)
+
     const chainFormat = client.chain?.formatters?.transactionRequest?.format
     const format = chainFormat || formatTransactionRequest
 
@@ -169,7 +196,7 @@ export async function call<TChain extends Chain | undefined>(
       value,
     } as TransactionRequest) as TransactionRequest
 
-    if (batch && shouldPerformMulticall({ request })) {
+    if (batch && shouldPerformMulticall({ request }) && !rpcStateOverride) {
       try {
         return await scheduleMulticall(client, {
           ...request,
@@ -187,9 +214,9 @@ export async function call<TChain extends Chain | undefined>(
 
     const response = await client.request({
       method: 'eth_call',
-      params: block
-        ? [request as Partial<RpcTransactionRequest>, block]
-        : [request as Partial<RpcTransactionRequest>],
+      params: rpcStateOverride
+        ? [request as Partial<RpcTransactionRequest>, block, rpcStateOverride]
+        : [request as Partial<RpcTransactionRequest>, block],
     })
     if (response === '0x') return { data: undefined }
     return { data: response }
@@ -331,3 +358,75 @@ export function getRevertErrorData(err: unknown) {
   const error = err.walk() as RawContractError
   return typeof error.data === 'object' ? error.data.data : error.data
 }
+
+export type ParseStateMappingErrorType = InvalidBytesLengthErrorType
+
+export function parseStateMapping(
+  stateMapping: StateMapping | undefined,
+): RpcStateMapping | undefined {
+  if (!stateMapping || stateMapping.length === 0) return undefined
+  return stateMapping.reduce((acc, { slot, value }) => {
+    if (slot.length !== 66)
+      throw new InvalidBytesLengthError({
+        size: slot.length,
+        targetSize: 66,
+        type: 'hex',
+      })
+    if (value.length !== 66)
+      throw new InvalidBytesLengthError({
+        size: value.length,
+        targetSize: 66,
+        type: 'hex',
+      })
+    acc[slot] = value
+    return acc
+  }, {} as RpcStateMapping)
+}
+
+export type ParseAccountStateOverrideErrorType =
+  | NumberToHexErrorType
+  | StateAssignmentConflictErrorType
+  | ParseStateMappingErrorType
+
+export function parseAccountStateOverride(
+  args: Omit<StateOverride[number], 'address'>,
+): RpcAccountStateOverride {
+  const { balance, nonce, state, stateDiff, code } = args
+  const rpcAccountStateOverride: RpcAccountStateOverride = {}
+  if (code !== undefined) {
+    rpcAccountStateOverride.code = code
+  }
+  if (balance !== undefined) {
+    rpcAccountStateOverride.balance = numberToHex(balance, { size: 32 })
+  }
+  if (nonce !== undefined) {
+    rpcAccountStateOverride.nonce = numberToHex(nonce, { size: 8 })
+  }
+  if (state !== undefined) {
+    rpcAccountStateOverride.state = parseStateMapping(state)
+  }
+  if (stateDiff !== undefined) {
+    if (rpcAccountStateOverride.state) throw new StateAssignmentConflictError()
+    rpcAccountStateOverride.stateDiff = parseStateMapping(stateDiff)
+  }
+  return rpcAccountStateOverride
+}
+
+export type ParseStateOverrideErrorType =
+  | InvalidAddressErrorType
+  | AccountStateConflictErrorType
+  | ParseAccountStateOverrideErrorType
+
+export function parseStateOverride(
+  args?: StateOverride,
+): RpcStateOverride | undefined {
+  if (!args) return undefined
+  const rpcStateOverride: RpcStateOverride = {}
+  for (const { address, ...accountState } of args) {
+    if (!isAddress(address)) throw new InvalidAddressError({ address })
+    if (rpcStateOverride[address])
+      throw new AccountStateConflictError({ address: address })
+    rpcStateOverride[address] = parseAccountStateOverride(accountState)
+  }
+  return rpcStateOverride
+}

package/actions/public/getBlock.ts

@@ -10,6 +10,7 @@ import type { BlockTag } from '../../types/block.js'
 import type { Chain } from '../../types/chain.js'
 import type { Hash } from '../../types/misc.js'
 import type { RpcBlock } from '../../types/rpc.js'
+import type { Prettify } from '../../types/utils.js'
 import type { RequestErrorType } from '../../utils/buildRequest.js'
 import {
   type NumberToHexErrorType,
@@ -54,7 +55,7 @@ export type GetBlockReturnType<
   TChain extends Chain | undefined = undefined,
   TIncludeTransactions extends boolean = false,
   TBlockTag extends BlockTag = 'latest',
-> = FormattedBlock<TChain, TIncludeTransactions, TBlockTag>
+> = Prettify<FormattedBlock<TChain, TIncludeTransactions, TBlockTag>>
 
 export type GetBlockErrorType =
   | BlockNotFoundErrorType

package/actions/public/multicall.ts

@@ -42,7 +42,7 @@ export type MulticallParameters<
     optional?: boolean
     properties?: Record<string, any>
   } = {},
-> = Pick<CallParameters, 'blockNumber' | 'blockTag'> & {
+> = Pick<CallParameters, 'blockNumber' | 'blockTag' | 'stateOverride'> & {
   allowFailure?: allowFailure | boolean | undefined
   batchSize?: number | undefined
   contracts: MulticallContracts<
@@ -125,6 +125,7 @@ export async function multicall<
     blockNumber,
     blockTag,
     multicallAddress: multicallAddress_,
+    stateOverride,
   } = parameters
   const contracts = parameters.contracts as ContractFunctionParameters[]
 
@@ -218,6 +219,7 @@ export async function multicall<
         blockNumber,
         blockTag,
         functionName: 'aggregate3',
+        stateOverride,
       }),
     ),
   )

package/actions/public/readContract.ts

@@ -40,7 +40,7 @@ export type ReadContractParameters<
     functionName
   > = ContractFunctionArgs<abi, 'pure' | 'view', functionName>,
 > = UnionEvaluate<
-  Pick<CallParameters, 'account' | 'blockNumber' | 'blockTag'>
+  Pick<CallParameters, 'account' | 'blockNumber' | 'blockTag' | 'stateOverride'>
 > &
   ContractFunctionParameters<abi, 'pure' | 'view', functionName, args>
 

package/chains/definitions/x1Testnet.ts

@@ -0,0 +1,27 @@
+import { defineChain } from '../../utils/chain/defineChain.js'
+
+export const x1Testnet = /*#__PURE__*/ defineChain({
+  id: 195,
+  name: 'X1 Testnet',
+  nativeCurrency: {
+    decimals: 18,
+    name: 'OKB',
+    symbol: 'OKB',
+  },
+  rpcUrls: {
+    default: { http: ['https://x1testrpc.okx.com'] },
+  },
+  blockExplorers: {
+    default: {
+      name: 'OKLink',
+      url: 'https://www.oklink.com/x1-test',
+    },
+  },
+  contracts: {
+    multicall3: {
+      address: '0xca11bde05977b3631167028862be2a173976ca11',
+      blockCreated: 624344,
+    },
+  },
+  testnet: true,
+})

package/chains/index.ts

@@ -185,6 +185,7 @@ export { wanchain } from './definitions/wanchain.js'
 export { wanchainTestnet } from './definitions/wanchainTestnet.js'
 export { wemix } from './definitions/wemix.js'
 export { wemixTestnet } from './definitions/wemixTestnet.js'
+export { x1Testnet } from './definitions/x1Testnet.js'
 export { xdc } from './definitions/xdc.js'
 export { xdcTestnet } from './definitions/xdcTestnet.js'
 export { zhejiang } from './definitions/zhejiang.js'

package/clients/createClient.ts

@@ -60,8 +60,12 @@ export type ClientConfig<
 // They are allowed to be extended, but must conform to their parameter & return type interfaces.
 // Example: an extended `call` action must accept `CallParameters` as parameters,
 // and conform to the `CallReturnType` return type.
-type ExtendableProtectedActions = Pick<
-  PublicActions,
+type ExtendableProtectedActions<
+  transport extends Transport = Transport,
+  chain extends Chain | undefined = Chain | undefined,
+  account extends Account | undefined = Account | undefined,
+> = Pick<
+  PublicActions<transport, chain, account>,
   | 'call'
   | 'createContractEventFilter'
   | 'createEventFilter'
@@ -86,7 +90,7 @@ type ExtendableProtectedActions = Pick<
   | 'watchBlockNumber'
   | 'watchContractEvent'
 > &
-  Pick<WalletActions, 'sendTransaction' | 'writeContract'>
+  Pick<WalletActions<chain, account>, 'sendTransaction' | 'writeContract'>
 
 // TODO: Move `transport` to slot index 2 since `chain` and `account` used more frequently.
 // Otherwise, we end up with a lot of `Client<Transport, chain, account>` in actions.
@@ -99,7 +103,8 @@ export type Client<
 > = Client_Base<transport, chain, account, rpcSchema> &
   (extended extends Extended ? extended : unknown) & {
     extend: <
-      const client extends Extended & Partial<ExtendableProtectedActions>,
+      const client extends Extended &
+        Partial<ExtendableProtectedActions<transport, chain, account>>,
     >(
       fn: (
         client: Client<transport, chain, account, rpcSchema, extended>,