viem 0.0.1-alpha.21 → 0.0.1-alpha.22

package/src/actions/wallet/writeContract.ts

@@ -1,13 +1,7 @@
 import { Abi } from 'abitype'
 
 import type { WalletClient } from '../../clients'
-import type {
-  Address,
-  Chain,
-  ExtractArgsFromAbi,
-  ExtractFunctionNameFromAbi,
-  GetValue,
-} from '../../types'
+import type { Chain, ContractConfig, GetValue } from '../../types'
 import { EncodeFunctionDataArgs, encodeFunctionData } from '../../utils'
 import {
   sendTransaction,
@@ -18,20 +12,17 @@ import {
 export type WriteContractArgs<
   TChain extends Chain = Chain,
   TAbi extends Abi | readonly unknown[] = Abi,
-  TFunctionName extends string = any,
+  TFunctionName extends string = string,
 > = Omit<SendTransactionArgs<TChain>, 'to' | 'data' | 'value'> & {
-  address: Address
-  abi: TAbi
-  functionName: ExtractFunctionNameFromAbi<TAbi, TFunctionName>
   value?: GetValue<TAbi, TFunctionName, SendTransactionArgs<TChain>['value']>
-} & ExtractArgsFromAbi<TAbi, TFunctionName>
+} & ContractConfig<TAbi, TFunctionName, 'payable' | 'nonpayable'>
 
 export type WriteContractResponse = SendTransactionResponse
 
 export async function writeContract<
   TChain extends Chain,
-  TAbi extends Abi = Abi,
-  TFunctionName extends string = any,
+  TAbi extends Abi | readonly unknown[],
+  TFunctionName extends string,
 >(
   client: WalletClient,
   {

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

@@ -126,6 +126,40 @@ describe('request', () => {
     // ensure `retryCount` on transport is adhered
     expect(count).toBe(6)
   })
+
+  test('error (rpc)', async () => {
+    let count = 0
+    const server1 = await createHttpServer((req, res) => {
+      count++
+      res.writeHead(200, {
+        'Content-Type': 'application/json',
+      })
+      res.end(JSON.stringify({ error: 'ngmi' }))
+    })
+    const server2 = await createHttpServer((req, res) => {
+      count++
+      res.writeHead(500)
+      res.end()
+    })
+    const server3 = await createHttpServer((req, res) => {
+      count++
+      res.writeHead(200, {
+        'Content-Type': 'application/json',
+      })
+      res.end(JSON.stringify({ result: '0x1' }))
+    })
+
+    let transport = fallback([
+      http(server1.url),
+      http(server2.url),
+      http(server3.url),
+    ])({
+      chain: localhost,
+    })
+    await expect(() =>
+      transport.config.request({ method: 'eth_blockNumber' }),
+    ).rejects.toThrowError()
+  })
 })
 
 describe('client', () => {

package/src/clients/transports/fallback.ts

@@ -1,3 +1,4 @@
+import { HttpRequestError, RpcError } from '../../errors'
 import type { Transport, TransportConfig } from './createTransport'
 import { createTransport } from './createTransport'
 
@@ -31,7 +32,8 @@ export function fallback(
                 params,
               } as any)
             } catch (err) {
-              if (i < transports.length - 1) return fetch(i + 1)
+              if (!(err instanceof RpcError) && i < transports.length - 1)
+                return fetch(i + 1)
               throw err
             }
           }

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

@@ -103,7 +103,6 @@ test('no url', () => {
     "No URL was provided to the Transport. Please provide a valid RPC URL to the Transport.
 
     Docs: https://viem.sh/docs/clients/intro
-
     Version: viem@1.0.2"
   `,
   )

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

@@ -158,7 +158,6 @@ test('no url', () => {
     "No URL was provided to the Transport. Please provide a valid RPC URL to the Transport.
 
     Docs: https://viem.sh/docs/clients/intro
-
     Version: viem@1.0.2"
   `)
 })

package/src/constants/abis.test.ts

@@ -0,0 +1,53 @@
+import { expect, test } from 'vitest'
+
+import * as abis from './abis'
+
+test('exports abis', () => {
+  expect(abis).toMatchInlineSnapshot(`
+    {
+      "multicall3Abi": [
+        {
+          "inputs": [
+            {
+              "components": [
+                {
+                  "name": "target",
+                  "type": "address",
+                },
+                {
+                  "name": "allowFailure",
+                  "type": "bool",
+                },
+                {
+                  "name": "callData",
+                  "type": "bytes",
+                },
+              ],
+              "name": "calls",
+              "type": "tuple[]",
+            },
+          ],
+          "name": "aggregate3",
+          "outputs": [
+            {
+              "components": [
+                {
+                  "name": "success",
+                  "type": "bool",
+                },
+                {
+                  "name": "returnData",
+                  "type": "bytes",
+                },
+              ],
+              "name": "returnData",
+              "type": "tuple[]",
+            },
+          ],
+          "stateMutability": "view",
+          "type": "function",
+        },
+      ],
+    }
+  `)
+})

package/src/constants/abis.ts

