viem 0.0.1-alpha.20 → 0.0.1-alpha.22

package/src/errors/transaction.test.ts

@@ -19,40 +19,40 @@ describe('TransactionNotFoundError', () => {
     expect(
       new TransactionNotFoundError({ blockHash: '0x123', index: 420 }),
     ).toMatchInlineSnapshot(`
-        [TransactionNotFoundError: Transaction at block hash "0x123" at index "420" could not be found.
+      [TransactionNotFoundError: Transaction at block hash "0x123" at index "420" could not be found.
 
-        Version: viem@1.0.2]
-      `)
+      Version: viem@1.0.2]
+    `)
   })
 
   test('blockTag', async () => {
     expect(
       new TransactionNotFoundError({ blockTag: 'latest', index: 420 }),
     ).toMatchInlineSnapshot(`
-        [TransactionNotFoundError: Transaction at block time "latest" at index "420" could not be found.
+      [TransactionNotFoundError: Transaction at block time "latest" at index "420" could not be found.
 
-        Version: viem@1.0.2]
-      `)
+      Version: viem@1.0.2]
+    `)
   })
 
   test('blockNumber', async () => {
     expect(
       new TransactionNotFoundError({ blockNumber: 42069n, index: 420 }),
     ).toMatchInlineSnapshot(`
-        [TransactionNotFoundError: Transaction at block number "42069" at index "420" could not be found.
+      [TransactionNotFoundError: Transaction at block number "42069" at index "420" could not be found.
 
-        Version: viem@1.0.2]
-      `)
+      Version: viem@1.0.2]
+    `)
   })
 
   test('hash', async () => {
     expect(
       new TransactionNotFoundError({ hash: '0x123' }),
     ).toMatchInlineSnapshot(`
-        [TransactionNotFoundError: Transaction with hash "0x123" could not be found.
+      [TransactionNotFoundError: Transaction with hash "0x123" could not be found.
 
-        Version: viem@1.0.2]
-      `)
+      Version: viem@1.0.2]
+    `)
   })
 })
 

package/src/errors/transport.test.ts

