@0xtorch/evm 0.0.1

package/src/analyzer/createAccountActionByAction/trade.ts

@@ -0,0 +1,105 @@
+import type {
+  AccountAction,
+  AccountActionType,
+  CryptoCurrencyPrice,
+  NormalActionTrade,
+} from '@0xtorch/core'
+import type {
+  EvmAccount,
+  LowerHex,
+  TransactionDecoded,
+  TransactionSource,
+} from '../../types'
+import { toLowerHex } from '../../types'
+
+export const createAccountActionByActionTrade = <
+  Price extends CryptoCurrencyPrice | undefined,
+>(
+  action: NormalActionTrade<EvmAccount, Price>,
+  transaction: TransactionDecoded<Price>,
+  accountAddresses: readonly LowerHex[],
+):
+  | AccountAction<
+      AccountActionType,
+      TransactionSource,
+      EvmAccount | undefined,
+      Price
+    >
+  | undefined => {
+  const transfersIn = action.transfers.filter(
+    (transfer) => transfer.direction === 'in',
+  )
+  const transfersOut = action.transfers.filter(
+    (transfer) => transfer.direction === 'out',
+  )
+  if (transfersIn.length === 0 || transfersOut.length === 0) {
+    throw new Error('invalid action')
+  }
+
+  const source =
+    `evm_${transaction.chainId}_${toLowerHex(transaction.transactionHash)}` as const
+  if (
+    transfersIn.every((transfer) =>
+      accountAddresses.includes(transfer.to.address),
+    ) &&
+    transfersOut.every((transfer) =>
+      accountAddresses.includes(transfer.from.address),
+    )
+  ) {
+    // transfers の両側全てが自分の address の場合は trade として扱う
+    return {
+      type: 'AccountAction',
+      action: 'trade',
+      source,
+      evidence: action.evidence,
+      timestamp: action.timestamp,
+      order: 0,
+      comment: action.comment,
+      app: action.app,
+      transfers: action.transfers,
+    }
+  } else if (
+    transfersIn.every((transfer) =>
+      accountAddresses.includes(transfer.to.address),
+    ) &&
+    transfersOut.every(
+      (transfer) => !accountAddresses.includes(transfer.from.address),
+    )
+  ) {
+    // transfers の in 側全て自分の address , out側全てが自分の address でない場合は swap-income として扱う
+    return {
+      type: 'AccountAction',
+      action: 'swap-income',
+      source,
+      evidence: action.evidence,
+      timestamp: action.timestamp,
+      order: 0,
+      comment: action.comment,
+      app: action.app,
+      transfers: transfersIn,
+    }
+  } else if (
+    transfersOut.every((transfer) =>
+      accountAddresses.includes(transfer.from.address),
+    ) &&
+    transfersIn.every(
+      (transfer) => !accountAddresses.includes(transfer.to.address),
+    )
+  ) {
+    // transfers の out 側全てが自分の address , in 側全てが自分の address でない場合は swap-transfer として扱う
+    return {
+      type: 'AccountAction',
+      action: 'swap-transfer',
+      source,
+      evidence: action.evidence,
+      timestamp: action.timestamp,
+      order: 0,
+      comment: action.comment,
+      app: action.app,
+      transfers: transfersOut,
+    }
+  } else {
+    // それ以外の場合は分析不能として undefined を返す
+    return undefined
+  }
+}

package/src/analyzer/createAccountActionByAction/transactionFee.ts

@@ -0,0 +1,51 @@
+import type {
+  AccountAction,
+  AccountActionType,
+  CryptoCurrencyPrice,
+  NormalActionTransactionFee,
+} from '@0xtorch/core'
+import type {
+  EvmAccount,
+  LowerHex,
+  TransactionDecoded,
+  TransactionSource,
+} from '../../types'
+import { toLowerHex } from '../../types'
+
+export const createAccountActionByActionTransactionFee = <
+  Price extends CryptoCurrencyPrice | undefined,
+>(
+  action: NormalActionTransactionFee<EvmAccount | undefined, Price>,
+  transaction: TransactionDecoded<Price>,
+  accountAddresses: readonly LowerHex[],
+):
+  | AccountAction<
+      AccountActionType,
+      TransactionSource,
+      EvmAccount | undefined,
+      Price
+    >
+  | undefined => {
+  if (action.transfers.length !== 1) {
+    return undefined
+  }
+  const transferFrom = action.transfers[0].from?.address
+  if (transferFrom === undefined) {
+    return undefined
+  }
+  if (!accountAddresses.includes(transferFrom)) {
+    return undefined
+  }
+
+  return {
+    type: 'AccountAction',
+    action: 'transaction-fee',
+    source: `evm_${transaction.chainId}_${toLowerHex(transaction.hash)}`,
+    evidence: action.evidence,
+    timestamp: action.timestamp,
+    order: 0,
+    comment: action.comment,
+    app: action.app,
+    transfers: action.transfers,
+  }
+}