@@ -0,0 +1,44 @@
+/* [Multicall3](https://github.com/mds1/multicall) */
+export const multicall3Abi = [
+  {
+    inputs: [
+      {
+        components: [
+          {
+            name: 'target',
+            type: 'address',
+          },
+          {
+            name: 'allowFailure',
+            type: 'bool',
+          },
+          {
+            name: 'callData',
+            type: 'bytes',
+          },
+        ],
+        name: 'calls',
+        type: 'tuple[]',
+      },
+    ],
+    name: 'aggregate3',
+    outputs: [
+      {
+        components: [
+          {
+            name: 'success',
+            type: 'bool',
+          },
+          {
+            name: 'returnData',
+            type: 'bytes',
+          },
+        ],
+        name: 'returnData',
+        type: 'tuple[]',
+      },
+    ],
+    stateMutability: 'view',
+    type: 'function',
+  },
+] as const

package/src/constants/index.test.ts

@@ -0,0 +1,14 @@
+import { expect, test } from 'vitest'
+
+import * as index from './index'
+
+test('exports index', () => {
+  expect(Object.keys(index)).toMatchInlineSnapshot(`
+    [
+      "multicall3Abi",
+      "panicReasons",
+      "solidityError",
+      "solidityPanic",
+    ]
+  `)
+})

package/src/constants/index.ts

@@ -0,0 +1,3 @@
+export { multicall3Abi } from './abis'
+
+export { panicReasons, solidityError, solidityPanic } from './solidity'

package/src/constants/solidity.test.ts

@@ -0,0 +1,41 @@
+import { expect, test } from 'vitest'
+
+import * as solidity from './solidity'
+
+test('exports solidity constants', () => {
+  expect(solidity).toMatchInlineSnapshot(`
+    {
+      "panicReasons": {
+        "1": "An \`assert\` condition failed.",
+        "17": "Arithmic operation resulted in underflow or overflow.",
+        "18": "Division or modulo by zero (e.g. \`5 / 0\` or \`23 % 0\`).",
+        "33": "Attempted to convert to an invalid type.",
+        "34": "Attempted to access a storage byte array that is incorrectly encoded.",
+        "49": "Performed \`.pop()\` on an empty array",
+        "50": "Array index is out of bounds.",
+        "65": "Allocated too much memory or created an array which is too large.",
+        "81": "Attempted to call a zero-initialized variable of internal function type.",
+      },
+      "solidityError": {
+        "inputs": [
+          {
+            "name": "message",
+            "type": "string",
+          },
+        ],
+        "name": "Error",
+        "type": "error",
+      },
+      "solidityPanic": {
+        "inputs": [
+          {
+            "name": "reason",
+            "type": "uint256",
+          },
+        ],
+        "name": "Panic",
+        "type": "error",
+      },
+    }
+  `)
+})

package/src/constants/solidity.ts

@@ -0,0 +1,35 @@
+import { AbiError } from 'abitype'
+
+// https://docs.soliditylang.org/en/v0.8.16/control-structures.html#panic-via-assert-and-error-via-require
+export const panicReasons = {
+  1: 'An `assert` condition failed.',
+  17: 'Arithmic operation resulted in underflow or overflow.',
+  18: 'Division or modulo by zero (e.g. `5 / 0` or `23 % 0`).',
+  33: 'Attempted to convert to an invalid type.',
+  34: 'Attempted to access a storage byte array that is incorrectly encoded.',
+  49: 'Performed `.pop()` on an empty array',
+  50: 'Array index is out of bounds.',
+  65: 'Allocated too much memory or created an array which is too large.',
+  81: 'Attempted to call a zero-initialized variable of internal function type.',
+} as const
+
+export const solidityError: AbiError = {
+  inputs: [
+    {
+      name: 'message',
+      type: 'string',
+    },
+  ],
+  name: 'Error',
+  type: 'error',
+}
+export const solidityPanic: AbiError = {
+  inputs: [
+    {
+      name: 'reason',
+      type: 'uint256',
+    },
+  ],
+  name: 'Panic',
+  type: 'error',
+}

package/src/ens.ts

@@ -0,0 +1,5 @@
+export {
+  labelhash,
+  namehash,
+  normalize,
+} from './utils'

package/src/errors/abi.test.ts

@@ -25,7 +25,6 @@ test('InvalidAbiDecodingTypeError', () => {
     Please provide a valid ABI type.
 
     Docs: https://viem.sh/lol
-
     Version: viem@1.0.2]
   `)
 })
@@ -69,7 +68,6 @@ test('InvalidAbiEncodingTypeError', () => {
     Please provide a valid ABI type.
 
     Docs: https://viem.sh/lol
-
     Version: viem@1.0.2]
   `)
 })

package/src/errors/base.test.ts

