viem 0.0.1-alpha.25 → 0.0.1-alpha.26

package/src/utils/contract/getContractError.test.ts

@@ -1,282 +0,0 @@
-import { describe, expect, test } from 'vitest'
-
-import { accounts } from '../../_test'
-import { baycContractConfig } from '../../_test/abis'
-import {
-  AbiDecodingZeroDataError,
-  BaseError,
-  RawContractError,
-} from '../../errors'
-import { getContractError } from './getContractError'
-
-describe('getContractError', () => {
-  test('default', () => {
-    const error = getContractError(
-      new RawContractError({
-        message: 'execution reverted: Sale must be active to mint Ape',
-        data: '0x08c379a00000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000001f53616c65206d7573742062652061637469766520746f206d696e742041706500',
-      }),
-      {
-        abi: baycContractConfig.abi,
-        functionName: 'mintApe',
-        args: [1n],
-        sender: accounts[0].address,
-      },
-    )
-    expect(error).toMatchInlineSnapshot(`
-      [ContractFunctionExecutionError: The contract function "mintApe" reverted with the following reason:
-      Sale must be active to mint Ape
-
-      Function:  mintApe(uint256 numberOfTokens)
-      Arguments:        (1)
-      Sender:    0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266
-
-      Version: viem@1.0.2]
-    `)
-    expect(error.cause).toMatchInlineSnapshot(`
-      [ContractFunctionRevertedError: The contract function "mintApe" reverted with the following reason:
-      Sale must be active to mint Ape
-
-      Version: viem@1.0.2]
-    `)
-  })
-
-  test('default: rpc', () => {
-    const error = getContractError(
-      new BaseError('An RPC error occurred', {
-        cause: {
-          code: 3,
-          message: 'execution reverted: Sale must be active to mint Ape',
-          data: '0x08c379a00000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000001f53616c65206d7573742062652061637469766520746f206d696e742041706500',
-        } as unknown as Error,
-      }),
-      {
-        abi: baycContractConfig.abi,
-        functionName: 'mintApe',
-        args: [1n],
-        sender: accounts[0].address,
-      },
-    )
-    expect(error).toMatchInlineSnapshot(`
-      [ContractFunctionExecutionError: The contract function "mintApe" reverted with the following reason:
-      Sale must be active to mint Ape
-
-      Function:  mintApe(uint256 numberOfTokens)
-      Arguments:        (1)
-      Sender:    0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266
-
-      Version: viem@1.0.2]
-    `)
-    expect(error.cause).toMatchInlineSnapshot(`
-      [ContractFunctionRevertedError: The contract function "mintApe" reverted with the following reason:
-      Sale must be active to mint Ape
-
-      Version: viem@1.0.2]
-    `)
-  })
-
-  test('no data', () => {
-    const error = getContractError(
-      new BaseError('An RPC error occurred', {
-        cause: {
-          code: 3,
-          message: 'ah no',
-        } as unknown as Error,
-      }),
-      {
-        abi: baycContractConfig.abi,
-        functionName: 'mintApe',
-        args: [1n],
-        sender: accounts[0].address,
-      },
-    )
-    expect(error).toMatchInlineSnapshot(`
-      [ContractFunctionExecutionError: The contract function "mintApe" reverted with the following reason:
-      ah no
-
-      Function:  mintApe(uint256 numberOfTokens)
-      Arguments:        (1)
-      Sender:    0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266
-
-      Version: viem@1.0.2]
-    `)
-    expect(error.cause).toMatchInlineSnapshot(`
-      [ContractFunctionRevertedError: The contract function "mintApe" reverted with the following reason:
-      ah no
-
-      Version: viem@1.0.2]
-    `)
-  })
-
-  test('no message', () => {
-    const error = getContractError(
-      new BaseError('An RPC error occurred', {
-        cause: {
-          code: 3,
-          data: '0x08c379a00000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000001f53616c65206d7573742062652061637469766520746f206d696e742041706500',
-        } as unknown as Error,
-      }),
-      {
-        abi: baycContractConfig.abi,
-        functionName: 'mintApe',
-        args: [1n],
-        sender: accounts[0].address,
-      },
-    )
-    expect(error).toMatchInlineSnapshot(`
-      [ContractFunctionExecutionError: The contract function "mintApe" reverted with the following reason:
-      Sale must be active to mint Ape
-
-      Function:  mintApe(uint256 numberOfTokens)
-      Arguments:        (1)
-      Sender:    0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266
-
-      Version: viem@1.0.2]
-    `)
-    expect(error.cause).toMatchInlineSnapshot(`
-      [ContractFunctionRevertedError: The contract function "mintApe" reverted with the following reason:
-      Sale must be active to mint Ape
-
-      Version: viem@1.0.2]
-    `)
-  })
-
-  test('unknown function', () => {
-    const error = getContractError(
-      new BaseError('An RPC error occurred', {
-        cause: {
-          code: 3,
-          message: 'execution reverted: Sale must be active to mint Ape',
-          data: '0x08c379a00000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000001f53616c65206d7573742062652061637469766520746f206d696e742041706500',
-        } as unknown as Error,
-      }),
-      {
-        abi: baycContractConfig.abi,
-        functionName: 'mintApe',
-        args: [1n],
-        sender: accounts[0].address,
-      },
-    )
-    expect(error).toMatchInlineSnapshot(`
-      [ContractFunctionExecutionError: The contract function "mintApe" reverted with the following reason:
-      Sale must be active to mint Ape
-
-      Function:  mintApe(uint256 numberOfTokens)
-      Arguments:        (1)
-      Sender:    0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266
-
-      Version: viem@1.0.2]
-    `)
-    expect(error.cause).toMatchInlineSnapshot(`
-      [ContractFunctionRevertedError: The contract function "mintApe" reverted with the following reason:
-      Sale must be active to mint Ape
-
-      Version: viem@1.0.2]
-    `)
-  })
-
-  test('unknown error', () => {
-    const error = getContractError(
-      new BaseError('An RPC error occurred', {
-        cause: new Error('rarararar i am an error lmaoaoo'),
-      }),
-      {
-        abi: baycContractConfig.abi,
-        functionName: 'mintApe',
-        args: [1n],
-        sender: accounts[0].address,
-      },
-    )
-    expect(error).toMatchInlineSnapshot(`
-      [ContractFunctionExecutionError: An RPC error occurred
-
-      Function:  mintApe(uint256 numberOfTokens)
-      Arguments:        (1)
-      Sender:    0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266
-
-      Details: rarararar i am an error lmaoaoo
-      Version: viem@1.0.2]
-    `)
-    expect(error.cause).toMatchInlineSnapshot(`
-      [ViemError: An RPC error occurred
-
-      Details: rarararar i am an error lmaoaoo
-      Version: viem@1.0.2]
-    `)
-
-    const error2 = getContractError(new BaseError('An RPC error occurred'), {
-      abi: baycContractConfig.abi,
-      functionName: 'mintApe',
-      args: [1n],
-      sender: accounts[0].address,
-    })
-    expect(error2).toMatchInlineSnapshot(`
-      [ContractFunctionExecutionError: An RPC error occurred
-
-      Function:  mintApe(uint256 numberOfTokens)
-      Arguments:        (1)
-      Sender:    0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266
-
-      Version: viem@1.0.2]
-    `)
-    expect(error2.cause).toMatchInlineSnapshot(`
-      [ViemError: An RPC error occurred
-
-      Version: viem@1.0.2]
-    `)
-
-    const error3 = getContractError(new BaseError(''), {
-      abi: baycContractConfig.abi,
-      functionName: 'mintApe',
-      args: [1n],
-      sender: accounts[0].address,
-    })
-    expect(error3).toMatchInlineSnapshot(`
-      [ContractFunctionExecutionError: An unknown error occurred while executing the contract function "mintApe".
-
-      Function:  mintApe(uint256 numberOfTokens)
-      Arguments:        (1)
-      Sender:    0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266
-
-      Version: viem@1.0.2]
-    `)
-    expect(error3.cause).toMatchInlineSnapshot(`
-      [ViemError: An error occurred.
-
-      Version: viem@1.0.2]
-    `)
-  })
-
-  test('zero data', () => {
-    const error = getContractError(new AbiDecodingZeroDataError(), {
-      abi: baycContractConfig.abi,
-      functionName: 'mintApe',
-      args: [1n],
-      sender: accounts[0].address,
-    })
-    expect(error).toMatchInlineSnapshot(`
-      [ContractFunctionExecutionError: The contract function "mintApe" returned no data ("0x").
-
-      This could be due to any of the following:
-      - The contract does not have the function "mintApe",
-      - The parameters passed to the contract function may be invalid, or
-      - The address is not a contract.
-       
-      Function:  mintApe(uint256 numberOfTokens)
-      Arguments:        (1)
-      Sender:    0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266
-
-      Version: viem@1.0.2]
-    `)
-    expect(error.cause).toMatchInlineSnapshot(`
-      [ContractFunctionZeroDataError: The contract function "mintApe" returned no data ("0x").
-
-      This could be due to any of the following:
-      - The contract does not have the function "mintApe",
-      - The parameters passed to the contract function may be invalid, or
-      - The address is not a contract.
-
-      Version: viem@1.0.2]
-    `)
-  })
-})

