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

package/src/errors/abi.ts

@@ -0,0 +1,254 @@
+import { Hex } from '../types'
+import { BaseError } from './base'
+
+export class AbiConstructorNotFoundError extends BaseError {
+  name = 'AbiConstructorNotFoundError'
+  constructor({ docsPath }: { docsPath: string }) {
+    super(
+      [
+        'A constructor was not found on the ABI.',
+        'Make sure you are using the correct ABI and that the constructor exists on it.',
+      ].join('\n'),
+      {
+        docsPath,
+      },
+    )
+  }
+}
+
+export class AbiConstructorParamsNotFoundError extends BaseError {
+  name = 'AbiConstructorParamsNotFoundError'
+  constructor({ docsPath }: { docsPath: string }) {
+    super(
+      [
+        'Constructor arguments were provided (`args`), but a constructor parameters (`inputs`) were not found on the ABI.',
+        'Make sure you are using the correct ABI, and that the `inputs` attribute on the constructor exists.',
+      ].join('\n'),
+      {
+        docsPath,
+      },
+    )
+  }
+}
+
+export class AbiDecodingDataSizeInvalidError extends BaseError {
+  name = 'AbiDecodingDataSizeInvalidError'
+  constructor(size: number) {
+    super(
+      [
+        `Data size of ${size} bytes is invalid.`,
+        'Size must be in increments of 32 bytes (size % 32 === 0).',
+      ].join('\n'),
+    )
+  }
+}
+
+export class AbiDecodingZeroDataError extends BaseError {
+  name = 'AbiDecodingZeroDataError'
+  constructor() {
+    super('Cannot decode zero data ("0x") with ABI parameters.')
+  }
+}
+
+export class AbiEncodingArrayLengthMismatchError extends BaseError {
+  name = 'AbiEncodingArrayLengthMismatchError'
+  constructor({
+    expectedLength,
+    givenLength,
+    type,
+  }: { expectedLength: number; givenLength: number; type: string }) {
+    super(
+      [
+        `ABI encoding array length mismatch for type ${type}.`,
+        `Expected length: ${expectedLength}`,
+        `Given length: ${givenLength}`,
+      ].join('\n'),
+    )
+  }
+}
+
+export class AbiEncodingLengthMismatchError extends BaseError {
+  name = 'AbiEncodingLengthMismatchError'
+  constructor({
+    expectedLength,
+    givenLength,
+  }: { expectedLength: number; givenLength: number }) {
+    super(
+      [
+        'ABI encoding params/values length mismatch.',
+        `Expected length (params): ${expectedLength}`,
+        `Given length (values): ${givenLength}`,
+      ].join('\n'),
+    )
+  }
+}
+
+export class AbiErrorInputsNotFoundError extends BaseError {
+  name = 'AbiErrorInputsNotFoundError'
+  constructor(errorName: string, { docsPath }: { docsPath: string }) {
+    super(
+      [
+        `Arguments (\`args\`) were provided to "${errorName}", but "${errorName}" on the ABI does not contain any parameters (\`inputs\`).`,
+        'Cannot encode error result without knowing what the parameter types are.',
+        'Make sure you are using the correct ABI and that the inputs exist on it.',
+      ].join('\n'),
+      {
+        docsPath,
+      },
+    )
+  }
+}
+
+export class AbiErrorNotFoundError extends BaseError {
+  name = 'AbiErrorNotFoundError'
+  constructor(errorName: string, { docsPath }: { docsPath: string }) {
+    super(
+      [
+        `Error "${errorName}" not found on ABI.`,
+        'Make sure you are using the correct ABI and that the error exists on it.',
+      ].join('\n'),
+      {
+        docsPath,
+      },
+    )
+  }
+}
+
+export class AbiErrorSignatureNotFoundError extends BaseError {
+  name = 'AbiErrorSignatureNotFoundError'
+  constructor(signature: Hex, { docsPath }: { docsPath: string }) {
+    super(
+      [
+        `Encoded error signature "${signature}" not found on ABI.`,
+        'Make sure you are using the correct ABI and that the error exists on it.',
+        `You can look up the signature here: https://openchain.xyz/signatures?query=${signature}.`,
+      ].join('\n'),
+      {
+        docsPath,
+      },
+    )
+  }
+}
+
+export class AbiEventSignatureNotFoundError extends BaseError {
+  name = 'AbiEventSignatureNotFoundError'
+  constructor(signature: Hex, { docsPath }: { docsPath: string }) {
+    super(
+      [
+        `Encoded event signature "${signature}" not found on ABI.`,
+        'Make sure you are using the correct ABI and that the event exists on it.',
+        `You can look up the signature here: https://openchain.xyz/signatures?query=${signature}.`,
+      ].join('\n'),
+      {
+        docsPath,
+      },
+    )
+  }
+}
+
+export class AbiEventNotFoundError extends BaseError {
+  name = 'AbiEventNotFoundError'
+  constructor(eventName: string, { docsPath }: { docsPath: string }) {
+    super(
+      [
+        `Event "${eventName}" not found on ABI.`,
+        'Make sure you are using the correct ABI and that the event exists on it.',
+      ].join('\n'),
+      {
+        docsPath,
+      },
+    )
+  }
+}
+
+export class AbiFunctionNotFoundError extends BaseError {
+  name = 'AbiFunctionNotFoundError'
+  constructor(functionName: string, { docsPath }: { docsPath: string }) {
+    super(
+      [
+        `Function "${functionName}" not found on ABI.`,
+        'Make sure you are using the correct ABI and that the function exists on it.',
+      ].join('\n'),
+      {
+        docsPath,
+      },
+    )
+  }
+}
+
+export class AbiFunctionOutputsNotFoundError extends BaseError {
+  name = 'AbiFunctionOutputsNotFoundError'
+  constructor(functionName: string, { docsPath }: { docsPath: string }) {
+    super(
+      [
+        `Function "${functionName}" does not contain any \`outputs\` on ABI.`,
+        'Cannot decode function result without knowing what the parameter types are.',
+        'Make sure you are using the correct ABI and that the function exists on it.',
+      ].join('\n'),
+      {
+        docsPath,
+      },
+    )
+  }
+}
+
+export class AbiFunctionSignatureNotFoundError extends BaseError {
+  name = 'AbiFunctionSignatureNotFoundError'
+  constructor(signature: Hex, { docsPath }: { docsPath: string }) {
+    super(
+      [
+        `Encoded function signature "${signature}" not found on ABI.`,
+        'Make sure you are using the correct ABI and that the function exists on it.',
+        `You can look up the signature here: https://openchain.xyz/signatures?query=${signature}.`,
+      ].join('\n'),
+      {
+        docsPath,
+      },
+    )
+  }
+}
+
+export class InvalidAbiEncodingTypeError extends BaseError {
+  name = 'InvalidAbiEncodingType'
+  constructor(type: string, { docsPath }: { docsPath: string }) {
+    super(
+      [
+        `Type "${type}" is not a valid encoding type.`,
+        'Please provide a valid ABI type.',
+      ].join('\n'),
+      { docsPath },
+    )
+  }
+}
+
+export class InvalidAbiDecodingTypeError extends BaseError {
+  name = 'InvalidAbiDecodingType'
+  constructor(type: string, { docsPath }: { docsPath: string }) {
+    super(
+      [
+        `Type "${type}" is not a valid decoding type.`,
+        'Please provide a valid ABI type.',
+      ].join('\n'),
+      { docsPath },
+    )
+  }
+}
+
+export class InvalidArrayError extends BaseError {
+  name = 'InvalidArrayError'
+  constructor(value: unknown) {
+    super([`Value "${value}" is not a valid array.`].join('\n'))
+  }
+}
+
+export class InvalidDefinitionTypeError extends BaseError {
+  name = 'InvalidDefinitionTypeError'
+  constructor(type: string) {
+    super(
+      [
+        `"${type}" is not a valid definition type.`,
+        'Valid types: "function", "event", "error"',
+      ].join('\n'),
+    )
+  }
+}

