@0xtorch/core 0.0.1

package/src/actions/index.ts

@@ -0,0 +1,44 @@
+export type {
+  AccountAction,
+  AccountActionAddLiquidity,
+  AccountActionAtomicArbitrage,
+  AccountActionBridgeFrom,
+  AccountActionBridgeTo,
+  AccountActionBuyNft,
+  AccountActionDeposit,
+  AccountActionDepositWithBond,
+  AccountActionFreeMintNft,
+  AccountActionIncome,
+  AccountActionMove,
+  AccountActionNftRoyalty,
+  AccountActionRemoveLiquidity,
+  AccountActionSellNft,
+  AccountActionSpam,
+  AccountActionSwapIncome,
+  AccountActionSwapNft,
+  AccountActionSwapTransfer,
+  AccountActionTrade,
+  AccountActionTransactionFee,
+  AccountActionTransfer,
+  AccountActionType,
+  AccountActionWithdraw,
+  AccountActionWithdrawWithBond,
+  ActionType,
+  Evidence,
+  NormalAction,
+  NormalActionAddLiquidity,
+  NormalActionAtomicArbitrage,
+  NormalActionBridgeFrom,
+  NormalActionBridgeTo,
+  NormalActionBuyNft,
+  NormalActionDeposit,
+  NormalActionDepositWithBond,
+  NormalActionFreeMintNft,
+  NormalActionRemoveLiquidity,
+  NormalActionSpam,
+  NormalActionTrade,
+  NormalActionTransactionFee,
+  NormalActionTransfer,
+  NormalActionWithdraw,
+  NormalActionWithdrawWithBond,
+} from './types'

package/src/actions/schemas/constants.ts

@@ -0,0 +1,16 @@
+import { z } from 'zod'
+
+export const actionConstantsSchema = z.object({
+  type: z.string(),
+  evidence: z.union([
+    z.literal('contract'),
+    z.literal('system-rule'),
+    z.literal('user-rule'),
+    z.literal('manual-check'),
+    z.literal('none'),
+  ]),
+  timestamp: z.number().int(),
+  comment: z.string().optional(),
+})
+
+export const transferSchema = z.object({})

package/src/actions/schemas/swap.ts

@@ -0,0 +1,7 @@
+import { z } from 'zod'
+
+export const swapActionSchema = z.object({
+  type: z.literal('swap'),
+})
+
+// transfer の型定義がむず過ぎて読めない

package/src/actions/types/addLiquidity.ts

@@ -0,0 +1,23 @@
+import type { CryptoCurrency, CryptoCurrencyPrice, Nft } from '../../assets'
+import type { AccountAction, NormalAction } from './common'
+
+type Action = 'add-liquidity'
+
+export type NormalActionAddLiquidity<
+  Account = unknown,
+  // TODO crypto 以外の価格にも対応させる
+  Price extends CryptoCurrencyPrice | undefined =
+    | CryptoCurrencyPrice
+    | undefined,
+  Asset extends CryptoCurrency | Nft = CryptoCurrency | Nft,
+> = NormalAction<Action, Account, Price, Asset, 'in' | 'out'>
+
+export type AccountActionAddLiquidity<
+  Account = unknown,
+  Source extends string = string,
+  // TODO crypto 以外の価格にも対応させる
+  Price extends CryptoCurrencyPrice | undefined =
+    | CryptoCurrencyPrice
+    | undefined,
+  Asset extends CryptoCurrency | Nft = CryptoCurrency | Nft,
+> = AccountAction<Action, Source, Account, Price, Asset, 'in' | 'out'>

package/src/actions/types/atomicArbitrage.ts

@@ -0,0 +1,30 @@
+import type { CryptoCurrency, CryptoCurrencyPrice } from '../../assets'
+import type { AccountAction, NormalAction } from './common'
+
+export type NormalActionAtomicArbitrage<
+  Account = unknown,
+  Price extends CryptoCurrencyPrice | undefined =
+    | CryptoCurrencyPrice
+    | undefined,
+> = NormalAction<
+  'atomic-arbitrage',
+  Account,
+  Price,
+  CryptoCurrency,
+  'in' | 'out'
+>
+
+export type AccountActionAtomicArbitrage<
+  Account = unknown,
+  Source extends string = string,
+  Price extends CryptoCurrencyPrice | undefined =
+    | CryptoCurrencyPrice
+    | undefined,
+> = AccountAction<
+  'atomic-arbitrage',
+  Source,
+  Account,
+  Price,
+  CryptoCurrency,
+  'in'
+>