package/src/analyzer/createAccountActionByAction/transfer.ts

@@ -0,0 +1,95 @@
+import type {
+  AccountAction,
+  AccountActionType,
+  CryptoCurrencyPrice,
+  NormalActionTransfer,
+} from '@0xtorch/core'
+import type {
+  EvmAccount,
+  LowerHex,
+  TransactionDecoded,
+  TransactionSource,
+} from '../../types'
+import { toLowerHex } from '../../types'
+
+export const createAccountActionByActionTransfer = <
+  Price extends CryptoCurrencyPrice | undefined,
+>(
+  action: NormalActionTransfer<EvmAccount, Price>,
+  transaction: TransactionDecoded<Price>,
+  accountAddresses: readonly LowerHex[],
+):
+  | AccountAction<
+      AccountActionType,
+      TransactionSource,
+      EvmAccount | undefined,
+      Price
+    >
+  | undefined => {
+  if (action.transfers.length !== 1) {
+    throw new Error('invalid action')
+  }
+  const source =
+    `evm_${transaction.chainId}_${toLowerHex(transaction.transactionHash)}` as const
+  const transfer = action.transfers[0]
+  if (
+    accountAddresses.includes(transfer.from.address) &&
+    accountAddresses.includes(transfer.to.address)
+  ) {
+    return {
+      type: 'AccountAction',
+      action: 'move',
+      source,
+      evidence: 'system-rule',
+      timestamp: action.timestamp,
+      order: 0,
+      comment: action.comment,
+      app: action.app,
+      transfers: [
+        {
+          ...transfer,
+          target: '',
+          direction: 'none',
+        },
+      ],
+    }
+  } else if (accountAddresses.includes(transfer.from.address)) {
+    return {
+      type: 'AccountAction',
+      action: 'transfer',
+      source,
+      evidence: action.evidence,
+      timestamp: action.timestamp,
+      order: 0,
+      comment: action.comment,
+      app: action.app,
+      transfers: [
+        {
+          ...transfer,
+          target: transfer.from.address,
+          direction: 'out',
+        },
+      ],
+    }
+  } else if (accountAddresses.includes(transfer.to.address)) {
+    return {
+      type: 'AccountAction',
+      action: 'income',
+      source,
+      evidence: action.evidence,
+      timestamp: action.timestamp,
+      order: 0,
+      comment: action.comment,
+      app: action.app,
+      transfers: [
+        {
+          ...transfer,
+          target: transfer.to.address,
+          direction: 'in',
+        },
+      ],
+    }
+  } else {
+    return undefined
+  }
+}

package/src/analyzer/createAccountActionByAction/withdraw.ts

@@ -0,0 +1,61 @@
+import type {
+  AccountAction,
+  AccountActionType,
+  CryptoCurrencyPrice,
+  NormalActionWithdraw,
+} from '@0xtorch/core'
+import type {
+  EvmAccount,
+  LowerHex,
+  TransactionDecoded,
+  TransactionSource,
+} from '../../types'
+import { toLowerHex } from '../../types'
+
+export const createAccountActionByActionWithdraw = <
+  Price extends CryptoCurrencyPrice | undefined,
+>(
+  action: NormalActionWithdraw<EvmAccount, Price>,
+  transaction: TransactionDecoded<Price>,
+  accountAddresses: readonly LowerHex[],
+):
+  | AccountAction<
+      AccountActionType,
+      TransactionSource,
+      EvmAccount | undefined,
+      Price
+    >
+  | undefined => {
+  if (action.transfers.length !== 1) {
+    throw new Error('invalid action')
+  }
+
+  const transfer = action.transfers[0]
+  if (
+    accountAddresses.includes(transfer.from.address) &&
+    accountAddresses.includes(transfer.to.address)
+  ) {
+    return undefined
+  } else if (accountAddresses.includes(transfer.to.address)) {
+    return {
+      type: 'AccountAction',
+      action: 'withdraw',
+      source:
+        `evm_${transaction.chainId}_${toLowerHex(transaction.transactionHash)}` as const,
+      evidence: action.evidence,
+      timestamp: action.timestamp,
+      order: 0,
+      comment: action.comment,
+      app: action.app,
+      transfers: [
+        {
+          ...transfer,
+          target: transfer.to.address,
+          direction: 'in',
+        },
+      ],
+    }
+  } else {
+    return undefined
+  }
+}

package/src/analyzer/createAccountActionByAction/withdrawWithBond.ts

