viem 0.0.1-alpha.21 → 0.0.1-alpha.23

package/src/utils/abi/encodeDeployData.test.ts

@@ -11,7 +11,7 @@ test('constructor()', () => {
           stateMutability: 'nonpayable',
           type: 'constructor',
         },
-      ] as const,
+      ],
       bytecode:
         '0x6080604052348015600f57600080fd5b50603f80601d6000396000f3fe6080604052600080fdfea2646970667358221220116554d4ba29ee08da9e97dc54ff9a2a65d67a648140d616fc225a25ff08c86364736f6c63430008070033',
     }),
@@ -20,13 +20,12 @@ test('constructor()', () => {
   )
   expect(
     encodeDeployData({
-      // @ts-expect-error
       abi: [
         {
           stateMutability: 'nonpayable',
           type: 'constructor',
         },
-      ] as const,
+      ],
       bytecode:
         '0x6080604052348015600f57600080fd5b50603f80601d6000396000f3fe6080604052600080fdfea2646970667358221220116554d4ba29ee08da9e97dc54ff9a2a65d67a648140d616fc225a25ff08c86364736f6c63430008070033',
     }),
@@ -50,7 +49,7 @@ test('constructor(uint256)', () => {
           stateMutability: 'nonpayable',
           type: 'constructor',
         },
-      ] as const,
+      ],
       bytecode:
         '0x6080604052348015600f57600080fd5b50603f80601d6000396000f3fe6080604052600080fdfea2646970667358221220116554d4ba29ee08da9e97dc54ff9a2a65d67a648140d616fc225a25ff08c86364736f6c63430008070033',
       args: [69420n],