package/src/actions/types/bridgeFrom.ts

@@ -0,0 +1,23 @@
+import type { CryptoCurrency, CryptoCurrencyPrice, Nft } from '../../assets'
+import type { AccountAction, NormalAction } from './common'
+
+export type Action = 'bridge-from'
+
+export type NormalActionBridgeFrom<
+  Account = unknown,
+  // TODO crypto 以外の価格にも対応させる
+  Price extends CryptoCurrencyPrice | undefined =
+    | CryptoCurrencyPrice
+    | undefined,
+  Asset extends CryptoCurrency | Nft = CryptoCurrency | Nft,
+> = NormalAction<Action, Account, Price, Asset, 'out'>
+
+export type AccountActionBridgeFrom<
+  Account = unknown,
+  Source extends string = string,
+  // TODO crypto 以外の価格にも対応させる
+  Price extends CryptoCurrencyPrice | undefined =
+    | CryptoCurrencyPrice
+    | undefined,
+  Asset extends CryptoCurrency | Nft = CryptoCurrency | Nft,
+> = AccountAction<Action, Source, Account, Price, Asset, 'out'>

package/src/actions/types/bridgeTo.ts

@@ -0,0 +1,23 @@
+import type { CryptoCurrency, CryptoCurrencyPrice, Nft } from '../../assets'
+import type { AccountAction, NormalAction } from './common'
+
+export type Action = 'bridge-to'
+
+export type NormalActionBridgeTo<
+  Account = unknown,
+  // TODO crypto 以外の価格にも対応させる
+  Price extends CryptoCurrencyPrice | undefined =
+    | CryptoCurrencyPrice
+    | undefined,
+  Asset extends CryptoCurrency | Nft = CryptoCurrency | Nft,
+> = NormalAction<Action, Account, Price, Asset, 'in'>
+
+export type AccountActionBridgeTo<
+  Account = unknown,
+  Source extends string = string,
+  // TODO crypto 以外の価格にも対応させる
+  Price extends CryptoCurrencyPrice | undefined =
+    | CryptoCurrencyPrice
+    | undefined,
+  Asset extends CryptoCurrency | Nft = CryptoCurrency | Nft,
+> = AccountAction<Action, Source, Account, Price, Asset, 'in'>

package/src/actions/types/buyNft.ts

@@ -0,0 +1,34 @@
+import type {
+  CryptoCurrency,
+  CryptoCurrencyPrice,
+  FiatCurrency,
+  Nft,
+} from '../../assets'
+import type { AccountAction, NormalAction } from './common'
+
+type Action = 'buy-nft'
+
+export type NormalActionBuyNft<
+  Account = unknown,
+  // TODO crypto 以外の価格にも対応させる
+  Price extends CryptoCurrencyPrice | undefined =
+    | CryptoCurrencyPrice
+    | undefined,
+  Asset extends CryptoCurrency | FiatCurrency | Nft =
+    | CryptoCurrency
+    | FiatCurrency
+    | Nft,
+> = NormalAction<Action, Account, Price, Asset, 'in' | 'out'>
+
+export type AccountActionBuyNft<
+  Account = unknown,
+  Source extends string = string,
+  // TODO crypto 以外の価格にも対応させる
+  Price extends CryptoCurrencyPrice | undefined =
+    | CryptoCurrencyPrice
+    | undefined,
+  Asset extends CryptoCurrency | FiatCurrency | Nft =
+    | CryptoCurrency
+    | FiatCurrency
+    | Nft,
+> = AccountAction<Action, Source, Account, Price, Asset, 'in' | 'out'>

package/src/actions/types/common.ts

