viem 0.0.1-cjs.10 → 0.0.1-sushi.26

package/src/errors/transaction.test.ts

@@ -0,0 +1,83 @@
+import { describe, expect, test } from 'vitest'
+import {
+  InvalidGasArgumentsError,
+  TransactionNotFoundError,
+  TransactionReceiptNotFoundError,
+  WaitForTransactionReceiptTimeoutError,
+} from './transaction'
+
+describe('TransactionNotFoundError', () => {
+  test('no args', async () => {
+    expect(new TransactionNotFoundError({})).toMatchInlineSnapshot(`
+      [TransactionNotFoundError: Transaction could not be found.
+
+      Version: viem@1.0.2]
+    `)
+  })
+
+  test('blockHash', async () => {
+    expect(
+      new TransactionNotFoundError({ blockHash: '0x123', index: 420 }),
+    ).toMatchInlineSnapshot(`
+      [TransactionNotFoundError: Transaction at block hash "0x123" at index "420" could not be found.
+
+      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.
+
+      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.
+
+      Version: viem@1.0.2]
+    `)
+  })
+
+  test('hash', async () => {
+    expect(
+      new TransactionNotFoundError({ hash: '0x123' }),
+    ).toMatchInlineSnapshot(`
+      [TransactionNotFoundError: Transaction with hash "0x123" could not be found.
+
+      Version: viem@1.0.2]
+    `)
+  })
+})
+
+test('TransactionReceiptNotFoundError', () => {
+  const error = new TransactionReceiptNotFoundError({
+    hash: '0xa4b1f606b66105fa45cb5db23d2f6597075701e7f0e2367f4e6a39d17a8cf98a',
+  })
+
+  expect(error.message).toMatchInlineSnapshot(`
+    "Transaction receipt with hash \\"0xa4b1f606b66105fa45cb5db23d2f6597075701e7f0e2367f4e6a39d17a8cf98a\\" could not be found. The Transaction may not be processed on a block yet.
+
+    Version: viem@1.0.2"
+  `)
+})
+
+test('WaitForTransactionReceiptTimeoutError', () => {
+  expect(() => {
+    throw new WaitForTransactionReceiptTimeoutError({ hash: '0x123' })
+  }).toThrowError(WaitForTransactionReceiptTimeoutError)
+})
+
+test('InvalidGasArgumentsError', () => {
+  expect(new InvalidGasArgumentsError()).toMatchInlineSnapshot(`
+    [InvalidGasArgumentsError: \`maxFeePerGas\` cannot be less than \`maxPriorityFeePerGas\`
+
+    Version: viem@1.0.2]
+  `)
+})

package/src/errors/transaction.ts

@@ -0,0 +1,54 @@
+import { BlockTag, Hash } from '../types'
+import { BaseError } from './base'
+
+export class InvalidGasArgumentsError extends BaseError {
+  name = 'InvalidGasArgumentsError'
+  constructor() {
+    super('`maxFeePerGas` cannot be less than `maxPriorityFeePerGas`')
+  }
+}
+
+export class TransactionNotFoundError extends BaseError {
+  name = 'TransactionNotFoundError'
+  constructor({
+    blockHash,
+    blockNumber,
+    blockTag,
+    hash,
+    index,
+  }: {
+    blockHash?: Hash
+    blockNumber?: bigint
+    blockTag?: BlockTag
+    hash?: Hash
+    index?: number
+  }) {
+    let identifier = 'Transaction'
+    if (blockTag && index !== undefined)
+      identifier = `Transaction at block time "${blockTag}" at index "${index}"`
+    if (blockHash && index !== undefined)
+      identifier = `Transaction at block hash "${blockHash}" at index "${index}"`
+    if (blockNumber && index !== undefined)
+      identifier = `Transaction at block number "${blockNumber}" at index "${index}"`
+    if (hash) identifier = `Transaction with hash "${hash}"`
+    super(`${identifier} could not be found.`)
+  }
+}
+
+export class TransactionReceiptNotFoundError extends BaseError {
+  name = 'TransactionReceiptNotFoundError'
+  constructor({ hash }: { hash: Hash }) {
+    super(
+      `Transaction receipt with hash "${hash}" could not be found. The Transaction may not be processed on a block yet.`,
+    )
+  }
+}
+
+export class WaitForTransactionReceiptTimeoutError extends BaseError {
+  name = 'WaitForTransactionReceiptTimeoutError'
+  constructor({ hash }: { hash: Hash }) {
+    super(
+      `Timed out while waiting for transaction with hash "${hash}" to be confirmed.`,
+    )
+  }
+}

