@cygnus-wealth/data-models 0.0.2 → 1.0.0

package/dist/enums/AssetType.d.ts

@@ -1,15 +1,129 @@
+/**
+ * Classification of financial asset types across all integration sources.
+ *
+ * AssetType provides standardized categorization for all tradeable, holdable, or
+ * stakeable instruments within the CygnusWealth ecosystem. This enum serves as
+ * the primary taxonomy for asset classification across CEX, DEX, traditional
+ * finance, and DeFi sources.
+ *
+ * **Design Rationale:**
+ * - Covers both traditional finance (stocks, bonds) and crypto (tokens, NFTs, DeFi positions)
+ * - Distinguishes between base assets and derivative/yield-generating positions
+ * - Extensible via OTHER for edge cases without breaking existing types
+ *
+ * **Integration Guidance:**
+ * - Integration domains should map external classifications to these types
+ * - When in doubt between similar types, prefer more specific (e.g., NFT over CRYPTOCURRENCY)
+ * - Use metadata field for preserving source-specific asset classifications
+ *
+ * @example
+ * ```typescript
+ * // Mapping external asset types
+ * function mapRobinhoodAsset(rhAsset: any): AssetType {
+ *   switch (rhAsset.type) {
+ *     case 'stock': return AssetType.STOCK;
+ *     case 'cryptocurrency': return AssetType.CRYPTOCURRENCY;
+ *     case 'etp': return AssetType.ETF;
+ *     default: return AssetType.OTHER;
+ *   }
+ * }
+ * ```
+ *
+ * @since 0.0.1
+ * @stability core
+ *
+ * @see {@link Asset} for usage in asset models
+ */
 export declare enum AssetType {
+    /**
+     * Fungible digital currencies and tokens (BTC, ETH, ERC-20 tokens, SPL tokens).
+     *
+     * Includes all blockchain-based fungible assets that serve as currencies or
+     * utility tokens. Does not include NFTs or DeFi positions (use specific types for those).
+     */
     CRYPTOCURRENCY = "CRYPTOCURRENCY",
+    /**
+     * Equity securities in publicly traded companies (AAPL, TSLA, etc.).
+     *
+     * Represents ownership shares in corporations. Sourced from traditional
+     * exchanges (NYSE, NASDAQ) via brokerages like Robinhood or Kraken.
+     */
     STOCK = "STOCK",
+    /**
+     * Exchange-Traded Funds - baskets of securities trading on exchanges (SPY, QQQ).
+     *
+     * Investment funds that track indices, commodities, or asset baskets and
+     * trade like stocks on traditional exchanges.
+     */
     ETF = "ETF",
+    /**
+     * Mutual funds - professionally managed investment portfolios.
+     *
+     * Pooled investment vehicles typically accessed through brokerages,
+     * not traded on exchanges. Examples: VTSAX, FXAIX.
+     */
     MUTUAL_FUND = "MUTUAL_FUND",
+    /**
+     * Fixed-income debt securities (government bonds, corporate bonds).
+     *
+     * Instruments representing loans to governments or corporations with
+     * defined interest payments and maturity dates.
+     */
     BOND = "BOND",
+    /**
+     * Physical goods or raw materials (gold, oil, wheat).
+     *
+     * Tangible assets traded on commodity exchanges or held as commodities-backed
+     * instruments. Includes precious metals, energy, agricultural products.
+     */
     COMMODITY = "COMMODITY",
+    /**
+     * Government-issued currencies (USD, EUR, JPY).
+     *
+     * Traditional fiat money held in brokerage cash accounts or wallets.
+     * Represents purchasing power in sovereign currencies.
+     */
     FIAT = "FIAT",
+    /**
+     * Non-fungible tokens - unique digital assets (ERC-721, ERC-1155, Solana NFTs).
+     *
+     * Blockchain-based unique or semi-fungible assets with distinct identities.
+     * Includes art, collectibles, gaming assets, membership tokens.
+     */
     NFT = "NFT",
+    /**
+     * Financial instruments deriving value from underlying assets (options, futures).
+     *
+     * Contracts whose value depends on underlying securities, indices, or commodities.
+     * Includes options, futures, swaps, and structured products.
+     */
     DERIVATIVE = "DERIVATIVE",
+    /**
+     * DeFi liquidity pool positions (Uniswap V2/V3 LP, Curve LP tokens).
+     *
+     * Represents shares in automated market maker (AMM) liquidity pools.
+     * These are yield-generating positions, not base assets.
+     */
     LIQUIDITY_POOL = "LIQUIDITY_POOL",
+    /**
+     * Staked cryptocurrency positions (ETH 2.0 staking, validator delegations).
+     *
+     * Assets locked in proof-of-stake protocols to earn rewards.
+     * Includes direct staking and delegated staking positions.
+     */
     STAKED_POSITION = "STAKED_POSITION",
+    /**
+     * DeFi lending protocol positions (Aave deposits, Compound supplies).
+     *
+     * Assets supplied to lending protocols to earn interest.
+     * Represents yield-generating positions in money markets.
+     */
     LENDING_POSITION = "LENDING_POSITION",
+    /**
+     * Catch-all for assets not fitting standard categories.
+     *
+     * Use sparingly for genuinely novel asset types. Document the specific
+     * type in the asset's metadata field for future classification refinement.
+     */
     OTHER = "OTHER"
 }

