viem 0.0.1-alpha.2 → 0.0.1-alpha.21

package/src/errors/request.ts

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

package/src/errors/rpc.test.ts

@@ -0,0 +1,88 @@
+import { expect, test } from 'vitest'
+import { initialBlockNumber } from '../_test'
+import { numberToHex } from '../utils'
+import {
+  HttpRequestError,
+  RpcError,
+  TimeoutError,
+  WebSocketRequestError,
+} from './rpc'
+
+test('RpcError', () => {
+  const err = new RpcError({
+    body: { foo: 'bar' },
+    error: { code: 420, message: 'Error' },
+    url: 'https://lol.com',
+  })
+  expect(err).toMatchInlineSnapshot(`
+    [RpcError: RPC Request failed.
+
+    URL: https://lol.com
+    Request body: {"foo":"bar"}
+
+    Details: Error
+    Version: viem@1.0.2
+    Internal Error: {"code":420,"message":"Error"}]
+  `)
+})
+
+test('HttpRequestError', () => {
+  const err = new HttpRequestError({
+    url: 'https://eth-mainnet.g.alchemy.com/v2/_gg7wSSi0KMBsdKnGVfHDueq6xMB9EkC',
+    body: {
+      method: 'eth_getBlockByNumber',
+      params: [numberToHex(initialBlockNumber), false],
+    },
+    status: 500,
+    details: 'Some error',
+  })
+  expect(err).toMatchInlineSnapshot(`
+    [HttpRequestError: HTTP request failed.
+
+    Status: 500
+    URL: https://eth-mainnet.g.alchemy.com/v2/_gg7wSSi0KMBsdKnGVfHDueq6xMB9EkC
+    Request body: {"method":"eth_getBlockByNumber","params":["0xf86cc2",false]}
+
+    Details: Some error
+    Version: viem@1.0.2]
+  `)
+})
+
+test('WebSocketRequestError', () => {
+  const err = new WebSocketRequestError({
+    url: 'ws://eth-mainnet.g.alchemy.com/v2/_gg7wSSi0KMBsdKnGVfHDueq6xMB9EkC',
+    body: {
+      method: 'eth_getBlockByNumber',
+      params: [numberToHex(initialBlockNumber), false],
+    },
+    details: 'Some error',
+  })
+  expect(err).toMatchInlineSnapshot(`
+    [WebSocketRequestError: WebSocket request failed.
+
+    URL: ws://eth-mainnet.g.alchemy.com/v2/_gg7wSSi0KMBsdKnGVfHDueq6xMB9EkC
+    Request body: {"method":"eth_getBlockByNumber","params":["0xf86cc2",false]}
+
+    Details: Some error
+    Version: viem@1.0.2]
+  `)
+})
+
+test('TimeoutError', () => {
+  const err = new TimeoutError({
+    url: 'https://eth-mainnet.g.alchemy.com/v2/_gg7wSSi0KMBsdKnGVfHDueq6xMB9EkC',
+    body: {
+      method: 'eth_getBlockByNumber',
+      params: [numberToHex(initialBlockNumber), false],
+    },
+  })
+  expect(err).toMatchInlineSnapshot(`
+    [TimeoutError: The request took too long to respond.
+
+    URL: https://eth-mainnet.g.alchemy.com/v2/_gg7wSSi0KMBsdKnGVfHDueq6xMB9EkC
+    Request body: {"method":"eth_getBlockByNumber","params":["0xf86cc2",false]}
+
+    Details: The request timed out.
+    Version: viem@1.0.2]
+  `)
+})

package/src/errors/rpc.ts

@@ -0,0 +1,113 @@
+import { stringify } from '../utils'
+import { BaseError } from './base'
+
+export class HttpRequestError extends BaseError {
+  name = 'HttpRequestError'
+  status
+
+  constructor({
+    body,
+    details,
+    status,
+    url,
+  }: {
+    body: { [key: string]: unknown }
+    details: string
+    status: number
+    url: string
+  }) {
+    super(
+      [
+        'HTTP request failed.',
+        '',
+        `Status: ${status}`,
+        `URL: ${url}`,
+        `Request body: ${stringify(body)}`,
+      ].join('\n'),
+      {
+        details,
+      },
+    )
+    this.status = status
+  }
+}
+
+export class WebSocketRequestError extends BaseError {
+  name = 'WebSocketRequestError'
+
+  constructor({
+    body,
+    details,
+    url,
+  }: {
+    body: { [key: string]: unknown }
+    details: string
+    url: string
+  }) {
+    super(
+      [
+        'WebSocket request failed.',
+        '',
+        `URL: ${url}`,
+        `Request body: ${stringify(body)}`,
+      ].join('\n'),
+      {
+        details,
+      },
+    )
+  }
+}
+
+export class RpcError extends BaseError {
+  code: number
+
+  name = 'RpcError'
+
+  constructor({
+    body,
+    error,
+    url,
+  }: {
+    body: { [key: string]: unknown }
+    error: { code: number; message: string }
+    url: string
+  }) {
+    super(
+      [
+        'RPC Request failed.',
+        '',
+        `URL: ${url}`,
+        `Request body: ${stringify(body)}`,
+      ].join('\n'),
+      {
+        cause: error as any,
+        details: error.message,
+      },
+    )
+    this.code = error.code
+  }
+}
+
+export class TimeoutError extends BaseError {
+  name = 'TimeoutError'
+
+  constructor({
+    body,
+    url,
+  }: {
+    body: { [key: string]: unknown }
+    url: string
+  }) {
+    super(
+      [
+        'The request took too long to respond.',
+        '',
+        `URL: ${url}`,
+        `Request body: ${stringify(body)}`,
+      ].join('\n'),
+      {
+        details: 'The request timed out.',
+      },
+    )
+  }
+}

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,12 @@
+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',
+      },
+    )
+  }
+}