CfdTypes

Git Source

Title: CfdTypes

Core data structures for the Plether CFD Engine

Note: security-contact: contact@plether.com

Structs

Position

A user’s active position in a specific market.

margin is the engine’s canonical economic position-margin state used for risk and state transitions. It is intentionally distinct from the clearinghouse custody bucket that holds the locked funds backing it.

struct Position {
    uint256 size; // [18 dec] Notional size in synthetic tokens
    uint256 margin; // [6 dec] Isolated margin backing this position
    uint256 entryPrice; // [8 dec] Oracle price of BEAR at execution
    uint256 maxProfitUsdc; // [6 dec] Cumulative max profit tracked to avoid truncation underflow
    int256 entryFundingIndex; // [18 dec WAD] Global funding index at the time of entry
    Side side; // [uint8] Trade direction
    uint64 lastUpdateTime; // [uint64] Timestamp of last modification
    int256 vpiAccrued; // [6 dec] Cumulative VPI charges (+) and rebates (-) across the position's lifetime
}

Order

An intent submitted by a user, waiting for Keeper execution

struct Order {
    bytes32 accountId; // Maps to MarginClearinghouse unified account
    uint256 sizeDelta; // [18 dec] Amount of size to add/remove
    uint256 marginDelta; // [6 dec] Amount of margin to add/remove
    uint256 targetPrice; // [8 dec] Slippage protection limit
    uint64 commitTime; // Timestamp of intent submission (MEV shield)
    uint64 commitBlock; // Block number of intent submission (same-block execution shield)
    uint64 orderId; // Strict FIFO execution queue ID
    Side side; // [uint8] BULL or BEAR
    bool isClose; // [bool] True if strictly closing/reducing
}

RiskParams

Global configuration parameters for the VPI and Funding engines

struct RiskParams {
    uint256 vpiFactor; // [18 dec WAD] Impact severity 'k'
    uint256 maxSkewRatio; // [18 dec WAD] Hard cliff e.g., 40% (0.40e18)
    uint256 kinkSkewRatio; // [18 dec WAD] Inflection point e.g., 25% (0.25e18)
    uint256 baseApy; // [18 dec WAD] Rate at the kink e.g., 15% (0.15e18)
    uint256 maxApy; // [18 dec WAD] Rate at the wall e.g., 300% (3.00e18)
    uint256 maintMarginBps; // e.g., 100 (1%)
    uint256 initMarginBps; // e.g., 150 (1.5%)
    uint256 fadMarginBps; // e.g., 300 (3%)
    uint256 minBountyUsdc; // e.g., 5_000_000 ($5 USDC floor)
    uint256 bountyBps; // e.g., 15 (0.15% of Notional Size)
}

Enums

Side

BULL profits when USD strengthens (oracle price drops). BEAR profits when USD weakens (oracle price rises).

enum Side {
    BULL,
    BEAR
}

CloseInvalidReason

enum CloseInvalidReason {
    None,
    NoPosition,
    BadSize,
    PartialCloseUnderwater,
    DustPosition
}