package/dist/enums/AssetType.js

@@ -1,16 +1,130 @@
+/**
+ * Classification of financial asset types across all integration sources.
+ *
+ * AssetType provides standardized categorization for all tradeable, holdable, or
+ * stakeable instruments within the CygnusWealth ecosystem. This enum serves as
+ * the primary taxonomy for asset classification across CEX, DEX, traditional
+ * finance, and DeFi sources.
+ *
+ * **Design Rationale:**
+ * - Covers both traditional finance (stocks, bonds) and crypto (tokens, NFTs, DeFi positions)
+ * - Distinguishes between base assets and derivative/yield-generating positions
+ * - Extensible via OTHER for edge cases without breaking existing types
+ *
+ * **Integration Guidance:**
+ * - Integration domains should map external classifications to these types
+ * - When in doubt between similar types, prefer more specific (e.g., NFT over CRYPTOCURRENCY)
+ * - Use metadata field for preserving source-specific asset classifications
+ *
+ * @example
+ * ```typescript
+ * // Mapping external asset types
+ * function mapRobinhoodAsset(rhAsset: any): AssetType {
+ *   switch (rhAsset.type) {
+ *     case 'stock': return AssetType.STOCK;
+ *     case 'cryptocurrency': return AssetType.CRYPTOCURRENCY;
+ *     case 'etp': return AssetType.ETF;
+ *     default: return AssetType.OTHER;
+ *   }
+ * }
+ * ```
+ *
+ * @since 0.0.1
+ * @stability core
+ *
+ * @see {@link Asset} for usage in asset models
+ */
 export var AssetType;
 (function (AssetType) {
+    /**
+     * Fungible digital currencies and tokens (BTC, ETH, ERC-20 tokens, SPL tokens).
+     *
+     * Includes all blockchain-based fungible assets that serve as currencies or
+     * utility tokens. Does not include NFTs or DeFi positions (use specific types for those).
+     */
     AssetType["CRYPTOCURRENCY"] = "CRYPTOCURRENCY";
+    /**
+     * Equity securities in publicly traded companies (AAPL, TSLA, etc.).
+     *
+     * Represents ownership shares in corporations. Sourced from traditional
+     * exchanges (NYSE, NASDAQ) via brokerages like Robinhood or Kraken.
+     */
     AssetType["STOCK"] = "STOCK";
+    /**
+     * Exchange-Traded Funds - baskets of securities trading on exchanges (SPY, QQQ).
+     *
+     * Investment funds that track indices, commodities, or asset baskets and
+     * trade like stocks on traditional exchanges.
+     */
     AssetType["ETF"] = "ETF";
+    /**
+     * Mutual funds - professionally managed investment portfolios.
+     *
+     * Pooled investment vehicles typically accessed through brokerages,
+     * not traded on exchanges. Examples: VTSAX, FXAIX.
+     */
     AssetType["MUTUAL_FUND"] = "MUTUAL_FUND";
+    /**
+     * Fixed-income debt securities (government bonds, corporate bonds).
+     *
+     * Instruments representing loans to governments or corporations with
+     * defined interest payments and maturity dates.
+     */
     AssetType["BOND"] = "BOND";
+    /**
+     * Physical goods or raw materials (gold, oil, wheat).
+     *
+     * Tangible assets traded on commodity exchanges or held as commodities-backed
+     * instruments. Includes precious metals, energy, agricultural products.
+     */
     AssetType["COMMODITY"] = "COMMODITY";
+    /**
+     * Government-issued currencies (USD, EUR, JPY).
+     *
+     * Traditional fiat money held in brokerage cash accounts or wallets.
+     * Represents purchasing power in sovereign currencies.
+     */
     AssetType["FIAT"] = "FIAT";
+    /**
+     * Non-fungible tokens - unique digital assets (ERC-721, ERC-1155, Solana NFTs).
+     *
+     * Blockchain-based unique or semi-fungible assets with distinct identities.
+     * Includes art, collectibles, gaming assets, membership tokens.
+     */
     AssetType["NFT"] = "NFT";
+    /**
+     * Financial instruments deriving value from underlying assets (options, futures).
+     *
+     * Contracts whose value depends on underlying securities, indices, or commodities.
+     * Includes options, futures, swaps, and structured products.
+     */
     AssetType["DERIVATIVE"] = "DERIVATIVE";
+    /**
+     * DeFi liquidity pool positions (Uniswap V2/V3 LP, Curve LP tokens).
+     *
+     * Represents shares in automated market maker (AMM) liquidity pools.
+     * These are yield-generating positions, not base assets.
+     */
     AssetType["LIQUIDITY_POOL"] = "LIQUIDITY_POOL";
+    /**
+     * Staked cryptocurrency positions (ETH 2.0 staking, validator delegations).
+     *
+     * Assets locked in proof-of-stake protocols to earn rewards.
+     * Includes direct staking and delegated staking positions.
+     */
     AssetType["STAKED_POSITION"] = "STAKED_POSITION";
+    /**
+     * DeFi lending protocol positions (Aave deposits, Compound supplies).
+     *
+     * Assets supplied to lending protocols to earn interest.
+     * Represents yield-generating positions in money markets.
+     */
     AssetType["LENDING_POSITION"] = "LENDING_POSITION";
+    /**
+     * Catch-all for assets not fitting standard categories.
+     *
+     * Use sparingly for genuinely novel asset types. Document the specific
+     * type in the asset's metadata field for future classification refinement.
+     */
     AssetType["OTHER"] = "OTHER";
 })(AssetType || (AssetType = {}));

