@kehtus/proportion-sdk 0.1.0

package/dist/types.d.ts

@@ -0,0 +1,384 @@
+import type { Address, WalletClient } from "viem";
+import type { ADDRESSES } from "./constants.js";
+export interface SDKConfig {
+    rpcUrl?: string;
+    graphqlUrl: string;
+    graphqlWsUrl?: string;
+    walletClient?: WalletClient;
+    fetchFn?: typeof fetch;
+    webSocketCtor?: WebSocketConstructor;
+    addresses?: Partial<typeof ADDRESSES>;
+}
+export interface WebSocketLike {
+    readyState: number;
+    send(data: string): void;
+    close(): void;
+    onopen: ((this: unknown, ...args: unknown[]) => unknown) | null;
+    onmessage: ((this: unknown, event: {
+        data: unknown;
+    }, ...args: unknown[]) => unknown) | null;
+    onclose: ((this: unknown, ...args: unknown[]) => unknown) | null;
+    onerror: ((this: unknown, ...args: unknown[]) => unknown) | null;
+}
+export interface WebSocketConstructor {
+    new (url: string, protocols?: string | string[]): WebSocketLike;
+    readonly OPEN: number;
+}
+export declare enum AccountState {
+    Uninitialized = 0,
+    Initialized = 1,
+    Active = 2,
+    WithdrawalPending = 3,
+    Closing = 4,
+    Returning = 5,
+    Closed = 6
+}
+export type AccountStateLabel = "UNINITIALIZED" | "INITIALIZED" | "ACTIVE" | "WITHDRAWAL_PENDING" | "CLOSING" | "RETURNING" | "CLOSED";
+export type IndexerAccountStateLabel = "INITIALIZED" | "ACTIVE" | "WITHDRAWAL_PENDING" | "CLOSING" | "RETURNING" | "CLOSED";
+export type BreachType = "TRAILING_DRAWDOWN" | "DAILY_DRAWDOWN" | "LEVERAGE" | "POSITION_LEVERAGE" | "UNAUTHORIZED_ASSET" | "SUBSCRIPTION_EXPIRED";
+export interface VaultStats {
+    totalAssets: bigint;
+    sharePrice: bigint;
+    utilizationBps: bigint;
+    availableForAllocation: bigint;
+    maxAccountSize: bigint;
+    remainingCap: bigint;
+    paused: boolean;
+    feeMultiplier: number;
+    subscriptionFeeMultiplier: number;
+    totalShares: bigint;
+    totalAllocated: bigint;
+    owner: Address;
+    pendingOwner: Address;
+    relayer: Address;
+    protocolFeeReceiver: Address;
+    maxCap: bigint;
+    hypeForSpot: bigint;
+    factory: Address;
+    minBuilderShares: bigint;
+    builderLeverage: bigint;
+    protocolFeeBps: bigint;
+    minAccountSize: bigint;
+    maxAccountSizeLimit: bigint;
+    minDrawdownBps: number;
+    maxDrawdownBps: number;
+    maxUtilizationBps: bigint;
+    maxSingleAccountBps: bigint;
+    dailyDdDiscountBps: number;
+}
+export interface LPPosition {
+    shares: bigint;
+    sharesValue: bigint;
+    withdrawableShares: bigint;
+}
+export interface BuilderInfo {
+    active: boolean;
+    activeFunded: bigint;
+    availableFunded: bigint;
+}
+export interface AccountDetails {
+    address: Address;
+    state: AccountState;
+    owner: Address;
+    builder: Address;
+    accountSize: bigint;
+    drawdownBps: number;
+    dailyDrawdownEnabled: boolean;
+    subscriptionFeeMultiplier: number;
+    highWaterMark: bigint;
+    dayStartValue: bigint;
+    activatedAt: bigint;
+    subscriptionPaidUntil: bigint;
+    subscriptionCancelled: boolean;
+    pendingSubscriptionFee: bigint;
+    apiWallet: Address;
+    riskEngineWallet: Address;
+    builderRiskEngineWallet: Address;
+    checkpointIndex: number;
+    totalCheckpoints: number;
+    profitableDaysCount: number;
+    lastCheckpointDay: bigint;
+    closingInitiatedAt: number;
+    returnInitiatedAt: number;
+    pendingWithdrawal: {
+        profit: bigint;
+        requestedAt: number;
+    };
+    trailingFloor: bigint;
+    dailyFloor: bigint;
+    subscriptionFee: bigint;
+    isSubscriptionActive: boolean;
+    canWithdrawProfit: boolean;
+    checkpoints: Array<{
+        accountValue: bigint;
+        timestamp: number;
+        profitable: boolean;
+    }>;
+}
+export interface GqlVault {
+    id: string;
+    address: string;
+    totalDeposits: string;
+    totalWithdrawals: string;
+    totalActivationFees: string;
+    cumulativeActivationFeesToVault: string;
+    totalAllocated: string;
+    totalShares: string;
+    cumulativeProfitShares: string;
+    cumulativeCancelledProfit: string;
+    cumulativeSubscriptionFees: string;
+    cumulativeProtocolFeesRouted: string;
+    cumulativeHypercoreFees: string;
+    cumulativeAccountGains: string;
+    cumulativeAccountLosses: string;
+    cumulativeRescuedFunds: string;
+    totalAccountsActivated: number;
+    totalAccountsActive: number;
+    totalAccountsClosed: number;
+    paused: boolean;
+    subscriptionFeeMultiplier: number;
+    protocolFeeBps: number;
+    protocolFeeReceiver: string | null;
+    updatedAt: string;
+}
+export interface GqlLP {
+    id: string;
+    totalDeposited: string;
+    totalWithdrawn: string;
+    depositCount: number;
+    withdrawCount: number;
+    lastActionAt: string;
+}
+export interface GqlBuilder {
+    id: string;
+    address: string;
+    vaultAddress: string;
+    active: boolean;
+    totalAccountsActivated: number;
+    totalAccountsClosed: number;
+    activeAccounts: number;
+    registeredAt: string;
+    deactivatedAt: string | null;
+}
+export interface GqlAccount {
+    id: string;
+    owner: string;
+    builder: {
+        id: string;
+        address: string;
+        vaultAddress: string;
+    };
+    vaultAddress: string;
+    factoryAddress: string;
+    state: IndexerAccountStateLabel;
+    accountSize: string;
+    drawdownBps: number;
+    dailyDrawdownEnabled: boolean;
+    activationFee: string;
+    highWaterMark: string;
+    profitableDaysCount: number;
+    lastCheckpointDay: string;
+    totalCheckpoints: number;
+    subscriptionPaidUntil: string;
+    subscriptionCancelled: boolean;
+    pendingSubscriptionFee: string;
+    subscriptionFeeMultiplier: number;
+    dayStartValue: string;
+    apiWallet: string | null;
+    riskEngineWallet: string | null;
+    builderRiskEngineWallet: string | null;
+    createdAt: string;
+    activatedAt: string | null;
+    closingInitiatedAt: string | null;
+    returnInitiatedAt: string | null;
+    closedAt: string | null;
+    returnedAmount: string | null;
+    breachType: BreachType | null;
+    breachValue: string | null;
+    breachFloor: string | null;
+    closePendingSubFee: string | null;
+    closePendingProfit: string | null;
+    lastWithdrawalId: string | null;
+    updatedAt: string;
+}
+export interface GqlCheckpoint {
+    id: string;
+    dayNumber: string;
+    accountValue: string;
+    previousValue: string;
+    profitable: boolean;
+    profitableDaysCount: number;
+    timestamp: string;
+}
+export interface GqlProfitWithdrawal {
+    id: string;
+    profit: string;
+    ownerAmount: string;
+    vaultAmount: string;
+    protocolAmount: string;
+    status: "REQUESTED" | "CLAIMED" | "CANCELLED";
+    requestedAt: string;
+    claimedAt: string | null;
+    cancelledAt: string | null;
+}
+export interface GqlSubscriptionPayment {
+    id: string;
+    amount: string;
+    paidUntil: string;
+    timestamp: string;
+}
+export interface GqlDeposit {
+    id: string;
+    lp: {
+        id: string;
+    };
+    amount: string;
+    sharesReceived: string;
+    timestamp: string;
+    blockNumber?: number;
+    txHash: string;
+}
+export interface GqlWithdrawal {
+    id: string;
+    lp: {
+        id: string;
+    };
+    amount: string;
+    sharesBurned: string;
+    timestamp: string;
+    blockNumber?: number;
+    txHash: string;
+}
+export interface GqlAccountEvent {
+    id: string;
+    eventType: string;
+    data: string;
+    timestamp: string;
+    blockNumber: number;
+    txHash: string;
+}
+export interface GqlAllowedPerp {
+    id: string;
+    vaultAddress: string;
+    perpIndex: number;
+    allowed: boolean;
+}
+export interface GqlDelegate {
+    id: string;
+    vaultAddress: string;
+    delegateAddress: string;
+    builderAddress: string;
+}
+export interface GqlProtocolConfig {
+    id: string;
+    vaultAddress: string;
+    factoryAddress: string;
+    updatedAt: string;
+}
+export type GqlConfigContractType = "MainVault" | "FundedAccountFactory";
+export interface GqlMainVaultConfig {
+    id: string;
+    vaultAddress: string;
+    factoryAddress: string;
+    owner: string;
+    pendingOwner: string;
+    relayer: string;
+    paused: boolean;
+    protocolFeeReceiver: string;
+    feeMultiplier: number;
+    subscriptionFeeMultiplier: number;
+    dailyDdDiscountBps: number;
+    minBuilderShares: string;
+    builderLeverage: string;
+    protocolFeeBps: number;
+    minAccountSize: string;
+    maxAccountSize: string;
+    minDrawdownBps: number;
+    maxDrawdownBps: number;
+    maxUtilizationBps: number;
+    maxSingleAccountBps: number;
+    hypeForSpot: string;
+    maxCap: string;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface GqlFactoryConfig {
+    id: string;
+    factoryAddress: string;
+    vaultAddress: string;
+    owner: string;
+    pendingOwner: string;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface GqlConfigChange {
+    id: string;
+    contractAddress: string;
+    contractType: GqlConfigContractType;
+    field: string;
+    oldValue: string;
+    newValue: string;
+    blockNumber: number;
+    timestamp: string;
+    txHash: string;
+}
+export interface GqlVaultDayData {
+    id: string;
+    date: number;
+    dayNumber: number;
+    evmBalance: string;
+    totalAllocated: string;
+    totalAssets: string;
+    totalShares: string;
+    sharePrice: string;
+    dailyDeposits: string;
+    dailyWithdrawals: string;
+    dailyNetLpFlow: string;
+    dailyActivationFees: string;
+    dailyActivationFeesToVault: string;
+    dailyProfitShares: string;
+    dailyCancelledProfit: string;
+    dailySubscriptionFees: string;
+    dailyProtocolFeesRouted: string;
+    dailyHypercoreFees: string;
+    dailyRescuedFunds: string;
+    dailyAccountReturnAmount: string;
+    dailyAccountPrincipalReturned: string;
+    dailyAccountGains: string;
+    dailyAccountLosses: string;
+    dailyPerformancePnl: string;
+    totalAccountsActivated: number;
+    totalAccountsActive: number;
+    totalAccountsClosed: number;
+    accountsActivatedToday: number;
+    accountsClosedToday: number;
+    navChange24h: string;
+    sharePriceChange24h: string;
+    return24hBps: number;
+    paused: boolean;
+    updatedAt: string;
+}
+export interface GqlLiquidityProviderDayData {
+    id: string;
+    lp: {
+        id: string;
+    };
+    date: number;
+    dayNumber: number;
+    shares: string;
+    sharesValue: string;
+    dailyDeposits: string;
+    dailyWithdrawals: string;
+    depositCount: number;
+    withdrawCount: number;
+}
+export interface Pagination {
+    limit?: number;
+    offset?: number;
+}
+export interface ConfigChangeFilters extends Pagination {
+    contractAddress?: string;
+    contractType?: GqlConfigContractType;
+    field?: string;
+}
+export type Unsubscribe = () => void;

package/dist/types.js

@@ -0,0 +1,11 @@
+// ── Enums ───────────────────────────────────────────
+export var AccountState;
+(function (AccountState) {
+    AccountState[AccountState["Uninitialized"] = 0] = "Uninitialized";
+    AccountState[AccountState["Initialized"] = 1] = "Initialized";
+    AccountState[AccountState["Active"] = 2] = "Active";
+    AccountState[AccountState["WithdrawalPending"] = 3] = "WithdrawalPending";
+    AccountState[AccountState["Closing"] = 4] = "Closing";
+    AccountState[AccountState["Returning"] = 5] = "Returning";
+    AccountState[AccountState["Closed"] = 6] = "Closed";
+})(AccountState || (AccountState = {}));

package/dist/utils.d.ts

@@ -0,0 +1,21 @@
+import { AccountState, type AccountStateLabel } from "./types.js";
+export declare function fromUsdc(amount: bigint): number;
+export declare function toUsdc(amount: number): bigint;
+export declare function from8Dec(value: bigint): number;
+export declare function toUsdc6(value8dec: bigint): bigint;
+export declare function to8Dec(value6dec: bigint): bigint;
+export declare function formatUsd(amount: bigint, dec?: number): string;
+export declare function trailingFloor(hwm: bigint, drawdownBps: number): bigint;
+export declare function dailyFloor(dayStartValue: bigint, drawdownBps: number): bigint;
+export declare function isTrailingBreached(value: bigint, hwm: bigint, bps: number): boolean;
+export declare function isDailyBreached(value: bigint, dsv: bigint, bps: number): boolean;
+export declare function activationFee(accountSize: bigint, drawdownBps: number, dailyDD: boolean, feeMultiplier?: number, dailyDdDiscountBps?: number): bigint;
+export declare function subscriptionFee(accountSize: bigint, subFeeMultiplier: number): bigint;
+export declare function subscriptionFee(accountSize: bigint, _drawdownBps: number, _dailyDD: boolean, subFeeMultiplier: number): bigint;
+export declare function splitProfit(profit: bigint): {
+    owner: bigint;
+    vault: bigint;
+    protocol: bigint;
+};
+export declare function stateToLabel(state: AccountState): AccountStateLabel;
+export declare function labelToState(label: AccountStateLabel): AccountState;

package/dist/utils.js

@@ -0,0 +1,89 @@
+import { BPS, DAILY_DD_DISCOUNT_BPS, DECIMALS_MULTIPLIER, OWNER_PROFIT_BPS, PROTOCOL_PROFIT_BPS, USDC_DECIMALS, } from "./constants.js";
+import { AccountState } from "./types.js";
+// ── Decimals ────────────────────────────────────────
+export function fromUsdc(amount) {
+    return Number(amount) / 10 ** USDC_DECIMALS;
+}
+export function toUsdc(amount) {
+    return BigInt(Math.round(amount * 10 ** USDC_DECIMALS));
+}
+export function from8Dec(value) {
+    return Number(value) / 1e8;
+}
+export function toUsdc6(value8dec) {
+    return value8dec / DECIMALS_MULTIPLIER;
+}
+export function to8Dec(value6dec) {
+    return value6dec * DECIMALS_MULTIPLIER;
+}
+export function formatUsd(amount, dec = USDC_DECIMALS) {
+    const num = Number(amount) / 10 ** dec;
+    return "$" + num.toLocaleString("en-US", { minimumFractionDigits: 2, maximumFractionDigits: 2 });
+}
+// ── Drawdown ────────────────────────────────────────
+export function trailingFloor(hwm, drawdownBps) {
+    return hwm - (hwm * BigInt(drawdownBps)) / BPS;
+}
+export function dailyFloor(dayStartValue, drawdownBps) {
+    const dailyBps = BigInt(drawdownBps) / 2n;
+    return dayStartValue - (dayStartValue * dailyBps) / BPS;
+}
+export function isTrailingBreached(value, hwm, bps) {
+    return value < trailingFloor(hwm, bps);
+}
+export function isDailyBreached(value, dsv, bps) {
+    return value < dailyFloor(dsv, bps);
+}
+// ── Fees ────────────────────────────────────────────
+const FEE_DIVISOR = 1000000n;
+const USDC_UNIT = 1000000n;
+function roundUpUsdc(fee) {
+    return ((fee + USDC_UNIT - 1n) / USDC_UNIT) * USDC_UNIT;
+}
+function applyDailyDiscount(fee, discountBps) {
+    return (fee * (BPS - discountBps)) / BPS;
+}
+export function activationFee(accountSize, drawdownBps, dailyDD, feeMultiplier = 120, dailyDdDiscountBps = Number(DAILY_DD_DISCOUNT_BPS)) {
+    let fee = (accountSize * BigInt(drawdownBps) * BigInt(feeMultiplier)) / FEE_DIVISOR;
+    if (dailyDD) {
+        fee = applyDailyDiscount(fee, BigInt(dailyDdDiscountBps));
+    }
+    return roundUpUsdc(fee);
+}
+export function subscriptionFee(accountSize, a, _b, c) {
+    const subFeeMultiplier = c ?? a;
+    const fee = (accountSize * BigInt(subFeeMultiplier)) / BPS;
+    return roundUpUsdc(fee);
+}
+// ── Profit split ────────────────────────────────────
+export function splitProfit(profit) {
+    const owner = (profit * OWNER_PROFIT_BPS) / BPS;
+    const protocol = (profit * PROTOCOL_PROFIT_BPS) / BPS;
+    const vault = profit - owner - protocol;
+    return { owner, vault, protocol };
+}
+// ── Enum mapping ────────────────────────────────────
+const stateLabels = {
+    [AccountState.Uninitialized]: "UNINITIALIZED",
+    [AccountState.Initialized]: "INITIALIZED",
+    [AccountState.Active]: "ACTIVE",
+    [AccountState.WithdrawalPending]: "WITHDRAWAL_PENDING",
+    [AccountState.Closing]: "CLOSING",
+    [AccountState.Returning]: "RETURNING",
+    [AccountState.Closed]: "CLOSED",
+};
+const labelStates = {
+    UNINITIALIZED: AccountState.Uninitialized,
+    INITIALIZED: AccountState.Initialized,
+    ACTIVE: AccountState.Active,
+    WITHDRAWAL_PENDING: AccountState.WithdrawalPending,
+    CLOSING: AccountState.Closing,
+    RETURNING: AccountState.Returning,
+    CLOSED: AccountState.Closed,
+};
+export function stateToLabel(state) {
+    return stateLabels[state];
+}
+export function labelToState(label) {
+    return labelStates[label];
+}

package/dist/vault.d.ts

@@ -0,0 +1,60 @@
+import type { Address, Chain, Hash, PublicClient, WalletClient } from "viem";
+import type { BuilderInfo, LPPosition, VaultStats } from "./types.js";
+export declare class VaultModule {
+    private publicClient;
+    private walletClient;
+    private chain;
+    private addresses;
+    constructor(publicClient: PublicClient, walletClient: WalletClient | undefined, chain: Chain, addresses: {
+        vault: Address;
+        usdc: Address;
+    });
+    getStats(): Promise<VaultStats>;
+    getLPPosition(account: Address): Promise<LPPosition>;
+    getBuilderInfo(builder: Address): Promise<BuilderInfo>;
+    getAllowedPerps(): Promise<number[]>;
+    isAllowedPerp(index: number): Promise<boolean>;
+    calculateFee(size: bigint, bps: number, dailyDD: boolean): Promise<bigint>;
+    isPaused(): Promise<boolean>;
+    getRemainingCap(): Promise<bigint>;
+    isFundedAccount(account: Address): Promise<boolean>;
+    getDelegateBuilder(delegate: Address): Promise<Address>;
+    private requireWallet;
+    private write;
+    deposit(amount: bigint): Promise<Hash>;
+    withdraw(shares: bigint): Promise<Hash>;
+    approveUsdc(amount: bigint): Promise<Hash>;
+    registerBuilder(): Promise<Hash>;
+    setDelegate(delegate: Address): Promise<Hash>;
+    removeDelegate(delegate: Address): Promise<Hash>;
+    activateFunded(p: {
+        trader: Address;
+        accountSize: bigint;
+        drawdownBps: number;
+        dailyDrawdownEnabled: boolean;
+        hypeValue?: bigint;
+    }): Promise<Hash>;
+    pause(): Promise<Hash>;
+    unpause(): Promise<Hash>;
+    addAllowedPerp(index: number): Promise<Hash>;
+    removeAllowedPerp(index: number): Promise<Hash>;
+    setRelayer(addr: Address): Promise<Hash>;
+    setFactory(addr: Address): Promise<Hash>;
+    setProtocolFeeReceiver(addr: Address): Promise<Hash>;
+    transferOwnership(newOwner: Address): Promise<Hash>;
+    acceptOwnership(): Promise<Hash>;
+    setFeeMultiplier(value: number): Promise<Hash>;
+    setSubscriptionFeeMultiplier(value: number): Promise<Hash>;
+    setHypeForSpot(value: bigint): Promise<Hash>;
+    setMaxCap(value: bigint): Promise<Hash>;
+    setMinBuilderShares(value: bigint): Promise<Hash>;
+    setBuilderLeverage(value: bigint): Promise<Hash>;
+    setProtocolFeeBps(value: bigint): Promise<Hash>;
+    setMinAccountSize(value: bigint): Promise<Hash>;
+    setMaxAccountSize(value: bigint): Promise<Hash>;
+    setMinDrawdownBps(value: number): Promise<Hash>;
+    setMaxDrawdownBps(value: number): Promise<Hash>;
+    setMaxUtilizationBps(value: bigint): Promise<Hash>;
+    setMaxSingleAccountBps(value: bigint): Promise<Hash>;
+    setDailyDdDiscountBps(value: number): Promise<Hash>;
+}