package/src/errors/address.test.ts

@@ -0,0 +1,14 @@
+import { expect, test } from 'vitest'
+import { InvalidAddressError } from './address'
+
+test('InvalidAddressError', () => {
+  expect(
+    new InvalidAddressError({
+      address: '0xa5cc3c03994db5b0d9a5eEdD10Cabab0813678az',
+    }),
+  ).toMatchInlineSnapshot(`
+    [InvalidAddressError: Address "0xa5cc3c03994db5b0d9a5eEdD10Cabab0813678az" is invalid.
+
+    Version: viem@1.0.2]
+  `)
+})

package/src/errors/address.ts

@@ -0,0 +1,9 @@
+import { Address } from '../types'
+import { BaseError } from './base'
+
+export class InvalidAddressError extends BaseError {
+  name = 'InvalidAddressError'
+  constructor({ address }: { address: Address }) {
+    super(`Address "${address}" is invalid.`)
+  }
+}

package/src/errors/base.test.ts

@@ -0,0 +1,114 @@
+import { expect, test } from 'vitest'
+
+import { BaseError } from './base'
+
+test('BaseError', () => {
+  expect(new BaseError('An error occurred.')).toMatchInlineSnapshot(`
+    [ViemError: An error occurred.
+
+    Version: viem@1.0.2]
+  `)
+
+  expect(
+    new BaseError('An error occurred.', { details: 'details' }),
+  ).toMatchInlineSnapshot(`
+    [ViemError: An error occurred.
+
+    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)', () => {
+  expect(
+    new BaseError('An error occurred.', {
+      details: 'details',
+      docsPath: '/lol',
+    }),
+  ).toMatchInlineSnapshot(`
+    [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]
+  `)
+})
+
+test('inherited BaseError', () => {
+  const err = new BaseError('An error occurred.', {
+    details: 'details',
+    docsPath: '/lol',
+  })
+  expect(
+    new BaseError('An internal error occurred.', {
+      cause: err,
+    }),
+  ).toMatchInlineSnapshot(`
+    [ViemError: An internal error occurred.
+
+    Docs: https://viem.sh/lol
+    Details: details
+    Version: viem@1.0.2]
+  `)
+})
+
+test('inherited Error', () => {
+  const err = new Error('details')
+  expect(
+    new BaseError('An internal error occurred.', {
+      cause: err,
+      docsPath: '/lol',
+    }),
+  ).toMatchInlineSnapshot(`
+    [ViemError: An internal error occurred.
+
+    Docs: https://viem.sh/lol
+    Details: details
+    Version: viem@1.0.2]
+  `)
+})

package/src/errors/base.ts

@@ -0,0 +1,57 @@
+// @ts-ignore
+import pkg from '../../package.json'
+
+/* c8 ignore next */
+const version = process.env.TEST ? '1.0.2' : pkg.version
+
+type BaseErrorArgs = {
+  docsPath?: string
+  metaMessages?: string[]
+} & (
+  | {
+      cause?: never
+      details?: string
+    }
+  | {
+      cause: BaseError | Error
+      details?: never
+    }
+)
+
+export class BaseError extends Error {
+  details: string
+  docsPath?: string
+  metaMessages?: string[]
+  shortMessage: string
+
+  name = 'ViemError'
+
+  constructor(shortMessage: string, args: BaseErrorArgs = {}) {
+    const details =
+      args.cause instanceof BaseError
+        ? args.cause.details
+        : args.cause?.message
+        ? args.cause.message
+        : args.details!
+    const docsPath =
+      args.cause instanceof BaseError
+        ? args.cause.docsPath || args.docsPath
+        : args.docsPath
+    const message = [
+      shortMessage || 'An error occurred.',
+      '',
+      ...(args.metaMessages ? [...args.metaMessages, ''] : []),
+      ...(docsPath ? [`Docs: https://viem.sh${docsPath}`] : []),
+      ...(details ? [`Details: ${details}`] : []),
+      `Version: viem@${version}`,
+    ].join('\n')
+
+    super(message)
+
+    if (args.cause) this.cause = args.cause
+    this.details = details
+    this.docsPath = docsPath
+    this.metaMessages = args.metaMessages
+    this.shortMessage = shortMessage
+  }
+}