package/dist/enums/Chain.d.ts

@@ -1,12 +1,69 @@
+/**
+ * Blockchain network identifiers for multi-chain asset tracking.
+ *
+ * Provides standardized identifiers for all supported blockchain networks.
+ * Enables consistent asset identification across EVM chains, alternative L1s,
+ * and traditional finance systems.
+ *
+ * **Design Rationale:**
+ * - Covers major EVM chains (Ethereum, Polygon, Arbitrum, Optimism, Avalanche, BSC, Base)
+ * - Includes alternative L1s (Solana, SUI, Bitcoin)
+ * - Extensible via OTHER for new chains without breaking changes
+ * - Chain-agnostic operations use Chain type for abstraction
+ *
+ * **Integration Guidance:**
+ * - Map chain IDs (1, 137, 42161) to these enum values in integration domains
+ * - Use Chain.OTHER for unsupported chains, document actual chain in metadata
+ * - Testnets should be distinguished in metadata, not separate enum values
+ *
+ * @example
+ * ```typescript
+ * function getChainFromId(chainId: number): Chain {
+ *   const chainMap: Record<number, Chain> = {
+ *     1: Chain.ETHEREUM,
+ *     137: Chain.POLYGON,
+ *     42161: Chain.ARBITRUM,
+ *     10: Chain.OPTIMISM,
+ *     43114: Chain.AVALANCHE,
+ *     56: Chain.BSC,
+ *     8453: Chain.BASE
+ *   };
+ *   return chainMap[chainId] || Chain.OTHER;
+ * }
+ * ```
+ *
+ * @since 0.0.1
+ * @stability core
+ *
+ * @see {@link Asset} for usage in asset identification
+ * @see {@link Transaction} for usage in transaction tracking
+ */
 export declare enum Chain {
+    /** Ethereum mainnet (Chain ID: 1) - Primary EVM L1 */
     ETHEREUM = "ETHEREUM",
+    /** Polygon PoS (Chain ID: 137) - EVM sidechain for Ethereum */
     POLYGON = "POLYGON",
+    /** Arbitrum One (Chain ID: 42161) - Optimistic rollup L2 for Ethereum */
     ARBITRUM = "ARBITRUM",
+    /** Optimism (Chain ID: 10) - Optimistic rollup L2 for Ethereum */
     OPTIMISM = "OPTIMISM",
+    /** Avalanche C-Chain (Chain ID: 43114) - EVM-compatible L1 */
     AVALANCHE = "AVALANCHE",
+    /** Binance Smart Chain (Chain ID: 56) - EVM-compatible chain */
     BSC = "BSC",
+    /** Base (Chain ID: 8453) - Coinbase's Optimistic rollup L2 */
+    BASE = "BASE",
+    /** Solana mainnet - High-performance L1, non-EVM */
     SOLANA = "SOLANA",
+    /** SUI mainnet - Move-based L1, non-EVM */
     SUI = "SUI",
+    /** Bitcoin mainnet - Original blockchain, UTXO model */
     BITCOIN = "BITCOIN",
+    /**
+     * Unsupported or emerging chains.
+     *
+     * Use for chains not yet explicitly enumerated. Store actual chain
+     * identifier in asset metadata for future classification.
+     */
     OTHER = "OTHER"
 }

