@kehtus/proportion-sdk 0.1.0

package/src/__tests__/utils.test.ts

@@ -0,0 +1,245 @@
+import { describe, it, expect } from "vitest";
+import {
+  activationFee,
+  subscriptionFee,
+  splitProfit,
+  trailingFloor,
+  dailyFloor,
+  isTrailingBreached,
+  isDailyBreached,
+  fromUsdc,
+  toUsdc,
+  from8Dec,
+  to8Dec,
+  toUsdc6,
+  formatUsd,
+  stateToLabel,
+  labelToState,
+} from "../utils.js";
+import { AccountState } from "../types.js";
+
+// ── Helpers ──────────────────────────────────────────
+
+const usdc = (n: number) => BigInt(n) * 1_000_000n; // 6-dec USDC
+const dec8 = (n: number) => BigInt(n) * 100_000_000n; // 8-dec internal
+
+// ── Decimal conversions ──────────────────────────────
+
+describe("decimal conversions", () => {
+  it("toUsdc converts number to 6-dec bigint", () => {
+    expect(toUsdc(100)).toBe(100_000_000n);
+    expect(toUsdc(0.5)).toBe(500_000n);
+    expect(toUsdc(5000)).toBe(5_000_000_000n);
+  });
+
+  it("fromUsdc converts 6-dec bigint to number", () => {
+    expect(fromUsdc(100_000_000n)).toBe(100);
+    expect(fromUsdc(500_000n)).toBe(0.5);
+  });
+
+  it("to8Dec scales 6-dec to 8-dec (*100)", () => {
+    expect(to8Dec(usdc(1000))).toBe(dec8(1000));
+  });
+
+  it("toUsdc6 scales 8-dec down to 6-dec (/100)", () => {
+    expect(toUsdc6(dec8(1000))).toBe(usdc(1000));
+  });
+
+  it("from8Dec converts 8-dec bigint to number", () => {
+    expect(from8Dec(dec8(5000))).toBe(5000);
+    expect(from8Dec(50_000_000n)).toBe(0.5);
+  });
+
+  it("roundtrip: toUsdc -> to8Dec -> toUsdc6", () => {
+    const original = toUsdc(1234);
+    const up = to8Dec(original);
+    const down = toUsdc6(up);
+    expect(down).toBe(original);
+  });
+});
+
+// ── Activation fee ───────────────────────────────────
+
+describe("activationFee", () => {
+  const FM = 120; // current contract feeMultiplier
+
+  it("$5000 account, 500bps, no daily DD → $300", () => {
+    // 5000 * 500 * 120 / 1_000_000 = 300
+    expect(activationFee(usdc(5000), 500, false, FM)).toBe(usdc(300));
+  });
+
+  it("$5000 account, 500bps, daily DD → $240", () => {
+    // 300 * 8000 / 10000 = 240 (20% discount)
+    expect(activationFee(usdc(5000), 500, true, FM)).toBe(usdc(240));
+  });
+
+  it("$10000 account, 1000bps, no daily DD → $1200", () => {
+    // 10000 * 1000 * 120 / 1_000_000 = 1200
+    expect(activationFee(usdc(10000), 1000, false, FM)).toBe(usdc(1200));
+  });
+
+  it("$10000 account, 1000bps, daily DD → $960", () => {
+    // 1200 * 8000 / 10000 = 960 (20% discount)
+    expect(activationFee(usdc(10000), 1000, true, FM)).toBe(usdc(960));
+  });
+
+  it("min params: $100 account, 500bps → $6", () => {
+    // 100 * 500 * 120 / 1_000_000 = 6
+    const fee = activationFee(usdc(100), 500, false, FM);
+    expect(fee).toBe(usdc(6));
+  });
+});
+
+// ── Subscription fee ─────────────────────────────────
+
+describe("subscriptionFee", () => {
+  const SFM = 150; // current contract subscriptionFeeMultiplier
+
+  it("$5000 account → $75/month", () => {
+    // 5000 * 150 / 10000 = 75
+    expect(subscriptionFee(usdc(5000), SFM)).toBe(usdc(75));
+  });
+
+  it("legacy signature is still accepted for compatibility", () => {
+    expect(subscriptionFee(usdc(5000), 500, true, SFM)).toBe(usdc(75));
+  });
+
+  it("$10000 account → $150/month", () => {
+    expect(subscriptionFee(usdc(10000), SFM)).toBe(usdc(150));
+  });
+});
+
+// ── Profit split ─────────────────────────────────────
+
+describe("splitProfit", () => {
+  it("$1000 profit → 80% owner, 7% protocol, 13% vault", () => {
+    const { owner, vault, protocol } = splitProfit(usdc(1000));
+    expect(owner).toBe(usdc(800));
+    expect(protocol).toBe(usdc(70));
+    expect(vault).toBe(usdc(130));
+  });
+
+  it("sum of parts equals total", () => {
+    const profit = usdc(7777);
+    const { owner, vault, protocol } = splitProfit(profit);
+    expect(owner + vault + protocol).toBe(profit);
+  });
+
+  it("zero profit", () => {
+    const { owner, vault, protocol } = splitProfit(0n);
+    expect(owner).toBe(0n);
+    expect(vault).toBe(0n);
+    expect(protocol).toBe(0n);
+  });
+
+  it("small profit — rounding goes to vault (remainder)", () => {
+    // $1 = 1_000_000
+    // owner = 1_000_000 * 8000 / 10000 = 800_000
+    // protocol = 1_000_000 * 700 / 10000 = 70_000
+    // vault = 1_000_000 - 800_000 - 70_000 = 130_000
+    const { owner, vault, protocol } = splitProfit(usdc(1));
+    expect(owner).toBe(800_000n);
+    expect(protocol).toBe(70_000n);
+    expect(vault).toBe(130_000n);
+  });
+});
+
+// ── Drawdown floors ──────────────────────────────────
+
+describe("trailingFloor", () => {
+  it("500bps = 5% drawdown from HWM", () => {
+    const hwm = dec8(10000); // $10,000 in 8-dec
+    expect(trailingFloor(hwm, 500)).toBe(dec8(9500));
+  });
+
+  it("1000bps = 10% drawdown", () => {
+    const hwm = dec8(5000);
+    expect(trailingFloor(hwm, 1000)).toBe(dec8(4500));
+  });
+});
+
+describe("dailyFloor", () => {
+  it("500bps → daily = 250bps = 2.5% from day start", () => {
+    const dsv = dec8(10000);
+    // dailyBps = 500 / 2 = 250
+    // floor = 10000 - 10000 * 250 / 10000 = 10000 - 250 = 9750
+    expect(dailyFloor(dsv, 500)).toBe(dec8(9750));
+  });
+
+  it("1000bps → daily = 500bps = 5%", () => {
+    const dsv = dec8(10000);
+    expect(dailyFloor(dsv, 1000)).toBe(dec8(9500));
+  });
+});
+
+describe("breach checks", () => {
+  const hwm = dec8(10000);
+  const dsv = dec8(10000);
+
+  it("isTrailingBreached — below floor → true", () => {
+    expect(isTrailingBreached(dec8(9499), hwm, 500)).toBe(true);
+  });
+
+  it("isTrailingBreached — at floor → false", () => {
+    expect(isTrailingBreached(dec8(9500), hwm, 500)).toBe(false);
+  });
+
+  it("isTrailingBreached — above floor → false", () => {
+    expect(isTrailingBreached(dec8(9501), hwm, 500)).toBe(false);
+  });
+
+  it("isDailyBreached — below floor → true", () => {
+    expect(isDailyBreached(dec8(9749), dsv, 500)).toBe(true);
+  });
+
+  it("isDailyBreached — at floor → false", () => {
+    expect(isDailyBreached(dec8(9750), dsv, 500)).toBe(false);
+  });
+});
+
+// ── Enum mapping ─────────────────────────────────────
+
+describe("state enum mapping", () => {
+  it("stateToLabel maps all states", () => {
+    expect(stateToLabel(AccountState.Uninitialized)).toBe("UNINITIALIZED");
+    expect(stateToLabel(AccountState.Active)).toBe("ACTIVE");
+    expect(stateToLabel(AccountState.Closing)).toBe("CLOSING");
+    expect(stateToLabel(AccountState.Closed)).toBe("CLOSED");
+    expect(stateToLabel(AccountState.WithdrawalPending)).toBe("WITHDRAWAL_PENDING");
+    expect(stateToLabel(AccountState.Returning)).toBe("RETURNING");
+    expect(stateToLabel(AccountState.Initialized)).toBe("INITIALIZED");
+  });
+
+  it("labelToState reverses correctly", () => {
+    expect(labelToState("UNINITIALIZED")).toBe(AccountState.Uninitialized);
+    expect(labelToState("ACTIVE")).toBe(AccountState.Active);
+    expect(labelToState("CLOSED")).toBe(AccountState.Closed);
+    expect(labelToState("CLOSING")).toBe(AccountState.Closing);
+  });
+
+  it("roundtrip: state → label → state", () => {
+    for (const state of [
+      AccountState.Initialized,
+      AccountState.Active,
+      AccountState.WithdrawalPending,
+      AccountState.Closing,
+      AccountState.Returning,
+      AccountState.Closed,
+    ]) {
+      expect(labelToState(stateToLabel(state))).toBe(state);
+    }
+  });
+});
+
+// ── formatUsd ────────────────────────────────────────
+
+describe("formatUsd", () => {
+  it("formats 6-dec bigint as USD", () => {
+    expect(formatUsd(usdc(1000))).toBe("$1,000.00");
+    expect(formatUsd(usdc(0))).toBe("$0.00");
+  });
+
+  it("formats with custom decimals", () => {
+    expect(formatUsd(dec8(5000), 8)).toBe("$5,000.00");
+  });
+});

