@elmntl/jlpd-sdk 0.2.0 → 0.13.4

package/dist/p-stv-core/types.d.ts

@@ -0,0 +1,361 @@
+import { PublicKey } from "@solana/web3.js";
+import BN from "bn.js";
+export interface GlobalConfig {
+    admin: PublicKey;
+    nextVaultId: BN;
+    flags: number;
+    version: number;
+    bump: number;
+}
+export interface Stv {
+    baseMint: PublicKey;
+    evMint: PublicKey;
+    strategy: PublicKey;
+    feeReceiver: PublicKey;
+    lendProgram: PublicKey;
+    /** Canonical ATA for (stv_pda, base_mint, token_program). Set at init. */
+    vaultAta: PublicKey;
+    /**
+     * Per-vault cold admin pubkey (v2 layout, offset 200; Rust field `cold_admin`).
+     * Set at create or migration. Never zero on a v2-loadable STV (enforced by
+     * the v2 freeze gate). Only `accept_vault_admin` may change this
+     * post-create/migration.
+     */
+    coldAdmin: PublicKey;
+    /**
+     * Pending admin for two-step rotation (v2 layout, offset 232). Non-zero means a
+     * rotation is in progress; `accept_vault_admin` completes it. Zero = no pending
+     * rotation. A pending admin has ZERO authority before accept.
+     */
+    pendingAdmin: PublicKey;
+    childVaults: BN[];
+    vaultId: BN;
+    reservedBase: BN;
+    /** Pending withdrawal shares (sum across unprocessed WithdrawRequests).
+     *  Display value: requestedShares × currentPps / PPS_DECIMALS. */
+    requestedShares: BN;
+    vaultCapacity: BN;
+    minDeposit: BN;
+    hwm: BN;
+    lastFeeTs: BN;
+    epochPps: BN;
+    lastNav: BN;
+    dailyWithdrawnBase: BN;
+    nextEpochTs: number;
+    epochSec: number;
+    currentEpochId: number;
+    pendingWithdrawals: number;
+    withdrawWindowStart: number;
+    mgmtFeeBps: number;
+    perfFeeBps: number;
+    flags: number;
+    dailyWithdrawLimitBps: number;
+    childVaultCount: number;
+    version: number;
+    bump: number;
+    /** Fee (BPS) charged on migrate-in when FLAG_DEPOSIT_FEE_ON_MIGRATE is set. Max MAX_FEE_BPS. */
+    depositFeeBps: number;
+    /** Fee (BPS) charged on migrate-out when FLAG_WITHDRAWAL_FEE_ON_MIGRATE is set. Max MAX_FEE_BPS. */
+    withdrawalFeeBps: number;
+    /** Gross base from delayed deposits not yet minted into evX. */
+    pendingDepositBase: BN;
+    /** Number of open DelayedDepositRequest accounts. */
+    pendingDepositCount: number;
+    /** Pinned canonical ATA for feeReceiver + evMint (offset 424 in v2). */
+    feeReceiverEvAta: PublicKey;
+    /** C-1 supply floor (seed shares) — set by seed_stv, redeemed only via close_stv. */
+    lockedSeedShares: BN;
+    /** Withdrawal mode: 0=instant, 1=X, 2=X+1. Create-only/immutable. */
+    withdrawalMode: number;
+    /**
+     * Unix timestamp (seconds, u32) at which `lastNav` was written by `process_epoch`.
+     * Used by allocator NAV freshness gating. 0 = no epoch processed yet.
+     * Offset 468 in the v2 layout (_OFFSET_LAST_NAV_TS == 468).
+     */
+    lastNavTs: number;
+    /**
+     * Per-vault strategy staleness window in seconds (u32).
+     * `0` = use `DEFAULT_STRATEGY_STALENESS_THRESHOLD` (24 h).
+     * Admin-set via `init_or_update_stv`; no range validation on-chain.
+     * Existing STVs read `0` here (zeroed reserved tail) and resolve to the
+     * 24 h default — no migration needed.
+     * Offset 472 in the v2 layout (_OFFSET_STRATEGY_STALENESS_THRESHOLD == 472).
+     */
+    strategyStalenessThreshold: number;
+    /**
+     * Warm admin (v2 layout, offset 476). Operational authority: `add_manager`,
+     * `remove_manager`, `override_claim_withdraw`, `trip_circuit_breaker` — NOT
+     * `init_or_update_stv`/`close_stv`/`seed_stv`/`migrate_lend` (cold-only).
+     * See docs/spec-warm-admin-guardrails.md §2.
+     *
+     * `PublicKey.default` (`[0u8;32]`) is the "follow cold" sentinel — the raw
+     * value stored here MAY be stale-looking (every live STV pre-upgrade reads
+     * the sentinel because the field lives in the former zeroed reserved
+     * tail). Use `warmAdminEffective(stv)` (accounts.ts) for the resolved
+     * authority; never compare this raw field directly to decide auth.
+     *
+     * PRE-DEPLOY CAVEAT: the currently-deployed mainnet program predates this
+     * field. Decoding it is always safe (the bytes exist in the account either
+     * way — pre-upgrade STVs just read the sentinel from a zeroed tail), but
+     * the WRITE path (`init_or_update_stv`'s `warmAdminArg`) and the new/changed
+     * instructions (`tripCircuitBreaker`, the new `overrideClaimWithdraw`
+     * account list) only take effect once the program upgrade ships.
+     * Offset 476 in the v2 layout (_OFFSET_WARM_ADMIN == 476).
+     */
+    warmAdmin: PublicKey;
+}
+export interface ManagerRole {
+    stv: PublicKey;
+    manager: PublicKey;
+    bump: number;
+}
+export interface WithdrawRequest {
+    stv: PublicKey;
+    user: PublicKey;
+    shares: BN;
+    pps: BN;
+    epochId: number;
+    claimAvailableAfter: number;
+    bump: number;
+    /** Account layout version (withdraw_request.rs:67, offset 97). Currently 0. */
+    version: number;
+    /** Request kind flags. bit0 (WR_FLAG_MIGRATE): 0 = withdraw, 1 = migrate. */
+    requestFlags: number;
+    /** Migrate kind: destination STV vault_id. Withdraw kind: 0. */
+    destVaultId: BN;
+    /** Migrate kind: minimum dest shares (slippage protection). Withdraw kind: 0. */
+    minDestShares: BN;
+}
+export interface DelayedDepositRequest {
+    stv: PublicKey;
+    user: PublicKey;
+    amount: BN;
+    epochId: number;
+    bump: number;
+    version: number;
+}
+export interface ConfigInitializedEvent {
+    name: "ConfigInitialized";
+    admin: PublicKey;
+}
+export interface ConfigUpdatedEvent {
+    name: "ConfigUpdated";
+    admin: PublicKey;
+    flags: number;
+}
+export interface StvCreatedEvent {
+    name: "StvCreated";
+    vaultId: BN;
+    baseMint: PublicKey;
+    evMint: PublicKey;
+    feeReceiver: PublicKey;
+    strategy: PublicKey;
+    lendProgram: PublicKey;
+    epochSec: number;
+    mgmtFeeBps: number;
+    perfFeeBps: number;
+}
+export interface StvUpdatedEvent {
+    name: "StvUpdated";
+    vaultId: BN;
+    feeReceiver: PublicKey;
+    flags: number;
+    mgmtFeeBps: number;
+    perfFeeBps: number;
+    vaultCapacity: BN;
+    minDeposit: BN;
+    childVaultCount: number;
+    lendProgram: PublicKey;
+}
+export interface DepositedEvent {
+    name: "Deposited";
+    vaultId: BN;
+    user: PublicKey;
+    amount: BN;
+    sharesMinted: BN;
+    /** Fee shares credited to fee receiver (new field; on-chain offset 57). */
+    depositFeeShares: BN;
+    pps: BN;
+}
+export interface WithdrawRequestedEvent {
+    name: "WithdrawRequested";
+    vaultId: BN;
+    user: PublicKey;
+    shares: BN;
+    epochId: number;
+}
+export interface WithdrawRequestIncreasedEvent {
+    name: "WithdrawRequestIncreased";
+    vaultId: BN;
+    user: PublicKey;
+    additionalShares: BN;
+    totalShares: BN;
+    epochId: number;
+}
+export interface WithdrawClaimedEvent {
+    name: "WithdrawClaimed";
+    vaultId: BN;
+    user: PublicKey;
+    shares: BN;
+    baseAmount: BN;
+    withdrawalFeeBase: BN;
+    epochId: number;
+}
+export interface DepositedToStrategyEvent {
+    name: "DepositedToStrategy";
+    vaultId: BN;
+    strategy: PublicKey;
+    amount: BN;
+    sharesReceived: BN;
+}
+export interface WithdrawnFromStrategyEvent {
+    name: "WithdrawnFromStrategy";
+    vaultId: BN;
+    strategy: PublicKey;
+    shares: BN;
+    baseReceived: BN;
+}
+export interface EpochProcessedEvent {
+    name: "EpochProcessed";
+    vaultId: BN;
+    epochId: number;
+    epochPps: BN;
+    feeSharesMinted: BN;
+}
+export interface EpochAdvancedEvent {
+    name: "EpochAdvanced";
+    vaultId: BN;
+    newEpochId: number;
+    nextEpochTs: number;
+}
+export interface FeesSettledEvent {
+    name: "FeesSettled";
+    vaultId: BN;
+    mgmtFeeBase: BN;
+    perfFeeBase: BN;
+    feeSharesMinted: BN;
+    postFeePps: BN;
+    hwm: BN;
+}
+export interface StvClosedEvent {
+    name: "StvClosed";
+    vaultId: BN;
+}
+export interface ManagerAddedEvent {
+    name: "ManagerAdded";
+    stv: PublicKey;
+    manager: PublicKey;
+}
+export interface ManagerRemovedEvent {
+    name: "ManagerRemoved";
+    stv: PublicKey;
+    manager: PublicKey;
+}
+export interface WithdrawOverrideClaimedEvent {
+    name: "WithdrawOverrideClaimed";
+    vaultId: BN;
+    /**
+     * The signer who called override_claim_withdraw. Field name is legacy —
+     * since warm-admin-guardrails, manager is hard-cut from this instruction,
+     * so this is always the cold admin (stv.coldAdmin) or warm admin
+     * (stv.warmAdminEffective()), never a manager. Wire layout unchanged.
+     */
+    manager: PublicKey;
+    user: PublicKey;
+    shares: BN;
+    baseAmount: BN;
+    withdrawalFeeBase: BN;
+    epochId: number;
+    dailyWithdrawnBase: BN;
+    dailyLimit: BN;
+}
+export interface LendMigratedEvent {
+    name: "LendMigrated";
+    vaultId: BN;
+    oldLendProgram: PublicKey;
+    newLendProgram: PublicKey;
+    sharesWithdrawn: BN;
+    baseMigrated: BN;
+}
+export interface MigrateRequestedEvent {
+    name: "MigrateRequested";
+    srcVaultId: BN;
+    destVaultId: BN;
+    user: PublicKey;
+    shares: BN;
+    epochId: number;
+}
+export interface MigrateExecutedEvent {
+    name: "MigrateExecuted";
+    srcVaultId: BN;
+    destVaultId: BN;
+    user: PublicKey;
+    sharesBurned: BN;
+    baseMoved: BN;
+    withdrawalFeeBase: BN;
+    depositFeeBase: BN;
+    userDestShares: BN;
+    epochId: number;
+}
+export interface DelayedDepositProcessedEvent {
+    name: "DelayedDepositProcessed";
+    vaultId: BN;
+    user: PublicKey;
+    amount: BN;
+    sharesMinted: BN;
+    depositFeeShares: BN;
+    pps: BN;
+    requestEpochId: number;
+}
+export interface InstantWithdrawnEvent {
+    name: "InstantWithdrawn";
+    vaultId: BN;
+    user: PublicKey;
+    shares: BN;
+    netBase: BN;
+    withdrawalFeeBase: BN;
+}
+export interface StvSeededEvent {
+    name: "StvSeeded";
+    vaultId: BN;
+    amount: BN;
+}
+/** Emitted by init_or_update_stv (update path) when pending_admin is set to a nonzero value. */
+export interface AdminRotationStartedEvent {
+    name: "AdminRotationStarted";
+    vaultId: BN;
+    newPendingAdmin: PublicKey;
+}
+/** Emitted by accept_vault_admin after the new admin accepts the rotation. */
+export interface AdminRotationAcceptedEvent {
+    name: "AdminRotationAccepted";
+    vaultId: BN;
+    newAdmin: PublicKey;
+}
+/**
+ * Emitted whenever the stored `Stv.warmAdmin` value actually changes:
+ * (a) `init_or_update_stv` on create (`Some(nonzero, != vaultAdmin)`) or
+ * update (set / reset-to-follow-cold / normalize-to-sentinel); (b)
+ * `accept_vault_admin` when the concrete self-warm normalization zeroes
+ * `warmAdmin` on promotion. `warmAdmin` is the raw stored value —
+ * `PublicKey.default` on any reset/normalize, so indexers can distinguish
+ * "follows cold" from an explicit key.
+ */
+export interface WarmAdminSetEvent {
+    name: "WarmAdminSet";
+    vaultId: BN;
+    warmAdmin: PublicKey;
+}
+/**
+ * Emitted by `trip_circuit_breaker` (disc 21) every time it is called,
+ * including idempotent re-trips of an already-paused vault.
+ * `authorityKind`: 0 = cold admin, 1 = warm admin, 2 = manager
+ * (see `TRIP_AUTHORITY_KIND_*` in constants.ts).
+ */
+export interface CircuitBreakerTrippedEvent {
+    name: "CircuitBreakerTripped";
+    vaultId: BN;
+    trippedBy: PublicKey;
+    authorityKind: number;
+}
+export type StvEvent = ConfigInitializedEvent | ConfigUpdatedEvent | StvCreatedEvent | StvUpdatedEvent | DepositedEvent | WithdrawRequestedEvent | WithdrawRequestIncreasedEvent | WithdrawClaimedEvent | DepositedToStrategyEvent | WithdrawnFromStrategyEvent | EpochProcessedEvent | EpochAdvancedEvent | FeesSettledEvent | StvClosedEvent | ManagerAddedEvent | ManagerRemovedEvent | WithdrawOverrideClaimedEvent | LendMigratedEvent | MigrateRequestedEvent | MigrateExecutedEvent | DelayedDepositProcessedEvent | InstantWithdrawnEvent | StvSeededEvent | AdminRotationStartedEvent | AdminRotationAcceptedEvent | WarmAdminSetEvent | CircuitBreakerTrippedEvent;

