viem 0.0.1-sushi.26 → 0.1.0

package/src/utils/abi/decodeEventLog.test.ts

@@ -1,542 +0,0 @@
-import { assertType, expect, test } from 'vitest'
-import { getAddress } from '../address'
-import { decodeEventLog } from './decodeEventLog'
-
-test('Transfer()', () => {
-  const event = decodeEventLog({
-    abi: [
-      {
-        inputs: [],
-        name: 'Transfer',
-        type: 'event',
-      },
-      {
-        inputs: [],
-        name: 'Approve',
-        type: 'event',
-      },
-    ],
-    topics: [
-      '0x406dade31f7ae4b5dbc276258c28dde5ae6d5c2773c5745802c493a2360e55e0',
-    ],
-  })
-  assertType<typeof event>({ eventName: 'Transfer' })
-  expect(event).toEqual({
-    eventName: 'Transfer',
-  })
-})
-
-test('no args: Transfer(address,address,uint256)', () => {
-  const event = decodeEventLog({
-    abi: [
-      {
-        inputs: [
-          {
-            indexed: true,
-            name: 'from',
-            type: 'address',
-          },
-          {
-            indexed: true,
-            name: 'to',
-            type: 'address',
-          },
-          {
-            indexed: false,
-            name: 'tokenId',
-            type: 'uint256',
-          },
-        ],
-        name: 'Transfer',
-        type: 'event',
-      },
-    ],
-    topics: [
-      '0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef',
-    ],
-  })
-  assertType<typeof event>({ eventName: 'Transfer' })
-  expect(event).toEqual({
-    eventName: 'Transfer',
-  })
-})
-
-test('named args: Transfer(address,address,uint256)', () => {
-  const event = decodeEventLog({
-    abi: [
-      {
-        inputs: [
-          {
-            indexed: true,
-            name: 'from',
-            type: 'address',
-          },
-          {
-            indexed: true,
-            name: 'to',
-            type: 'address',
-          },
-          {
-            indexed: false,
-            name: 'tokenId',
-            type: 'uint256',
-          },
-        ],
-        name: 'Transfer',
-        type: 'event',
-      },
-    ],
-    topics: [
-      '0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef',
-      '0x000000000000000000000000a5cc3c03994db5b0d9a5eedd10cabab0813678ac',
-    ],
-  })
-  assertType<typeof event>({ eventName: 'Transfer', args: { from: '0x' } })
-  expect(event).toEqual({
-    eventName: 'Transfer',
-    args: {
-      from: '0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC',
-    },
-  })
-})
-
-test('named args: Transfer(address,address,uint256)', () => {
-  const event = decodeEventLog({
-    abi: [
-      {
-        inputs: [
-          {
-            indexed: true,
-            name: 'from',
-            type: 'address',
-          },
-          {
-            indexed: true,
-            name: 'to',
-            type: 'address',
-          },
-          {
-            indexed: false,
-            name: 'tokenId',
-            type: 'uint256',
-          },
-        ],
-        name: 'Transfer',
-        type: 'event',
-      },
-    ],
-    topics: [
-      '0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef',
-      '0x000000000000000000000000a5cc3c03994db5b0d9a5eedd10cabab0813678ac',
-      [],
-    ],
-  })
-  assertType<typeof event>({
-    eventName: 'Transfer',
-    args: { from: '0x', to: [] },
-  })
-  expect(event).toEqual({
-    eventName: 'Transfer',
-    args: {
-      from: '0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC',
-      to: [],
-    },
-  })
-})
-
-test('named args: Transfer(address,address,uint256)', () => {
-  const event = decodeEventLog({
-    abi: [
-      {
-        inputs: [
-          {
-            indexed: true,
-            name: 'from',
-            type: 'address',
-          },
-          {
-            indexed: true,
-            name: 'to',
-            type: 'address',
-          },
-          {
-            indexed: false,
-            name: 'tokenId',
-            type: 'uint256',
-          },
-        ],
-        name: 'Transfer',
-        type: 'event',
-      },
-    ],
-    topics: [
-      '0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef',
-      null,
-      '0x000000000000000000000000a5cc3c03994db5b0d9a5eedd10cabab0813678ac',
-    ],
-  })
-  assertType<typeof event>({
-    eventName: 'Transfer',
-    args: { from: null, to: '0x' },
-  })
-  expect(event).toEqual({
-    eventName: 'Transfer',
-    args: {
-      from: null,
-      to: '0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC',
-    },
-  })
-})
-
-test('named args: Transfer(address,address,uint256)', () => {
-  const event = decodeEventLog({
-    abi: [
-      {
-        inputs: [
-          {
-            indexed: true,
-            name: 'from',
-            type: 'address',
-          },
-          {
-            indexed: true,
-            name: 'to',
-            type: 'address',
-          },
-          {
-            indexed: false,
-            name: 'tokenId',
-            type: 'uint256',
-          },
-        ],
-        name: 'Transfer',
-        type: 'event',
-      },
-    ],
-    topics: [
-      '0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef',
-      null,
-      [
-        '0x000000000000000000000000a5cc3c03994db5b0d9a5eedd10cabab0813678ac',
-        '0x000000000000000000000000c961145a54c96e3ae9baa048c4f4d6b04c13916b',
-      ],
-    ],
-  })
-  assertType<typeof event>({
-    eventName: 'Transfer',
-    args: { from: null, to: ['0x', '0x'] },
-  })
-  expect(event).toEqual({
-    args: {
-      from: null,
-      to: [
-        '0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC',
-        '0xc961145a54C96E3aE9bAA048c4F4D6b04C13916b',
-      ],
-    },
-    eventName: 'Transfer',
-  })
-})
-
-test('unnamed args: Transfer(address,address,uint256)', () => {
-  const event = decodeEventLog({
-    abi: [
-      {
-        inputs: [
-          {
-            indexed: true,
-            type: 'address',
-          },
-          {
-            indexed: true,
-            type: 'address',
-          },
-          {
-            indexed: false,
-            type: 'uint256',
-          },
-        ],
-        name: 'Transfer',
-        type: 'event',
-      },
-    ],
-    topics: [
-      '0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef',
-      null,
-      '0x000000000000000000000000a5cc3c03994db5b0d9a5eedd10cabab0813678ac',
-    ],
-  })
-  assertType<typeof event>({ eventName: 'Transfer', args: [null, '0x'] })
-  expect(event).toEqual({
-    args: [null, '0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC'],
-    eventName: 'Transfer',
-  })
-})
-
-test('unnamed args: Transfer(address,address,uint256)', () => {
-  const event = decodeEventLog({
-    abi: [
-      {
-        inputs: [
-          {
-            indexed: true,
-            type: 'address',
-          },
-          {
-            indexed: true,
-            type: 'address',
-          },
-          {
-            indexed: false,
-            type: 'uint256',
-          },
-        ],
-        name: 'Transfer',
-        type: 'event',
-      },
-    ],
-    topics: [
-      '0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef',
-      null,
-      [
-        '0x000000000000000000000000a5cc3c03994db5b0d9a5eedd10cabab0813678ac',
-        '0x000000000000000000000000c961145a54c96e3ae9baa048c4f4d6b04c13916b',
-      ],
-    ],
-  })
-  assertType<typeof event>({
-    eventName: 'Transfer',
-    args: [null, ['0x', '0x']],
-  })
-  expect(event).toEqual({
-    args: [
-      null,
-      [
-        '0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC',
-        '0xc961145a54C96E3aE9bAA048c4F4D6b04C13916b',
-      ],
-    ],
-    eventName: 'Transfer',
-  })
-})
-
-test('Foo(string)', () => {
-  const event = decodeEventLog({
-    abi: [
-      {
-        inputs: [
-          {
-            indexed: true,
-            name: 'message',
-            type: 'string',
-          },
-        ],
-        name: 'Foo',
-        type: 'event',
-      },
-    ],
-    topics: [
-      '0x9f0b7f1630bdb7d474466e2dfef0fb9dff65f7a50eec83935b68f77d0808f08a',
-      '0x1c8aff950685c2ed4bc3174f3472287b56d9517b9c948127319a09a7a36deac8',
-    ],
-  })
-  assertType<typeof event>({
-    eventName: 'Foo',
-    args: {
-      message:
-        '0x1c8aff950685c2ed4bc3174f3472287b56d9517b9c948127319a09a7a36deac8',
-    },
-  })
-  expect(event).toEqual({
-    args: {
-      message:
-        '0x1c8aff950685c2ed4bc3174f3472287b56d9517b9c948127319a09a7a36deac8',
-    },
-    eventName: 'Foo',
-  })
-})
-
-test('args: eventName', () => {
-  const event = decodeEventLog({
-    abi: [
-      {
-        inputs: [
-          {
-            indexed: true,
-            type: 'address',
-          },
-          {
-            indexed: true,
-            type: 'address',
-          },
-          {
-            indexed: false,
-            type: 'uint256',
-          },
-        ],
-        name: 'Transfer',
-        type: 'event',
-      },
-      {
-        inputs: [
-          {
-            indexed: true,
-            name: 'message',
-            type: 'string',
-          },
-        ],
-        name: 'Foo',
-        type: 'event',
-      },
-    ],
-    eventName: 'Foo',
-    topics: [
-      '0x9f0b7f1630bdb7d474466e2dfef0fb9dff65f7a50eec83935b68f77d0808f08a',
-      '0x1c8aff950685c2ed4bc3174f3472287b56d9517b9c948127319a09a7a36deac8',
-    ],
-  })
-  assertType<typeof event>({
-    eventName: 'Foo',
-    args: {
-      message:
-        '0x1c8aff950685c2ed4bc3174f3472287b56d9517b9c948127319a09a7a36deac8',
-    },
-  })
-  expect(event).toEqual({
-    args: {
-      message:
-        '0x1c8aff950685c2ed4bc3174f3472287b56d9517b9c948127319a09a7a36deac8',
-    },
-    eventName: 'Foo',
-  })
-})
-
-test('args: data', () => {
-  const event = decodeEventLog({
-    abi: [
-      {
-        inputs: [
-          {
-            indexed: true,
-            name: 'from',
-            type: 'address',
-          },
-          {
-            indexed: true,
-            name: 'to',
-            type: 'address',
-          },
-          {
-            indexed: false,
-            name: 'tokenId',
-            type: 'uint256',
-          },
-        ],
-        name: 'Transfer',
-        type: 'event',
-      },
-    ],
-    data: '0x0000000000000000000000000000000000000000000000000000000000000001',
-    eventName: 'Transfer',
-    topics: [
-      '0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef',
-      '0x000000000000000000000000d8da6bf26964af9d7eed9e03e53415d37aa96045',
-      '0x000000000000000000000000f39fd6e51aad88f6f4ce6ab8827279cfffb92266',
-    ],
-  })
-  assertType<typeof event>({
-    eventName: 'Transfer',
-    args: {
-      from: '0xd8da6bf26964af9d7eed9e03e53415d37aa96045',
-      to: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
-      tokenId: 1n,
-    },
-  })
-  expect(event).toEqual({
-    eventName: 'Transfer',
-    args: {
-      from: getAddress('0xd8da6bf26964af9d7eed9e03e53415d37aa96045'),
-      to: getAddress('0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266'),
-      tokenId: 1n,
-    },
-  })
-})
-
-test('args: data', () => {
-  const event = decodeEventLog({
-    abi: [
-      {
-        inputs: [
-          {
-            indexed: true,
-            type: 'address',
-          },
-          {
-            indexed: true,
-            type: 'address',
-          },
-          {
-            indexed: false,
-            type: 'uint256',
-          },
-        ],
-        name: 'Transfer',
-        type: 'event',
-      },
-    ],
-    data: '0x0000000000000000000000000000000000000000000000000000000000000001',
-    eventName: 'Transfer',
-    topics: [
-      '0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef',
-      '0x000000000000000000000000d8da6bf26964af9d7eed9e03e53415d37aa96045',
-      '0x000000000000000000000000f39fd6e51aad88f6f4ce6ab8827279cfffb92266',
-    ],
-  })
-  assertType<typeof event>({
-    eventName: 'Transfer',
-    args: [
-      '0xd8da6bf26964af9d7eed9e03e53415d37aa96045',
-      '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
-      1n,
-    ],
-  })
-  expect(event).toEqual({
-    eventName: 'Transfer',
-    args: [
-      getAddress('0xd8da6bf26964af9d7eed9e03e53415d37aa96045'),
-      getAddress('0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266'),
-      1n,
-    ],
-  })
-})
-
-test("errors: event doesn't exist", () => {
-  expect(() =>
-    decodeEventLog({
-      abi: [
-        {
-          inputs: [
-            {
-              indexed: true,
-              name: 'message',
-              type: 'string',
-            },
-          ],
-          name: 'Bar',
-          type: 'event',
-        },
-      ],
-      topics: [
-        '0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef',
-        '0x1c8aff950685c2ed4bc3174f3472287b56d9517b9c948127319a09a7a36deac8',
-      ],
-    }),
-  ).toThrowErrorMatchingInlineSnapshot(`
-    "Encoded event signature \\"0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef\\" 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=0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef.
-
-    Docs: https://viem.sh/docs/contract/decodeEventLog
-    Version: viem@1.0.2"
-  `)
-})

