@0xtorch/evm 0.0.51 → 0.0.53

package/explorers/externals/etherscan/getEventLogsByAddressAndTopics.ts

@@ -0,0 +1,111 @@
+import type { Logger } from '@0xtorch/core'
+import { z } from 'zod'
+import type { Hex } from '../../../types'
+import { isHex, toLowerHex } from '../../../types'
+import { createEtherscanClient } from './middleware'
+
+type GetEventLogsByAddressAndTopicsParameters = {
+  readonly apiEndpoint: string
+  readonly apiKey: string
+  readonly address: Hex
+  readonly topic0: Hex
+  readonly fromBlock?: bigint
+  readonly toBlock?: bigint
+  readonly page?: number
+  readonly logger?: Logger
+}
+
+const logSchema = z.object({
+  address: z
+    .string()
+    .regex(/^0x[\da-f]{40}$/)
+    .transform((x) => (isHex(x) ? toLowerHex(x) : '0x')),
+  topics: z.array(
+    z
+      .string()
+      .regex(/^0x[\da-f]{64}$/)
+      .transform((x) => (isHex(x) ? x : '0x')),
+  ),
+  data: z
+    .string()
+    .regex(/^0x[\da-f]*$/)
+    .transform((x) => (isHex(x) ? x : '0x')),
+  blockNumber: z
+    .string()
+    .regex(/^0x[\da-f]*$/)
+    .transform(BigInt),
+  logIndex: z
+    .string()
+    .regex(/^0x[\da-f]*$/)
+    .transform(BigInt),
+  transactionHash: z
+    .string()
+    .regex(/^0x[\da-f]{64}$/)
+    .transform((x) => (isHex(x) ? x : '0x')),
+})
+
+const responseSchema = z.object({
+  status: z.string(),
+  message: z.string(),
+  result: z.union([z.array(logSchema), z.string()]).nullable(),
+})
+
+type Log = Readonly<z.infer<typeof logSchema>>
+type ReturnType = readonly Log[]
+
+/** {@link https://docs.etherscan.io/api-endpoints/logs#get-event-logs-by-address-filtered-by-topics} */
+export const getEventLogsByAddressAndTopics = async ({
+  apiEndpoint,
+  apiKey,
+  address,
+  topic0,
+  fromBlock,
+  toBlock,
+  page,
+  logger,
+}: GetEventLogsByAddressAndTopicsParameters): Promise<ReturnType> => {
+  try {
+    const { status, message, result } = await createEtherscanClient(
+      apiEndpoint,
+      apiKey,
+    ).get(
+      '',
+      {
+        module: 'logs',
+        action: 'getLogs',
+        address,
+        topic0,
+        ...(fromBlock === undefined ? {} : { fromBlock: fromBlock.toString() }),
+        ...(toBlock === undefined ? {} : { toBlock: toBlock.toString() }),
+        ...(page === undefined ? {} : { page: page.toString() }),
+        offset: '1000',
+      },
+      responseSchema,
+      logger,
+    )
+    if (status !== '1' || result === null) {
+      const error =
+        typeof result === 'string' ? new Error(result) : new Error(message)
+      throw error
+    }
+    if (typeof result === 'string') {
+      throw new TypeError(result)
+    }
+    return result
+  } catch (error) {
+    if (error instanceof Error && error.message === 'Max rate limit reached') {
+      await new Promise((resolve) => setTimeout(resolve, 1000))
+      return await getEventLogsByAddressAndTopics({
+        apiEndpoint,
+        apiKey,
+        address,
+        topic0,
+        fromBlock,
+        toBlock,
+        page,
+        logger,
+      })
+    }
+    throw error
+  }
+}

package/explorers/externals/etherscan/index.ts

@@ -4,6 +4,7 @@ export { getContractCreations } from './getContractCreations'
 export { getErc1155TokenTransfersByAddress } from './getErc1155TokenTransfersByAddress'
 export { getErc20TokenTransfersByAddress } from './getErc20TokenTransfersByAddress'
 export { getErc721TokenTransfersByAddress } from './getErc721TokenTransfersByAddress'
+export { getEventLogsByAddressAndTopics } from './getEventLogsByAddressAndTopics'
 export { getInternalTransactionsByAddress } from './getInternalTransactionsByAddress'
 export { getInternalTransactionsByTransactionHash } from './getInternalTransactionsByTransactionHash'
 export { getNormalTransactionsByAddress } from './getNormalTransactionsByAddress'

package/explorers/types.ts

@@ -1,5 +1,5 @@
 import type { CryptoCurrency, Logger } from '@0xtorch/core'
-import type { Hex, InternalTransaction } from '../types'
+import type { Hex, InternalTransaction, LowerHex } from '../types'
 
 export type Explorer = {
   readonly name: string
@@ -17,6 +17,7 @@ export type Explorer = {
   ) => Promise<bigint>
   readonly getContract: FunctionGetContract
   readonly getContractCreations: FunctionGetContractCreations
+  readonly getEventLogs: FunctionGetEventLogs
   readonly getInternalTransactionOfTransaction: FunctionGetInternalTransactionOfTransaction
 }
 
@@ -92,9 +93,24 @@ type FunctionGetContractCreations = (
   logger?: Logger,
 ) => Promise<
   readonly {
-    readonly contractAddress: Hex
-    readonly contractCreator: Hex
-    readonly txHash: Hex
+    readonly contractAddress: LowerHex
+    readonly contractCreator: LowerHex | undefined
+    readonly txHash: Hex | undefined
+  }[]
+>
+
+type FunctionGetEventLogs = (parameters: {
+  readonly address: Hex
+  readonly topic0: Hex
+  readonly fromBlock?: bigint
+  readonly toBlock?: bigint
+  readonly logger?: Logger
+}) => Promise<
+  readonly {
+    blockNumber: bigint
+    transactionHash: Hex
+    data: Hex
+    topics: readonly Hex[]
   }[]
 >
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@0xtorch/evm",
-  "version": "0.0.51",
+  "version": "0.0.53",
   "description": "Cryptorch EVM extension",
   "keywords": [
     "cryptorch",