ox/src/core/internal/human-readable/formatAbiParameters.test-d.ts

Ethereum Standard Library

import { expectTypeOf, test } from 'vp/test'

import type { AbiParameter } from 'abitype'

import type { FormatAbiParameters } from './formatAbiParameters.js'
import { formatAbiParameters } from './formatAbiParameters.js'

test('FormatAbiParameters', () => {
  // @ts-expect-error must have at least one parameter
  expectTypeOf<FormatAbiParameters<[]>>().toEqualTypeOf<never>()

  // string
  expectTypeOf<
    FormatAbiParameters<
      [
        {
          readonly type: 'address'
          readonly name: 'from'
        },
      ]
    >
  >().toEqualTypeOf<'address from'>()
  expectTypeOf<
    FormatAbiParameters<
      [
        {
          readonly type: 'address'
          readonly name: 'from'
          readonly indexed: true
        },
      ]
    >
  >().toEqualTypeOf<'address indexed from'>()

  // Array
  expectTypeOf<
    FormatAbiParameters<
      [
        {
          readonly type: 'tuple'
          readonly components: readonly [
            {
              readonly name: 'name'
              readonly type: 'string'
            },
          ]
        },
      ]
    >
  >().toEqualTypeOf<'(string name)'>()

  expectTypeOf<
    FormatAbiParameters<
      [
        {
          readonly type: 'tuple'
          readonly components: readonly [
            {
              readonly type: 'string'
              readonly name: 'bar'
            },
          ]
          readonly name: 'foo'
        },
      ]
    >
  >().toEqualTypeOf<'(string bar) foo'>()
})

test('formatAbiParameter', () => {
  expectTypeOf(
    formatAbiParameters([
      {
        type: 'tuple',
        components: [{ type: 'string' }],
      },
    ]),
  ).toEqualTypeOf<'(string)'>()

  const param = { type: 'address' }
  const param2: AbiParameter = param

  expectTypeOf(formatAbiParameters([param])).toEqualTypeOf<string>()

  expectTypeOf(
    formatAbiParameters([param, param]),
  ).toEqualTypeOf<`${string}, ${string}`>()

  expectTypeOf(
    formatAbiParameters([param2, param2]),
  ).toEqualTypeOf<`${string}, ${string}`>()
})