package/dist/enums/Chain.js

@@ -1,13 +1,70 @@
+/**
+ * Blockchain network identifiers for multi-chain asset tracking.
+ *
+ * Provides standardized identifiers for all supported blockchain networks.
+ * Enables consistent asset identification across EVM chains, alternative L1s,
+ * and traditional finance systems.
+ *
+ * **Design Rationale:**
+ * - Covers major EVM chains (Ethereum, Polygon, Arbitrum, Optimism, Avalanche, BSC, Base)
+ * - Includes alternative L1s (Solana, SUI, Bitcoin)
+ * - Extensible via OTHER for new chains without breaking changes
+ * - Chain-agnostic operations use Chain type for abstraction
+ *
+ * **Integration Guidance:**
+ * - Map chain IDs (1, 137, 42161) to these enum values in integration domains
+ * - Use Chain.OTHER for unsupported chains, document actual chain in metadata
+ * - Testnets should be distinguished in metadata, not separate enum values
+ *
+ * @example
+ * ```typescript
+ * function getChainFromId(chainId: number): Chain {
+ *   const chainMap: Record<number, Chain> = {
+ *     1: Chain.ETHEREUM,
+ *     137: Chain.POLYGON,
+ *     42161: Chain.ARBITRUM,
+ *     10: Chain.OPTIMISM,
+ *     43114: Chain.AVALANCHE,
+ *     56: Chain.BSC,
+ *     8453: Chain.BASE
+ *   };
+ *   return chainMap[chainId] || Chain.OTHER;
+ * }
+ * ```
+ *
+ * @since 0.0.1
+ * @stability core
+ *
+ * @see {@link Asset} for usage in asset identification
+ * @see {@link Transaction} for usage in transaction tracking
+ */
 export var Chain;
 (function (Chain) {
+    /** Ethereum mainnet (Chain ID: 1) - Primary EVM L1 */
     Chain["ETHEREUM"] = "ETHEREUM";
+    /** Polygon PoS (Chain ID: 137) - EVM sidechain for Ethereum */
     Chain["POLYGON"] = "POLYGON";
+    /** Arbitrum One (Chain ID: 42161) - Optimistic rollup L2 for Ethereum */
     Chain["ARBITRUM"] = "ARBITRUM";
+    /** Optimism (Chain ID: 10) - Optimistic rollup L2 for Ethereum */
     Chain["OPTIMISM"] = "OPTIMISM";
+    /** Avalanche C-Chain (Chain ID: 43114) - EVM-compatible L1 */
     Chain["AVALANCHE"] = "AVALANCHE";
+    /** Binance Smart Chain (Chain ID: 56) - EVM-compatible chain */
     Chain["BSC"] = "BSC";
+    /** Base (Chain ID: 8453) - Coinbase's Optimistic rollup L2 */
+    Chain["BASE"] = "BASE";
+    /** Solana mainnet - High-performance L1, non-EVM */
     Chain["SOLANA"] = "SOLANA";
+    /** SUI mainnet - Move-based L1, non-EVM */
     Chain["SUI"] = "SUI";
+    /** Bitcoin mainnet - Original blockchain, UTXO model */
     Chain["BITCOIN"] = "BITCOIN";
+    /**
+     * Unsupported or emerging chains.
+     *
+     * Use for chains not yet explicitly enumerated. Store actual chain
+     * identifier in asset metadata for future classification.
+     */
     Chain["OTHER"] = "OTHER";
 })(Chain || (Chain = {}));