package/src/errors/block.test.ts

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

package/src/errors/block.ts

@@ -0,0 +1,18 @@
+import { Hash } from '../types'
+import { BaseError } from './base'
+
+export class BlockNotFoundError extends BaseError {
+  name = 'BlockNotFoundError'
+  constructor({
+    blockHash,
+    blockNumber,
+  }: {
+    blockHash?: Hash
+    blockNumber?: bigint
+  }) {
+    let identifier = 'Block'
+    if (blockHash) identifier = `Block at hash "${blockHash}"`
+    if (blockNumber) identifier = `Block at number "${blockNumber}"`
+    super(`${identifier} could not be found.`)
+  }
+}

package/src/errors/chain.test.ts

@@ -0,0 +1,46 @@
+import { expect, test } from 'vitest'
+import { mainnet } from '../chains'
+import { ChainDoesNotSupportContract } from './chain'
+
+test('ChainDoesNotSupportContract', () => {
+  expect(
+    new ChainDoesNotSupportContract({
+      chain: mainnet,
+      contract: { name: 'ensUniversalResolver' },
+    }),
+  ).toMatchInlineSnapshot(`
+    [ChainDoesNotSupportContract: Chain "Ethereum" does not support contract "ensUniversalResolver".
+
+    This could be due to any of the following:
+    - The chain does not have the contract "ensUniversalResolver" configured.
+
+    Version: viem@1.0.2]
+  `)
+  expect(
+    new ChainDoesNotSupportContract({
+      chain: mainnet,
+      contract: { name: 'ensUniversalResolver', blockCreated: 16172161 },
+    }),
+  ).toMatchInlineSnapshot(`
+    [ChainDoesNotSupportContract: Chain "Ethereum" does not support contract "ensUniversalResolver".
+
+    This could be due to any of the following:
+    - The chain does not have the contract "ensUniversalResolver" configured.
+
+    Version: viem@1.0.2]
+  `)
+  expect(
+    new ChainDoesNotSupportContract({
+      blockNumber: 16172160n,
+      chain: mainnet,
+      contract: { name: 'ensUniversalResolver', blockCreated: 16172161 },
+    }),
+  ).toMatchInlineSnapshot(`
+    [ChainDoesNotSupportContract: Chain "Ethereum" does not support contract "ensUniversalResolver".
+
+    This could be due to any of the following:
+    - The contract "ensUniversalResolver" was not deployed until block 16172161 (current block 16172160).
+
+    Version: viem@1.0.2]
+  `)
+})

package/src/errors/chain.ts

@@ -0,0 +1,33 @@
+import { Chain } from '../types'
+import { BaseError } from './base'
+
+export class ChainDoesNotSupportContract extends BaseError {
+  name = 'ChainDoesNotSupportContract'
+  constructor({
+    blockNumber,
+    chain,
+    contract,
+  }: {
+    blockNumber?: bigint
+    chain: Chain
+    contract: { name: string; blockCreated?: number }
+  }) {
+    super(
+      `Chain "${chain.name}" does not support contract "${contract.name}".`,
+      {
+        metaMessages: [
+          'This could be due to any of the following:',
+          ...(blockNumber &&
+          contract.blockCreated &&
+          contract.blockCreated > blockNumber
+            ? [
+                `- The contract "${contract.name}" was not deployed until block ${contract.blockCreated} (current block ${blockNumber}).`,
+              ]
+            : [
+                `- The chain does not have the contract "${contract.name}" configured.`,
+              ]),
+        ],
+      },
+    )
+  }
+}