@@ -0,0 +1,142 @@
+import type { BigDecimal } from '@0xtorch/big-decimal'
+import type { App } from '../../apps'
+import type {
+  CryptoCurrency,
+  CryptoCurrencyPrice,
+  FiatCurrency,
+  Nft,
+} from '../../assets'
+
+const actions = [
+  'add-liquidity',
+  'atomic-arbitrage',
+  'bridge-from',
+  'bridge-to',
+  'buy-nft',
+  'deposit',
+  'deposit-with-bond',
+  'free-mint-nft',
+  'remove-liquidity',
+  'spam',
+  'trade',
+  'transaction-fee',
+  'transfer',
+  'withdraw',
+  'withdraw-with-bond',
+] as const
+export type ActionType = (typeof actions)[number]
+
+const accountActions = [
+  'add-liquidity',
+  'atomic-arbitrage',
+  'bridge-from',
+  'bridge-to',
+  'buy-nft',
+  'deposit',
+  'deposit-with-bond',
+  'free-mint-nft',
+  'income',
+  'move',
+  'nft-royalty',
+  'remove-liquidity',
+  'sell-nft',
+  'spam',
+  'swap-income',
+  'swap-nft',
+  'swap-transfer',
+  'trade',
+  'transaction-fee',
+  'transfer',
+  'withdraw',
+  'withdraw-with-bond',
+] as const
+export type AccountActionType = (typeof accountActions)[number]
+
+export type AccountAction<
+  Action extends AccountActionType = AccountActionType,
+  Source extends string = string,
+  Account = unknown,
+  // TODO crypto 以外の価格にも対応させる
+  Price extends CryptoCurrencyPrice | undefined =
+    | CryptoCurrencyPrice
+    | undefined,
+  Asset extends CryptoCurrency | FiatCurrency | Nft =
+    | CryptoCurrency
+    | FiatCurrency
+    | Nft,
+  Direction extends TransferDirection = TransferDirection,
+> = {
+  readonly type: 'AccountAction'
+  readonly action: Action
+  readonly source: Source
+  readonly evidence: Evidence
+  readonly timestamp: number
+  readonly order: number
+  readonly comment: string | undefined
+  readonly app: App | undefined
+  readonly transfers: readonly Transfer<Account, Price, Asset, Direction>[]
+}
+
+export type NormalAction<
+  Action extends ActionType = ActionType,
+  Account = unknown,
+  // TODO crypto 以外の価格にも対応させる
+  Price extends CryptoCurrencyPrice | undefined =
+    | CryptoCurrencyPrice
+    | undefined,
+  Asset extends CryptoCurrency | FiatCurrency | Nft =
+    | CryptoCurrency
+    | FiatCurrency
+    | Nft,
+  Direction extends TransferDirection = TransferDirection,
+> = {
+  readonly type: 'NormalAction'
+  readonly action: Action
+  readonly evidence: Evidence
+  readonly timestamp: number
+  readonly comment: string | undefined
+  readonly app: App | undefined
+  readonly transfers: readonly Transfer<Account, Price, Asset, Direction>[]
+}
+
+// TODO これで良いか再検討
+const evidences = [
+  'contract',
+  'system-rule',
+  'user-rule',
+  'manual-check',
+  'none',
+] as const
+export type Evidence = (typeof evidences)[number]
+
+/** action 内で発生している token transfer */
+export type Transfer<
+  Account,
+  // TODO crypto 以外の価格にも対応させる
+  Price extends CryptoCurrencyPrice | undefined = undefined,
+  Asset extends CryptoCurrency | FiatCurrency | Nft =
+    | CryptoCurrency
+    | FiatCurrency
+    | Nft,
+  Direction extends TransferDirection = TransferDirection,
+> = {
+  /** 誰視点なのか */
+  readonly target: string
+  /** target 視点からの移動方向 */
+  readonly direction: Direction
+  /** 移動元 account */
+  // TODO 適切な型を考える
+  readonly from: Account
+  /** 移動先 account */
+  // TODO 適切な型を考える
+  readonly to: Account
+  /** 移動した asset */
+  readonly asset: Asset
+  /** 移動したトークン量 */
+  readonly amount: BigDecimal
+  /**  移動したトークンの価格  */
+  readonly price: Price
+}
+
+const transferDirections = ['in', 'out', 'none'] as const
+type TransferDirection = (typeof transferDirections)[number]