package/dist/p-stv-core/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,32 +1,73 @@
 {
   "name": "@elmntl/jlpd-sdk",
-  "version": "0.2.0",
-  "description": "SDK for JLP.D (JLP Deconstructed) by Elemental",
+  "version": "0.13.4",
+  "description": "SDK for JLP.D (JLP Deconstructed) by Elemental \u2014 p-stv-core, jlpd-strategy, and elemental-lend clients",
+  "license": "Apache-2.0",
+  "keywords": [
+    "solana",
+    "defi",
+    "vault",
+    "yield",
+    "jlp",
+    "jupiter",
+    "kamino",
+    "pinocchio",
+    "anchor",
+    "sdk"
+  ],
   "main": "dist/index.js",
-  "module": "dist/index.mjs",
   "types": "dist/index.d.ts",
+  "exports": {
+    ".": "./dist/index.js",
+    "./common": "./dist/common/index.js",
+    "./p-stv-core": "./dist/p-stv-core/index.js",
+    "./elemental-lend": "./dist/elemental-lend/index.js",
+    "./jlpd-strategy": "./dist/jlpd-strategy/index.js"
+  },
+  "typesVersions": {
+    "*": {
+      "common": [
+        "dist/common/index.d.ts"
+      ],
+      "p-stv-core": [
+        "dist/p-stv-core/index.d.ts"
+      ],
+      "elemental-lend": [
+        "dist/elemental-lend/index.d.ts"
+      ],
+      "jlpd-strategy": [
+        "dist/jlpd-strategy/index.d.ts"
+      ]
+    }
+  },
   "files": [
     "dist"
   ],
   "scripts": {
-    "build": "tsup src/index.ts --format cjs,esm --dts",
-    "dev": "tsup src/index.ts --format cjs,esm --dts --watch",
-    "lint": "eslint src/",
-    "clean": "rm -rf dist"
+    "build": "tsc",
+    "clean": "rm -rf dist",
+    "test": "TS_NODE_TRANSPILE_ONLY=true mocha --require ts-node/register --extensions ts \"src/**/__tests__/**/*.test.ts\"",
+    "prepublishOnly": "npm run clean && npm run build"
   },
   "dependencies": {
-    "@coral-xyz/anchor": "0.32.1",
-    "@solana/spl-token": "^0.4.9",
-    "@solana/web3.js": "^1.95.8"
+    "bn.js": "^5.2.1"
   },
   "devDependencies": {
-    "@types/node": "^20.11.0",
-    "tsup": "^8.0.1",
+    "@solana/spl-token": "^0.4.0",
+    "@solana/web3.js": "^1.95.0",
+    "@types/bn.js": "^5.2.0",
+    "@types/chai": "^4.3.20",
+    "@types/mocha": "^10.0.10",
+    "chai": "^4.5.0",
+    "mocha": "^10.8.2",
+    "ts-node": "^10.9.2",
     "typescript": "^5.3.3"
   },
   "peerDependencies": {
+    "@solana/spl-token": "^0.4.0",
     "@solana/web3.js": "^1.95.0"
   },
-  "author": "Elemental",
-  "license": "MIT"
-}
+  "publishConfig": {
+    "access": "public"
+  }
+}