@0xtorch/evm 0.0.1

package/src/explorers/definitions/blockscout.test.ts

@@ -0,0 +1,124 @@
+import { ethereum } from '@0xtorch/core'
+import { describe, expect, it } from 'bun:test'
+import { isIntegrationTest } from '../../tests'
+import { createBlockscout } from './blockscout'
+
+const univ2RouterAddress = '0x7a250d5630b4cf539739df2c5dacb4c659f2488d'
+const wethAddress = '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2'
+const vitalikEthAddress = '0xd8da6bf26964af9d7eed9e03e53415d37aa96045'
+
+describe.if(isIntegrationTest)('blockscout.getAddressTransactionHashes', () => {
+  it('should return transaction hashes', async () => {
+    const blockscout = createBlockscout({
+      name: 'Ethereum Explorer',
+      url: 'https://eth.blockscout.com',
+      apiUrl: 'https://eth.blockscout.com/api',
+    })
+    const hashes = await blockscout.getAddressTransactionHashes({
+      address: univ2RouterAddress,
+      startBlock: 19_000_000n,
+      endBlock: 19_010_000n,
+    })
+    expect(hashes.length).toBeGreaterThan(12_500)
+    expect(hashes.length).toBeLessThan(12_600)
+    // expect(hashes).toHaveLength(12_520)
+  }, 60_000)
+})
+
+describe.if(isIntegrationTest)(
+  'blockscout.getAddressInternalTransactions',
+  () => {
+    it('should return internal transaction hashes', async () => {
+      const blockscout = createBlockscout({
+        name: 'Ethereum Explorer',
+        url: 'https://eth.blockscout.com',
+        apiUrl: 'https://eth.blockscout.com/api',
+      })
+      const transactions = await blockscout.getAddressInternalTransactions({
+        address: univ2RouterAddress,
+        startBlock: 19_000_000n,
+        endBlock: 19_003_000n,
+        nativeCurrency: ethereum,
+      })
+      expect(transactions.length).toBeGreaterThan(10_000)
+      expect(transactions.length).toBeLessThan(20_100)
+      // expect(transactions).toHaveLength(10_007)
+    }, 60_000)
+  },
+)
+
+describe.if(isIntegrationTest)(
+  'blockscout.getAddressTokenTransferHashes',
+  () => {
+    it('should return token transfer tx hashes', async () => {
+      const blockscout = createBlockscout({
+        name: 'Ethereum Explorer',
+        url: 'https://eth.blockscout.com',
+        apiUrl: 'https://eth.blockscout.com/api',
+      })
+      const hashes = await blockscout.getAddressTokenTransferHashes({
+        address: univ2RouterAddress,
+        startBlock: 18_870_000n,
+        endBlock: 18_880_000n,
+      })
+      expect(hashes).toHaveLength(4373)
+    }, 60_000)
+  },
+)
+
+describe.if(isIntegrationTest)('blockscout.getBlockNumberOfTimestamp', () => {
+  it('should return block number', async () => {
+    const blockscout = createBlockscout({
+      name: 'Ethereum Explorer',
+      url: 'https://eth.blockscout.com',
+      apiUrl: 'https://eth.blockscout.com/api',
+    })
+    const blockNumber =
+      await blockscout.getBlockNumberOfTimestamp(1_705_462_847)
+    expect(blockNumber).toBe(19_023_982n)
+  }, 60_000)
+})
+
+describe.if(isIntegrationTest)('blockscout.getContract', () => {
+  it('should return contract', async () => {
+    const blockscout = createBlockscout({
+      name: 'Ethereum Explorer',
+      url: 'https://eth.blockscout.com',
+      apiUrl: 'https://eth.blockscout.com/api',
+    })
+    const contract = await blockscout.getContract(wethAddress)
+    expect(contract?.name).toEqual('WETH9')
+    expect(contract?.abi.length).toBeGreaterThan(0)
+  }, 60_000)
+
+  it('should return undefined', async () => {
+    const blockscout = createBlockscout({
+      name: 'Ethereum Explorer',
+      url: 'https://eth.blockscout.com',
+      apiUrl: 'https://eth.blockscout.com/api',
+    })
+    const contract = await blockscout.getContract(vitalikEthAddress)
+    expect(contract).toBeUndefined()
+  }, 60_000)
+})
+
+describe.if(isIntegrationTest)(
+  'blockscout.getInternalTransactionOfTransaction',
+  () => {
+    it('should return internal transactions', async () => {
+      const blockscout = createBlockscout({
+        name: 'Ethereum Explorer',
+        url: 'https://eth.blockscout.com',
+        apiUrl: 'https://eth.blockscout.com/api',
+      })
+      const transactions = await blockscout.getInternalTransactionOfTransaction(
+        {
+          hash: '0x78ef484e62a5174b5fb716cde105a9669fc333e7ccb59c8eced163a9802a9c43',
+          nativeCurrency: ethereum,
+        },
+      )
+      expect(transactions.filter((tx) => tx.value > 0)).toHaveLength(1)
+      expect(transactions).toHaveLength(7)
+    })
+  },
+)