package/dist/enums/IntegrationSource.d.ts

@@ -1,18 +1,65 @@
+/**
+ * Data source identifiers for integration traceability.
+ *
+ * Tracks origin of data flowing through the system, enabling source-specific
+ * logic, validation, and troubleshooting. This comprehensive enum covers centralized
+ * exchanges (CEXs), decentralized exchanges (DEXs), wallet providers, and manual entries.
+ *
+ * @example
+ * ```typescript
+ * import { IntegrationSource } from '@cygnus-wealth/data-models';
+ *
+ * // Identify data source for routing logic
+ * function processAccountData(source: IntegrationSource) {
+ *   switch(source) {
+ *     case IntegrationSource.ROBINHOOD:
+ *       return fetchCEXData();
+ *     case IntegrationSource.UNISWAP:
+ *       return fetchDEXData();
+ *     case IntegrationSource.METAMASK:
+ *       return fetchWalletData();
+ *     default:
+ *       return fetchGenericData();
+ *   }
+ * }
+ * ```
+ *
+ * @since 0.0.1
+ * @stability standard
+ */
 export declare enum IntegrationSource {
+    /** Robinhood centralized exchange */
     ROBINHOOD = "ROBINHOOD",
+    /** Kraken centralized exchange */
     KRAKEN = "KRAKEN",
+    /** Coinbase centralized exchange */
     COINBASE = "COINBASE",
+    /** Binance centralized exchange */
     BINANCE = "BINANCE",
+    /** Uniswap decentralized exchange */
     UNISWAP = "UNISWAP",
+    /** SushiSwap decentralized exchange */
     SUSHISWAP = "SUSHISWAP",
+    /** PancakeSwap decentralized exchange */
     PANCAKESWAP = "PANCAKESWAP",
+    /** Curve Finance decentralized exchange */
     CURVE = "CURVE",
+    /** Balancer decentralized exchange */
     BALANCER = "BALANCER",
+    /** MetaMask wallet provider */
     METAMASK = "METAMASK",
+    /** Rabby wallet provider */
     RABBY = "RABBY",
+    /** Phantom wallet provider (Solana) */
     PHANTOM = "PHANTOM",
+    /** Slush wallet provider (SUI) */
     SLUSH = "SLUSH",
+    /** Suiet wallet provider (SUI) */
+    SUIET = "SUIET",
+    /** Manually entered data by user */
     MANUAL_ENTRY = "MANUAL_ENTRY",
+    /** Data fetched directly from blockchain via RPC */
     BLOCKCHAIN_DIRECT = "BLOCKCHAIN_DIRECT",
+    /** Other or unclassified data source */
     OTHER = "OTHER"
 }

