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

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

@@ -2,96 +2,281 @@ import { describe, expect, test } from 'vitest'
 
 import { accounts } from '../../_test'
 import { baycContractConfig } from '../../_test/abis'
-import { BaseError } from '../../errors'
+import {
+  AbiDecodingZeroDataError,
+  BaseError,
+  RawContractError,
+} from '../../errors'
 import { getContractError } from './getContractError'
 
 describe('getContractError', () => {
   test('default', () => {
-    expect(
-      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,
-        },
-      ),
-    ).toMatchInlineSnapshot(`
-      [ContractMethodExecutionError: Sale must be active to mint Ape
-       
+    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
 
-      Details: execution reverted: Sale must be active to mint Ape
       Version: viem@1.0.2]
     `)
   })
 
-  test('default', () => {
-    expect(
-      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: 'foo',
-          args: [1n],
-          sender: accounts[0].address,
-        },
-      ),
-    ).toMatchInlineSnapshot(`
-      [ContractMethodExecutionError: Sale must be active to mint Ape
-       
+  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
 
-      Details: execution reverted: Sale must be active to mint Ape
+      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('unknown error', () => {
-    expect(
-      getContractError(
-        new BaseError('An RPC error occurred', {
-          cause: new Error('rarararar i am an error lmaoaoo'),
-        }),
-        {
-          abi: baycContractConfig.abi,
-          functionName: 'foo',
-          args: [1n],
-          sender: accounts[0].address,
-        },
-      ),
-    ).toMatchInlineSnapshot(`
-      [ViemError: An RPC error occurred
+  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
 
-      Details: rarararar i am an error lmaoaoo
       Version: viem@1.0.2]
     `)
-    expect(
-      getContractError(new BaseError('An RPC error occurred'), {
+  })
+
+  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: 'foo',
+        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'),
       }),
-    ).toMatchInlineSnapshot(`
+      {
+        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,66 +1,58 @@
 import { Abi } from 'abitype'
 import {
   AbiDecodingZeroDataError,
-  ContractMethodExecutionError,
-  ContractMethodZeroDataError,
+  BaseError,
+  ContractFunctionExecutionError,
+  RawContractError,
 } from '../../errors'
+import {
+  ContractFunctionRevertedError,
+  ContractFunctionZeroDataError,
+} from '../../errors/contract'
 import { Address } from '../../types'
-import { formatAbiItemWithArgs, formatAbiItem, getAbiItem } from '../abi'
+
+const EXECUTION_REVERTED_ERROR_CODE = 3
 
 export function getContractError(
-  err: unknown,
+  err: BaseError,
   {
     abi,
     address,
     args,
+    docsPath,
     functionName,
     sender,
   }: {
     abi: Abi
     args: any
     address?: Address
+    docsPath?: string
     functionName: string
     sender?: Address
   },
 ) {
-  const { code, message } =
-    ((err as Error).cause as { code?: number; message?: string }) || {}
-
-  const abiItem = getAbiItem({ abi, name: functionName })
-  const formattedArgs = abiItem
-    ? formatAbiItemWithArgs({
-        abiItem,
-        args,
-        includeFunctionName: false,
-        includeName: false,
-      })
-    : undefined
-  const functionWithParams = abiItem
-    ? formatAbiItem(abiItem, { includeName: true })
-    : undefined
+  const { code, data, message } = (
+    err instanceof RawContractError ? err : err.cause || {}
+  ) as RawContractError
 
+  let cause = err
   if (err instanceof AbiDecodingZeroDataError) {
-    return new ContractMethodZeroDataError({
-      abi,
-      args,
-      cause: err as Error,
-      contractAddress: address,
-      functionName,
-      functionWithParams,
-    })
-  }
-  if (code === 3 || message?.includes('execution reverted')) {
-    const message_ = message?.replace('execution reverted: ', '')
-    return new ContractMethodExecutionError(message_, {
+    cause = new ContractFunctionZeroDataError({ functionName })
+  } else if (code === EXECUTION_REVERTED_ERROR_CODE && (data || message)) {
+    cause = new ContractFunctionRevertedError({
       abi,
-      args,
-      cause: err as Error,
-      contractAddress: address,
-      formattedArgs,
+      data,
       functionName,
-      functionWithParams,
-      sender,
+      message,
     })
   }
-  return err
+
+  return new ContractFunctionExecutionError(cause, {
+    abi,
+    args,
+    contractAddress: address,
+    docsPath,
+    functionName,
+    sender,
+  })
 }

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

@@ -1,5 +1,4 @@
 import { hexZeroPad, zeroPad } from 'ethers/lib/utils'
-import { hexZeroPad as hexZeroPad2, zeroPad as zeroPad2 } from 'essential-eth'
 
 import { bench, describe } from 'vitest'
 import Web3 from 'web3'
@@ -18,10 +17,6 @@ describe('Pad Hex', () => {
   bench('web3.js: `padLeft`', () => {
     Web3.utils.padLeft('0xa4e12a45', 32)
   })
-
-  bench('essential-eth: `hexZeroPad`', () => {
-    hexZeroPad2('0xa4e12a45', 32)
-  })
 })
 
 describe('Pad Bytes', () => {
@@ -32,8 +27,4 @@ describe('Pad Bytes', () => {
   bench('ethers: `zeroPad`', () => {
     zeroPad(new Uint8Array([1, 122, 51, 123]), 32)
   })
-
-  bench('essential-eth: `zeroPad`', () => {
-    zeroPad2(new Uint8Array([1, 122, 51, 123]), 32)
-  })
 })

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

@@ -1,8 +1,4 @@
 import { hexStripZeros, stripZeros } from 'ethers/lib/utils'
-import {
-  hexStripZeros as hexStripZeros2,
-  stripZeros as stripZeros2,
-} from 'essential-eth'
 
 import { bench, describe } from 'vitest'
 
@@ -16,10 +12,6 @@ describe('Trim Hex', () => {
   bench('ethers: `hexStripZeros`', () => {
     hexStripZeros('0x00000000000000000000000a4e12a45')
   })
-
-  bench('essential-eth: `hexStripZeros`', () => {
-    hexStripZeros2('0x00000000000000000000000a4e12a45')
-  })
 })
 
 describe('Trim Bytes', () => {
@@ -39,12 +31,4 @@ describe('Trim Bytes', () => {
       ]),
     )
   })
-
-  bench('essential-eth: `stripZeros`', () => {
-    stripZeros2(
-      new Uint8Array([
-        0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 122, 51, 123,
-      ]),
-    )
-  })
 })

package/src/utils/encoding/encodeBytes.bench.ts

@@ -1,8 +1,4 @@
 import { arrayify, toUtf8Bytes } from 'ethers/lib/utils'
-import {
-  arrayify as arrayify2,
-  toUtf8Bytes as toUtf8Bytes2,
-} from 'essential-eth'
 import { bench, describe } from 'vitest'
 import Web3 from 'web3'
 
@@ -20,10 +16,6 @@ describe('Hex to Bytes', () => {
   bench('web3.js: `hexToBytes`', () => {
     Web3.utils.hexToBytes('0x48656c6c6f20576f726c6421')
   })
-
-  bench('essential-eth: `arrayify`', () => {
-    arrayify2('0x48656c6c6f20576f726c6421')
-  })
 })
 
 describe('String to Bytes', () => {
@@ -34,8 +26,4 @@ describe('String to Bytes', () => {
   bench('ethers: `toUtf8Bytes`', () => {
     toUtf8Bytes('Hello world')
   })
-
-  bench('essential-eth: `toUtf8Bytes`', () => {
-    toUtf8Bytes2('Hello world')
-  })
 })

package/src/utils/encoding/encodeHex.bench.ts

@@ -1,5 +1,4 @@
 import { hexlify } from 'ethers/lib/utils'
-import { hexlify as hexlify2 } from 'essential-eth'
 import { bench, describe } from 'vitest'
 import Web3 from 'web3'
 
@@ -17,10 +16,6 @@ describe('Number to Hex', () => {
   bench('web3.js: `numberToHex`', () => {
     Web3.utils.numberToHex(52)
   })
-
-  bench('essential-eth: `hexlify`', () => {
-    hexlify2(52)
-  })
 })
 
 describe('String to Hex', () => {
@@ -51,10 +46,4 @@ describe('Bytes to Hex', () => {
       72, 101, 108, 108, 111, 32, 87, 111, 114, 108, 100, 33,
     ])
   })
-
-  bench('essential-eth: `hexlify`', () => {
-    hexlify2(
-      new Uint8Array([72, 101, 108, 108, 111, 32, 87, 111, 114, 108, 100, 33]),
-    )
-  })
 })

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

@@ -0,0 +1,13 @@
+import { expect, test } from 'vitest'
+
+import * as utils from './index'
+
+test('exports utils', () => {
+  expect(utils).toMatchInlineSnapshot(`
+    {
+      "labelhash": [Function],
+      "namehash": [Function],
+      "normalize": [Function],
+    }
+  `)
+})

package/src/utils/ens/index.ts

@@ -0,0 +1,5 @@
+export { labelhash } from './labelhash'
+
+export { namehash } from './namehash'
+
+export { normalize } from './normalize'

package/src/utils/ens/labelhash.test.ts

@@ -0,0 +1,55 @@
+import { test, expect } from 'vitest'
+
+import { labelhash } from './labelhash'
+
+test.each([
+  {
+    label: '',
+    expected:
+      '0x0000000000000000000000000000000000000000000000000000000000000000',
+  },
+  {
+    label: 'eth',
+    expected:
+      '0x4f5b812789fc606be1b3b16908db13fc7a9adf7ca72641f84d75b47069d3d7f0',
+  },
+  {
+    label: 'awkweb',
+    expected:
+      '0x7aaad03ddcacc63166440f59c14a1a2c97ee381014b59c58f55b49ab05f31a38',
+  },
+  {
+    label: 'awkw𝝣b',
+    expected:
+      '0x064cfb20fc5f10bd727bd17232b9b0c8021cec89e596b1c966ff1c611420c72f',
+  },
+  {
+    label: '\u{0061}wkweb',
+    expected:
+      '0x7aaad03ddcacc63166440f59c14a1a2c97ee381014b59c58f55b49ab05f31a38',
+  },
+  {
+    label: '\u{0061}wkw\u{0065}b',
+    expected:
+      '0x7aaad03ddcacc63166440f59c14a1a2c97ee381014b59c58f55b49ab05f31a38',
+  },
+  {
+    label: 'awkweb',
+    //     ^ latin small "a"
+    expected:
+      '0x7aaad03ddcacc63166440f59c14a1a2c97ee381014b59c58f55b49ab05f31a38',
+  },
+  {
+    label: 'awkweb',
+    //         ^ latin small "e"
+    expected:
+      '0x7aaad03ddcacc63166440f59c14a1a2c97ee381014b59c58f55b49ab05f31a38',
+  },
+  {
+    label: 'ʘ‿ʘ',
+    expected:
+      '0xc142daa955184f4c4992e064a059bd8950e0bff10db566df9068ae2d5379e652',
+  },
+])("labelhash('$label') -> '$expected'", ({ label, expected }) => {
+  expect(labelhash(label)).toBe(expected)
+})

package/src/utils/ens/labelhash.ts

@@ -0,0 +1,16 @@
+import { bytesToHex, stringToBytes } from '../encoding'
+import { keccak256 } from '../hash'
+import { normalize } from './normalize'
+
+/**
+ * @description Hashes ENS label
+ *
+ * @example
+ * labelhash('eth')
+ * '0x4f5b812789fc606be1b3b16908db13fc7a9adf7ca72641f84d75b47069d3d7f0'
+ */
+export function labelhash(label: string) {
+  let result = new Uint8Array(32).fill(0)
+  if (!label) return bytesToHex(result)
+  return keccak256(stringToBytes(normalize(label)))
+}