package/src/actions/types/deposit.ts

@@ -0,0 +1,23 @@
+import type { CryptoCurrency, CryptoCurrencyPrice, Nft } from '../../assets'
+import type { AccountAction, NormalAction } from './common'
+
+export type Action = 'deposit'
+
+export type NormalActionDeposit<
+  Account = unknown,
+  // TODO crypto 以外の価格にも対応させる
+  Price extends CryptoCurrencyPrice | undefined =
+    | CryptoCurrencyPrice
+    | undefined,
+  Asset extends CryptoCurrency | Nft = CryptoCurrency | Nft,
+> = NormalAction<Action, Account, Price, Asset, 'out'>
+
+export type AccountActionDeposit<
+  Account = unknown,
+  Source extends string = string,
+  // TODO crypto 以外の価格にも対応させる
+  Price extends CryptoCurrencyPrice | undefined =
+    | CryptoCurrencyPrice
+    | undefined,
+  Asset extends CryptoCurrency | Nft = CryptoCurrency | Nft,
+> = AccountAction<Action, Source, Account, Price, Asset, 'out'>

package/src/actions/types/depositWithBond.ts

@@ -0,0 +1,23 @@
+import type { CryptoCurrency, CryptoCurrencyPrice, Nft } from '../../assets'
+import type { AccountAction, NormalAction } from './common'
+
+type Action = 'deposit-with-bond'
+
+export type NormalActionDepositWithBond<
+  Account = unknown,
+  // TODO crypto 以外の価格にも対応させる
+  Price extends CryptoCurrencyPrice | undefined =
+    | CryptoCurrencyPrice
+    | undefined,
+  Asset extends CryptoCurrency | Nft = CryptoCurrency | Nft,
+> = NormalAction<Action, Account, Price, Asset, 'in' | 'out'>
+
+export type AccountActionDepositWithBond<
+  Account = unknown,
+  Source extends string = string,
+  // TODO crypto 以外の価格にも対応させる
+  Price extends CryptoCurrencyPrice | undefined =
+    | CryptoCurrencyPrice
+    | undefined,
+  Asset extends CryptoCurrency | Nft = CryptoCurrency | Nft,
+> = AccountAction<Action, Source, Account, Price, Asset, 'in' | 'out'>

package/src/actions/types/freeMintNft.ts

@@ -0,0 +1,20 @@
+import type { Nft } from '../../assets'
+import type { AccountAction, NormalAction } from './common'
+
+export type Action = 'free-mint-nft'
+
+// TODO crypto 以外の価格にも対応させる
+/** asset transfer */
+export type NormalActionFreeMintNft<Account = unknown> = NormalAction<
+  Action,
+  Account,
+  undefined,
+  Nft
+>
+
+// TODO crypto 以外の価格にも対応させる
+/** transfer from account to others */
+export type AccountActionFreeMintNft<
+  Account = unknown,
+  Source extends string = string,
+> = AccountAction<Action, Source, Account, undefined, Nft, 'in'>

package/src/actions/types/income.ts

@@ -0,0 +1,21 @@
+import type {
+  CryptoCurrency,
+  CryptoCurrencyPrice,
+  FiatCurrency,
+  Nft,
+} from '../../assets'
+import type { AccountAction } from './common'
+
+/** income */
+export type AccountActionIncome<
+  Account = unknown,
+  Source extends string = string,
+  // TODO crypto 以外の価格にも対応させる
+  Price extends CryptoCurrencyPrice | undefined =
+    | CryptoCurrencyPrice
+    | undefined,
+  Asset extends CryptoCurrency | FiatCurrency | Nft =
+    | CryptoCurrency
+    | FiatCurrency
+    | Nft,
+> = AccountAction<'income', Source, Account, Price, Asset, 'in'>

package/src/actions/types/index.ts

