viem 0.0.1-alpha.24 → 0.0.1-alpha.25

package/src/clients/transports/webSocket.test.ts

@@ -1,4 +1,5 @@
 import { assertType, describe, expect, test } from 'vitest'
+import WebSocket from 'isomorphic-ws'
 
 import { localWsUrl } from '../../_test'
 import { localhost } from '../../chains'

package/src/clients/transports/webSocket.ts

@@ -1,3 +1,4 @@
+import WebSocket from 'isomorphic-ws'
 import { UrlRequiredError } from '../../errors'
 import type { Hash } from '../../types'
 import type { RpcResponse } from '../../utils/rpc'

package/src/contract.test.ts

@@ -0,0 +1,31 @@
+import { expect, test } from 'vitest'
+
+import * as contract from './contract'
+
+test('exports contract actions', () => {
+  expect(Object.keys(contract)).toMatchInlineSnapshot(`
+    [
+      "getBytecode",
+      "getStorageAt",
+      "multicall",
+      "readContract",
+      "simulateContract",
+      "watchContractEvent",
+      "deployContract",
+      "writeContract",
+      "decodeAbi",
+      "decodeErrorResult",
+      "decodeFunctionData",
+      "decodeFunctionResult",
+      "encodeAbi",
+      "encodeDeployData",
+      "encodeErrorResult",
+      "encodeEventTopics",
+      "encodeFunctionData",
+      "encodeFunctionResult",
+      "formatAbiItemWithArgs",
+      "formatAbiItem",
+      "getAbiItem",
+    ]
+  `)
+})

package/src/contract.ts

@@ -0,0 +1,68 @@
+export type {
+  GetBytecodeArgs,
+  GetBytecodeResponse,
+  GetStorageAtArgs,
+  GetStorageAtResponse,
+  MulticallArgs,
+  MulticallResponse,
+  OnLogs,
+  OnLogsResponse,
+  ReadContractArgs,
+  ReadContractResponse,
+  SimulateContractArgs,
+  SimulateContractResponse,
+  WatchContractEventArgs,
+} from './actions/public'
+export {
+  getBytecode,
+  getStorageAt,
+  multicall,
+  readContract,
+  simulateContract,
+  watchContractEvent,
+} from './actions/public'
+
+export type {
+  DeployContractArgs,
+  DeployContractResponse,
+  WriteContractArgs,
+  WriteContractResponse,
+} from './actions/wallet'
+export {
+  deployContract,
+  writeContract,
+} from './actions/wallet'
+
+export type {
+  DecodeAbiArgs,
+  DecodeErrorResultArgs,
+  DecodeErrorResultResponse,
+  DecodeEventLogArgs,
+  DecodeEventLogResponse,
+  DecodeFunctionDataArgs,
+  DecodeFunctionResultArgs,
+  DecodeFunctionResultResponse,
+  EncodeAbiArgs,
+  EncodeDeployDataArgs,
+  EncodeErrorResultArgs,
+  EncodeEventTopicsArgs,
+  EncodeFunctionDataArgs,
+  EncodeFunctionResultArgs,
+  GetAbiItemArgs,
+} from './utils'
+export {
+  decodeAbi,
+  decodeErrorResult,
+  decodeEventLog,
+  decodeFunctionData,
+  decodeFunctionResult,
+  encodeAbi,
+  encodeDeployData,
+  encodeErrorResult,
+  encodeEventTopics,
+  encodeFunctionData,
+  encodeFunctionResult,
+  formatAbiItemWithArgs,
+  formatAbiItem,
+  getAbiItem,
+} from './utils'

package/src/ens.test.ts

@@ -0,0 +1,15 @@
+import { expect, test } from 'vitest'
+
+import * as ens from './ens'
+
+test('exports ens', () => {
+  expect(ens).toMatchInlineSnapshot(`
+    {
+      "getEnsAddress": [Function],
+      "getEnsName": [Function],
+      "labelhash": [Function],
+      "namehash": [Function],
+      "normalize": [Function],
+    }
+  `)
+})

