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

package/src/errors/request.ts

@@ -4,9 +4,9 @@ import { RpcError } from './rpc'
 export class RequestError extends BaseError {
   constructor(
     err: Error,
-    { docsPath, humanMessage }: { docsPath?: string; humanMessage: string },
+    { docsPath, shortMessage }: { docsPath?: string; shortMessage: string },
   ) {
-    super(humanMessage, {
+    super(shortMessage, {
       cause: err,
       docsPath,
     })
@@ -19,9 +19,9 @@ export class RpcRequestError extends RequestError {
 
   constructor(
     err: RpcError,
-    { docsPath, humanMessage }: { docsPath?: string; humanMessage: string },
+    { docsPath, shortMessage }: { docsPath?: string; shortMessage: string },
   ) {
-    super(err, { docsPath, humanMessage })
+    super(err, { docsPath, shortMessage })
     this.code = err.code
     this.name = err.name
   }
@@ -33,7 +33,7 @@ export class ParseRpcError extends RpcRequestError {
 
   constructor(err: RpcError) {
     super(err, {
-      humanMessage:
+      shortMessage:
         'Invalid JSON was received by the server. An error occurred on the server while parsing the JSON text.',
     })
   }
@@ -44,7 +44,7 @@ export class InvalidRequestRpcError extends RpcRequestError {
   code = -32600
 
   constructor(err: RpcError) {
-    super(err, { humanMessage: 'JSON is not a valid request object.' })
+    super(err, { shortMessage: 'JSON is not a valid request object.' })
   }
 }
 
@@ -54,7 +54,7 @@ export class MethodNotFoundRpcError extends RpcRequestError {
 
   constructor(err: RpcError) {
     super(err, {
-      humanMessage: 'The method does not exist / is not available.',
+      shortMessage: 'The method does not exist / is not available.',
     })
   }
 }
@@ -65,7 +65,7 @@ export class InvalidParamsRpcError extends RpcRequestError {
 
   constructor(err: RpcError) {
     super(err, {
-      humanMessage: [
+      shortMessage: [
         'Invalid parameters were provided to the RPC method.',
         'Double check you have provided the correct parameters.',
       ].join('\n'),
@@ -78,7 +78,7 @@ export class InternalRpcError extends RpcRequestError {
   code = -32603
 
   constructor(err: RpcError) {
-    super(err, { humanMessage: 'An internal error was received.' })
+    super(err, { shortMessage: 'An internal error was received.' })
   }
 }
 
@@ -88,7 +88,7 @@ export class InvalidInputRpcError extends RpcRequestError {
 
   constructor(err: RpcError) {
     super(err, {
-      humanMessage: [
+      shortMessage: [
         'Missing or invalid parameters.',
         'Double check you have provided the correct parameters.',
       ].join('\n'),
@@ -101,7 +101,7 @@ export class ResourceNotFoundRpcError extends RpcRequestError {
   code = -32001
 
   constructor(err: RpcError) {
-    super(err, { humanMessage: 'Requested resource not found.' })
+    super(err, { shortMessage: 'Requested resource not found.' })
   }
 }
 
@@ -110,7 +110,7 @@ export class ResourceUnavailableRpcError extends RpcRequestError {
   code = -32002
 
   constructor(err: RpcError) {
-    super(err, { humanMessage: 'Requested resource not available.' })
+    super(err, { shortMessage: 'Requested resource not available.' })
   }
 }
 
@@ -119,7 +119,7 @@ export class TransactionRejectedRpcError extends RpcRequestError {
   code = -32003
 
   constructor(err: RpcError) {
-    super(err, { humanMessage: 'Transaction creation failed.' })
+    super(err, { shortMessage: 'Transaction creation failed.' })
   }
 }
 
@@ -128,7 +128,7 @@ export class MethodNotSupportedRpcError extends RpcRequestError {
   code = -32004
 
   constructor(err: RpcError) {
-    super(err, { humanMessage: 'Method is not implemented.' })
+    super(err, { shortMessage: 'Method is not implemented.' })
   }
 }
 
@@ -137,7 +137,7 @@ export class LimitExceededRpcError extends RpcRequestError {
   code = -32005
 
   constructor(err: RpcError) {
-    super(err, { humanMessage: 'Request exceeds defined limit.' })
+    super(err, { shortMessage: 'Request exceeds defined limit.' })
   }
 }
 
@@ -147,7 +147,7 @@ export class JsonRpcVersionUnsupportedError extends RpcRequestError {
 
   constructor(err: RpcError) {
     super(err, {
-      humanMessage: 'Version of JSON-RPC protocol is not supported.',
+      shortMessage: 'Version of JSON-RPC protocol is not supported.',
     })
   }
 }
@@ -157,7 +157,7 @@ export class UnknownRpcError extends RequestError {
 
   constructor(err: Error) {
     super(err, {
-      humanMessage: 'An unknown RPC error occurred.',
+      shortMessage: 'An unknown RPC error occurred.',
     })
   }
 }

package/src/errors/rpc.test.ts

@@ -21,8 +21,7 @@ test('RpcError', () => {
     Request body: {"foo":"bar"}
 
     Details: Error
-    Version: viem@1.0.2
-    Internal Error: {"code":420,"message":"Error"}]
+    Version: viem@1.0.2]
   `)
 })
 

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,50 @@ test('exports actions', () => {
       "isHex": [Function],
       "keccak256": [Function],
       "mine": [Function],
+      "multicall": [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

@@ -45,6 +45,7 @@ export type {
   ImpersonateAccountArgs,
   IncreaseTimeArgs,
   MineArgs,
+  MulticallArgs,
   OnBlock,
   OnBlockNumber,
   OnBlockNumberResponse,
@@ -124,6 +125,7 @@ export {
   increaseTime,
   inspectTxpool,
   mine,
+  multicall,
   readContract,
   removeBlockTimestampInterval,
   reset,
@@ -191,6 +193,8 @@ export {
   webSocket,
 } from './clients'
 
+export { multicall3Abi } from './constants'
+
 export {
   AbiConstructorNotFoundError,
   AbiConstructorParamsNotFoundError,
@@ -206,6 +210,9 @@ export {
   AbiFunctionSignatureNotFoundError,
   BaseError,
   BlockNotFoundError,
+  ContractFunctionExecutionError,
+  ContractFunctionRevertedError,
+  ContractFunctionZeroDataError,
   DataLengthTooLongError,
   DataLengthTooShortError,
   HttpRequestError,
@@ -254,6 +261,8 @@ export type {
   BlockNumber,
   BlockTag,
   ByteArray,
+  Chain,
+  ContractConfig,
   Hex,
   FeeHistory,
   FeeValues,
@@ -300,6 +309,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