@@ -0,0 +1,53 @@
+export type {
+  AccountActionAddLiquidity,
+  NormalActionAddLiquidity,
+} from './addLiquidity'
+export type {
+  AccountActionAtomicArbitrage,
+  NormalActionAtomicArbitrage,
+} from './atomicArbitrage'
+export type {
+  AccountActionBridgeFrom,
+  NormalActionBridgeFrom,
+} from './bridgeFrom'
+export type { AccountActionBridgeTo, NormalActionBridgeTo } from './bridgeTo'
+export type { AccountActionBuyNft, NormalActionBuyNft } from './buyNft'
+export type {
+  AccountAction,
+  AccountActionType,
+  ActionType,
+  Evidence,
+  NormalAction,
+} from './common'
+export type { AccountActionDeposit, NormalActionDeposit } from './deposit'
+export type {
+  AccountActionDepositWithBond,
+  NormalActionDepositWithBond,
+} from './depositWithBond'
+export type {
+  AccountActionFreeMintNft,
+  NormalActionFreeMintNft,
+} from './freeMintNft'
+export type { AccountActionIncome } from './income'
+export type { AccountActionMove } from './move'
+export type { AccountActionNftRoyalty } from './nftRoyalty'
+export type {
+  AccountActionRemoveLiquidity,
+  NormalActionRemoveLiquidity,
+} from './removeLiquidity'
+export type { AccountActionSellNft } from './sellNft'
+export type { AccountActionSpam, NormalActionSpam } from './spam'
+export type { AccountActionSwapIncome } from './swapIncome'
+export type { AccountActionSwapNft } from './swapNft'
+export type { AccountActionSwapTransfer } from './swapTransfer'
+export type { AccountActionTrade, NormalActionTrade } from './trade'
+export type {
+  AccountActionTransactionFee,
+  NormalActionTransactionFee,
+} from './transactionFee'
+export type { AccountActionTransfer, NormalActionTransfer } from './transfer'
+export type { AccountActionWithdraw, NormalActionWithdraw } from './withdraw'
+export type {
+  AccountActionWithdrawWithBond,
+  NormalActionWithdrawWithBond,
+} from './withdrawWithBond'

package/src/actions/types/move.ts

@@ -0,0 +1,21 @@
+import type {
+  CryptoCurrency,
+  CryptoCurrencyPrice,
+  FiatCurrency,
+  Nft,
+} from '../../assets'
+import type { AccountAction } from './common'
+
+/** move asset between accounts */
+export type AccountActionMove<
+  Account = unknown,
+  Source extends string = string,
+  // TODO crypto 以外の価格にも対応させる
+  Price extends CryptoCurrencyPrice | undefined =
+    | CryptoCurrencyPrice
+    | undefined,
+  Asset extends CryptoCurrency | FiatCurrency | Nft =
+    | CryptoCurrency
+    | FiatCurrency
+    | Nft,
+> = AccountAction<'move', Source, Account, Price, Asset, 'none'>

package/src/actions/types/nftRoyalty.ts

@@ -0,0 +1,19 @@
+import type {
+  CryptoCurrency,
+  CryptoCurrencyPrice,
+  FiatCurrency,
+} from '../../assets'
+import type { AccountAction } from './common'
+
+type Action = 'nft-royalty'
+
+/** nft-royalty */
+export type AccountActionNftRoyalty<
+  Account = unknown,
+  Source extends string = string,
+  // TODO crypto 以外の価格にも対応させる
+  Price extends CryptoCurrencyPrice | undefined =
+    | CryptoCurrencyPrice
+    | undefined,
+  Asset extends CryptoCurrency | FiatCurrency = CryptoCurrency | FiatCurrency,
+> = AccountAction<Action, Source, Account, Price, Asset, 'in'>

package/src/actions/types/removeLiquidity.ts

@@ -0,0 +1,23 @@
+import type { CryptoCurrency, CryptoCurrencyPrice, Nft } from '../../assets'
+import type { AccountAction, NormalAction } from './common'
+
+type Action = 'remove-liquidity'
+
+export type NormalActionRemoveLiquidity<
+  Account = unknown,
+  // TODO crypto 以外の価格にも対応させる
+  Price extends CryptoCurrencyPrice | undefined =
+    | CryptoCurrencyPrice
+    | undefined,
+  Asset extends CryptoCurrency | Nft = CryptoCurrency | Nft,
+> = NormalAction<Action, Account, Price, Asset, 'in' | 'out'>
+
+export type AccountActionRemoveLiquidity<
+  Account = unknown,
+  Source extends string = string,
+  // TODO crypto 以外の価格にも対応させる
+  Price extends CryptoCurrencyPrice | undefined =
+    | CryptoCurrencyPrice
+    | undefined,
+  Asset extends CryptoCurrency | Nft = CryptoCurrency | Nft,
+> = AccountAction<Action, Source, Account, Price, Asset, 'in' | 'out'>