package/src/explorers/definitions/blockscout.ts

@@ -0,0 +1,205 @@
+import type { Logger } from '@0xtorch/core'
+import type { InternalTransaction, LowerHex } from '../../types'
+import {
+  getBlockNumberOfTimestamp,
+  getContractByAddress,
+  getInternalTransactionsByAddress,
+  getInternalTransactionsByTransactionHash,
+  getNormalTransactionsByAddress,
+  getTokenTransfersByAddress,
+} from '../externals/blockscout'
+import { defineExplorer } from './defineExplorer'
+
+type CreateBlockscoutParameters<
+  TName extends string,
+  TUrl extends string,
+  TApiUrl extends string,
+> = {
+  readonly name: TName
+  readonly url: TUrl
+  readonly apiUrl: TApiUrl
+}
+
+export const createBlockscout = <
+  TName extends string,
+  TUrl extends string,
+  TApiUrl extends string,
+>({
+  name,
+  url,
+  apiUrl,
+}: CreateBlockscoutParameters<TName, TUrl, TApiUrl>) =>
+  defineExplorer({
+    name,
+    url,
+    apiUrl,
+    getAddressTransactionHashes: async ({
+      address,
+      startBlock,
+      endBlock,
+      logger,
+    }) => {
+      const loop = true
+      const hashSet = new Set<LowerHex>()
+      let mut_startBlock = startBlock
+      while (loop) {
+        const transactions = await getNormalTransactionsByAddress({
+          apiEndpoint: apiUrl,
+          address,
+          startBlock: mut_startBlock,
+          endBlock,
+          logger,
+        })
+        for (const { hash } of transactions) {
+          hashSet.add(hash)
+        }
+        if (transactions.length < 10_000) {
+          break
+        }
+        const maxTxBlockNumber = transactions.reduce(
+          (max, { blockNumber }) =>
+            max < BigInt(blockNumber) ? BigInt(blockNumber) : max,
+          0n,
+        )
+        if (maxTxBlockNumber === 0n || maxTxBlockNumber === mut_startBlock) {
+          break
+        }
+        mut_startBlock = maxTxBlockNumber
+      }
+      return [...hashSet]
+    },
+    getAddressInternalTransactions: async ({
+      address,
+      startBlock,
+      endBlock,
+      nativeCurrency,
+      logger,
+    }) => {
+      const loop = true
+      const mut_internalTransactions: InternalTransaction<undefined>[] = []
+      let mut_startBlock = startBlock
+      while (loop) {
+        const transactions = await getInternalTransactionsByAddress({
+          apiEndpoint: apiUrl,
+          address,
+          startBlock: mut_startBlock,
+          endBlock,
+          logger,
+        })
+        for (const transaction of transactions) {
+          if (
+            mut_internalTransactions.some(
+              ({ transactionHash, from, to, value }) =>
+                transaction.transactionHash === transactionHash &&
+                transaction.from === from &&
+                transaction.to === to &&
+                transaction.value === value,
+            )
+          ) {
+            continue
+          }
+          mut_internalTransactions.push({
+            ...transaction,
+            type: 'InternalTransaction',
+            to: transaction.to,
+            contractAddress: transaction.contractAddress,
+            txType: transaction.type,
+            currency: nativeCurrency,
+            price: undefined,
+          })
+        }
+        if (transactions.length < 10_000) {
+          break
+        }
+        const maxTxBlockNumber = transactions.reduce(
+          (max, { blockNumber }) =>
+            max < BigInt(blockNumber) ? BigInt(blockNumber) : max,
+          0n,
+        )
+        if (maxTxBlockNumber === 0n || maxTxBlockNumber === mut_startBlock) {
+          break
+        }
+        mut_startBlock = maxTxBlockNumber
+      }
+      return mut_internalTransactions
+    },
+
+    getAddressTokenTransferHashes: async ({
+      address,
+      startBlock,
+      endBlock,
+      logger,
+    }) => {
+      const loop = true
+      const hashSet = new Set<LowerHex>()
+
+      // erc20 transfer
+      let mut_startBlock = startBlock
+      while (loop) {
+        const transfers = await getTokenTransfersByAddress({
+          apiEndpoint: apiUrl,
+          address,
+          startBlock: mut_startBlock,
+          endBlock,
+          logger,
+        })
+        for (const { hash } of transfers) {
+          hashSet.add(hash)
+        }
+        if (transfers.length < 10_000) {
+          break
+        }
+        const maxTxBlockNumber = transfers.reduce(
+          (max, { blockNumber }) =>
+            max < BigInt(blockNumber) ? BigInt(blockNumber) : max,
+          0n,
+        )
+        if (maxTxBlockNumber === 0n || maxTxBlockNumber === mut_startBlock) {
+          break
+        }
+        mut_startBlock = maxTxBlockNumber
+      }
+      return [...hashSet]
+    },
+    getBlockNumberOfTimestamp: async (timestamp, logger?: Logger) =>
+      await getBlockNumberOfTimestamp({
+        apiEndpoint: apiUrl,
+        timestamp,
+        logger,
+      }),
+    getContract: async (address, logger?: Logger) => {
+      const contract = await getContractByAddress({
+        apiEndpoint: apiUrl,
+        address,
+        logger,
+      })
+      if (contract === undefined) {
+        return
+      }
+      return {
+        name: contract.ContractName,
+        abi: contract.ABI,
+      }
+    },
+    getInternalTransactionOfTransaction: async ({
+      hash,
+      nativeCurrency,
+      logger,
+    }) => {
+      const transactions = await getInternalTransactionsByTransactionHash({
+        apiEndpoint: apiUrl,
+        transactionHash: hash,
+        logger,
+      })
+      return transactions.map((transaction) => ({
+        ...transaction,
+        type: 'InternalTransaction',
+        transactionHash: hash,
+        to: transaction.to,
+        contractAddress: transaction.contractAddress,
+        txType: transaction.type,
+        currency: nativeCurrency,
+        price: undefined,
+      }))
+    },
+  })