package/src/errors/transport.test.ts

@@ -0,0 +1,11 @@
+import { expect, test } from 'vitest'
+import { UrlRequiredError } from './transport'
+
+test('UrlRequiredError', () => {
+  expect(new UrlRequiredError()).toMatchInlineSnapshot(`
+    [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/errors/transport.ts

@@ -0,0 +1,12 @@
+import { BaseError } from './base'
+
+export class UrlRequiredError extends BaseError {
+  constructor() {
+    super(
+      'No URL was provided to the Transport. Please provide a valid RPC URL to the Transport.',
+      {
+        docsPath: '/docs/clients/intro',
+      },
+    )
+  }
+}

package/src/index.test.ts

@@ -0,0 +1,116 @@
+import { expect, test } from 'vitest'
+
+import * as actions from './index'
+
+test('exports actions', () => {
+  expect(actions).toMatchInlineSnapshot(`
+    {
+      "AbiConstructorNotFoundError": [Function],
+      "AbiConstructorParamsNotFoundError": [Function],
+      "AbiDecodingDataSizeInvalidError": [Function],
+      "AbiEncodingArrayLengthMismatchError": [Function],
+      "AbiEncodingLengthMismatchError": [Function],
+      "AbiErrorInputsNotFoundError": [Function],
+      "AbiErrorNotFoundError": [Function],
+      "AbiErrorSignatureNotFoundError": [Function],
+      "AbiEventNotFoundError": [Function],
+      "AbiFunctionNotFoundError": [Function],
+      "AbiFunctionOutputsNotFoundError": [Function],
+      "AbiFunctionSignatureNotFoundError": [Function],
+      "BaseError": [Function],
+      "BlockNotFoundError": [Function],
+      "ContractFunctionExecutionError": [Function],
+      "ContractFunctionRevertedError": [Function],
+      "ContractFunctionZeroDataError": [Function],
+      "DataLengthTooLongError": [Function],
+      "DataLengthTooShortError": [Function],
+      "FilterTypeNotSupportedError": [Function],
+      "HttpRequestError": [Function],
+      "InternalRpcError": [Function],
+      "InvalidAbiDecodingTypeError": [Function],
+      "InvalidAbiEncodingTypeError": [Function],
+      "InvalidAddressError": [Function],
+      "InvalidArrayError": [Function],
+      "InvalidBytesBooleanError": [Function],
+      "InvalidDefinitionTypeError": [Function],
+      "InvalidGasArgumentsError": [Function],
+      "InvalidHexBooleanError": [Function],
+      "InvalidHexValueError": [Function],
+      "InvalidInputRpcError": [Function],
+      "InvalidParamsRpcError": [Function],
+      "InvalidRequestRpcError": [Function],
+      "JsonRpcVersionUnsupportedError": [Function],
+      "LimitExceededRpcError": [Function],
+      "MethodNotFoundRpcError": [Function],
+      "MethodNotSupportedRpcError": [Function],
+      "OffsetOutOfBoundsError": [Function],
+      "ParseRpcError": [Function],
+      "RequestError": [Function],
+      "ResourceNotFoundRpcError": [Function],
+      "ResourceUnavailableRpcError": [Function],
+      "RpcError": [Function],
+      "RpcRequestError": [Function],
+      "SizeExceedsPaddingSizeError": [Function],
+      "TimeoutError": [Function],
+      "TransactionNotFoundError": [Function],
+      "TransactionReceiptNotFoundError": [Function],
+      "TransactionRejectedRpcError": [Function],
+      "UnknownRpcError": [Function],
+      "UrlRequiredError": [Function],
+      "WaitForTransactionReceiptTimeoutError": [Function],
+      "WebSocketRequestError": [Function],
+      "createClient": [Function],
+      "createPublicClient": [Function],
+      "createTestClient": [Function],
+      "createTransport": [Function],
+      "createWalletClient": [Function],
+      "custom": [Function],
+      "fallback": [Function],
+      "http": [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",
+        },
+      ],
+      "webSocket": [Function],
+    }
+  `)
+})

package/src/index.ts

@@ -0,0 +1,132 @@
+export type {
+  Client,
+  ClientConfig,
+  CustomTransport,
+  CustomTransportConfig,
+  FallbackTransport,
+  FallbackTransportConfig,
+  HttpTransport,
+  HttpTransportConfig,
+  PublicClient,
+  PublicClientConfig,
+  TestClient,
+  TestClientConfig,
+  Transport,
+  TransportConfig,
+  WalletClient,
+  WalletClientConfig,
+  WebSocketTransport,
+  WebSocketTransportConfig,
+} from './clients'
+export {
+  createClient,
+  createPublicClient,
+  createTestClient,
+  createTransport,
+  createWalletClient,
+  custom,
+  fallback,
+  http,
+  webSocket,
+} from './clients'
+
+export { multicall3Abi } from './constants'
+
+export {
+  AbiConstructorNotFoundError,
+  AbiConstructorParamsNotFoundError,
+  AbiDecodingDataSizeInvalidError,
+  AbiEncodingArrayLengthMismatchError,
+  AbiEncodingLengthMismatchError,
+  AbiErrorInputsNotFoundError,
+  AbiErrorNotFoundError,
+  AbiErrorSignatureNotFoundError,
+  AbiEventNotFoundError,
+  AbiFunctionNotFoundError,
+  AbiFunctionOutputsNotFoundError,
+  AbiFunctionSignatureNotFoundError,
+  BaseError,
+  BlockNotFoundError,
+  ContractFunctionExecutionError,
+  ContractFunctionRevertedError,
+  ContractFunctionZeroDataError,
+  DataLengthTooLongError,
+  DataLengthTooShortError,
+  HttpRequestError,
+  FilterTypeNotSupportedError,
+  InternalRpcError,
+  InvalidAbiDecodingTypeError,
+  InvalidAbiEncodingTypeError,
+  InvalidAddressError,
+  InvalidArrayError,
+  InvalidBytesBooleanError,
+  InvalidDefinitionTypeError,
+  InvalidGasArgumentsError,
+  InvalidHexBooleanError,
+  InvalidHexValueError,
+  InvalidInputRpcError,
+  InvalidParamsRpcError,
+  InvalidRequestRpcError,
+  JsonRpcVersionUnsupportedError,
+  LimitExceededRpcError,
+  MethodNotFoundRpcError,
+  MethodNotSupportedRpcError,
+  OffsetOutOfBoundsError,
+  ParseRpcError,
+  RequestError,
+  ResourceNotFoundRpcError,
+  ResourceUnavailableRpcError,
+  RpcError,
+  RpcRequestError,
+  SizeExceedsPaddingSizeError,
+  TimeoutError,
+  TransactionNotFoundError,
+  TransactionReceiptNotFoundError,
+  TransactionRejectedRpcError,
+  UnknownRpcError,
+  UrlRequiredError,
+  WaitForTransactionReceiptTimeoutError,
+  WebSocketRequestError,
+} from './errors'
+
+export type {
+  Address,
+  AbiItem,
+  AccessList,
+  Block,
+  BlockIdentifier,
+  BlockNumber,
+  BlockTag,
+  ByteArray,
+  Chain,
+  ContractConfig,
+  Hex,
+  FeeHistory,
+  FeeValues,
+  FeeValuesEIP1559,
+  FeeValuesLegacy,
+  Hash,
+  Log,
+  RpcBlock,
+  RpcBlockIdentifier,
+  RpcBlockNumber,
+  RpcFeeHistory,
+  RpcFeeValues,
+  RpcLog,
+  RpcTransaction,
+  RpcTransactionReceipt,
+  RpcTransactionRequest,
+  RpcUncle,
+  TransactionReceipt,
+  TransactionRequest,
+  TransactionRequestBase,
+  TransactionRequestEIP1559,
+  TransactionRequestEIP2930,
+  TransactionRequestLegacy,
+  Transaction,
+  TransactionBase,
+  TransactionEIP1559,
+  TransactionEIP2930,
+  TransactionLegacy,
+  Uncle,
+} from './types'

package/src/public.test.ts

@@ -0,0 +1,36 @@
+import { expect, test } from 'vitest'
+
+import * as public_ from './public'
+
+test('exports public actions', () => {
+  expect(Object.keys(public_)).toMatchInlineSnapshot(`
+    [
+      "call",
+      "createBlockFilter",
+      "createPendingTransactionFilter",
+      "estimateGas",
+      "getBalance",
+      "getBlock",
+      "getBlockNumber",
+      "getBlockNumberCache",
+      "getBlockTransactionCount",
+      "getBytecode",
+      "getChainId",
+      "getFeeHistory",
+      "getFilterChanges",
+      "getFilterLogs",
+      "getLogs",
+      "getGasPrice",
+      "getTransaction",
+      "getTransactionConfirmations",
+      "getTransactionCount",
+      "getTransactionReceipt",
+      "uninstallFilter",
+      "waitForTransactionReceipt",
+      "watchBlockNumber",
+      "watchBlocks",
+      "watchEvent",
+      "watchPendingTransactions",
+    ]
+  `)
+})

package/src/public.ts

@@ -0,0 +1,76 @@
+export {
+  call,
+  createBlockFilter,
+  createPendingTransactionFilter,
+  estimateGas,
+  getBalance,
+  getBlock,
+  getBlockNumber,
+  getBlockNumberCache,
+  getBlockTransactionCount,
+  getBytecode,
+  getChainId,
+  getFeeHistory,
+  getFilterChanges,
+  getFilterLogs,
+  getLogs,
+  getGasPrice,
+  getTransaction,
+  getTransactionConfirmations,
+  getTransactionCount,
+  getTransactionReceipt,
+  uninstallFilter,
+  waitForTransactionReceipt,
+  watchBlockNumber,
+  watchBlocks,
+  watchEvent,
+  watchPendingTransactions,
+} from './actions/public'
+export type {
+  CallArgs,
+  CallResponse,
+  CreateBlockFilterResponse,
+  CreatePendingTransactionFilterResponse,
+  EstimateGasArgs,
+  EstimateGasResponse,
+  GetBalanceArgs,
+  GetBalanceResponse,
+  GetBlockArgs,
+  GetBlockNumberArgs,
+  GetBlockNumberResponse,
+  GetBlockResponse,
+  GetBlockTransactionCountArgs,
+  GetBlockTransactionCountResponse,
+  GetBytecodeArgs,
+  GetBytecodeResponse,
+  GetFeeHistoryArgs,
+  GetFeeHistoryResponse,
+  GetFilterChangesArgs,
+  GetFilterChangesResponse,
+  GetFilterLogsArgs,
+  GetFilterLogsResponse,
+  GetGasPriceResponse,
+  GetTransactionArgs,
+  GetTransactionConfirmationsArgs,
+  GetTransactionConfirmationsResponse,
+  GetTransactionCountArgs,
+  GetTransactionCountResponse,
+  GetTransactionReceiptArgs,
+  GetTransactionReceiptResponse,
+  GetTransactionResponse,
+  OnBlock,
+  OnBlockNumber,
+  OnBlockNumberResponse,
+  OnBlockResponse,
+  OnTransactions,
+  OnTransactionsResponse,
+  ReplacementReason,
+  ReplacementResponse,
+  UninstallFilterArgs,
+  UninstallFilterResponse,
+  WaitForTransactionReceiptArgs,
+  WaitForTransactionReceiptResponse,
+  WatchBlockNumberArgs,
+  WatchBlocksArgs,
+  WatchPendingTransactionsArgs,
+} from './actions/public'

package/src/test.test.ts

@@ -0,0 +1,38 @@
+import { expect, test } from 'vitest'
+
+import * as test_ from './test'
+
+test('exports test actions', () => {
+  expect(Object.keys(test_)).toMatchInlineSnapshot(`
+    [
+      "dropTransaction",
+      "getAutomine",
+      "getTxpoolContent",
+      "getTxpoolStatus",
+      "impersonateAccount",
+      "increaseTime",
+      "inspectTxpool",
+      "mine",
+      "removeBlockTimestampInterval",
+      "reset",
+      "revert",
+      "sendUnsignedTransaction",
+      "setAutomine",
+      "setBalance",
+      "setBlockGasLimit",
+      "setBlockTimestampInterval",
+      "setCode",
+      "setCoinbase",
+      "setIntervalMining",
+      "setLoggingEnabled",
+      "setMinGasPrice",
+      "setNextBlockBaseFeePerGas",
+      "setNextBlockTimestamp",
+      "setNonce",
+      "setStorageAt",
+      "snapshot",
+      "setRpcUrl",
+      "stopImpersonatingAccount",
+    ]
+  `)
+})

package/src/test.ts

@@ -0,0 +1,52 @@
+export {
+  dropTransaction,
+  getAutomine,
+  getTxpoolContent,
+  getTxpoolStatus,
+  impersonateAccount,
+  increaseTime,
+  inspectTxpool,
+  mine,
+  removeBlockTimestampInterval,
+  reset,
+  revert,
+  sendUnsignedTransaction,
+  setAutomine,
+  setBalance,
+  setBlockGasLimit,
+  setBlockTimestampInterval,
+  setCode,
+  setCoinbase,
+  setIntervalMining,
+  setLoggingEnabled,
+  setMinGasPrice,
+  setNextBlockBaseFeePerGas,
+  setNextBlockTimestamp,
+  setNonce,
+  setStorageAt,
+  snapshot,
+  setRpcUrl,
+  stopImpersonatingAccount,
+} from './actions/test'
+export type {
+  DropTransactionArgs,
+  ImpersonateAccountArgs,
+  IncreaseTimeArgs,
+  MineArgs,
+  ResetArgs,
+  RevertArgs,
+  SendUnsignedTransactionArgs,
+  SendUnsignedTransactionResponse,
+  SetBalanceArgs,
+  SetBlockGasLimitArgs,
+  SetBlockTimestampIntervalArgs,
+  SetCodeArgs,
+  SetCoinbaseArgs,
+  SetIntervalMiningArgs,
+  SetMinGasPriceArgs,
+  SetNextBlockBaseFeePerGasArgs,
+  SetNextBlockTimestampArgs,
+  SetNonceArgs,
+  SetStorageAtArgs,
+  StopImpersonatingAccountArgs,
+} from './actions/test'

package/src/types/block.ts

@@ -0,0 +1,71 @@
+import type { Address, Hash, Hex } from './misc'
+import type { Transaction } from './transaction'
+
+export type Block<TQuantity = bigint, TTransaction = Transaction> = {
+  /** Base fee per gas */
+  baseFeePerGas: TQuantity | null
+  /** Difficulty for this block */
+  difficulty: TQuantity
+  /** "Extra data" field of this block */
+  extraData: Hex
+  /** Maximum gas allowed in this block */
+  gasLimit: TQuantity
+  /** Total used gas by all transactions in this block */
+  gasUsed: TQuantity
+  /** Block hash or `null` if pending */
+  hash: Hash | null
+  /** Logs bloom filter or `null` if pending */
+  logsBloom: Hex | null
+  /** Address that received this block’s mining rewards */
+  miner: Address
+  /** Unique identifier for the block. */
+  mixHash: Hash
+  /** Proof-of-work hash or `null` if pending */
+  nonce: Hex | null
+  /** Block number or `null` if pending */
+  number: TQuantity | null
+  /** Parent block hash */
+  parentHash: Hash
+  /** Root of the this block’s receipts trie */
+  receiptsRoot: Hex
+  sealFields: Hex[]
+  /** SHA3 of the uncles data in this block */
+  sha3Uncles: Hash
+  /** Size of this block in bytes */
+  size: TQuantity
+  /** Root of this block’s final state trie */
+  stateRoot: Hash
+  /** Unix timestamp of when this block was collated */
+  timestamp: TQuantity
+  /** Total difficulty of the chain until this block */
+  totalDifficulty: TQuantity | null
+  /** List of transaction objects or hashes */
+  transactions: Hash[] | TTransaction[]
+  /** Root of this block’s transaction trie */
+  transactionsRoot: Hash
+  /** List of uncle hashes */
+  uncles: Hash[]
+}
+
+export type BlockIdentifier<TQuantity = bigint> = {
+  /** Whether or not to throw an error if the block is not in the canonical chain as described below. Only allowed in conjunction with the blockHash tag. Defaults to false. */
+  requireCanonical?: boolean
+} & (
+  | {
+      /** The block in the canonical chain with this number */
+      blockNumber: BlockNumber<TQuantity>
+    }
+  | {
+      /** The block uniquely identified by this hash. The `blockNumber` and `blockHash` properties are mutually exclusive; exactly one of them must be set. */
+      blockHash: Hash
+    }
+)
+
+export type BlockNumber<TQuantity = bigint> = TQuantity
+
+export type BlockTag = 'latest' | 'earliest' | 'pending' | 'safe' | 'finalized'
+
+export type Uncle<TQuantity = bigint, TTransaction = Transaction> = Block<
+  TQuantity,
+  TTransaction
+>

package/src/types/chain.ts

@@ -0,0 +1,6 @@
+import { Chain as Chain_ } from '@wagmi/chains'
+import { Formatters } from './formatter'
+
+export type Chain<TFormatters extends Formatters = Formatters> = Chain_ & {
+  formatters?: TFormatters
+}