package/dist/enums/IntegrationSource.js

@@ -1,23 +1,66 @@
+/**
+ * Data source identifiers for integration traceability.
+ *
+ * Tracks origin of data flowing through the system, enabling source-specific
+ * logic, validation, and troubleshooting. This comprehensive enum covers centralized
+ * exchanges (CEXs), decentralized exchanges (DEXs), wallet providers, and manual entries.
+ *
+ * @example
+ * ```typescript
+ * import { IntegrationSource } from '@cygnus-wealth/data-models';
+ *
+ * // Identify data source for routing logic
+ * function processAccountData(source: IntegrationSource) {
+ *   switch(source) {
+ *     case IntegrationSource.ROBINHOOD:
+ *       return fetchCEXData();
+ *     case IntegrationSource.UNISWAP:
+ *       return fetchDEXData();
+ *     case IntegrationSource.METAMASK:
+ *       return fetchWalletData();
+ *     default:
+ *       return fetchGenericData();
+ *   }
+ * }
+ * ```
+ *
+ * @since 0.0.1
+ * @stability standard
+ */
 export var IntegrationSource;
 (function (IntegrationSource) {
-    // CEXs
+    /** Robinhood centralized exchange */
     IntegrationSource["ROBINHOOD"] = "ROBINHOOD";
+    /** Kraken centralized exchange */
     IntegrationSource["KRAKEN"] = "KRAKEN";
+    /** Coinbase centralized exchange */
     IntegrationSource["COINBASE"] = "COINBASE";
+    /** Binance centralized exchange */
     IntegrationSource["BINANCE"] = "BINANCE";
-    // DEXs
+    /** Uniswap decentralized exchange */
     IntegrationSource["UNISWAP"] = "UNISWAP";
+    /** SushiSwap decentralized exchange */
     IntegrationSource["SUSHISWAP"] = "SUSHISWAP";
+    /** PancakeSwap decentralized exchange */
     IntegrationSource["PANCAKESWAP"] = "PANCAKESWAP";
+    /** Curve Finance decentralized exchange */
     IntegrationSource["CURVE"] = "CURVE";
+    /** Balancer decentralized exchange */
     IntegrationSource["BALANCER"] = "BALANCER";
-    // Wallets
+    /** MetaMask wallet provider */
     IntegrationSource["METAMASK"] = "METAMASK";
+    /** Rabby wallet provider */
     IntegrationSource["RABBY"] = "RABBY";
+    /** Phantom wallet provider (Solana) */
     IntegrationSource["PHANTOM"] = "PHANTOM";
+    /** Slush wallet provider (SUI) */
     IntegrationSource["SLUSH"] = "SLUSH";
-    // Other
+    /** Suiet wallet provider (SUI) */
+    IntegrationSource["SUIET"] = "SUIET";
+    /** Manually entered data by user */
     IntegrationSource["MANUAL_ENTRY"] = "MANUAL_ENTRY";
+    /** Data fetched directly from blockchain via RPC */
     IntegrationSource["BLOCKCHAIN_DIRECT"] = "BLOCKCHAIN_DIRECT";
+    /** Other or unclassified data source */
     IntegrationSource["OTHER"] = "OTHER";
 })(IntegrationSource || (IntegrationSource = {}));

package/dist/enums/LendingPositionType.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Type of lending position: supply (lender) or borrow (borrower).
+ *
+ * Discriminates between assets deposited to earn interest (SUPPLY) and
+ * assets borrowed while paying interest (BORROW) in DeFi lending protocols.
+ *
+ * @example
+ * ```typescript
+ * import { LendingPositionType } from '@cygnus-wealth/data-models';
+ *
+ * const supplyType = LendingPositionType.SUPPLY;
+ * const borrowType = LendingPositionType.BORROW;
+ * ```
+ *
+ * @since 0.2.0
+ * @stability core
+ *
+ * @see {@link LendingPosition} for usage in lending positions
+ */
+export declare enum LendingPositionType {
+    /** User supplied assets earning interest (lender) */
+    SUPPLY = "SUPPLY",
+    /** User borrowed assets paying interest (borrower) */
+    BORROW = "BORROW"
+}