package/src/utils/contract/getContractError.ts

@@ -1,58 +0,0 @@
-import { Abi } from 'abitype'
-import {
-  AbiDecodingZeroDataError,
-  BaseError,
-  ContractFunctionExecutionError,
-  RawContractError,
-} from '../../errors'
-import {
-  ContractFunctionRevertedError,
-  ContractFunctionZeroDataError,
-} from '../../errors/contract'
-import { Address } from '../../types'
-
-const EXECUTION_REVERTED_ERROR_CODE = 3
-
-export function getContractError(
-  err: BaseError,
-  {
-    abi,
-    address,
-    args,
-    docsPath,
-    functionName,
-    sender,
-  }: {
-    abi: Abi
-    args: any
-    address?: Address
-    docsPath?: string
-    functionName: string
-    sender?: Address
-  },
-) {
-  const { code, data, message } = (
-    err instanceof RawContractError ? err : err.cause || {}
-  ) as RawContractError
-
-  let cause = err
-  if (err instanceof AbiDecodingZeroDataError) {
-    cause = new ContractFunctionZeroDataError({ functionName })
-  } else if (code === EXECUTION_REVERTED_ERROR_CODE && (data || message)) {
-    cause = new ContractFunctionRevertedError({
-      abi,
-      data,
-      functionName,
-      message,
-    })
-  }
-
-  return new ContractFunctionExecutionError(cause, {
-    abi,
-    args,
-    contractAddress: address,
-    docsPath,
-    functionName,
-    sender,
-  })
-}