@@ -6,7 +6,6 @@ test('UrlRequiredError', () => {
     [ViemError: 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/index.test.ts

@@ -19,6 +19,9 @@ test('exports actions', () => {
       "AbiFunctionSignatureNotFoundError": [Function],
       "BaseError": [Function],
       "BlockNotFoundError": [Function],
+      "ContractFunctionExecutionError": [Function],
+      "ContractFunctionRevertedError": [Function],
+      "ContractFunctionZeroDataError": [Function],
       "DataLengthTooLongError": [Function],
       "DataLengthTooShortError": [Function],
       "FilterTypeNotSupportedError": [Function],
@@ -151,6 +154,49 @@ test('exports actions', () => {
       "isHex": [Function],
       "keccak256": [Function],
       "mine": [Function],
+      "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",
+        },
+      ],
       "numberToBytes": [Function],
       "numberToHex": [Function],
       "pad": [Function],

package/src/index.ts

@@ -191,6 +191,8 @@ export {
   webSocket,
 } from './clients'
 
+export { multicall3Abi } from './constants'
+
 export {
   AbiConstructorNotFoundError,
   AbiConstructorParamsNotFoundError,
@@ -206,6 +208,9 @@ export {
   AbiFunctionSignatureNotFoundError,
   BaseError,
   BlockNotFoundError,
+  ContractFunctionExecutionError,
+  ContractFunctionRevertedError,
+  ContractFunctionZeroDataError,
   DataLengthTooLongError,
   DataLengthTooShortError,
   HttpRequestError,
@@ -254,6 +259,8 @@ export type {
   BlockNumber,
   BlockTag,
   ByteArray,
+  Chain,
+  ContractConfig,
   Hex,
   FeeHistory,
   FeeValues,
@@ -300,6 +307,7 @@ export type {
   GetContractAddressOptions,
   GetCreateAddressOptions,
   GetCreate2AddressOptions,
+  GetAbiItemArgs,
   EncodeRlpResponse,
   FormattedBlock,
   FormattedTransaction,

package/src/types/contract.ts

@@ -8,15 +8,17 @@ import type {
   AbiParameter,
   AbiParameterToPrimitiveType,
   AbiParametersToPrimitiveTypes,
+  AbiStateMutability,
   ExtractAbiFunction,
   ExtractAbiEvent,
   ExtractAbiEventNames,
   ExtractAbiError,
-  AbiStateMutability,
+  ExtractAbiErrorNames,
   ExtractAbiFunctionNames,
+  Narrow,
 } from 'abitype'
-import { TransactionRequest } from './transaction'
-
+import type { Address } from './misc'
+import type { TransactionRequest } from './transaction'
 import type { Trim } from './utils'
 
 //////////////////////////////////////////////////////////////////////
@@ -163,6 +165,18 @@ export type ExtractEventArgsFromAbi<
       args?: TArgs
     }
 
+export type ExtractErrorNameFromAbi<
+  TAbi extends Abi | readonly unknown[] = Abi,
+  TErrorName extends string = string,
+> = TAbi extends Abi
+  ? ExtractAbiErrorNames<TAbi> extends infer AbiErrorNames
+    ?
+        | AbiErrorNames
+        | (TErrorName extends AbiErrorNames ? TErrorName : never)
+        | (Abi extends TAbi ? string : never)
+    : never
+  : TErrorName
+
 export type ExtractEventNameFromAbi<
   TAbi extends Abi | readonly unknown[] = Abi,
   TEventName extends string = string,
@@ -191,6 +205,23 @@ export type ExtractFunctionNameFromAbi<
     : never
   : TFunctionName
 
+type ExtractNames<TAbi extends Abi> =
+  | ExtractAbiFunctionNames<TAbi>
+  | ExtractAbiEventNames<TAbi>
+  | ExtractAbiErrorNames<TAbi>
+
+export type ExtractNameFromAbi<
+  TAbi extends Abi | readonly unknown[] = Abi,
+  TName extends string = string,
+> = TAbi extends Abi
+  ? ExtractNames<TAbi> extends infer AbiNames
+    ?
+        | AbiNames
+        | (TName extends AbiNames ? TName : never)
+        | (Abi extends TAbi ? string : never)
+    : never
+  : TName
+
 export type ExtractResultFromAbi<
   TAbi extends Abi | readonly unknown[] = Abi,
   TFunctionName extends string = string,
@@ -214,6 +245,9 @@ export type ExtractResultFromAbi<
 //////////////////////////////////////////////////////////////////////
 // Event/Function Definitions
 
+// REFACTOR: Remove below once we implement `ParseAbi`.
+// https://github.com/wagmi-dev/viem/issues/29
+
 export type EventDefinition = `${string}(${string})`
 
 type ExtractArgsFromDefinitionConfig = {
@@ -326,7 +360,24 @@ export type ExtractArgsFromFunctionDefinition<TDef> = ExtractArgsFromDefinition<
 >
 
 //////////////////////////////////////////////////////////////////////
-// Call Args
+// Args
+
+export type ContractConfig<
+  TAbi extends Abi | readonly unknown[] = Abi,
+  TFunctionName extends string = string,
+  TAbiStateMutability extends AbiStateMutability = AbiStateMutability,
+> = {
+  /** Contract ABI */
+  abi: Narrow<TAbi>
+  /** Contract address */
+  address: Address
+  /** Function to invoke on the contract */
+  functionName: ExtractFunctionNameFromAbi<
+    TAbi,
+    TFunctionName,
+    TAbiStateMutability
+  >
+} & ExtractArgsFromAbi<TAbi, TFunctionName>
 
 export type GetValue<
   TAbi extends Abi | readonly unknown[],

package/src/types/index.ts

@@ -11,15 +11,18 @@ export type { Chain } from './chain'
 export type {
   AbiItem,
   AbiEventParametersToPrimitiveTypes,
+  ContractConfig,
   EventDefinition,
   ExtractArgsFromAbi,
   ExtractArgsFromEventDefinition,
   ExtractArgsFromFunctionDefinition,
   ExtractConstructorArgsFromAbi,
   ExtractErrorArgsFromAbi,
+  ExtractErrorNameFromAbi,
   ExtractEventArgsFromAbi,
   ExtractEventNameFromAbi,
   ExtractFunctionNameFromAbi,
+  ExtractNameFromAbi,
   ExtractResultFromAbi,
   GetValue,
 } from './contract'
@@ -40,6 +43,8 @@ export type { Log } from './log'
 
 export type { Address, ByteArray, Hex, Hash, LogTopic } from './misc'
 
+export type { MulticallContracts } from './multicall'
+
 export type {
   Index,
   Quantity,

package/src/types/multicall.ts

@@ -0,0 +1,82 @@
+import { Abi } from 'abitype';
+import { ContractConfig, ExtractResultFromAbi } from './contract';
+
+type MAXIMUM_DEPTH = 20
+
+export type Contract<
+  TAbi extends Abi | readonly unknown[] = Abi | readonly unknown[],
+  TFunctionName extends string = string,
+> = { abi: TAbi; functionName: TFunctionName }
+
+export type MulticallContracts<
+  TContracts extends Contract[],
+  TProperties extends Record<string, any> = object,
+  Result extends any[] = [],
+  Depth extends ReadonlyArray<number> = [],
+> = Depth['length'] extends MAXIMUM_DEPTH
+  ? (ContractConfig & TProperties)[]
+  : TContracts extends []
+  ? []
+  : TContracts extends [infer Head extends Contract]
+  ? [
+      ...Result,
+      ContractConfig<Head['abi'], Head['functionName']> &
+        TProperties,
+    ]
+  : TContracts extends [
+      infer Head extends Contract,
+      ...infer Tail extends Contract[],
+    ]
+  ? MulticallContracts<
+      [...Tail],
+      TProperties,
+      [
+        ...Result,
+        ContractConfig<Head['abi'], Head['functionName']> &
+          TProperties,
+      ],
+      [...Depth, 1]
+    >
+  : unknown[] extends TContracts
+  ? TContracts
+  : // If `TContracts` is *some* array but we couldn't assign `unknown[]` to it, then it must hold some known/homogenous type!
+  // use this to infer the param types in the case of Array.map() argument
+  TContracts extends ContractConfig<infer TAbi, infer TFunctionName>[]
+  ? (ContractConfig<TAbi, TFunctionName> & TProperties)[]
+  : (ContractConfig & TProperties)[]
+
+
+export type MulticallResult<Result, TAllowFailure extends boolean = true> = TAllowFailure extends true ? ({
+  error?: undefined
+  result: Result
+  status: 'success'
+} | {
+  error: Error
+  result?: undefined
+  status: 'error'
+}) : Result
+
+export type MulticallResults<
+  TContracts extends Contract[],
+  TAllowFailure extends boolean = true,
+  Result extends any[] = [],
+  Depth extends ReadonlyArray<number> = [],
+> = Depth['length'] extends MAXIMUM_DEPTH
+  ? MulticallResult<ExtractResultFromAbi, TAllowFailure>[]
+  : TContracts extends []
+  ? []
+  : TContracts extends [infer Head extends Contract]
+  ? [...Result, MulticallResult<ExtractResultFromAbi<Head['abi'], Head['functionName']>, TAllowFailure>]
+  : TContracts extends [
+      infer Head extends Contract,
+      ...infer Tail extends Contract[],
+    ]
+  ? MulticallResults<
+      [...Tail],
+      TAllowFailure,
+      [...Result, MulticallResult<ExtractResultFromAbi<Head['abi'], Head['functionName']>, TAllowFailure>],
+      [...Depth, 1]
+    >
+  : TContracts extends ContractConfig<infer TAbi, infer TFunctionName>[]
+  ? MulticallResult<ExtractResultFromAbi<TAbi, TFunctionName>, TAllowFailure>[]
+  : MulticallResult<ExtractResultFromAbi, TAllowFailure>[]

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

@@ -1582,7 +1582,6 @@ test('invalid type', () => {
     Please provide a valid ABI type.
 
     Docs: https://viem.sh/docs/contract/decodeAbi
-
     Version: viem@1.0.2"
   `)
 })
@@ -1604,7 +1603,7 @@ test('error: zero data', () => {
           stateMutability: 'pure',
           type: 'function',
         },
-      ] as const,
+      ],
       data: '0x',
     }),
   ).toThrowErrorMatchingInlineSnapshot(`

package/src/utils/abi/decodeAbi.ts

@@ -2,6 +2,7 @@ import {
   AbiParameter,
   AbiParametersToPrimitiveTypes,
   AbiParameterToPrimitiveType,
+  Narrow,
 } from 'abitype'
 
 import {
@@ -15,21 +16,24 @@ import { size, slice, trim } from '../data'
 import { hexToBigInt, hexToBool, hexToNumber, hexToString } from '../encoding'
 import { getArrayComponents } from './encodeAbi'
 
-export type DecodeAbiArgs<TParams extends readonly AbiParameter[]> = {
+export type DecodeAbiArgs<
+  TParams extends
+    | readonly AbiParameter[]
+    | readonly unknown[] = readonly AbiParameter[],
+> = {
   data: Hex
-  params: TParams
+  params: Narrow<TParams>
 }
 
-export function decodeAbi<TParams extends readonly AbiParameter[]>({
-  data,
-  params,
-}: DecodeAbiArgs<TParams>) {
+export function decodeAbi<
+  TParams extends readonly AbiParameter[] | readonly unknown[],
+>({ data, params }: DecodeAbiArgs<TParams>) {
   if (data === '0x' && params.length > 0) throw new AbiDecodingZeroDataError()
   if (size(data) % 32 !== 0)
     throw new AbiDecodingDataSizeInvalidError(size(data))
   const values = decodeParams({
     data,
-    params,
+    params: params as readonly AbiParameter[],
   })
   if (values.length === 0) return undefined
   return values

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

@@ -11,7 +11,7 @@ test('constructor()', () => {
           stateMutability: 'nonpayable',
           type: 'constructor',
         },
-      ] as const,
+      ],
       bytecode:
         '0x6080604052348015600f57600080fd5b50603f80601d6000396000f3fe6080604052600080fdfea2646970667358221220116554d4ba29ee08da9e97dc54ff9a2a65d67a648140d616fc225a25ff08c86364736f6c63430008070033',
       data: '0x6080604052348015600f57600080fd5b50603f80601d6000396000f3fe6080604052600080fdfea2646970667358221220116554d4ba29ee08da9e97dc54ff9a2a65d67a648140d616fc225a25ff08c86364736f6c63430008070033',
@@ -22,13 +22,12 @@ test('constructor()', () => {
   })
   expect(
     decodeDeployData({
-      // @ts-expect-error
       abi: [
         {
           stateMutability: 'nonpayable',
           type: 'constructor',
         },
-      ] as const,
+      ],
       bytecode:
         '0x6080604052348015600f57600080fd5b50603f80601d6000396000f3fe6080604052600080fdfea2646970667358221220116554d4ba29ee08da9e97dc54ff9a2a65d67a648140d616fc225a25ff08c86364736f6c63430008070033',
       data: '0x6080604052348015600f57600080fd5b50603f80601d6000396000f3fe6080604052600080fdfea2646970667358221220116554d4ba29ee08da9e97dc54ff9a2a65d67a648140d616fc225a25ff08c86364736f6c63430008070033',
@@ -54,7 +53,7 @@ test('constructor(uint256)', () => {
           stateMutability: 'nonpayable',
           type: 'constructor',
         },
-      ] as const,
+      ],
       bytecode:
         '0x6080604052348015600f57600080fd5b50603f80601d6000396000f3fe6080604052600080fdfea2646970667358221220116554d4ba29ee08da9e97dc54ff9a2a65d67a648140d616fc225a25ff08c86364736f6c63430008070033',
       data: '0x6080604052348015600f57600080fd5b50603f80601d6000396000f3fe6080604052600080fdfea2646970667358221220116554d4ba29ee08da9e97dc54ff9a2a65d67a648140d616fc225a25ff08c86364736f6c634300080700330000000000000000000000000000000000000000000000000000000000010f2c',
@@ -69,8 +68,7 @@ test('constructor(uint256)', () => {
 test('error: constructor not found', () => {
   expect(() =>
     decodeDeployData({
-      // @ts-expect-error
-      abi: [{}] as const,
+      abi: [{}],
       bytecode:
         '0x6080604052348015600f57600080fd5b50603f80601d6000396000f3fe6080604052600080fdfea2646970667358221220116554d4ba29ee08da9e97dc54ff9a2a65d67a648140d616fc225a25ff08c86364736f6c63430008070033',
       data: '0x6080604052348015600f57600080fd5b50603f80601d6000396000f3fe6080604052600080fdfea2646970667358221220116554d4ba29ee08da9e97dc54ff9a2a65d67a648140d616fc225a25ff08c86364736f6c634300080700330000000000000000000000000000000000000000000000000000000000010f2c',
@@ -80,7 +78,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/decodeDeployData
-
     Version: viem@1.0.2"
   `)
 })
@@ -88,13 +85,12 @@ test('error: constructor not found', () => {
 test('error: no inputs', () => {
   expect(() =>
     decodeDeployData({
-      // @ts-expect-error
       abi: [
         {
           stateMutability: 'nonpayable',
           type: 'constructor',
         },
-      ] as const,
+      ],
       bytecode:
         '0x6080604052348015600f57600080fd5b50603f80601d6000396000f3fe6080604052600080fdfea2646970667358221220116554d4ba29ee08da9e97dc54ff9a2a65d67a648140d616fc225a25ff08c86364736f6c63430008070033',
       data: '0x6080604052348015600f57600080fd5b50603f80601d6000396000f3fe6080604052600080fdfea2646970667358221220116554d4ba29ee08da9e97dc54ff9a2a65d67a648140d616fc225a25ff08c86364736f6c634300080700330000000000000000000000000000000000000000000000000000000000010f2c',
@@ -105,7 +101,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/decodeDeployData
-
     Version: viem@1.0.2"
   `,
   )
@@ -117,7 +112,7 @@ test('error: no inputs', () => {
           stateMutability: 'nonpayable',
           type: 'constructor',
         },
-      ] as const,
+      ],
       bytecode:
         '0x6080604052348015600f57600080fd5b50603f80601d6000396000f3fe6080604052600080fdfea2646970667358221220116554d4ba29ee08da9e97dc54ff9a2a65d67a648140d616fc225a25ff08c86364736f6c63430008070033',
       data: '0x6080604052348015600f57600080fd5b50603f80601d6000396000f3fe6080604052600080fdfea2646970667358221220116554d4ba29ee08da9e97dc54ff9a2a65d67a648140d616fc225a25ff08c86364736f6c634300080700330000000000000000000000000000000000000000000000000000000000010f2c',
@@ -128,20 +123,18 @@ 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/decodeDeployData
-
     Version: viem@1.0.2"
   `,
   )
   expect(() =>
     decodeDeployData({
-      // @ts-expect-error
       abi: [
         {
           inputs: undefined,
           stateMutability: 'nonpayable',
           type: 'constructor',
         },
-      ] as const,
+      ],
       bytecode:
         '0x6080604052348015600f57600080fd5b50603f80601d6000396000f3fe6080604052600080fdfea2646970667358221220116554d4ba29ee08da9e97dc54ff9a2a65d67a648140d616fc225a25ff08c86364736f6c63430008070033',
       data: '0x6080604052348015600f57600080fd5b50603f80601d6000396000f3fe6080604052600080fdfea2646970667358221220116554d4ba29ee08da9e97dc54ff9a2a65d67a648140d616fc225a25ff08c86364736f6c634300080700330000000000000000000000000000000000000000000000000000000000010f2c',
@@ -152,7 +145,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/decodeDeployData
-
     Version: viem@1.0.2"
   `,
   )

package/src/utils/abi/decodeDeployData.ts

@@ -9,24 +9,27 @@ import { decodeAbi } from './decodeAbi'
 
 const docsPath = '/docs/contract/decodeDeployData'
 
-export type DecodeDeployDataArgs<TAbi extends Abi = Abi> = {
-  abi: TAbi
-  bytecode: Hex
-  data: Hex
-}
+export type DecodeDeployDataArgs<TAbi extends Abi | readonly unknown[] = Abi> =
+  {
+    abi: TAbi
+    bytecode: Hex
+    data: Hex
+  }
 export type DecodeDeployDataResponse = {
   args?: readonly unknown[] | undefined
   bytecode: Hex
 }
 
-export function decodeDeployData<TAbi extends Abi = Abi>({
+export function decodeDeployData<TAbi extends Abi | readonly unknown[]>({
   abi,
   bytecode,
   data,
 }: DecodeDeployDataArgs<TAbi>): DecodeDeployDataResponse {
   if (data === bytecode) 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 })