@@ -63,8 +62,7 @@ test('constructor(uint256)', () => {
 test('error: constructor not found', () => {
   expect(() =>
     encodeDeployData({
-      // @ts-expect-error
-      abi: [{}] as const,
+      abi: [{}],
       bytecode:
         '0x6080604052348015600f57600080fd5b50603f80601d6000396000f3fe6080604052600080fdfea2646970667358221220116554d4ba29ee08da9e97dc54ff9a2a65d67a648140d616fc225a25ff08c86364736f6c63430008070033',
       args: [69420n],
@@ -74,7 +72,6 @@ test('error: constructor not found', () => {
     Make sure you are using the correct ABI and that the constructor exists on it.
 
     Docs: https://viem.sh/docs/contract/encodeDeployData
-
     Version: viem@1.0.2"
   `)
 })
@@ -82,13 +79,12 @@ test('error: constructor not found', () => {
 test('error: no inputs', () => {
   expect(() =>
     encodeDeployData({
-      // @ts-expect-error
       abi: [
         {
           stateMutability: 'nonpayable',
           type: 'constructor',
         },
-      ] as const,
+      ],
       bytecode:
         '0x6080604052348015600f57600080fd5b50603f80601d6000396000f3fe6080604052600080fdfea2646970667358221220116554d4ba29ee08da9e97dc54ff9a2a65d67a648140d616fc225a25ff08c86364736f6c63430008070033',
       args: [69420n],
@@ -99,21 +95,19 @@ test('error: no inputs', () => {
     Make sure you are using the correct ABI, and that the \`inputs\` attribute on the constructor exists.
 
     Docs: https://viem.sh/docs/contract/encodeDeployData
-
     Version: viem@1.0.2"
   `,
   )
 
   expect(() =>
     encodeDeployData({
-      // @ts-expect-error
       abi: [
         {
           inputs: undefined,
           stateMutability: 'nonpayable',
           type: 'constructor',
         },
-      ] as const,
+      ],
       bytecode:
         '0x6080604052348015600f57600080fd5b50603f80601d6000396000f3fe6080604052600080fdfea2646970667358221220116554d4ba29ee08da9e97dc54ff9a2a65d67a648140d616fc225a25ff08c86364736f6c63430008070033',
       args: [69420n],
@@ -124,7 +118,6 @@ test('error: no inputs', () => {
     Make sure you are using the correct ABI, and that the \`inputs\` attribute on the constructor exists.
 
     Docs: https://viem.sh/docs/contract/encodeDeployData
-
     Version: viem@1.0.2"
   `,
   )

package/src/utils/abi/encodeDeployData.ts

@@ -1,4 +1,4 @@
-import { Abi } from 'abitype'
+import { Abi, Narrow } from 'abitype'
 
 import {
   AbiConstructorNotFoundError,
@@ -10,19 +10,22 @@ import { encodeAbi } from './encodeAbi'
 
 const docsPath = '/docs/contract/encodeDeployData'
 
-export type EncodeDeployDataArgs<TAbi extends Abi = Abi> = {
-  abi: TAbi
-  bytecode: Hex
-} & ExtractConstructorArgsFromAbi<TAbi>
+export type EncodeDeployDataArgs<TAbi extends Abi | readonly unknown[] = Abi> =
+  {
+    abi: Narrow<TAbi>
+    bytecode: Hex
+  } & ExtractConstructorArgsFromAbi<TAbi>
 
-export function encodeDeployData<TAbi extends Abi = Abi>({
+export function encodeDeployData<TAbi extends Abi | readonly unknown[]>({
   abi,
   args,
   bytecode,
 }: EncodeDeployDataArgs<TAbi>) {
   if (!args || args.length === 0) return bytecode
 
-  const description = abi.find((x) => 'type' in x && x.type === 'constructor')
+  const description = (abi as Abi).find(
+    (x) => 'type' in x && x.type === 'constructor',
+  )
   if (!description) throw new AbiConstructorNotFoundError({ docsPath })
   if (!('inputs' in description))
     throw new AbiConstructorParamsNotFoundError({ docsPath })

package/src/utils/abi/encodeErrorResult.test.ts

@@ -18,7 +18,6 @@ test('revert SoldOutError()', () => {
   expect(
     encodeErrorResult({
       abi: [
-        // @ts-expect-error
         {
           name: 'SoldOutError',
           type: 'error',
@@ -44,7 +43,7 @@ test('revert AccessDeniedError(string)', () => {
           name: 'AccessDeniedError',
           type: 'error',
         },
-      ] as const,
+      ],
       errorName: 'AccessDeniedError',
       args: ['you do not have access ser'],
     }),
@@ -116,6 +115,7 @@ test("errors: error doesn't exist", () => {
           type: 'error',
         },
       ],
+      // @ts-expect-error
       errorName: 'AccessDeniedError',
       args: [
         {
@@ -131,7 +131,6 @@ test("errors: error doesn't exist", () => {
     Make sure you are using the correct ABI and that the error exists on it.
 
     Docs: https://viem.sh/docs/contract/encodeErrorResult
-
     Version: viem@1.0.2"
   `)
 })
@@ -140,7 +139,6 @@ test('errors: no inputs', () => {
   expect(() =>
     encodeErrorResult({
       abi: [
-        // @ts-expect-error
         {
           name: 'AccessDeniedError',
           type: 'error',
@@ -162,14 +160,12 @@ test('errors: no inputs', () => {
     Make sure you are using the correct ABI and that the inputs exist on it.
 
     Docs: https://viem.sh/docs/contract/encodeErrorResult
-
     Version: viem@1.0.2"
   `)
   expect(() =>
     encodeErrorResult({
       abi: [
         {
-          // @ts-expect-error
           inputs: undefined,
           name: 'AccessDeniedError',
           type: 'error',
@@ -191,7 +187,6 @@ test('errors: no inputs', () => {
     Make sure you are using the correct ABI and that the inputs exist on it.
 
     Docs: https://viem.sh/docs/contract/encodeErrorResult
-
     Version: viem@1.0.2"
   `)
 })

package/src/utils/abi/encodeErrorResult.ts

@@ -1,31 +1,38 @@
-import { Abi, ExtractAbiErrorNames } from 'abitype'
+import { Abi, Narrow } from 'abitype'
 import {
   AbiErrorInputsNotFoundError,
   AbiErrorNotFoundError,
 } from '../../errors'
-
-import { ExtractErrorArgsFromAbi, Hex } from '../../types'
+import {
+  ExtractErrorArgsFromAbi,
+  ExtractErrorNameFromAbi,
+  Hex,
+} from '../../types'
 import { concatHex } from '../data'
 import { getFunctionSignature } from '../hash'
 import { encodeAbi } from './encodeAbi'
 import { formatAbiItem } from './formatAbiItem'
-import { getAbiItem } from './getAbiItem'
+import { getAbiItem, GetAbiItemArgs } from './getAbiItem'
 
 const docsPath = '/docs/contract/encodeErrorResult'
 
 export type EncodeErrorResultArgs<
-  TAbi extends Abi = Abi,
-  TErrorName extends ExtractAbiErrorNames<TAbi> = any,
+  TAbi extends Abi | readonly unknown[] = Abi,
+  TErrorName extends string = string,
 > = {
-  abi: TAbi
-  errorName: TErrorName
+  abi: Narrow<TAbi>
+  errorName: ExtractErrorNameFromAbi<TAbi, TErrorName>
 } & ExtractErrorArgsFromAbi<TAbi, TErrorName>
 
 export function encodeErrorResult<
-  TAbi extends Abi = Abi,
-  TErrorName extends ExtractAbiErrorNames<TAbi> = any,
+  TAbi extends Abi | readonly unknown[],
+  TErrorName extends string,
 >({ abi, errorName, args }: EncodeErrorResultArgs<TAbi, TErrorName>) {
-  const description = getAbiItem({ abi, name: errorName })
+  const description = getAbiItem({
+    abi,
+    args,
+    name: errorName,
+  } as GetAbiItemArgs)
   if (!description) throw new AbiErrorNotFoundError(errorName, { docsPath })
   const definition = formatAbiItem(description)
   const signature = getFunctionSignature(definition)

package/src/utils/abi/encodeEventTopics.test.ts

@@ -11,7 +11,7 @@ test('Transfer()', () => {
           name: 'Transfer',
           type: 'event',
         },
-      ] as const,
+      ],
       eventName: 'Transfer',
     }),
   ).toEqual([
@@ -19,13 +19,12 @@ test('Transfer()', () => {
   ])
   expect(
     encodeEventTopics({
-      // @ts-expect-error
       abi: [
         {
           name: 'Transfer',
           type: 'event',
         },
-      ] as const,
+      ],
       eventName: 'Transfer',
     }),
   ).toEqual([
@@ -58,7 +57,7 @@ test('no args: Transfer(address,address,uint256)', () => {
           name: 'Transfer',
           type: 'event',
         },
-      ] as const,
+      ],
       eventName: 'Transfer',
     }),
   ).toEqual([
@@ -91,7 +90,7 @@ test('named args: Transfer(address,address,uint256)', () => {
           name: 'Transfer',
           type: 'event',
         },
-      ] as const,
+      ],
       eventName: 'Transfer',
       args: {
         from: null,
@@ -130,7 +129,7 @@ test('named args: Transfer(address,address,uint256)', () => {
           name: 'Transfer',
           type: 'event',
         },
-      ] as const,
+      ],
       eventName: 'Transfer',
       args: {
         from: null,
@@ -172,7 +171,7 @@ test('unnamed args: Transfer(address,address,uint256)', () => {
           name: 'Transfer',
           type: 'event',
         },
-      ] as const,
+      ],
       eventName: 'Transfer',
       args: [null, '0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC'],
     }),
@@ -205,7 +204,7 @@ test('unnamed args: Transfer(address,address,uint256)', () => {
           name: 'Transfer',
           type: 'event',
         },
-      ] as const,
+      ],
       eventName: 'Transfer',
       args: [
         null,
@@ -240,7 +239,7 @@ test('Foo(string)', () => {
           name: 'Foo',
           type: 'event',
         },
-      ] as const,
+      ],
       eventName: 'Foo',
       args: {
         message: 'hello',
@@ -280,7 +279,7 @@ test('Foo((uint,string))', () => {
           name: 'Bar',
           type: 'event',
         },
-      ] as const,
+      ],
       eventName: 'Bar',
       args: {
         x: {
@@ -311,7 +310,7 @@ test("errors: event doesn't exist", () => {
           name: 'Foo',
           type: 'event',
         },
-      ] as const,
+      ],
       // @ts-expect-error
       eventName: 'Bar',
     }),
@@ -320,7 +319,6 @@ test("errors: event doesn't exist", () => {
     Make sure you are using the correct ABI and that the event exists on it.
 
     Docs: https://viem.sh/docs/contract/encodeEventTopics
-
     Version: viem@1.0.2"
   `)
 })
@@ -328,14 +326,13 @@ test("errors: event doesn't exist", () => {
 test("errors: event doesn't exist", () => {
   expect(
     encodeEventTopics({
-      // @ts-expect-error
       abi: [
         {
           inputs: undefined,
           name: 'Foo',
           type: 'event',
         },
-      ] as const,
+      ],
       eventName: 'Foo',
       // @ts-expect-error
       args: {},

package/src/utils/abi/encodeEventTopics.ts

@@ -3,32 +3,38 @@ import {
   AbiParameter,
   AbiParameterToPrimitiveType,
   ExtractAbiEventNames,
+  Narrow,
 } from 'abitype'
 
 import {
   AbiEventNotFoundError,
   FilterTypeNotSupportedError,
 } from '../../errors'
-import { EventDefinition, ExtractEventArgsFromAbi, Hex } from '../../types'
+import {
+  EventDefinition,
+  ExtractEventArgsFromAbi,
+  ExtractEventNameFromAbi,
+  Hex,
+} from '../../types'
 import { encodeBytes } from '../encoding'
 import { keccak256, getEventSignature } from '../hash'
 import { encodeAbi } from './encodeAbi'
 import { formatAbiItem } from './formatAbiItem'
-import { getAbiItem } from './getAbiItem'
+import { getAbiItem, GetAbiItemArgs } from './getAbiItem'
 
 export type EncodeEventTopicsArgs<
-  TAbi extends Abi = Abi,
-  TEventName extends ExtractAbiEventNames<TAbi> = any,
+  TAbi extends Abi | readonly unknown[] = Abi,
+  TEventName extends string = string,
 > = {
-  abi: TAbi
-  eventName: TEventName
+  abi: Narrow<TAbi>
+  eventName: ExtractEventNameFromAbi<TAbi, TEventName>
 } & ExtractEventArgsFromAbi<TAbi, TEventName>
 
 export function encodeEventTopics<
-  TAbi extends Abi = Abi,
-  TEventName extends ExtractAbiEventNames<TAbi> = any,
+  TAbi extends Abi | readonly unknown[],
+  TEventName extends string,
 >({ abi, eventName, args }: EncodeEventTopicsArgs<TAbi, TEventName>) {
-  const abiItem = getAbiItem({ abi, name: eventName })
+  const abiItem = getAbiItem({ abi, args, name: eventName } as GetAbiItemArgs)
   if (!abiItem)
     throw new AbiEventNotFoundError(eventName, {
       docsPath: '/docs/contract/encodeEventTopics',

package/src/utils/abi/encodeFunctionData.test.ts

@@ -13,13 +13,12 @@ test('foo()', () => {
           stateMutability: 'nonpayable',
           type: 'function',
         },
-      ] as const,
+      ],
       functionName: 'foo',
     }),
   ).toEqual('0xc2985578')
   expect(
     encodeFunctionData({
-      // @ts-expect-error
       abi: [
         {
           name: 'foo',
@@ -27,7 +26,7 @@ test('foo()', () => {
           stateMutability: 'nonpayable',
           type: 'function',
         },
-      ] as const,
+      ],
       functionName: 'foo',
     }),
   ).toEqual('0xc2985578')
@@ -50,7 +49,7 @@ test('bar(uint256)', () => {
           stateMutability: 'nonpayable',
           type: 'function',
         },
-      ] as const,
+      ],
       functionName: 'bar',
       args: [1n],
     }),
@@ -98,7 +97,7 @@ test('getVoter((uint256,bool,address,uint256))', () => {
           stateMutability: 'nonpayable',
           type: 'function',
         },
-      ] as const,
+      ],
       functionName: 'getVoter',
       args: [
         {
@@ -125,7 +124,7 @@ test("errors: function doesn't exist", () => {
           stateMutability: 'nonpayable',
           type: 'function',
         },
-      ] as const,
+      ],
       // @ts-expect-error
       functionName: 'bar',
     }),
@@ -134,7 +133,6 @@ test("errors: function doesn't exist", () => {
     Make sure you are using the correct ABI and that the function exists on it.
 
     Docs: https://viem.sh/docs/contract/encodeFunctionData
-
     Version: viem@1.0.2"
   `)
 })

package/src/utils/abi/encodeFunctionData.ts

@@ -1,26 +1,33 @@
-import { Abi, ExtractAbiFunctionNames } from 'abitype'
+import { Abi, Narrow } from 'abitype'
 
-import { AbiFunctionNotFoundError } from '../../errors'
+import {
+  AbiEncodingLengthMismatchError,
+  AbiFunctionNotFoundError,
+} from '../../errors'
 import { ExtractArgsFromAbi, ExtractFunctionNameFromAbi } from '../../types'
 import { concatHex } from '../data'
 import { getFunctionSignature } from '../hash'
 import { encodeAbi } from './encodeAbi'
 import { formatAbiItem } from './formatAbiItem'
-import { getAbiItem } from './getAbiItem'
+import { getAbiItem, GetAbiItemArgs } from './getAbiItem'
 
 export type EncodeFunctionDataArgs<
-  TAbi extends Abi = Abi,
-  TFunctionName extends string = any,
+  TAbi extends Abi | readonly unknown[] = Abi,
+  TFunctionName extends string = string,
 > = {
-  abi: TAbi
+  abi: Narrow<TAbi>
   functionName: ExtractFunctionNameFromAbi<TAbi, TFunctionName>
 } & ExtractArgsFromAbi<TAbi, TFunctionName>
 
 export function encodeFunctionData<
-  TAbi extends Abi = Abi,
-  TFunctionName extends string = any,
+  TAbi extends Abi | readonly unknown[],
+  TFunctionName extends string,
 >({ abi, args, functionName }: EncodeFunctionDataArgs<TAbi, TFunctionName>) {
-  const description = getAbiItem({ abi, name: functionName })
+  const description = getAbiItem({
+    abi,
+    args,
+    name: functionName,
+  } as GetAbiItemArgs)
   if (!description)
     throw new AbiFunctionNotFoundError(functionName, {
       docsPath: '/docs/contract/encodeFunctionData',

package/src/utils/abi/encodeFunctionResult.test.ts

@@ -30,7 +30,7 @@ test('returns ()', () => {
         },
       ],
       functionName: 'foo',
-      result: [undefined],
+      result: undefined,
     }),
   ).toEqual('0x')
   expect(
@@ -45,7 +45,6 @@ test('returns ()', () => {
         },
       ],
       functionName: 'foo',
-      result: [],
     }),
   ).toEqual('0x')
 })
@@ -67,7 +66,7 @@ test('returns (address)', () => {
           stateMutability: 'pure',
           type: 'function',
         },
-      ] as const,
+      ],
       functionName: 'foo',
       result: '0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC',
     }),
@@ -129,17 +128,15 @@ test('returns (Bar)', () => {
         },
       ],
       functionName: 'bar',
-      result: [
-        {
-          foo: {
-            sender: '0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC',
-            x: 69420n,
-            y: true,
-          },
+      result: {
+        foo: {
           sender: '0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC',
-          z: 69,
+          x: 69420n,
+          y: true,
         },
-      ],
+        sender: '0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC',
+        z: 69,
+      },
     }),
   ).toEqual(
     '0x000000000000000000000000a5cc3c03994db5b0d9a5eedd10cabab0813678ac0000000000000000000000000000000000000000000000000000000000010f2c0000000000000000000000000000000000000000000000000000000000000001000000000000000000000000a5cc3c03994db5b0d9a5eedd10cabab0813678ac0000000000000000000000000000000000000000000000000000000000000045',
@@ -240,6 +237,7 @@ test("error: function doesn't exist", () => {
           type: 'function',
         },
       ],
+      // @ts-expect-error
       functionName: 'baz',
       result: ['0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC'],
     }),
@@ -249,7 +247,6 @@ test("error: function doesn't exist", () => {
     Make sure you are using the correct ABI and that the function exists on it.
 
     Docs: https://viem.sh/docs/contract/encodeFunctionResult
-
     Version: viem@1.0.2"
   `,
   )
@@ -259,7 +256,6 @@ test("error: function doesn't exist", () => {
   expect(() =>
     encodeFunctionResult({
       abi: [
-        // @ts-expect-error
         {
           inputs: [],
           name: 'foo',
@@ -277,7 +273,6 @@ test("error: function doesn't exist", () => {
     Make sure you are using the correct ABI and that the function exists on it.
 
     Docs: https://viem.sh/docs/contract/encodeFunctionResult
-
     Version: viem@1.0.2"
   `,
   )

package/src/utils/abi/encodeFunctionResult.ts

@@ -1,4 +1,4 @@
-import { Abi, ExtractAbiFunctionNames } from 'abitype'
+import { Abi, ExtractAbiFunctionNames, Narrow } from 'abitype'
 import {
   AbiFunctionNotFoundError,
   AbiFunctionOutputsNotFoundError,
@@ -10,23 +10,25 @@ import { encodeAbi } from './encodeAbi'
 const docsPath = '/docs/contract/encodeFunctionResult'
 
 export type EncodeFunctionResultArgs<
-  TAbi extends Abi = Abi,
-  TFunctionName extends string = any,
+  TAbi extends Abi | readonly unknown[] = Abi,
+  TFunctionName extends string = string,
 > = {
-  abi: TAbi
+  abi: Narrow<TAbi>
   functionName: ExtractFunctionNameFromAbi<TAbi, TFunctionName>
   result?: ExtractResultFromAbi<TAbi, TFunctionName>
 }
 
 export function encodeFunctionResult<
-  TAbi extends Abi = Abi,
-  TFunctionName extends string = any,
+  TAbi extends Abi | readonly unknown[],
+  TFunctionName extends string,
 >({
   abi,
   functionName,
   result,
 }: EncodeFunctionResultArgs<TAbi, TFunctionName>) {
-  const description = abi.find((x) => 'name' in x && x.name === functionName)
+  const description = (abi as Abi).find(
+    (x) => 'name' in x && x.name === functionName,
+  )
   if (!description)
     throw new AbiFunctionNotFoundError(functionName, { docsPath })
   if (!('outputs' in description))