package/src/utils/contract/index.test.ts

@@ -1,15 +0,0 @@
-import { expect, test } from 'vitest'
-
-import * as utils from './index'
-
-test('exports utils', () => {
-  expect(utils).toMatchInlineSnapshot(`
-    {
-      "extractFunctionName": [Function],
-      "extractFunctionParams": [Function],
-      "extractFunctionParts": [Function],
-      "extractFunctionType": [Function],
-      "getContractError": [Function],
-    }
-  `)
-})

package/src/utils/contract/index.ts

@@ -1,8 +0,0 @@
-export {
-  extractFunctionName,
-  extractFunctionParams,
-  extractFunctionParts,
-  extractFunctionType,
-} from './extractFunctionParts'
-
-export { getContractError } from './getContractError'

package/src/utils/data/concat.test.ts

@@ -1,35 +0,0 @@
-import { expect, test } from 'vitest'
-
-import { concat, concatBytes, concatHex } from './concat'
-
-test('concat', () => {
-  expect(concat(['0x0', '0x1'])).toBe('0x01')
-  expect(concat(['0x1', '0x69', '0x420'])).toBe('0x169420')
-  expect(concat(['0x00000001', '0x00000069', '0x00000420'])).toBe(
-    '0x000000010000006900000420',
-  )
-  expect(concatHex(['0x00000001', '0x00000069', '0x00000420'])).toBe(
-    '0x000000010000006900000420',
-  )
-
-  expect(concat([new Uint8Array([0]), new Uint8Array([1])])).toStrictEqual(
-    new Uint8Array([0, 1]),
-  )
-  expect(concatBytes([new Uint8Array([0]), new Uint8Array([1])])).toStrictEqual(
-    new Uint8Array([0, 1]),
-  )
-  expect(
-    concat([
-      new Uint8Array([1]),
-      new Uint8Array([69]),
-      new Uint8Array([420, 69]),
-    ]),
-  ).toStrictEqual(new Uint8Array([1, 69, 420, 69]))
-  expect(
-    concat([
-      new Uint8Array([0, 0, 0, 1]),
-      new Uint8Array([0, 0, 0, 69]),
-      new Uint8Array([0, 0, 420, 69]),
-    ]),
-  ).toStrictEqual(new Uint8Array([0, 0, 0, 1, 0, 0, 0, 69, 0, 0, 420, 69]))
-})

package/src/utils/data/concat.ts

