viem 0.0.1-cjs.10 → 0.0.1-sushi.26

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

@@ -0,0 +1,291 @@
+import { expect, test } from 'vitest'
+
+import { formatAbiItemWithArgs } from './formatAbiItemWithArgs'
+
+test('default', () => {
+  expect(
+    formatAbiItemWithArgs({
+      abiItem: {
+        name: 'foo',
+        outputs: [],
+        stateMutability: 'nonpayable',
+        type: 'function',
+        inputs: [],
+      },
+      args: [],
+    }),
+  ).toEqual('foo()')
+
+  expect(
+    formatAbiItemWithArgs({
+      abiItem: {
+        name: 'foo',
+        outputs: [],
+        stateMutability: 'nonpayable',
+        type: 'function',
+        inputs: [
+          {
+            name: 'x',
+            type: 'uint256',
+          },
+          {
+            name: 'sender',
+            type: 'address',
+          },
+        ],
+      },
+      args: [1n, '0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC'],
+    }),
+  ).toEqual('foo(1, 0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC)')
+
+  expect(
+    formatAbiItemWithArgs({
+      abiItem: {
+        name: 'foo',
+        outputs: [],
+        stateMutability: 'nonpayable',
+        type: 'function',
+        inputs: [
+          {
+            name: 'x',
+            type: 'uint256',
+          },
+          {
+            name: 'sender',
+            type: 'address',
+          },
+        ],
+      },
+      args: [1n, '0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC'],
+      includeFunctionName: false,
+    }),
+  ).toEqual('(1, 0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC)')
+
+  expect(
+    formatAbiItemWithArgs({
+      abiItem: {
+        name: 'foo',
+        outputs: [],
+        stateMutability: 'nonpayable',
+        type: 'function',
+        inputs: [
+          {
+            type: 'uint256',
+          },
+          {
+            type: 'address',
+          },
+        ],
+      },
+      args: [1n, '0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC'],
+    }),
+  ).toEqual('foo(1, 0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC)')
+
+  expect(
+    formatAbiItemWithArgs({
+      abiItem: {
+        name: 'foo',
+        outputs: [],
+        stateMutability: 'nonpayable',
+        type: 'function',
+        inputs: [
+          {
+            components: [
+              {
+                internalType: 'uint256[]',
+                name: 'x',
+                type: 'uint256[]',
+              },
+              {
+                internalType: 'bool',
+                name: 'y',
+                type: 'bool',
+              },
+              {
+                internalType: 'string[]',
+                name: 'z',
+                type: 'string[]',
+              },
+            ],
+            internalType: 'struct ABIExample.Baz',
+            name: 'bar',
+            type: 'tuple',
+          },
+          {
+            internalType: 'uint256',
+            name: 'a',
+            type: 'uint256',
+          },
+          {
+            internalType: 'string[]',
+            name: 'b',
+            type: 'string[]',
+          },
+        ],
+      },
+      args: [
+        {
+          x: [1n, 2n, 3n, 4n],
+          y: true,
+          z: ['hello', 'world'],
+        },
+        420n,
+        ['wagmi', 'viem'],
+      ],
+    }),
+  ).toMatchInlineSnapshot(
+    '"foo({\\"x\\":[\\"1\\",\\"2\\",\\"3\\",\\"4\\"],\\"y\\":true,\\"z\\":[\\"hello\\",\\"world\\"]}, 420, [\\"wagmi\\",\\"viem\\"])"',
+  )
+
+  expect(
+    formatAbiItemWithArgs({
+      abiItem: {
+        name: 'foo',
+        outputs: [],
+        stateMutability: 'nonpayable',
+        type: 'function',
+        inputs: [
+          {
+            components: [
+              {
+                internalType: 'uint256[]',
+                name: 'x',
+                type: 'uint256[]',
+              },
+              {
+                internalType: 'bool',
+                name: 'y',
+                type: 'bool',
+              },
+              {
+                internalType: 'string[]',
+                name: 'z',
+                type: 'string[]',
+              },
+            ],
+            internalType: 'struct ABIExample.Baz',
+            name: 'bar',
+            type: 'tuple',
+          },
+          {
+            internalType: 'uint256',
+            name: 'a',
+            type: 'uint256',
+          },
+          {
+            internalType: 'string[]',
+            name: 'b',
+            type: 'string[]',
+          },
+        ],
+      },
+      args: [
+        {
+          x: [1n, 2n, 3n, 4n],
+          y: true,
+          z: ['hello', 'world'],
+        },
+        420n,
+        ['wagmi', 'viem'],
+      ],
+      includeFunctionName: false,
+    }),
+  ).toMatchInlineSnapshot(
+    '"({\\"x\\":[\\"1\\",\\"2\\",\\"3\\",\\"4\\"],\\"y\\":true,\\"z\\":[\\"hello\\",\\"world\\"]}, 420, [\\"wagmi\\",\\"viem\\"])"',
+  )
+
+  expect(
+    formatAbiItemWithArgs({
+      abiItem: {
+        name: 'foo',
+        outputs: [],
+        stateMutability: 'nonpayable',
+        type: 'function',
+        inputs: [
+          {
+            components: [
+              {
+                internalType: 'uint256[]',
+                name: 'x',
+                type: 'uint256[]',
+              },
+              {
+                internalType: 'bool',
+                name: 'y',
+                type: 'bool',
+              },
+              {
+                internalType: 'string[]',
+                name: 'z',
+                type: 'string[]',
+              },
+            ],
+            internalType: 'struct ABIExample.Baz',
+            name: 'bar',
+            type: 'tuple',
+          },
+          {
+            internalType: 'uint256',
+            name: 'a',
+            type: 'uint256',
+          },
+          {
+            internalType: 'string[]',
+            name: 'b',
+            type: 'string[]',
+          },
+        ],
+      },
+      args: [
+        {
+          x: [1n, 2n, 3n, 4n],
+          y: true,
+          z: ['hello', 'world'],
+        },
+        420n,
+        ['wagmi', 'viem'],
+      ],
+      includeName: true,
+    }),
+  ).toMatchInlineSnapshot(
+    '"foo(bar: {\\"x\\":[\\"1\\",\\"2\\",\\"3\\",\\"4\\"],\\"y\\":true,\\"z\\":[\\"hello\\",\\"world\\"]}, a: 420, b: [\\"wagmi\\",\\"viem\\"])"',
+  )
+
+  expect(
+    formatAbiItemWithArgs({
+      // @ts-expect-error
+      abiItem: {
+        outputs: [],
+        stateMutability: 'nonpayable',
+        type: 'function',
+        inputs: [],
+      },
+      args: [],
+    }),
+  ).toEqual(undefined)
+  expect(
+    formatAbiItemWithArgs({
+      // @ts-expect-error
+      abiItem: {
+        name: 'foo',
+        outputs: [],
+        stateMutability: 'nonpayable',
+        type: 'function',
+      },
+      args: [],
+    }),
+  ).toEqual(undefined)
+  expect(
+    formatAbiItemWithArgs({
+      abiItem: {
+        name: 'foo',
+        outputs: [],
+        stateMutability: 'nonpayable',
+        type: 'function',
+        // @ts-expect-error
+        inputs: undefined,
+      },
+      args: [],
+    }),
+  ).toEqual(undefined)
+})

package/src/utils/abi/formatAbiItemWithArgs.ts

@@ -0,0 +1,27 @@
+import { AbiParameter } from 'abitype'
+import { AbiItem } from '../../types'
+import { stringify } from '../../utils'
+
+export function formatAbiItemWithArgs({
+  abiItem,
+  args,
+  includeFunctionName = true,
+  includeName = false,
+}: {
+  abiItem: AbiItem
+  args: readonly unknown[]
+  includeFunctionName?: boolean
+  includeName?: boolean
+}) {
+  if (!('name' in abiItem)) return
+  if (!('inputs' in abiItem)) return
+  if (!abiItem.inputs) return
+  return `${includeFunctionName ? abiItem.name : ''}(${abiItem.inputs
+    .map(
+      (input: AbiParameter, i: number) =>
+        `${includeName && input.name ? `${input.name}: ` : ''}${
+          typeof args[i] === 'object' ? stringify(args[i]) : args[i]
+        }`,
+    )
+    .join(', ')})`
+}