package/src/actions/types/sellNft.ts

@@ -0,0 +1,22 @@
+import type {
+  CryptoCurrency,
+  CryptoCurrencyPrice,
+  FiatCurrency,
+  Nft,
+} from '../../assets'
+import type { AccountAction } from './common'
+
+type Action = 'sell-nft'
+
+export type AccountActionSellNft<
+  Account = unknown,
+  Source extends string = string,
+  // TODO crypto 以外の価格にも対応させる
+  Price extends CryptoCurrencyPrice | undefined =
+    | CryptoCurrencyPrice
+    | undefined,
+  Asset extends CryptoCurrency | FiatCurrency | Nft =
+    | CryptoCurrency
+    | FiatCurrency
+    | Nft,
+> = AccountAction<Action, Source, Account, Price, Asset, 'in' | 'out'>

package/src/actions/types/spam.ts

@@ -0,0 +1,23 @@
+import type { CryptoCurrency, CryptoCurrencyPrice, Nft } from '../../assets'
+import type { AccountAction, NormalAction } from './common'
+
+export type Action = 'spam'
+
+export type NormalActionSpam<
+  Account = unknown,
+  // TODO crypto 以外の価格にも対応させる
+  Price extends CryptoCurrencyPrice | undefined =
+    | CryptoCurrencyPrice
+    | undefined,
+  Asset extends CryptoCurrency | Nft = CryptoCurrency | Nft,
+> = NormalAction<Action, Account, Price, Asset, 'none'>
+
+export type AccountActionSpam<
+  Account = unknown,
+  Source extends string = string,
+  // TODO crypto 以外の価格にも対応させる
+  Price extends CryptoCurrencyPrice | undefined =
+    | CryptoCurrencyPrice
+    | undefined,
+  Asset extends CryptoCurrency | Nft = CryptoCurrency | Nft,
+> = AccountAction<Action, Source, Account, Price, Asset, 'in' | 'out'>

package/src/actions/types/swapIncome.ts

@@ -0,0 +1,12 @@
+import type { CryptoCurrency, CryptoCurrencyPrice, Nft } from '../../assets'
+import type { AccountAction } from './common'
+
+export type AccountActionSwapIncome<
+  Account = unknown,
+  Source extends string = string,
+  // TODO crypto 以外の価格にも対応させる
+  Price extends CryptoCurrencyPrice | undefined =
+    | CryptoCurrencyPrice
+    | undefined,
+  Asset extends CryptoCurrency | Nft = CryptoCurrency | Nft,
+> = AccountAction<'swap-income', Source, Account, Price, Asset, 'in'>

package/src/actions/types/swapNft.ts

@@ -0,0 +1,12 @@
+import type { Nft } from '../../assets'
+import type { AccountAction } from './common'
+
+type Action = 'swap-nft'
+
+export type AccountActionSwapNft<
+  Account = unknown,
+  Source extends string = string,
+  // TODO crypto 以外の価格にも対応させる
+  Price extends undefined = undefined,
+  Asset extends Nft = Nft,
+> = AccountAction<Action, Source, Account, Price, Asset, 'in' | 'out'>

package/src/actions/types/swapTransfer.ts

@@ -0,0 +1,12 @@
+import type { CryptoCurrency, CryptoCurrencyPrice, Nft } from '../../assets'
+import type { AccountAction } from './common'
+
+export type AccountActionSwapTransfer<
+  Account = unknown,
+  Source extends string = string,
+  // TODO crypto 以外の価格にも対応させる
+  Price extends CryptoCurrencyPrice | undefined =
+    | CryptoCurrencyPrice
+    | undefined,
+  Asset extends CryptoCurrency | Nft = CryptoCurrency | Nft,
+> = AccountAction<'swap-transfer', Source, Account, Price, Asset, 'out'>