perk-protocol 0.1.0

package/dist/client.d.ts

@@ -0,0 +1,110 @@
+import { Connection, PublicKey, TransactionSignature, TransactionInstruction, Commitment } from "@solana/web3.js";
+import { Program, AnchorProvider, BN, Wallet } from "@coral-xyz/anchor";
+type AnyAccounts = Record<string, {
+    fetch: Function;
+    all: Function;
+    fetchNullable: Function;
+}>;
+import { Side, CreateMarketParams, AdminUpdateMarketParams, TriggerOrderParams, MarketAccount, UserPositionAccount, ProtocolAccount, TriggerOrderAccount, PerkOracleAccount, InitPerkOracleParams, UpdatePerkOracleParams, UpdateOracleConfigParams, SetFallbackOracleParams } from "./types";
+export interface PerkClientConfig {
+    connection: Connection;
+    wallet: Wallet;
+    programId?: PublicKey;
+    commitment?: Commitment;
+    /** Instructions to prepend to every transaction (e.g., ComputeBudget priority fees). */
+    preInstructions?: TransactionInstruction[];
+}
+export declare class PerkClient {
+    readonly connection: Connection;
+    readonly wallet: Wallet;
+    readonly programId: PublicKey;
+    readonly program: Program;
+    readonly accounts: AnyAccounts;
+    readonly provider: AnchorProvider;
+    readonly preInstructions: TransactionInstruction[];
+    constructor(config: PerkClientConfig);
+    getProtocolAddress(): PublicKey;
+    getMarketAddress(tokenMint: PublicKey): PublicKey;
+    getPositionAddress(market: PublicKey, user: PublicKey): PublicKey;
+    getVaultAddress(market: PublicKey): PublicKey;
+    getTriggerOrderAddress(market: PublicKey, user: PublicKey, orderId: number | BN): PublicKey;
+    getPerkOracleAddress(tokenMint: PublicKey): PublicKey;
+    fetchProtocol(): Promise<ProtocolAccount>;
+    fetchMarket(tokenMint: PublicKey): Promise<MarketAccount>;
+    fetchMarketByAddress(address: PublicKey): Promise<MarketAccount>;
+    fetchAllMarkets(): Promise<{
+        address: PublicKey;
+        account: MarketAccount;
+    }[]>;
+    fetchPosition(market: PublicKey, user: PublicKey): Promise<UserPositionAccount>;
+    fetchPositionByAddress(address: PublicKey): Promise<UserPositionAccount>;
+    fetchAllPositions(user: PublicKey): Promise<{
+        address: PublicKey;
+        account: UserPositionAccount;
+    }[]>;
+    fetchTriggerOrder(address: PublicKey): Promise<TriggerOrderAccount>;
+    fetchTriggerOrders(market: PublicKey, user: PublicKey): Promise<{
+        address: PublicKey;
+        account: TriggerOrderAccount;
+    }[]>;
+    /** Fetch a PerkOracle account. */
+    fetchPerkOracle(tokenMint: PublicKey): Promise<PerkOracleAccount>;
+    /** Fetch a PerkOracle account, returning null if not found. */
+    fetchPerkOracleNullable(tokenMint: PublicKey): Promise<PerkOracleAccount | null>;
+    /** Initialize the protocol (admin only, once). */
+    initializeProtocol(protocolFeeVault: PublicKey): Promise<TransactionSignature>;
+    /** Propose a new admin (current admin only). */
+    proposeAdmin(newAdmin: PublicKey): Promise<TransactionSignature>;
+    /** Accept admin transfer (pending admin only). */
+    acceptAdmin(): Promise<TransactionSignature>;
+    /** Pause/unpause the protocol. */
+    adminPause(paused: boolean): Promise<TransactionSignature>;
+    /** Update market parameters (admin only). */
+    adminUpdateMarket(tokenMint: PublicKey, oracle: PublicKey | null, params: AdminUpdateMarketParams): Promise<TransactionSignature>;
+    /** Withdraw SOL from protocol PDA (admin only). */
+    adminWithdrawSol(amount: BN): Promise<TransactionSignature>;
+    /** Create a new perpetual futures market. */
+    createMarket(tokenMint: PublicKey, oracle: PublicKey, params: CreateMarketParams): Promise<TransactionSignature>;
+    /** Initialize a position account for a user on a market. */
+    initializePosition(tokenMint: PublicKey): Promise<TransactionSignature>;
+    /** Deposit collateral into a position. */
+    deposit(tokenMint: PublicKey, oracle: PublicKey, amount: BN, fallbackOracle?: PublicKey): Promise<TransactionSignature>;
+    /** Withdraw collateral from a position. */
+    withdraw(tokenMint: PublicKey, oracle: PublicKey, amount: BN, fallbackOracle?: PublicKey): Promise<TransactionSignature>;
+    /** Open a leveraged position. */
+    openPosition(tokenMint: PublicKey, oracle: PublicKey, side: Side, baseSize: BN, leverage: number, maxSlippageBps?: number, fallbackOracle?: PublicKey): Promise<TransactionSignature>;
+    /** Close a position (full or partial). */
+    closePosition(tokenMint: PublicKey, oracle: PublicKey, baseSizeToClose?: BN, fallbackOracle?: PublicKey): Promise<TransactionSignature>;
+    /** Place a trigger order (limit, stop-loss, take-profit). */
+    placeTriggerOrder(tokenMint: PublicKey, params: TriggerOrderParams): Promise<TransactionSignature>;
+    /** Cancel a trigger order. */
+    cancelTriggerOrder(tokenMint: PublicKey, orderId: number | BN): Promise<TransactionSignature>;
+    /** Claim accumulated fees (creator or protocol). */
+    claimFees(tokenMint: PublicKey, recipientTokenAccount: PublicKey): Promise<TransactionSignature>;
+    /** Crank funding rate update. */
+    crankFunding(marketAddress: PublicKey, oracle: PublicKey, fallbackOracle?: PublicKey): Promise<TransactionSignature>;
+    /** Liquidate an underwater position. */
+    liquidate(marketAddress: PublicKey, oracle: PublicKey, targetUser: PublicKey, liquidatorTokenAccount: PublicKey, fallbackOracle?: PublicKey): Promise<TransactionSignature>;
+    /** Execute a trigger order that has been triggered. */
+    executeTriggerOrder(marketAddress: PublicKey, oracle: PublicKey, targetUser: PublicKey, orderId: number | BN, executorTokenAccount: PublicKey, fallbackOracle?: PublicKey): Promise<TransactionSignature>;
+    /** Update the vAMM peg multiplier (permissionless). */
+    updateAmm(marketAddress: PublicKey, oracle: PublicKey, fallbackOracle?: PublicKey): Promise<TransactionSignature>;
+    /** Reclaim an empty/abandoned position account (permissionless). */
+    reclaimEmptyAccount(marketAddress: PublicKey, oracle: PublicKey, positionOwner: PublicKey, fallbackOracle?: PublicKey): Promise<TransactionSignature>;
+    /** Initialize a PerkOracle price feed. Admin only. */
+    initializePerkOracle(tokenMint: PublicKey, oracleAuthority: PublicKey, params: InitPerkOracleParams): Promise<TransactionSignature>;
+    /** Update a PerkOracle price feed. Authorized cranker only. */
+    updatePerkOracle(tokenMint: PublicKey, params: UpdatePerkOracleParams): Promise<TransactionSignature>;
+    /** Build updatePerkOracle instructions without sending. Used for Jito bundle submission. */
+    buildUpdatePerkOracleIx(tokenMint: PublicKey, params: UpdatePerkOracleParams): Promise<TransactionInstruction[]>;
+    /** Freeze or unfreeze a PerkOracle. Admin only. */
+    freezePerkOracle(tokenMint: PublicKey, frozen: boolean): Promise<TransactionSignature>;
+    /** Transfer PerkOracle authority. Current authority or admin. */
+    transferOracleAuthority(tokenMint: PublicKey, newAuthority: PublicKey): Promise<TransactionSignature>;
+    /** Update PerkOracle config (price banding). Admin only. */
+    updateOracleConfig(tokenMint: PublicKey, params: UpdateOracleConfigParams): Promise<TransactionSignature>;
+    /** Set or remove fallback oracle on a market. Admin only. */
+    adminSetFallbackOracle(tokenMint: PublicKey, params: SetFallbackOracleParams): Promise<TransactionSignature>;
+}
+export {};
+//# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,SAAS,EAGT,oBAAoB,EACpB,sBAAsB,EACtB,UAAU,EACX,MAAM,iBAAiB,CAAC;AAKzB,OAAO,EAAE,OAAO,EAAE,cAAc,EAAO,EAAE,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAM7E,KAAK,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE;IAAE,KAAK,EAAE,QAAQ,CAAC;IAAC,GAAG,EAAE,QAAQ,CAAC;IAAC,aAAa,EAAE,QAAQ,CAAA;CAAE,CAAC,CAAC;AAS/F,OAAO,EACL,IAAI,EAEJ,kBAAkB,EAClB,uBAAuB,EAEvB,kBAAkB,EAClB,aAAa,EACb,mBAAmB,EACnB,eAAe,EACf,mBAAmB,EACnB,iBAAiB,EACjB,oBAAoB,EACpB,sBAAsB,EACtB,wBAAwB,EACxB,uBAAuB,EACxB,MAAM,SAAS,CAAC;AAqBjB,MAAM,WAAW,gBAAgB;IAC/B,UAAU,EAAE,UAAU,CAAC;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,wFAAwF;IACxF,eAAe,CAAC,EAAE,sBAAsB,EAAE,CAAC;CAC5C;AAED,qBAAa,UAAU;IACrB,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC;IAChC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAC9B,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,QAAQ,EAAE,WAAW,CAAC;IAC/B,QAAQ,CAAC,QAAQ,EAAE,cAAc,CAAC;IAClC,QAAQ,CAAC,eAAe,EAAE,sBAAsB,EAAE,CAAC;gBAEvC,MAAM,EAAE,gBAAgB;IAkBpC,kBAAkB,IAAI,SAAS;IAI/B,gBAAgB,CAAC,SAAS,EAAE,SAAS,GAAG,SAAS;IAIjD,kBAAkB,CAAC,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,GAAG,SAAS;IAIjE,eAAe,CAAC,MAAM,EAAE,SAAS,GAAG,SAAS;IAI7C,sBAAsB,CACpB,MAAM,EAAE,SAAS,EACjB,IAAI,EAAE,SAAS,EACf,OAAO,EAAE,MAAM,GAAG,EAAE,GACnB,SAAS;IAIZ,oBAAoB,CAAC,SAAS,EAAE,SAAS,GAAG,SAAS;IAQ/C,aAAa,IAAI,OAAO,CAAC,eAAe,CAAC;IAOzC,WAAW,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,aAAa,CAAC;IAOzD,oBAAoB,CAAC,OAAO,EAAE,SAAS,GAAG,OAAO,CAAC,aAAa,CAAC;IAMhE,eAAe,IAAI,OAAO,CAAC;QAAE,OAAO,EAAE,SAAS,CAAC;QAAC,OAAO,EAAE,aAAa,CAAA;KAAE,EAAE,CAAC;IAQ5E,aAAa,CACjB,MAAM,EAAE,SAAS,EACjB,IAAI,EAAE,SAAS,GACd,OAAO,CAAC,mBAAmB,CAAC;IAOzB,sBAAsB,CAC1B,OAAO,EAAE,SAAS,GACjB,OAAO,CAAC,mBAAmB,CAAC;IAMzB,iBAAiB,CACrB,IAAI,EAAE,SAAS,GACd,OAAO,CAAC;QAAE,OAAO,EAAE,SAAS,CAAC;QAAC,OAAO,EAAE,mBAAmB,CAAA;KAAE,EAAE,CAAC;IAU5D,iBAAiB,CAAC,OAAO,EAAE,SAAS,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAMnE,kBAAkB,CACtB,MAAM,EAAE,SAAS,EACjB,IAAI,EAAE,SAAS,GACd,OAAO,CAAC;QAAE,OAAO,EAAE,SAAS,CAAC;QAAC,OAAO,EAAE,mBAAmB,CAAA;KAAE,EAAE,CAAC;IAYlE,kCAAkC;IAC5B,eAAe,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAKvE,+DAA+D;IACzD,uBAAuB,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,iBAAiB,GAAG,IAAI,CAAC;IAStF,kDAAkD;IAC5C,kBAAkB,CACtB,gBAAgB,EAAE,SAAS,GAC1B,OAAO,CAAC,oBAAoB,CAAC;IAahC,gDAAgD;IAC1C,YAAY,CAAC,QAAQ,EAAE,SAAS,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAWtE,kDAAkD;IAC5C,WAAW,IAAI,OAAO,CAAC,oBAAoB,CAAC;IAWlD,kCAAkC;IAC5B,UAAU,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAWhE,6CAA6C;IACvC,iBAAiB,CACrB,SAAS,EAAE,SAAS,EACpB,MAAM,EAAE,SAAS,GAAG,IAAI,EACxB,MAAM,EAAE,uBAAuB,GAC9B,OAAO,CAAC,oBAAoB,CAAC;IAchC,mDAAmD;IAC7C,gBAAgB,CAAC,MAAM,EAAE,EAAE,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAgBjE,6CAA6C;IACvC,YAAY,CAChB,SAAS,EAAE,SAAS,EACpB,MAAM,EAAE,SAAS,EACjB,MAAM,EAAE,kBAAkB,GACzB,OAAO,CAAC,oBAAoB,CAAC;IA8BhC,4DAA4D;IACtD,kBAAkB,CACtB,SAAS,EAAE,SAAS,GACnB,OAAO,CAAC,oBAAoB,CAAC;IAiBhC,0CAA0C;IACpC,OAAO,CACX,SAAS,EAAE,SAAS,EACpB,MAAM,EAAE,SAAS,EACjB,MAAM,EAAE,EAAE,EACV,cAAc,CAAC,EAAE,SAAS,GACzB,OAAO,CAAC,oBAAoB,CAAC;IAwBhC,2CAA2C;IACrC,QAAQ,CACZ,SAAS,EAAE,SAAS,EACpB,MAAM,EAAE,SAAS,EACjB,MAAM,EAAE,EAAE,EACV,cAAc,CAAC,EAAE,SAAS,GACzB,OAAO,CAAC,oBAAoB,CAAC;IAwBhC,iCAAiC;IAC3B,YAAY,CAChB,SAAS,EAAE,SAAS,EACpB,MAAM,EAAE,SAAS,EACjB,IAAI,EAAE,IAAI,EACV,QAAQ,EAAE,EAAE,EACZ,QAAQ,EAAE,MAAM,EAChB,cAAc,GAAE,MAAY,EAC5B,cAAc,CAAC,EAAE,SAAS,GACzB,OAAO,CAAC,oBAAoB,CAAC;IA4BhC,0CAA0C;IACpC,aAAa,CACjB,SAAS,EAAE,SAAS,EACpB,MAAM,EAAE,SAAS,EACjB,eAAe,CAAC,EAAE,EAAE,EACpB,cAAc,CAAC,EAAE,SAAS,GACzB,OAAO,CAAC,oBAAoB,CAAC;IAuBhC,6DAA6D;IACvD,iBAAiB,CACrB,SAAS,EAAE,SAAS,EACpB,MAAM,EAAE,kBAAkB,GACzB,OAAO,CAAC,oBAAoB,CAAC;IAkChC,8BAA8B;IACxB,kBAAkB,CACtB,SAAS,EAAE,SAAS,EACpB,OAAO,EAAE,MAAM,GAAG,EAAE,GACnB,OAAO,CAAC,oBAAoB,CAAC;IAyBhC,oDAAoD;IAC9C,SAAS,CACb,SAAS,EAAE,SAAS,EACpB,qBAAqB,EAAE,SAAS,GAC/B,OAAO,CAAC,oBAAoB,CAAC;IAsBhC,iCAAiC;IAC3B,YAAY,CAChB,aAAa,EAAE,SAAS,EACxB,MAAM,EAAE,SAAS,EACjB,cAAc,CAAC,EAAE,SAAS,GACzB,OAAO,CAAC,oBAAoB,CAAC;IAYhC,wCAAwC;IAClC,SAAS,CACb,aAAa,EAAE,SAAS,EACxB,MAAM,EAAE,SAAS,EACjB,UAAU,EAAE,SAAS,EACrB,sBAAsB,EAAE,SAAS,EACjC,cAAc,CAAC,EAAE,SAAS,GACzB,OAAO,CAAC,oBAAoB,CAAC;IAsBhC,uDAAuD;IACjD,mBAAmB,CACvB,aAAa,EAAE,SAAS,EACxB,MAAM,EAAE,SAAS,EACjB,UAAU,EAAE,SAAS,EACrB,OAAO,EAAE,MAAM,GAAG,EAAE,EACpB,oBAAoB,EAAE,SAAS,EAC/B,cAAc,CAAC,EAAE,SAAS,GACzB,OAAO,CAAC,oBAAoB,CAAC;IA2BhC,uDAAuD;IACjD,SAAS,CACb,aAAa,EAAE,SAAS,EACxB,MAAM,EAAE,SAAS,EACjB,cAAc,CAAC,EAAE,SAAS,GACzB,OAAO,CAAC,oBAAoB,CAAC;IAYhC,oEAAoE;IAC9D,mBAAmB,CACvB,aAAa,EAAE,SAAS,EACxB,MAAM,EAAE,SAAS,EACjB,aAAa,EAAE,SAAS,EACxB,cAAc,CAAC,EAAE,SAAS,GACzB,OAAO,CAAC,oBAAoB,CAAC;IAqBhC,sDAAsD;IAChD,oBAAoB,CACxB,SAAS,EAAE,SAAS,EACpB,eAAe,EAAE,SAAS,EAC1B,MAAM,EAAE,oBAAoB,GAC3B,OAAO,CAAC,oBAAoB,CAAC;IA2DhC,+DAA+D;IACzD,gBAAgB,CACpB,SAAS,EAAE,SAAS,EACpB,MAAM,EAAE,sBAAsB,GAC7B,OAAO,CAAC,oBAAoB,CAAC;IAgBhC,4FAA4F;IACtF,uBAAuB,CAC3B,SAAS,EAAE,SAAS,EACpB,MAAM,EAAE,sBAAsB,GAC7B,OAAO,CAAC,sBAAsB,EAAE,CAAC;IAkBpC,mDAAmD;IAC7C,gBAAgB,CACpB,SAAS,EAAE,SAAS,EACpB,MAAM,EAAE,OAAO,GACd,OAAO,CAAC,oBAAoB,CAAC;IAchC,iEAAiE;IAC3D,uBAAuB,CAC3B,SAAS,EAAE,SAAS,EACpB,YAAY,EAAE,SAAS,GACtB,OAAO,CAAC,oBAAoB,CAAC;IAehC,4DAA4D;IACtD,kBAAkB,CACtB,SAAS,EAAE,SAAS,EACpB,MAAM,EAAE,wBAAwB,GAC/B,OAAO,CAAC,oBAAoB,CAAC;IA2DhC,6DAA6D;IACvD,sBAAsB,CAC1B,SAAS,EAAE,SAAS,EACpB,MAAM,EAAE,uBAAuB,GAC9B,OAAO,CAAC,oBAAoB,CAAC;CA0BjC"}