package/src/explorers/definitions/defineExplorer.ts

@@ -0,0 +1,7 @@
+import type { Explorer } from '..'
+
+export const defineExplorer = <const TExplorer extends Explorer>(
+  explorer: TExplorer,
+): TExplorer => ({
+  ...explorer,
+})

package/src/explorers/definitions/etherscan.test.ts

@@ -0,0 +1,123 @@
+import { ethereum } from '@0xtorch/core'
+import { describe, expect, it } from 'bun:test'
+import { isIntegrationTest } from '../../tests'
+import { createEtherscan } from './etherscan'
+
+const univ2RouterAddress = '0x7a250d5630b4cf539739df2c5dacb4c659f2488d'
+const wethAddress = '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2'
+const vitalikEthAddress = '0xd8da6bf26964af9d7eed9e03e53415d37aa96045'
+
+describe.if(isIntegrationTest)('etherscan.getAddressTransactionHashes', () => {
+  it('should return transaction hashes', async () => {
+    const etherscan = createEtherscan({
+      name: 'Etherscan',
+      url: 'https://etherscan.io',
+      apiUrl: 'https://api.etherscan.io/api',
+      apiKey: process.env.ETHERSCAN_API_KEY ?? '',
+    })
+    const hashes = await etherscan.getAddressTransactionHashes({
+      address: univ2RouterAddress,
+      startBlock: 19_000_000n,
+      endBlock: 19_010_000n,
+    })
+    expect(hashes).toHaveLength(12_520)
+  }, 60_000)
+})
+
+describe.if(isIntegrationTest)(
+  'etherscan.getAddressInternalTransactions',
+  () => {
+    it('should return internal transaction hashes', async () => {
+      const etherscan = createEtherscan({
+        name: 'Etherscan',
+        url: 'https://etherscan.io',
+        apiUrl: 'https://api.etherscan.io/api',
+        apiKey: process.env.ETHERSCAN_API_KEY ?? '',
+      })
+      const transactions = await etherscan.getAddressInternalTransactions({
+        address: univ2RouterAddress,
+        startBlock: 19_000_000n,
+        endBlock: 19_003_000n,
+        nativeCurrency: ethereum,
+      })
+      expect(transactions).toHaveLength(10_007)
+    }, 60_000)
+  },
+)
+
+describe.if(isIntegrationTest)(
+  'etherscan.getAddressTokenTransferHashes',
+  () => {
+    it('should return token transfer tx hashes', async () => {
+      const etherscan = createEtherscan({
+        name: 'Etherscan',
+        url: 'https://etherscan.io',
+        apiUrl: 'https://api.etherscan.io/api',
+        apiKey: process.env.ETHERSCAN_API_KEY ?? '',
+      })
+      const hashes = await etherscan.getAddressTokenTransferHashes({
+        address: univ2RouterAddress,
+        startBlock: 18_870_000n,
+        endBlock: 18_880_000n,
+      })
+      expect(hashes).toHaveLength(11_550)
+    }, 60_000)
+  },
+)
+
+describe.if(isIntegrationTest)('etherscan.getBlockNumberOfTimestamp', () => {
+  it('should return block number', async () => {
+    const etherscan = createEtherscan({
+      name: 'Etherscan',
+      url: 'https://etherscan.io',
+      apiUrl: 'https://api.etherscan.io/api',
+      apiKey: process.env.ETHERSCAN_API_KEY ?? '',
+    })
+    const blockNumber = await etherscan.getBlockNumberOfTimestamp(1_705_462_847)
+    expect(blockNumber).toBe(19_023_982n)
+  }, 60_000)
+})
+
+describe.if(isIntegrationTest)('etherscan.getContract', () => {
+  it('should return contract', async () => {
+    const etherscan = createEtherscan({
+      name: 'Etherscan',
+      url: 'https://etherscan.io',
+      apiUrl: 'https://api.etherscan.io/api',
+      apiKey: process.env.ETHERSCAN_API_KEY ?? '',
+    })
+    const contract = await etherscan.getContract(wethAddress)
+    expect(contract?.name).toEqual('WETH9')
+    expect(contract?.abi.length).toBeGreaterThan(0)
+  }, 60_000)
+
+  it('should return undefined', async () => {
+    const etherscan = createEtherscan({
+      name: 'Etherscan',
+      url: 'https://etherscan.io',
+      apiUrl: 'https://api.etherscan.io/api',
+      apiKey: process.env.ETHERSCAN_API_KEY ?? '',
+    })
+    const contract = await etherscan.getContract(vitalikEthAddress)
+    expect(contract).toBeUndefined()
+  }, 60_000)
+})
+
+describe.if(isIntegrationTest)(
+  'etherscan.getInternalTransactionOfTransaction',
+  () => {
+    it('should return internal transactions', async () => {
+      const etherscan = createEtherscan({
+        name: 'Etherscan',
+        url: 'https://etherscan.io',
+        apiUrl: 'https://api.etherscan.io/api',
+        apiKey: process.env.ETHERSCAN_API_KEY ?? '',
+      })
+      const transactions = await etherscan.getInternalTransactionOfTransaction({
+        hash: '0x78ef484e62a5174b5fb716cde105a9669fc333e7ccb59c8eced163a9802a9c43',
+        nativeCurrency: ethereum,
+      })
+      expect(transactions).toHaveLength(1)
+    })
+  },
+)