@@ -17,6 +17,13 @@ test('BaseError', () => {
     Details: details
     Version: viem@1.0.2]
   `)
+
+  expect(new BaseError('', { details: 'details' })).toMatchInlineSnapshot(`
+    [ViemError: An error occurred.
+
+    Details: details
+    Version: viem@1.0.2]
+  `)
 })
 
 test('BaseError (w/ docsPath)', () => {
@@ -29,6 +36,43 @@ test('BaseError (w/ docsPath)', () => {
     [ViemError: An error occurred.
 
     Docs: https://viem.sh/lol
+    Details: details
+    Version: viem@1.0.2]
+  `)
+  expect(
+    new BaseError('An error occurred.', {
+      cause: new BaseError('error', { docsPath: '/docs' }),
+    }),
+  ).toMatchInlineSnapshot(`
+    [ViemError: An error occurred.
+
+    Docs: https://viem.sh/docs
+    Version: viem@1.0.2]
+  `)
+  expect(
+    new BaseError('An error occurred.', {
+      cause: new BaseError('error'),
+      docsPath: '/lol',
+    }),
+  ).toMatchInlineSnapshot(`
+    [ViemError: An error occurred.
+
+    Docs: https://viem.sh/lol
+    Version: viem@1.0.2]
+  `)
+})
+
+test('BaseError (w/ metaMessages)', () => {
+  expect(
+    new BaseError('An error occurred.', {
+      details: 'details',
+      metaMessages: ['Reason: idk', 'Cause: lol'],
+    }),
+  ).toMatchInlineSnapshot(`
+    [ViemError: An error occurred.
+
+    Reason: idk
+    Cause: lol
 
     Details: details
     Version: viem@1.0.2]
@@ -48,7 +92,6 @@ test('inherited BaseError', () => {
     [ViemError: An internal error occurred.
 
     Docs: https://viem.sh/lol
-
     Details: details
     Version: viem@1.0.2]
   `)
@@ -65,7 +108,6 @@ test('inherited Error', () => {
     [ViemError: An internal error occurred.
 
     Docs: https://viem.sh/lol
-
     Details: details
     Version: viem@1.0.2]
   `)

package/src/errors/base.ts

@@ -1,11 +1,13 @@
 // @ts-ignore
 import pkg from '../../package.json'
-import { stringify } from '../utils/stringify'
 
 /* c8 ignore next */
 const version = process.env.TEST ? '1.0.2' : pkg.version
 
-type BaseErrorArgs = { docsPath?: string } & (
+type BaseErrorArgs = {
+  docsPath?: string
+  metaMessages?: string[]
+} & (
   | {
       cause?: never
       details?: string
@@ -17,13 +19,14 @@ type BaseErrorArgs = { docsPath?: string } & (
 )
 
 export class BaseError extends Error {
-  humanMessage: string
   details: string
   docsPath?: string
+  metaMessages?: string[]
+  shortMessage: string
 
   name = 'ViemError'
 
-  constructor(humanMessage: string, args: BaseErrorArgs = {}) {
+  constructor(shortMessage: string, args: BaseErrorArgs = {}) {
     const details =
       args.cause instanceof BaseError
         ? args.cause.details
@@ -35,16 +38,12 @@ export class BaseError extends Error {
         ? args.cause.docsPath || args.docsPath
         : args.docsPath
     const message = [
-      humanMessage,
-      ...(docsPath ? ['', `Docs: https://viem.sh${docsPath}`] : []),
+      shortMessage || 'An error occurred.',
       '',
+      ...(args.metaMessages ? [...args.metaMessages, ''] : []),
+      ...(docsPath ? [`Docs: https://viem.sh${docsPath}`] : []),
       ...(details ? [`Details: ${details}`] : []),
       `Version: viem@${version}`,
-      ...(args.cause &&
-      !(args.cause instanceof BaseError) &&
-      Object.keys(args.cause).length > 0
-        ? [`Internal Error: ${stringify(args.cause)}`]
-        : []),
     ].join('\n')
 
     super(message)
@@ -52,6 +51,7 @@ export class BaseError extends Error {
     if (args.cause) this.cause = args.cause
     this.details = details
     this.docsPath = docsPath
-    this.humanMessage = humanMessage
+    this.metaMessages = args.metaMessages
+    this.shortMessage = shortMessage
   }
 }

package/src/errors/block.test.ts

@@ -5,17 +5,17 @@ test('BlockNotFoundError', () => {
   expect(
     new BlockNotFoundError({ blockNumber: 69420n }),
   ).toMatchInlineSnapshot(`
-      [BlockNotFoundError: Block at number "69420" could not be found.
+    [BlockNotFoundError: Block at number "69420" could not be found.
 
-      Version: viem@1.0.2]
-    `)
+    Version: viem@1.0.2]
+  `)
   expect(
     new BlockNotFoundError({ blockHash: '0x69420' }),
   ).toMatchInlineSnapshot(`
-      [BlockNotFoundError: Block at hash "0x69420" could not be found.
+    [BlockNotFoundError: Block at hash "0x69420" could not be found.
 
-      Version: viem@1.0.2]
-    `)
+    Version: viem@1.0.2]
+  `)
   expect(new BlockNotFoundError({})).toMatchInlineSnapshot(`
     [BlockNotFoundError: Block could not be found.