@@ -1,34 +0,0 @@
-import type { ByteArray, Hex } from '../../types'
-
-type ConcatResult<TValue extends Hex | ByteArray> = TValue extends Hex
-  ? Hex
-  : ByteArray
-
-export function concat<TValue extends Hex | ByteArray>(
-  values: TValue[],
-): ConcatResult<TValue> {
-  if (typeof values[0] === 'string')
-    return concatHex(values as Hex[]) as ConcatResult<TValue>
-  return concatBytes(values as ByteArray[]) as ConcatResult<TValue>
-}
-
-export function concatBytes(values: ByteArray[]): ByteArray {
-  let length = 0
-  for (const arr of values) {
-    length += arr.length
-  }
-  const result = new Uint8Array(length)
-  let offset = 0
-  for (const arr of values) {
-    result.set(arr, offset)
-    offset += arr.length
-  }
-  return result
-}
-
-export function concatHex(values: Hex[]): Hex {
-  return `0x${(values as Hex[]).reduce(
-    (acc, x) => acc + x.replace('0x', ''),
-    '',
-  )}`
-}

package/src/utils/data/index.test.ts

@@ -1,23 +0,0 @@
-import { expect, test } from 'vitest'
-
-import * as utils from './index'
-
-test('exports utils', () => {
-  expect(utils).toMatchInlineSnapshot(`
-    {
-      "concat": [Function],
-      "concatBytes": [Function],
-      "concatHex": [Function],
-      "isBytes": [Function],
-      "isHex": [Function],
-      "pad": [Function],
-      "padBytes": [Function],
-      "padHex": [Function],
-      "size": [Function],
-      "slice": [Function],
-      "sliceBytes": [Function],
-      "sliceHex": [Function],
-      "trim": [Function],
-    }
-  `)
-})

package/src/utils/data/index.ts

@@ -1,13 +0,0 @@
-export { concat, concatBytes, concatHex } from './concat'
-
-export { isBytes } from './isBytes'
-
-export { isHex } from './isHex'
-
-export { pad, padBytes, padHex } from './pad'
-
-export { trim } from './trim'
-
-export { size } from './size'
-
-export { slice, sliceBytes, sliceHex } from './slice'

package/src/utils/data/isBytes.test.ts

@@ -1,9 +0,0 @@
-import { expect, test } from 'vitest'
-
-import { isBytes } from './isBytes'
-
-test('is bytes', () => {
-  expect(isBytes(new Uint8Array([1, 69, 420])))
-  expect(isBytes('0x1')).toBeFalsy()
-  expect(isBytes(undefined)).toBeFalsy()
-})

package/src/utils/data/isBytes.ts

@@ -1,7 +0,0 @@
-export function isBytes(value: any) {
-  if (!value) return false
-  if (typeof value !== 'object') return false
-  return (
-    value.BYTES_PER_ELEMENT === 1 && value.constructor.name === 'Uint8Array'
-  )
-}

package/src/utils/data/isHex.test.ts

@@ -1,13 +0,0 @@
-import { expect, test } from 'vitest'
-
-import { isHex } from './isHex'
-
-test('is hex', () => {
-  expect(isHex('0x')).toBeTruthy()
-  expect(isHex('0x0')).toBeTruthy()
-  expect(isHex('0x0123456789abcdef')).toBeTruthy()
-  expect(isHex('0x0123456789abcdefABCDEF')).toBeTruthy()
-  expect(isHex('0x0123456789abcdefg')).toBeFalsy()
-  expect(isHex({ foo: 'bar' })).toBeFalsy()
-  expect(isHex(undefined)).toBeFalsy()
-})

package/src/utils/data/isHex.ts

@@ -1,5 +0,0 @@
-export function isHex(value: any) {
-  if (!value) return false
-  if (typeof value !== 'string') return false
-  return /^0x[0-9a-fA-F]*$/.test(value)
-}

package/src/utils/data/pad.bench.ts

@@ -1,30 +0,0 @@
-import { hexZeroPad, zeroPad } from 'ethers/lib/utils'
-
-import { bench, describe } from 'vitest'
-import Web3 from 'web3'
-
-import { padBytes, padHex } from './pad'
-
-describe('Pad Hex', () => {
-  bench('viem: `padHex`', () => {
-    padHex('0xa4e12a45')
-  })
-
-  bench('ethers: `hexZeroPad`', () => {
-    hexZeroPad('0xa4e12a45', 32)
-  })
-
-  bench('web3.js: `padLeft`', () => {
-    Web3.utils.padLeft('0xa4e12a45', 32)
-  })
-})
-
-describe('Pad Bytes', () => {
-  bench('viem: `padBytes`', () => {
-    padBytes(new Uint8Array([1, 122, 51, 123]))
-  })
-
-  bench('ethers: `zeroPad`', () => {
-    zeroPad(new Uint8Array([1, 122, 51, 123]), 32)
-  })
-})