package/src/abi/factory.ts

@@ -0,0 +1,399 @@
+export const factoryAbi = [
+  {
+    "inputs": [
+      {
+        "internalType": "address",
+        "name": "_usdc",
+        "type": "address"
+      },
+      {
+        "internalType": "address",
+        "name": "_implementation",
+        "type": "address"
+      }
+    ],
+    "stateMutability": "nonpayable",
+    "type": "constructor"
+  },
+  {
+    "inputs": [],
+    "name": "FailedDeployment",
+    "type": "error"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "uint256",
+        "name": "balance",
+        "type": "uint256"
+      },
+      {
+        "internalType": "uint256",
+        "name": "needed",
+        "type": "uint256"
+      }
+    ],
+    "name": "InsufficientBalance",
+    "type": "error"
+  },
+  {
+    "anonymous": false,
+    "inputs": [
+      {
+        "indexed": true,
+        "internalType": "address",
+        "name": "vault",
+        "type": "address"
+      },
+      {
+        "indexed": true,
+        "internalType": "address",
+        "name": "owner",
+        "type": "address"
+      }
+    ],
+    "name": "FactoryConfigInitialized",
+    "type": "event"
+  },
+  {
+    "anonymous": false,
+    "inputs": [
+      {
+        "indexed": true,
+        "internalType": "address",
+        "name": "account",
+        "type": "address"
+      },
+      {
+        "indexed": true,
+        "internalType": "address",
+        "name": "owner",
+        "type": "address"
+      },
+      {
+        "indexed": true,
+        "internalType": "address",
+        "name": "builder",
+        "type": "address"
+      },
+      {
+        "indexed": false,
+        "internalType": "uint96",
+        "name": "accountSize",
+        "type": "uint96"
+      },
+      {
+        "indexed": false,
+        "internalType": "uint16",
+        "name": "drawdownBps",
+        "type": "uint16"
+      },
+      {
+        "indexed": false,
+        "internalType": "bool",
+        "name": "dailyDrawdownEnabled",
+        "type": "bool"
+      }
+    ],
+    "name": "FundedAccountCreated",
+    "type": "event"
+  },
+  {
+    "anonymous": false,
+    "inputs": [
+      {
+        "indexed": true,
+        "internalType": "address",
+        "name": "previousOwner",
+        "type": "address"
+      },
+      {
+        "indexed": true,
+        "internalType": "address",
+        "name": "newOwner",
+        "type": "address"
+      }
+    ],
+    "name": "OwnershipTransferStarted",
+    "type": "event"
+  },
+  {
+    "anonymous": false,
+    "inputs": [
+      {
+        "indexed": true,
+        "internalType": "address",
+        "name": "oldOwner",
+        "type": "address"
+      },
+      {
+        "indexed": true,
+        "internalType": "address",
+        "name": "newOwner",
+        "type": "address"
+      }
+    ],
+    "name": "OwnershipTransferred",
+    "type": "event"
+  },
+  {
+    "anonymous": false,
+    "inputs": [
+      {
+        "indexed": true,
+        "internalType": "address",
+        "name": "oldVault",
+        "type": "address"
+      },
+      {
+        "indexed": true,
+        "internalType": "address",
+        "name": "newVault",
+        "type": "address"
+      }
+    ],
+    "name": "VaultUpdated",
+    "type": "event"
+  },
+  {
+    "inputs": [],
+    "name": "acceptOwnership",
+    "outputs": [],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "uint256",
+        "name": "",
+        "type": "uint256"
+      }
+    ],
+    "name": "allAccounts",
+    "outputs": [
+      {
+        "internalType": "address",
+        "name": "",
+        "type": "address"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "address",
+        "name": "",
+        "type": "address"
+      }
+    ],
+    "name": "allAccountsIndex",
+    "outputs": [
+      {
+        "internalType": "uint256",
+        "name": "",
+        "type": "uint256"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "address",
+        "name": "accountOwner",
+        "type": "address"
+      },
+      {
+        "internalType": "address",
+        "name": "builder",
+        "type": "address"
+      },
+      {
+        "internalType": "uint96",
+        "name": "accountSize",
+        "type": "uint96"
+      },
+      {
+        "internalType": "uint16",
+        "name": "drawdownBps",
+        "type": "uint16"
+      },
+      {
+        "internalType": "bool",
+        "name": "dailyDrawdownEnabled",
+        "type": "bool"
+      },
+      {
+        "internalType": "uint16",
+        "name": "subscriptionFeeMultiplier",
+        "type": "uint16"
+      }
+    ],
+    "name": "createFundedAccount",
+    "outputs": [
+      {
+        "internalType": "address",
+        "name": "",
+        "type": "address"
+      }
+    ],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "inputs": [],
+    "name": "implementation",
+    "outputs": [
+      {
+        "internalType": "address",
+        "name": "",
+        "type": "address"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [],
+    "name": "owner",
+    "outputs": [
+      {
+        "internalType": "address",
+        "name": "",
+        "type": "address"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [],
+    "name": "pendingOwner",
+    "outputs": [
+      {
+        "internalType": "address",
+        "name": "",
+        "type": "address"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "address",
+        "name": "accountOwner",
+        "type": "address"
+      },
+      {
+        "internalType": "address",
+        "name": "builder",
+        "type": "address"
+      }
+    ],
+    "name": "predictFundedAccountAddress",
+    "outputs": [
+      {
+        "internalType": "address",
+        "name": "",
+        "type": "address"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "address",
+        "name": "account",
+        "type": "address"
+      }
+    ],
+    "name": "removeAccount",
+    "outputs": [],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "address",
+        "name": "_vault",
+        "type": "address"
+      }
+    ],
+    "name": "setVault",
+    "outputs": [],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "address",
+        "name": "",
+        "type": "address"
+      },
+      {
+        "internalType": "address",
+        "name": "",
+        "type": "address"
+      }
+    ],
+    "name": "traderBuilderNonce",
+    "outputs": [
+      {
+        "internalType": "uint256",
+        "name": "",
+        "type": "uint256"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "address",
+        "name": "newOwner",
+        "type": "address"
+      }
+    ],
+    "name": "transferOwnership",
+    "outputs": [],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "inputs": [],
+    "name": "usdc",
+    "outputs": [
+      {
+        "internalType": "address",
+        "name": "",
+        "type": "address"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [],
+    "name": "vault",
+    "outputs": [
+      {
+        "internalType": "address",
+        "name": "",
+        "type": "address"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  }
+] as const;