package/dist/enums/LendingPositionType.js

@@ -0,0 +1,26 @@
+/**
+ * Type of lending position: supply (lender) or borrow (borrower).
+ *
+ * Discriminates between assets deposited to earn interest (SUPPLY) and
+ * assets borrowed while paying interest (BORROW) in DeFi lending protocols.
+ *
+ * @example
+ * ```typescript
+ * import { LendingPositionType } from '@cygnus-wealth/data-models';
+ *
+ * const supplyType = LendingPositionType.SUPPLY;
+ * const borrowType = LendingPositionType.BORROW;
+ * ```
+ *
+ * @since 0.2.0
+ * @stability core
+ *
+ * @see {@link LendingPosition} for usage in lending positions
+ */
+export var LendingPositionType;
+(function (LendingPositionType) {
+    /** User supplied assets earning interest (lender) */
+    LendingPositionType["SUPPLY"] = "SUPPLY";
+    /** User borrowed assets paying interest (borrower) */
+    LendingPositionType["BORROW"] = "BORROW";
+})(LendingPositionType || (LendingPositionType = {}));

package/dist/enums/TransactionType.d.ts

@@ -1,21 +1,71 @@
+/**
+ * Standardized transaction type classification.
+ *
+ * Unified categorization for all financial operations across CEX, DEX,
+ * blockchain transfers, and DeFi protocols. Enables consistent transaction
+ * history and analytics across all integration sources.
+ *
+ * @example
+ * ```typescript
+ * import { TransactionType } from '@cygnus-wealth/data-models';
+ *
+ * // Classify transaction based on operation
+ * function getTransactionIcon(type: TransactionType): string {
+ *   switch(type) {
+ *     case TransactionType.BUY:
+ *       return '📈';
+ *     case TransactionType.SELL:
+ *       return '📉';
+ *     case TransactionType.STAKE:
+ *       return '🔒';
+ *     case TransactionType.SWAP:
+ *       return '🔄';
+ *     default:
+ *       return '📄';
+ *   }
+ * }
+ * ```
+ *
+ * @since 0.0.1
+ * @stability standard
+ */
 export declare enum TransactionType {
+    /** Purchase of an asset with fiat or another asset */
     BUY = "BUY",
+    /** Sale of an asset for fiat or another asset */
     SELL = "SELL",
+    /** Incoming transfer of assets to account */
     TRANSFER_IN = "TRANSFER_IN",
+    /** Outgoing transfer of assets from account */
     TRANSFER_OUT = "TRANSFER_OUT",
+    /** Exchange of one asset for another via DEX or CEX */
     SWAP = "SWAP",
+    /** Locking assets for staking rewards */
     STAKE = "STAKE",
+    /** Unlocking previously staked assets */
     UNSTAKE = "UNSTAKE",
+    /** Claiming earned staking or liquidity rewards */
     CLAIM_REWARD = "CLAIM_REWARD",
+    /** Adding assets to a liquidity pool */
     PROVIDE_LIQUIDITY = "PROVIDE_LIQUIDITY",
+    /** Removing assets from a liquidity pool */
     REMOVE_LIQUIDITY = "REMOVE_LIQUIDITY",
+    /** Borrowing assets from a lending protocol */
     BORROW = "BORROW",
+    /** Repaying borrowed assets to a lending protocol */
     REPAY = "REPAY",
+    /** Forced liquidation of collateralized position */
     LIQUIDATION = "LIQUIDATION",
+    /** Creation of new tokens (NFT minting, token minting) */
     MINT = "MINT",
+    /** Destruction of tokens */
     BURN = "BURN",
+    /** Transaction fee payment */
     FEE = "FEE",
+    /** Dividend payment received */
     DIVIDEND = "DIVIDEND",
+    /** Interest payment received or paid */
     INTEREST = "INTEREST",
+    /** Other or unclassified transaction type */
     OTHER = "OTHER"
 }