@@ -0,0 +1,60 @@
+import type {
+  AccountAction,
+  AccountActionType,
+  CryptoCurrencyPrice,
+  NormalActionWithdrawWithBond,
+} from '@0xtorch/core'
+import type {
+  EvmAccount,
+  LowerHex,
+  TransactionDecoded,
+  TransactionSource,
+} from '../../types'
+import { toLowerHex } from '../../types'
+
+export const createAccountActionByActionWithdrawWithBond = <
+  Price extends CryptoCurrencyPrice | undefined,
+>(
+  action: NormalActionWithdrawWithBond<EvmAccount, Price>,
+  transaction: TransactionDecoded<Price>,
+  accountAddresses: readonly LowerHex[],
+):
+  | AccountAction<
+      AccountActionType,
+      TransactionSource,
+      EvmAccount | undefined,
+      Price
+    >
+  | undefined => {
+  const transfersIn = action.transfers.filter(
+    (transfer) => transfer.direction === 'in',
+  )
+  const transfersOut = action.transfers.filter(
+    (transfer) => transfer.direction === 'out',
+  )
+  if (transfersIn.length === 0 || transfersOut.length === 0) {
+    throw new Error('invalid action')
+  }
+
+  const source =
+    `evm_${transaction.chainId}_${toLowerHex(transaction.transactionHash)}` as const
+
+  return transfersIn.every((transfer) =>
+    accountAddresses.includes(transfer.to.address),
+  ) &&
+    transfersOut.every((transfer) =>
+      accountAddresses.includes(transfer.from.address),
+    )
+    ? {
+        type: 'AccountAction',
+        action: 'withdraw-with-bond',
+        source,
+        evidence: action.evidence,
+        timestamp: action.timestamp,
+        order: 0,
+        comment: action.comment,
+        app: action.app,
+        transfers: action.transfers,
+      }
+    : undefined
+}

package/src/analyzer/gasFee/analyze.test.ts

@@ -0,0 +1,6 @@
+import { describe, it } from 'bun:test'
+
+describe('analyzeGasFee', () => {
+  // TODO
+  it.todo('Ethereum tx の gasFee の analyze が正常にされる')
+})

package/src/analyzer/gasFee/analyze.ts

@@ -0,0 +1,72 @@
+import { createBigDecimal } from '@0xtorch/big-decimal'
+import type {
+  CryptoCurrencyPrice,
+  NormalActionTransactionFee,
+} from '@0xtorch/core'
+import type { Chain } from '../../chains'
+import { createEvmAccount } from '../../creates/createEvmAccount'
+import type { EvmAccount, TransactionDecoded } from '../../types'
+import { toLowerHex } from '../../types'
+import { createAccountActionByAction } from '../createAccountActionByAction'
+import type { AnalyzeParameters, AnalyzeReturnType } from '../types'
+
+// [MAYBE] zkSyncEra は gasRefund の仕組みがあるので、最初の gas から refund された分を引いた値を使う
+export const analyzeGasFee = <Price extends CryptoCurrencyPrice | undefined>({
+  chain,
+  transaction,
+  accountAddresses,
+}: AnalyzeParameters<Price>): Promise<AnalyzeReturnType<Price> | undefined> => {
+  // transaction gas fee を計算して、 normalAction 作成
+  const normalAction = generateNormalAction(transaction, chain)
+
+  // transaction.from が accountAddresses に含まれている場合は、 accountAction 作成
+  const accountAction = createAccountActionByAction(
+    normalAction,
+    transaction,
+    accountAddresses,
+  )
+
+  return Promise.resolve({
+    actions: [normalAction],
+    accountActions: accountAction === undefined ? [] : [accountAction],
+  })
+}
+
+const generateNormalAction = <Price extends CryptoCurrencyPrice | undefined>(
+  {
+    gasUsed,
+    effectiveGasPrice,
+    block,
+    from,
+    nativeTokenPrice,
+  }: TransactionDecoded<Price>,
+  chain: Chain,
+): NormalActionTransactionFee<EvmAccount | undefined, Price> => {
+  const gasFee = createBigDecimal(
+    gasUsed * effectiveGasPrice,
+    chain.nativeToken.decimals,
+  )
+  const lowerFrom = toLowerHex(from)
+  return {
+    type: 'NormalAction',
+    action: 'transaction-fee',
+    evidence: 'system-rule',
+    timestamp: Number(block.timestamp) * 1000,
+    comment: undefined,
+    app: undefined,
+    transfers: [
+      {
+        target: lowerFrom,
+        direction: 'out',
+        from: createEvmAccount({
+          address: lowerFrom,
+          chainId: chain.id,
+        }),
+        to: undefined,
+        asset: chain.nativeToken.currency,
+        amount: gasFee,
+        price: nativeTokenPrice,
+      },
+    ],
+  }
+}

package/src/analyzer/gasFee/index.ts

@@ -0,0 +1 @@
+export { analyzeGasFee } from './analyze'

package/src/analyzer/index.ts

@@ -0,0 +1,9 @@
+export { analyze } from './analyze'
+export { analyzer } from './analyzer'
+export { analyzeAxieMarketplace } from './axieMarketplace'
+export { analyzeGasFee } from './gasFee'
+export { createAnalyzeByJsonRule } from './json'
+export { analyzeSeaport } from './seaport'
+export { analyzeSwap } from './swap'
+export { analyzeTransfer } from './transfer'
+export type { AnalyzeParameters, AnalyzeReturnType, Analyzer } from './types'