package/src/ens.ts

@@ -1,5 +1,8 @@
+export type { GetEnsAddressArgs, GetEnsNameArgs } from './actions/ens'
+export { getEnsAddress, getEnsName } from './actions/ens'
+
 export {
   labelhash,
   namehash,
   normalize,
-} from './utils'
+} from './utils/ens'

package/src/errors/abi.ts

@@ -121,7 +121,23 @@ export class AbiErrorSignatureNotFoundError extends BaseError {
       [
         `Encoded error signature "${signature}" not found on ABI.`,
         'Make sure you are using the correct ABI and that the error exists on it.',
-        `You can look up the signature "${signature}" here: https://sig.eth.samczsun.com/.`,
+        `You can look up the signature here: https://openchain.xyz/signatures?query=${signature}.`,
+      ].join('\n'),
+      {
+        docsPath,
+      },
+    )
+  }
+}
+
+export class AbiEventSignatureNotFoundError extends BaseError {
+  name = 'AbiEventSignatureNotFoundError'
+  constructor(signature: Hex, { docsPath }: { docsPath: string }) {
+    super(
+      [
+        `Encoded event signature "${signature}" not found on ABI.`,
+        'Make sure you are using the correct ABI and that the event exists on it.',
+        `You can look up the signature here: https://openchain.xyz/signatures?query=${signature}.`,
       ].join('\n'),
       {
         docsPath,
@@ -183,7 +199,7 @@ export class AbiFunctionSignatureNotFoundError extends BaseError {
       [
         `Encoded function signature "${signature}" not found on ABI.`,
         'Make sure you are using the correct ABI and that the function exists on it.',
-        `You can look up the signature "${signature}" here: https://sig.eth.samczsun.com/.`,
+        `You can look up the signature here: https://openchain.xyz/signatures?query=${signature}.`,
       ].join('\n'),
       {
         docsPath,

package/src/errors/chain.test.ts

@@ -0,0 +1,46 @@
+import { expect, test } from 'vitest'
+import { mainnet } from '../chains'
+import { ChainDoesNotSupportContract } from './chain'
+
+test('ChainDoesNotSupportContract', () => {
+  expect(
+    new ChainDoesNotSupportContract({
+      chain: mainnet,
+      contract: { name: 'ensUniversalResolver' },
+    }),
+  ).toMatchInlineSnapshot(`
+    [ChainDoesNotSupportContract: Chain "Ethereum" does not support contract "ensUniversalResolver".
+
+    This could be due to any of the following:
+    - The chain does not have the contract "ensUniversalResolver" configured.
+
+    Version: viem@1.0.2]
+  `)
+  expect(
+    new ChainDoesNotSupportContract({
+      chain: mainnet,
+      contract: { name: 'ensUniversalResolver', blockCreated: 16172161 },
+    }),
+  ).toMatchInlineSnapshot(`
+    [ChainDoesNotSupportContract: Chain "Ethereum" does not support contract "ensUniversalResolver".
+
+    This could be due to any of the following:
+    - The chain does not have the contract "ensUniversalResolver" configured.
+
+    Version: viem@1.0.2]
+  `)
+  expect(
+    new ChainDoesNotSupportContract({
+      blockNumber: 16172160n,
+      chain: mainnet,
+      contract: { name: 'ensUniversalResolver', blockCreated: 16172161 },
+    }),
+  ).toMatchInlineSnapshot(`
+    [ChainDoesNotSupportContract: Chain "Ethereum" does not support contract "ensUniversalResolver".
+
+    This could be due to any of the following:
+    - The contract "ensUniversalResolver" was not deployed until block 16172161 (current block 16172160).
+
+    Version: viem@1.0.2]
+  `)
+})

package/src/errors/chain.ts

@@ -0,0 +1,33 @@
+import { Chain } from '../types'
+import { BaseError } from './base'
+
+export class ChainDoesNotSupportContract extends BaseError {
+  name = 'ChainDoesNotSupportContract'
+  constructor({
+    blockNumber,
+    chain,
+    contract,
+  }: {
+    blockNumber?: bigint
+    chain: Chain
+    contract: { name: string; blockCreated?: number }
+  }) {
+    super(
+      `Chain "${chain.name}" does not support contract "${contract.name}".`,
+      {
+        metaMessages: [
+          'This could be due to any of the following:',
+          ...(blockNumber &&
+          contract.blockCreated &&
+          contract.blockCreated > blockNumber
+            ? [
+                `- The contract "${contract.name}" was not deployed until block ${contract.blockCreated} (current block ${blockNumber}).`,
+              ]
+            : [
+                `- The chain does not have the contract "${contract.name}" configured.`,
+              ]),
+        ],
+      },
+    )
+  }
+}

package/src/errors/contract.ts

@@ -1,12 +1,12 @@
 import { Abi } from 'abitype'
 import { panicReasons } from '../constants'
-import { Address, Hex } from '../types'
+import { Address, Chain, Hex } from '../types'
 import {
   DecodeErrorResultResponse,
   decodeErrorResult,
   getAbiItem,
-  formatAbiItemWithArgs,
   formatAbiItem,
+  formatAbiItemWithArgs,
 } from '../utils'
 import { BaseError } from './base'
 

package/src/errors/index.ts

@@ -8,6 +8,7 @@ export {
   AbiErrorInputsNotFoundError,
   AbiErrorNotFoundError,
   AbiErrorSignatureNotFoundError,
+  AbiEventSignatureNotFoundError,
   AbiEventNotFoundError,
   AbiFunctionNotFoundError,
   AbiFunctionOutputsNotFoundError,
@@ -24,6 +25,8 @@ export { BaseError } from './base'
 
 export { BlockNotFoundError } from './block'
 
+export { ChainDoesNotSupportContract } from './chain'
+
 export {
   ContractFunctionExecutionError,
   ContractFunctionRevertedError,

package/src/index.test.ts

@@ -59,102 +59,14 @@ test('exports actions', () => {
       "UrlRequiredError": [Function],
       "WaitForTransactionReceiptTimeoutError": [Function],
       "WebSocketRequestError": [Function],
-      "addChain": [Function],
-      "boolToBytes": [Function],
-      "boolToHex": [Function],
-      "bytesToBigint": [Function],
-      "bytesToBool": [Function],
-      "bytesToHex": [Function],
-      "bytesToNumber": [Function],
-      "bytesToString": [Function],
-      "call": [Function],
-      "createBlockFilter": [Function],
       "createClient": [Function],
-      "createContractEventFilter": [Function],
-      "createEventFilter": [Function],
-      "createPendingTransactionFilter": [Function],
       "createPublicClient": [Function],
       "createTestClient": [Function],
       "createTransport": [Function],
       "createWalletClient": [Function],
       "custom": [Function],
-      "decodeAbi": [Function],
-      "decodeBytes": [Function],
-      "decodeErrorResult": [Function],
-      "decodeFunctionData": [Function],
-      "decodeFunctionResult": [Function],
-      "decodeHex": [Function],
-      "decodeRlp": [Function],
-      "deployContract": [Function],
-      "dropTransaction": [Function],
-      "encodeAbi": [Function],
-      "encodeBytes": [Function],
-      "encodeDeployData": [Function],
-      "encodeErrorResult": [Function],
-      "encodeEventTopics": [Function],
-      "encodeFunctionData": [Function],
-      "encodeFunctionResult": [Function],
-      "encodeHex": [Function],
-      "encodeRlp": [Function],
-      "estimateGas": [Function],
-      "etherUnits": {
-        "gwei": 9,
-        "wei": 18,
-      },
       "fallback": [Function],
-      "formatBlock": [Function],
-      "formatEther": [Function],
-      "formatGwei": [Function],
-      "formatTransaction": [Function],
-      "formatTransactionRequest": [Function],
-      "formatUnit": [Function],
-      "getAccounts": [Function],
-      "getAddress": [Function],
-      "getAutomine": [Function],
-      "getBalance": [Function],
-      "getBlock": [Function],
-      "getBlockNumber": [Function],
-      "getBlockTransactionCount": [Function],
-      "getBytecode": [Function],
-      "getChainId": [Function],
-      "getContractAddress": [Function],
-      "getCreate2Address": [Function],
-      "getCreateAddress": [Function],
-      "getEventSignature": [Function],
-      "getFeeHistory": [Function],
-      "getFilterChanges": [Function],
-      "getFilterLogs": [Function],
-      "getFunctionSignature": [Function],
-      "getGasPrice": [Function],
-      "getLogs": [Function],
-      "getPermissions": [Function],
-      "getStorageAt": [Function],
-      "getTransaction": [Function],
-      "getTransactionConfirmations": [Function],
-      "getTransactionCount": [Function],
-      "getTransactionReceipt": [Function],
-      "getTxpoolContent": [Function],
-      "getTxpoolStatus": [Function],
-      "gweiUnits": {
-        "ether": -9,
-        "wei": 9,
-      },
-      "hexToBigInt": [Function],
-      "hexToBool": [Function],
-      "hexToBytes": [Function],
-      "hexToNumber": [Function],
-      "hexToString": [Function],
       "http": [Function],
-      "impersonateAccount": [Function],
-      "increaseTime": [Function],
-      "inspectTxpool": [Function],
-      "isAddress": [Function],
-      "isAddressEqual": [Function],
-      "isBytes": [Function],
-      "isHex": [Function],
-      "keccak256": [Function],
-      "mine": [Function],
-      "multicall": [Function],
       "multicall3Abi": [
         {
           "inputs": [
@@ -198,66 +110,7 @@ test('exports actions', () => {
           "type": "function",
         },
       ],
-      "numberToBytes": [Function],
-      "numberToHex": [Function],
-      "pad": [Function],
-      "padBytes": [Function],
-      "padHex": [Function],
-      "parseEther": [Function],
-      "parseGwei": [Function],
-      "parseUnit": [Function],
-      "readContract": [Function],
-      "removeBlockTimestampInterval": [Function],
-      "requestAccounts": [Function],
-      "requestPermissions": [Function],
-      "reset": [Function],
-      "revert": [Function],
-      "sendTransaction": [Function],
-      "sendUnsignedTransaction": [Function],
-      "setAutomine": [Function],
-      "setBalance": [Function],
-      "setBlockGasLimit": [Function],
-      "setBlockTimestampInterval": [Function],
-      "setCode": [Function],
-      "setCoinbase": [Function],
-      "setIntervalMining": [Function],
-      "setLoggingEnabled": [Function],
-      "setMinGasPrice": [Function],
-      "setNextBlockBaseFeePerGas": [Function],
-      "setNextBlockTimestamp": [Function],
-      "setNonce": [Function],
-      "setStorageAt": [Function],
-      "signMessage": [Function],
-      "simulateContract": [Function],
-      "size": [Function],
-      "slice": [Function],
-      "sliceBytes": [Function],
-      "sliceHex": [Function],
-      "snapshot": [Function],
-      "stopImpersonatingAccount": [Function],
-      "stringToBytes": [Function],
-      "stringToHex": [Function],
-      "switchChain": [Function],
-      "transactionType": {
-        "0x0": "legacy",
-        "0x1": "eip2930",
-        "0x2": "eip1559",
-      },
-      "trim": [Function],
-      "uninstallFilter": [Function],
-      "waitForTransactionReceipt": [Function],
-      "watchAsset": [Function],
-      "watchBlockNumber": [Function],
-      "watchBlocks": [Function],
-      "watchContractEvent": [Function],
-      "watchEvent": [Function],
-      "watchPendingTransactions": [Function],
       "webSocket": [Function],
-      "weiUnits": {
-        "ether": -18,
-        "gwei": -9,
-      },
-      "writeContract": [Function],
     }
   `)
 })