viem 0.0.1-alpha.19 → 0.0.1-alpha.20

package/src/utils/abi/{formatAbiItemWithParams.test.ts → formatAbiItem.test.ts}

@@ -1,11 +1,11 @@
 import { expect, test } from 'vitest'
 
-import { formatAbiItemWithParams } from './formatAbiItemWithParams'
+import { formatAbiItem } from './formatAbiItem'
 
 test('foo()', () => {
   expect(
     // @ts-expect-error
-    formatAbiItemWithParams({
+    formatAbiItem({
       name: 'foo',
       outputs: [],
       stateMutability: 'nonpayable',
@@ -13,7 +13,7 @@ test('foo()', () => {
     }),
   ).toEqual('foo()')
   expect(
-    formatAbiItemWithParams({
+    formatAbiItem({
       inputs: [],
       name: 'foo',
       outputs: [],
@@ -25,7 +25,7 @@ test('foo()', () => {
 
 test('foo(uint256)', () => {
   expect(
-    formatAbiItemWithParams({
+    formatAbiItem({
       inputs: [
         {
           internalType: 'uint256',
@@ -40,7 +40,7 @@ test('foo(uint256)', () => {
     }),
   ).toEqual('foo(uint256)')
   expect(
-    formatAbiItemWithParams(
+    formatAbiItem(
       {
         inputs: [
           {
@@ -61,7 +61,7 @@ test('foo(uint256)', () => {
 
 test('getVoter((uint256,bool,address,uint256),string[],bytes)', () => {
   expect(
-    formatAbiItemWithParams({
+    formatAbiItem({
       inputs: [
         {
           components: [
@@ -108,7 +108,7 @@ test('getVoter((uint256,bool,address,uint256),string[],bytes)', () => {
     }),
   ).toEqual('getVoter((uint256,bool,address,uint256),string[],bytes)')
   expect(
-    formatAbiItemWithParams(
+    formatAbiItem(
       {
         inputs: [
           {
@@ -163,7 +163,7 @@ test('getVoter((uint256,bool,address,uint256),string[],bytes)', () => {
 
 test('VoterEvent((uint256,bool,address,uint256),string[],bytes)', () => {
   expect(
-    formatAbiItemWithParams({
+    formatAbiItem({
       inputs: [
         {
           components: [
@@ -210,7 +210,7 @@ test('VoterEvent((uint256,bool,address,uint256),string[],bytes)', () => {
     }),
   ).toEqual('VoterEvent((uint256,bool,address,uint256),string[],bytes)')
   expect(
-    formatAbiItemWithParams(
+    formatAbiItem(
       {
         inputs: [
           {
@@ -265,7 +265,7 @@ test('VoterEvent((uint256,bool,address,uint256),string[],bytes)', () => {
 
 test('VoterError((uint256,bool,address,uint256),string[],bytes)', () => {
   expect(
-    formatAbiItemWithParams({
+    formatAbiItem({
       inputs: [
         {
           components: [
@@ -315,7 +315,7 @@ test('VoterError((uint256,bool,address,uint256),string[],bytes)', () => {
 
 test('error: invalid type', () => {
   expect(() =>
-    formatAbiItemWithParams({
+    formatAbiItem({
       inputs: [
         {
           internalType: 'bytes32[]',

package/src/utils/abi/{formatAbiItemWithParams.ts → formatAbiItem.ts}

@@ -3,7 +3,7 @@ import { AbiParameter } from 'abitype'
 import { InvalidDefinitionTypeError } from '../../errors'
 import { AbiItem } from '../../types'
 
-export function formatAbiItemWithParams(
+export function formatAbiItem(
   abiItem: AbiItem,
   { includeName = false }: { includeName?: boolean } = {},
 ) {

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

@@ -15,8 +15,8 @@ test('exports utils', () => {
       "encodeEventTopics": [Function],
       "encodeFunctionData": [Function],
       "encodeFunctionResult": [Function],
+      "formatAbiItem": [Function],
       "formatAbiItemWithArgs": [Function],
-      "formatAbiItemWithParams": [Function],
       "getAbiItem": [Function],
     }
   `)

package/src/utils/abi/index.ts

@@ -33,6 +33,6 @@ export { encodeFunctionResult } from './encodeFunctionResult'
 
 export { formatAbiItemWithArgs } from './formatAbiItemWithArgs'
 
-export { formatAbiItemWithParams } from './formatAbiItemWithParams'
+export { formatAbiItem } from './formatAbiItem'
 
 export { getAbiItem } from './getAbiItem'

package/src/utils/chain.test.ts

@@ -0,0 +1,43 @@
+import { describe, expect, test } from 'vitest'
+import { celo } from '../chains'
+import { defineChain } from './chain'
+
+describe('defineChain', () => {
+  test('default', () => {
+    expect(
+      defineChain({
+        id: 42220,
+        name: 'Celo',
+        network: 'celo',
+        nativeCurrency: { name: 'Celo', symbol: 'CELO', decimals: 18 },
+        rpcUrls: {
+          public: { http: ['https://rpc.ankr.com/celo'] },
+          default: { http: ['https://rpc.ankr.com/celo'] },
+        },
+      }),
+    ).toMatchInlineSnapshot(`
+      {
+        "id": 42220,
+        "name": "Celo",
+        "nativeCurrency": {
+          "decimals": 18,
+          "name": "Celo",
+          "symbol": "CELO",
+        },
+        "network": "celo",
+        "rpcUrls": {
+          "default": {
+            "http": [
+              "https://rpc.ankr.com/celo",
+            ],
+          },
+          "public": {
+            "http": [
+              "https://rpc.ankr.com/celo",
+            ],
+          },
+        },
+      }
+    `)
+  })
+})

package/src/utils/chain.ts

@@ -0,0 +1,8 @@
+import { Chain, Formatters } from '../types'
+
+export function defineChain<
+  TFormatters extends Formatters = Formatters,
+  TChain extends Chain<TFormatters> = Chain<TFormatters>,
+>(chain: TChain) {
+  return chain
+}

package/src/utils/contract/getContractError.ts

@@ -5,11 +5,7 @@ import {
   ContractMethodZeroDataError,
 } from '../../errors'
 import { Address } from '../../types'
-import {
-  formatAbiItemWithArgs,
-  formatAbiItemWithParams,
-  getAbiItem,
-} from '../abi'
+import { formatAbiItemWithArgs, formatAbiItem, getAbiItem } from '../abi'
 
 export function getContractError(
   err: unknown,
@@ -40,7 +36,7 @@ export function getContractError(
       })
     : undefined
   const functionWithParams = abiItem
-    ? formatAbiItemWithParams(abiItem, { includeName: true })
+    ? formatAbiItem(abiItem, { includeName: true })
     : undefined
 
   if (err instanceof AbiDecodingZeroDataError) {

package/src/utils/formatters/block.ts

@@ -1,6 +1,5 @@
-import type { Chain, Formatter, Formatters } from '../../chains'
-import type { Block, RpcBlock } from '../../types'
-import type { ExtractFormatter, Formatted } from './format'
+import type { Chain, Block, Formatter, Formatters, RpcBlock } from '../../types'
+import { defineFormatter, ExtractFormatter, Formatted } from './format'
 import { formatTransaction } from './transaction'
 
 export type BlockFormatter<TChain extends Chain = Chain> = ExtractFormatter<
@@ -34,3 +33,5 @@ export function formatBlock(block: Partial<RpcBlock>) {
       : null,
   } as Block
 }
+
+export const defineBlock = defineFormatter({ format: formatBlock })

package/src/utils/formatters/extract.ts

@@ -1,4 +1,4 @@
-import { Formatter } from '../../chains'
+import { Formatter } from '../../types'
 
 /**
  * @description Picks out the keys from `value` that exist in the formatter.

package/src/utils/formatters/format.ts

@@ -1,5 +1,4 @@
-import type { Chain, Formatter } from '../../chains'
-import type { OptionalNullable } from '../../types'
+import type { Chain, Formatter, OptionalNullable } from '../../types'
 
 export type ExtractFormatter<
   TChain extends Chain,
@@ -51,3 +50,41 @@ export function format<
 >(data: TSource, { formatter }: FormatOptions<TSource, TTarget>) {
   return formatter(data) as Formatted<TFormatter, TTarget>
 }
+
+export function defineFormatter<
+  TSource extends Record<string, unknown>,
+  TFormatted,
+>({
+  format,
+}: {
+  format: (data: TSource) => TFormatted
+}) {
+  return <
+      TFormat extends Formatter<
+        TSource,
+        Partial<TFormatted> & { [key: string]: unknown }
+      >,
+      TExclude extends (keyof TSource)[] = [],
+    >({
+      exclude,
+      format: formatOverride,
+    }: {
+      exclude?: TExclude
+      format?: TFormat
+    }) =>
+    (data: TSource & { [key: string]: unknown }) => {
+      const formatted = format(data)
+      if (exclude) {
+        for (const key of exclude) {
+          delete (formatted as any)[key]
+        }
+      }
+      return {
+        ...formatted,
+        ...formatOverride?.(data),
+      } as TFormatted &
+        ReturnType<TFormat> & {
+          [K in TExclude[number]]: never
+        }
+    }
+}

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

@@ -5,6 +5,11 @@ import * as formatters from './index'
 test('exports formatters', () => {
   expect(formatters).toMatchInlineSnapshot(`
     {
+      "defineBlock": [Function],
+      "defineFormatter": [Function],
+      "defineTransaction": [Function],
+      "defineTransactionReceipt": [Function],
+      "defineTransactionRequest": [Function],
       "extract": [Function],
       "format": [Function],
       "formatBlock": [Function],
@@ -12,6 +17,11 @@ test('exports formatters', () => {
       "formatTransaction": [Function],
       "formatTransactionReceipt": [Function],
       "formatTransactionRequest": [Function],
+      "transactionType": {
+        "0x0": "legacy",
+        "0x1": "eip2930",
+        "0x2": "eip1559",
+      },
     }
   `)
 })

package/src/utils/formatters/index.ts

@@ -1,24 +1,34 @@
 export type { BlockFormatter, FormattedBlock } from './block'
-export { formatBlock } from './block'
+export { defineBlock, formatBlock } from './block'
 
 export { extract } from './extract'
 
 export { formatFeeHistory } from './feeHistory'
 
 export type { ExtractFormatter, FormatOptions, Formatted } from './format'
-export { format } from './format'
+export { defineFormatter, format } from './format'
 
 export type { FormattedTransaction, TransactionFormatter } from './transaction'
-export { formatTransaction } from './transaction'
+export {
+  defineTransaction,
+  formatTransaction,
+  transactionType,
+} from './transaction'
 
 export type {
   FormattedTransactionReceipt,
   TransactionReceiptFormatter,
 } from './transactionReceipt'
-export { formatTransactionReceipt } from './transactionReceipt'
+export {
+  defineTransactionReceipt,
+  formatTransactionReceipt,
+} from './transactionReceipt'
 
 export type {
   FormattedTransactionRequest,
   TransactionRequestFormatter,
 } from './transactionRequest'
-export { formatTransactionRequest } from './transactionRequest'
+export {
+  defineTransactionRequest,
+  formatTransactionRequest,
+} from './transactionRequest'

package/src/utils/formatters/transaction.ts

@@ -1,8 +1,12 @@
-import type { Chain, Formatter, Formatters } from '../../chains'
-import type { RpcTransaction, Transaction } from '../../types'
-import { transactionType } from '../../constants'
+import type {
+  Chain,
+  Formatter,
+  Formatters,
+  RpcTransaction,
+  Transaction,
+} from '../../types'
 import { hexToNumber } from '../encoding'
-import type { ExtractFormatter, Formatted } from './format'
+import { defineFormatter, ExtractFormatter, Formatted } from './format'
 
 export type TransactionFormatter<TChain extends Chain = Chain> =
   ExtractFormatter<
@@ -15,6 +19,12 @@ export type FormattedTransaction<
   TFormatter extends Formatter | undefined = Formatter,
 > = Formatted<TFormatter, Transaction>
 
+export const transactionType = {
+  '0x0': 'legacy',
+  '0x1': 'eip2930',
+  '0x2': 'eip1559',
+} as const
+
 export function formatTransaction(transaction: Partial<RpcTransaction>) {
   const transaction_ = {
     ...transaction,
@@ -49,3 +59,5 @@ export function formatTransaction(transaction: Partial<RpcTransaction>) {
   }
   return transaction_ as Transaction
 }
+
+export const defineTransaction = defineFormatter({ format: formatTransaction })

package/src/utils/formatters/transactionReceipt.ts

@@ -1,9 +1,14 @@
-import type { Chain, Formatter, Formatters } from '../../chains'
-import { transactionType } from '../../constants'
-import type { RpcTransactionReceipt, TransactionReceipt } from '../../types'
+import type {
+  Chain,
+  Formatter,
+  Formatters,
+  RpcTransactionReceipt,
+  TransactionReceipt,
+} from '../../types'
 import { hexToNumber } from '../encoding'
-import type { ExtractFormatter, Formatted } from './format'
+import { defineFormatter, ExtractFormatter, Formatted } from './format'
 import { formatLog } from './log'
+import { transactionType } from './transaction'
 
 export type TransactionReceiptFormatter<TChain extends Chain = Chain> =
   ExtractFormatter<
@@ -52,3 +57,7 @@ export function formatTransactionReceipt(
       : null,
   } as TransactionReceipt
 }
+
+export const defineTransactionReceipt = defineFormatter({
+  format: formatTransactionReceipt,
+})

package/src/utils/formatters/transactionRequest.ts

@@ -1,6 +1,11 @@
-import type { Chain, Formatter, Formatters } from '../../chains'
-import type { RpcTransactionRequest, TransactionRequest } from '../../types'
-import type { ExtractFormatter, Formatted } from './format'
+import type {
+  Chain,
+  Formatter,
+  Formatters,
+  RpcTransactionRequest,
+  TransactionRequest,
+} from '../../types'
+import { defineFormatter, ExtractFormatter, Formatted } from './format'
 import { numberToHex } from '../encoding'
 
 export type TransactionRequestFormatter<TChain extends Chain = Chain> =
@@ -45,3 +50,7 @@ export function formatTransactionRequest(
         : undefined,
   } as RpcTransactionRequest
 }
+
+export const defineTransactionRequest = defineFormatter({
+  format: formatTransactionRequest,
+})

package/src/utils/hash/getEventSignature.ts

@@ -1,4 +1,4 @@
+import { EventDefinition } from '../../types'
 import { hashFunction } from './hashFunction'
 
-export const getEventSignature = (event: `${string}(${string})`) =>
-  hashFunction(event)
+export const getEventSignature = (event: EventDefinition) => hashFunction(event)

package/src/utils/index.test.ts

@@ -20,6 +20,12 @@ test('exports utils', () => {
       "decodeFunctionResult": [Function],
       "decodeHex": [Function],
       "decodeRlp": [Function],
+      "defineBlock": [Function],
+      "defineChain": [Function],
+      "defineFormatter": [Function],
+      "defineTransaction": [Function],
+      "defineTransactionReceipt": [Function],
+      "defineTransactionRequest": [Function],
       "encodeAbi": [Function],
       "encodeBytes": [Function],
       "encodeDeployData": [Function],
@@ -29,14 +35,18 @@ test('exports utils', () => {
       "encodeFunctionResult": [Function],
       "encodeHex": [Function],
       "encodeRlp": [Function],
+      "etherUnits": {
+        "gwei": 9,
+        "wei": 18,
+      },
       "extract": [Function],
       "extractFunctionName": [Function],
       "extractFunctionParams": [Function],
       "extractFunctionParts": [Function],
       "extractFunctionType": [Function],
       "format": [Function],
+      "formatAbiItem": [Function],
       "formatAbiItemWithArgs": [Function],
-      "formatAbiItemWithParams": [Function],
       "formatBlock": [Function],
       "formatEther": [Function],
       "formatGwei": [Function],
@@ -51,6 +61,10 @@ test('exports utils', () => {
       "getCreateAddress": [Function],
       "getEventSignature": [Function],
       "getFunctionSignature": [Function],
+      "gweiUnits": {
+        "ether": -9,
+        "wei": 9,
+      },
       "hexToBigInt": [Function],
       "hexToBool": [Function],
       "hexToBytes": [Function],
@@ -81,7 +95,16 @@ test('exports utils', () => {
       "stringToBytes": [Function],
       "stringToHex": [Function],
       "stringify": [Function],
+      "transactionType": {
+        "0x0": "legacy",
+        "0x1": "eip2930",
+        "0x2": "eip1559",
+      },
       "trim": [Function],
+      "weiUnits": {
+        "ether": -18,
+        "gwei": -9,
+      },
     }
   `)
 })

package/src/utils/index.ts

@@ -23,7 +23,7 @@ export {
   encodeFunctionData,
   encodeFunctionResult,
   formatAbiItemWithArgs,
-  formatAbiItemWithParams,
+  formatAbiItem,
   getAbiItem,
 } from './abi'
 
@@ -43,6 +43,8 @@ export {
 
 export { buildRequest } from './buildRequest'
 
+export { defineChain } from './chain'
+
 export {
   extractFunctionName,
   extractFunctionParams,
@@ -77,11 +79,17 @@ export type {
   TransactionRequestFormatter,
 } from './formatters'
 export {
+  defineBlock,
+  defineFormatter,
+  defineTransaction,
+  defineTransactionReceipt,
+  defineTransactionRequest,
   extract,
   format,
   formatBlock,
   formatTransaction,
   formatTransactionRequest,
+  transactionType,
 } from './formatters'
 
 export type { EncodeRlpResponse } from './encoding'
@@ -117,10 +125,13 @@ export { rpc } from './rpc'
 export { stringify } from './stringify'
 
 export {
+  etherUnits,
   formatEther,
   formatGwei,
   formatUnit,
+  gweiUnits,
   parseUnit,
   parseEther,
   parseGwei,
+  weiUnits,
 } from './unit'

package/src/{constants.test.ts → utils/unit/constants.test.ts}

@@ -13,11 +13,6 @@ test('exports constants', () => {
         "ether": -9,
         "wei": 9,
       },
-      "transactionType": {
-        "0x0": "legacy",
-        "0x1": "eip2930",
-        "0x2": "eip1559",
-      },
       "weiUnits": {
         "ether": -18,
         "gwei": -9,

package/src/{constants.ts → utils/unit/constants.ts}

@@ -10,9 +10,3 @@ export const weiUnits = {
   ether: -18,
   gwei: -9,
 }
-
-export const transactionType = {
-  '0x0': 'legacy',
-  '0x1': 'eip2930',
-  '0x2': 'eip1559',
-} as const

package/src/utils/unit/formatEther.ts

@@ -1,4 +1,4 @@
-import { etherUnits } from '../../constants'
+import { etherUnits } from '../../utils'
 import { formatUnit } from './formatUnit'
 
 export function formatEther(wei: bigint, unit: 'wei' | 'gwei' = 'wei') {

package/src/utils/unit/formatGwei.ts

@@ -1,4 +1,4 @@
-import { gweiUnits } from '../../constants'
+import { gweiUnits } from '../../utils'
 import { formatUnit } from './formatUnit'
 
 export function formatGwei(wei: bigint, unit: 'wei' = 'wei') {

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

@@ -5,12 +5,24 @@ import * as value from './index'
 test('exports value utils', () => {
   expect(value).toMatchInlineSnapshot(`
     {
+      "etherUnits": {
+        "gwei": 9,
+        "wei": 18,
+      },
       "formatEther": [Function],
       "formatGwei": [Function],
       "formatUnit": [Function],
+      "gweiUnits": {
+        "ether": -9,
+        "wei": 9,
+      },
       "parseEther": [Function],
       "parseGwei": [Function],
       "parseUnit": [Function],
+      "weiUnits": {
+        "ether": -18,
+        "gwei": -9,
+      },
     }
   `)
 })

package/src/utils/unit/index.ts

@@ -1,3 +1,4 @@
+export { etherUnits, gweiUnits, weiUnits } from './constants'
 export { formatEther } from './formatEther'
 export { formatGwei } from './formatGwei'
 export { formatUnit } from './formatUnit'

package/src/utils/unit/parseEther.ts

@@ -1,4 +1,4 @@
-import { etherUnits } from '../../constants'
+import { etherUnits } from '../../utils'
 import { parseUnit } from './parseUnit'
 
 export function parseEther(ether: `${number}`, unit: 'wei' | 'gwei' = 'wei') {

package/src/utils/unit/parseGwei.ts

@@ -1,4 +1,4 @@
-import { gweiUnits } from '../../constants'
+import { gweiUnits } from '../../utils'
 import { parseUnit } from './parseUnit'
 
 export function parseGwei(ether: `${number}`, unit: 'wei' = 'wei') {