package/src/utils/abi/decodeEventLog.ts

@@ -1,107 +0,0 @@
-import { Abi, AbiParameter, Narrow } from 'abitype'
-import { AbiEventSignatureNotFoundError } from '../../errors'
-import {
-  EventDefinition,
-  ExtractEventArgsFromTopics,
-  ExtractEventNameFromAbi,
-  Hex,
-  LogTopic,
-} from '../../types'
-import { getEventSignature } from '../hash'
-import { decodeAbi } from './decodeAbi'
-import { formatAbiItem } from './formatAbiItem'
-
-export type DecodeEventLogArgs<
-  TAbi extends Abi | readonly unknown[] = Abi,
-  TEventName extends string = string,
-  TTopics extends LogTopic[] = LogTopic[],
-  TData extends Hex | undefined = undefined,
-> = {
-  abi: Narrow<TAbi>
-  data?: TData
-  eventName?: ExtractEventNameFromAbi<TAbi, TEventName>
-  topics: [signature: Hex, ...args: TTopics]
-}
-
-export type DecodeEventLogResponse<
-  TAbi extends Abi | readonly unknown[] = Abi,
-  TEventName extends string = string,
-  TTopics extends LogTopic[] = LogTopic[],
-  TData extends Hex | undefined = undefined,
-> = {
-  eventName: TEventName
-} & ExtractEventArgsFromTopics<TAbi, TEventName, TTopics, TData>
-
-export function decodeEventLog<
-  TAbi extends Abi | readonly unknown[],
-  TEventName extends string,
-  TTopics extends LogTopic[],
-  TData extends Hex | undefined = undefined,
->({
-  abi,
-  data,
-  topics,
-}: DecodeEventLogArgs<
-  TAbi,
-  TEventName,
-  TTopics,
-  TData
->): DecodeEventLogResponse<TAbi, TEventName, TTopics, TData> {
-  const [signature, ...argTopics] = topics
-  const abiItem = (abi as Abi).find(
-    (x) => signature === getEventSignature(formatAbiItem(x) as EventDefinition),
-  )
-  if (!(abiItem && 'name' in abiItem))
-    throw new AbiEventSignatureNotFoundError(signature, {
-      docsPath: '/docs/contract/decodeEventLog',
-    })
-
-  const { name, inputs } = abiItem
-  const isUnnamed = inputs?.some((x) => !('name' in x && x.name))
-
-  let args: any = isUnnamed ? [] : {}
-
-  // Decode topics (indexed args).
-  for (let i = 0; i < inputs.length; i++) {
-    const param = inputs[i]
-    const topic = argTopics[i]
-    if (topic === null) args[param.name || i] = null
-    if (!topic) continue
-    if (Array.isArray(topic)) {
-      args[param.name || i] = topic.map((t) => decodeTopic({ param, value: t }))
-    } else {
-      args[param.name || i] = decodeTopic({ param, value: topic })
-    }
-  }
-
-  // Decode data (non-indexed args).
-  if (data) {
-    const params = inputs.filter((x) => !('indexed' in x && x.indexed))
-    const decodedData = decodeAbi({ params, data })
-    if (decodedData) {
-      if (isUnnamed) args = [...args, ...decodedData]
-      else {
-        for (let i = 0; i < params.length; i++) {
-          args[params[i].name!] = decodedData[i]
-        }
-      }
-    }
-  }
-
-  return {
-    eventName: name,
-    args: Object.values(args).length > 0 ? args : undefined,
-  } as unknown as DecodeEventLogResponse<TAbi, TEventName, TTopics, TData>
-}
-
-function decodeTopic({ param, value }: { param: AbiParameter; value: Hex }) {
-  if (
-    param.type === 'string' ||
-    param.type === 'bytes' ||
-    param.type === 'tuple' ||
-    param.type.match(/^(.*)\[(\d+)?\]$/)
-  )
-    return value
-  const decodedArg = decodeAbi({ params: [param], data: value }) || []
-  return decodedArg[0]
-}