@reflectmoney/stable.ts 1.0.0 → 1.0.2

package/dist/classes/ReflectAdmin.js

@@ -13,13 +13,35 @@ exports.ReflectAdmin = void 0;
 const web3_js_1 = require("@solana/web3.js");
 const reflect_main_1 = require("../generated/reflect_main");
 const PdaClient_1 = require("./PdaClient");
+/**
+ * Administrative client for the Reflect protocol.
+ * Provides functionality for protocol-level administration including:
+ * - Protocol initialization and setup
+ * - Role and permission management
+ * - Action freezing/unfreezing
+ * - Admin account creation and management
+ *
+ * This class is used by protocol administrators to manage global settings,
+ * user permissions, and protocol-wide configurations.
+ */
 class ReflectAdmin {
+    /**
+     * Creates a new ReflectAdmin instance.
+     *
+     * @param admin - Public key of the admin user
+     * @param connection - Solana connection instance
+     */
     constructor({ admin, connection }) {
         this.admin = admin;
         this.connection = connection;
         this.main = PdaClient_1.PdaClient.deriveMain();
     }
-    // Create `Main` account. Initial step of the setup
+    /**
+     * Creates the main program account. This is the initial step of protocol setup.
+     *
+     * @param admin - Public key of the initial admin
+     * @returns TransactionInstruction for initializing the main account
+     */
     static initializeMain(admin) {
         const [main] = web3_js_1.PublicKey.findProgramAddressSync([Buffer.from("main")], reflect_main_1.PROGRAM_ID);
         const ix = (0, reflect_main_1.createInitMainInstruction)({
@@ -30,6 +52,13 @@ class ReflectAdmin {
         }, reflect_main_1.PROGRAM_ID);
         return ix;
     }
+    /**
+     * Freezes or unfreezes a specific protocol action.
+     *
+     * @param freeze - Whether to freeze (true) or unfreeze (false) the action
+     * @param action - The action to freeze/unfreeze
+     * @returns Promise resolving to a TransactionInstruction
+     */
     freezeProtocolAction(freeze, action) {
         return __awaiter(this, void 0, void 0, function* () {
             const ix = (0, reflect_main_1.createFreezeProtocolActionInstruction)({
@@ -44,6 +73,13 @@ class ReflectAdmin {
             return ix;
         });
     }
+    /**
+     * Freezes or unfreezes a specific DEX program.
+     *
+     * @param freeze - Whether to freeze (true) or unfreeze (false) the program
+     * @param programIndex - Index of the program to freeze/unfreeze
+     * @returns Promise resolving to a TransactionInstruction
+     */
     freezeDex(freeze, programIndex) {
         return __awaiter(this, void 0, void 0, function* () {
             const ix = (0, reflect_main_1.createFreezeProgramInstruction)({
@@ -55,8 +91,16 @@ class ReflectAdmin {
                 freeze,
                 programIndex
             });
+            return ix;
         });
     }
+    /**
+     * Creates a new admin account with specified permissions.
+     *
+     * @param signer - Public key of the caller (must be existing admin)
+     * @param newAdmin - Public key of the new admin to create
+     * @returns Promise resolving to a TransactionInstruction
+     */
     createAdminAccount(signer, newAdmin) {
         return __awaiter(this, void 0, void 0, function* () {
             const ix = (0, reflect_main_1.createCreateAdminAccountInstruction)({
@@ -69,6 +113,15 @@ class ReflectAdmin {
             return ix;
         });
     }
+    /**
+     * Updates role holder permissions at the protocol level.
+     *
+     * @param signer - Public key of the admin signer
+     * @param adminToUpdate - Public key of the admin whose permissions are being updated
+     * @param affectedRole - The role being modified
+     * @param update - The type of update (Grant or Revoke)
+     * @returns Promise resolving to a TransactionInstruction
+     */
     updateRoleHolderProtocol(signer, adminToUpdate, affectedRole, update) {
         return __awaiter(this, void 0, void 0, function* () {
             const ix = (0, reflect_main_1.createUpdateRoleHolderProtocolInstruction)({
@@ -86,6 +139,16 @@ class ReflectAdmin {
             return ix;
         });
     }
+    /**
+     * Updates role holder permissions for a specific strategy.
+     *
+     * @param signer - Public key of the admin signer
+     * @param strategyId - ID of the strategy to update permissions for
+     * @param adminToUpdate - Public key of the admin whose permissions are being updated
+     * @param affectedRole - The role being modified
+     * @param update - The type of update (Grant or Revoke)
+     * @returns Promise resolving to a TransactionInstruction
+     */
     updateRoleHolderStrategy(signer, strategyId, adminToUpdate, affectedRole, update) {
         return __awaiter(this, void 0, void 0, function* () {
             const ix = (0, reflect_main_1.createUpdateRoleHolderStrategyInstruction)({
@@ -102,6 +165,16 @@ class ReflectAdmin {
             return ix;
         });
     }
+    /**
+     * Updates action role permissions for a specific strategy.
+     *
+     * @param signer - Public key of the admin signer
+     * @param strategyId - ID of the strategy to update permissions for
+     * @param action - The action being modified
+     * @param affectedRole - The role being modified
+     * @param update - The type of update (Grant or Revoke)
+     * @returns Promise resolving to a TransactionInstruction
+     */
     updateActionRoleStrategy(signer, strategyId, action, affectedRole, update) {
         return __awaiter(this, void 0, void 0, function* () {
             const ix = (0, reflect_main_1.createUpdateActionRoleStrategyInstruction)({
@@ -115,8 +188,18 @@ class ReflectAdmin {
                 role: affectedRole,
                 action
             }, reflect_main_1.PROGRAM_ID);
+            return ix;
         });
     }
+    /**
+     * Updates action role permissions at the protocol level.
+     *
+     * @param signer - Public key of the admin signer
+     * @param action - The action being modified
+     * @param affectedRole - The role being modified
+     * @param update - The type of update (Grant or Revoke)
+     * @returns Promise resolving to a TransactionInstruction
+     */
     updateActionRoleProtocol(signer, action, affectedRole, update) {
         return __awaiter(this, void 0, void 0, function* () {
             const ix = (0, reflect_main_1.createUpdateActionRoleProtocolInstruction)({

package/dist/classes/ReflectTokenisedBond.d.ts

@@ -2,15 +2,72 @@ import { Connection } from "@solana/web3.js";
 import { PublicKey } from "@solana/web3.js";
 import BN from "bn.js";
 import { Keypair } from "@solana/web3.js";
+/**
+ * Client class for interacting with the Reflect Tokenised Bonds program.
+ * Provides functionality for creating and managing tokenized bond vaults,
+ * including receipt token creation, vault initialization, deposits, and withdrawals.
+ *
+ * This class handles the tokenized bonds aspect of the Reflect protocol,
+ * allowing users to deposit assets and receive receipt tokens representing
+ * their share of the vault.
+ */
 export declare class ReflectTokenisedBond {
+    /** Solana connection instance for RPC communication */
     connection: Connection;
+    /**
+     * Creates a new ReflectTokenisedBond instance.
+     *
+     * @param connection - Solana connection instance
+     */
     constructor(connection: Connection);
+    /**
+     * Creates a receipt token for a vault.
+     * Generates a new keypair for the receipt token mint and creates the necessary instructions.
+     *
+     * @param connection - Solana connection instance
+     * @param signer - Public key of the transaction signer
+     * @param vault - Public key of the vault account
+     * @returns Promise resolving to an object containing instructions and signers
+     */
     createReceiptToken(connection: Connection, signer: PublicKey, vault: PublicKey): Promise<{
         instructions: import("@solana/web3.js").TransactionInstruction[];
         signers: Keypair[];
     }>;
+    /**
+     * Initializes the tokenized bonds program.
+     * Creates the config and admin accounts for the program.
+     *
+     * @param signer - Public key of the admin signer
+     * @returns Promise resolving to a TransactionInstruction
+     */
     initialize(signer: PublicKey): Promise<import("@solana/web3.js").TransactionInstruction>;
+    /**
+     * Initializes a new vault with specified deposit and receipt mints.
+     *
+     * @param signer - Public key of the admin signer
+     * @param depositMint - Public key of the deposit token mint
+     * @param receiptMint - Public key of the receipt token mint
+     * @returns Promise resolving to a TransactionInstruction
+     */
     initializeVault(signer: PublicKey, depositMint: PublicKey, receiptMint: PublicKey): Promise<import("@solana/web3.js").TransactionInstruction>;
+    /**
+     * Creates a deposit instruction for a vault.
+     * Allows users to deposit assets and receive receipt tokens.
+     *
+     * @param signer - Public key of the user making the deposit
+     * @param vaultId - Numeric identifier for the vault
+     * @param amount - Amount of deposit tokens to deposit
+     * @returns Promise resolving to a TransactionInstruction
+     */
     deposit(signer: PublicKey, vaultId: number, amount: BN): Promise<import("@solana/web3.js").TransactionInstruction>;
+    /**
+     * Creates a withdrawal instruction for a vault.
+     * Allows users to burn receipt tokens and receive back their deposit tokens.
+     *
+     * @param signer - Public key of the user making the withdrawal
+     * @param vaultId - Numeric identifier for the vault
+     * @param amount - Amount of receipt tokens to burn for withdrawal
+     * @returns Promise resolving to a TransactionInstruction
+     */
     withdraw(signer: PublicKey, vaultId: number, amount: BN): Promise<import("@solana/web3.js").TransactionInstruction>;
 }

package/dist/classes/ReflectTokenisedBond.js

@@ -15,10 +15,33 @@ const PdaClient_1 = require("./PdaClient");
 const web3_js_1 = require("@solana/web3.js");
 const spl_token_1 = require("@solana/spl-token");
 const web3_js_2 = require("@solana/web3.js");
+/**
+ * Client class for interacting with the Reflect Tokenised Bonds program.
+ * Provides functionality for creating and managing tokenized bond vaults,
+ * including receipt token creation, vault initialization, deposits, and withdrawals.
+ *
+ * This class handles the tokenized bonds aspect of the Reflect protocol,
+ * allowing users to deposit assets and receive receipt tokens representing
+ * their share of the vault.
+ */
 class ReflectTokenisedBond {
+    /**
+     * Creates a new ReflectTokenisedBond instance.
+     *
+     * @param connection - Solana connection instance
+     */
     constructor(connection) {
         this.connection = connection;
     }
+    /**
+     * Creates a receipt token for a vault.
+     * Generates a new keypair for the receipt token mint and creates the necessary instructions.
+     *
+     * @param connection - Solana connection instance
+     * @param signer - Public key of the transaction signer
+     * @param vault - Public key of the vault account
+     * @returns Promise resolving to an object containing instructions and signers
+     */
     createReceiptToken(connection, signer, vault) {
         return __awaiter(this, void 0, void 0, function* () {
             const keypair = web3_js_2.Keypair.generate();
@@ -37,6 +60,13 @@ class ReflectTokenisedBond {
             };
         });
     }
+    /**
+     * Initializes the tokenized bonds program.
+     * Creates the config and admin accounts for the program.
+     *
+     * @param signer - Public key of the admin signer
+     * @returns Promise resolving to a TransactionInstruction
+     */
     initialize(signer) {
         return __awaiter(this, void 0, void 0, function* () {
             const config = PdaClient_1.PdaClient.deriveLpConfig();
@@ -50,6 +80,14 @@ class ReflectTokenisedBond {
             return ix;
         });
     }
+    /**
+     * Initializes a new vault with specified deposit and receipt mints.
+     *
+     * @param signer - Public key of the admin signer
+     * @param depositMint - Public key of the deposit token mint
+     * @param receiptMint - Public key of the receipt token mint
+     * @returns Promise resolving to a TransactionInstruction
+     */
     initializeVault(signer, depositMint, receiptMint) {
         return __awaiter(this, void 0, void 0, function* () {
             const config = PdaClient_1.PdaClient.deriveLpConfig();
@@ -68,6 +106,15 @@ class ReflectTokenisedBond {
             return ix;
         });
     }
+    /**
+     * Creates a deposit instruction for a vault.
+     * Allows users to deposit assets and receive receipt tokens.
+     *
+     * @param signer - Public key of the user making the deposit
+     * @param vaultId - Numeric identifier for the vault
+     * @param amount - Amount of deposit tokens to deposit
+     * @returns Promise resolving to a TransactionInstruction
+     */
     deposit(signer, vaultId, amount) {
         return __awaiter(this, void 0, void 0, function* () {
             const vault = PdaClient_1.PdaClient.deriveLpVault(0);
@@ -95,6 +142,15 @@ class ReflectTokenisedBond {
             return ix;
         });
     }
+    /**
+     * Creates a withdrawal instruction for a vault.
+     * Allows users to burn receipt tokens and receive back their deposit tokens.
+     *
+     * @param signer - Public key of the user making the withdrawal
+     * @param vaultId - Numeric identifier for the vault
+     * @param amount - Amount of receipt tokens to burn for withdrawal
+     * @returns Promise resolving to a TransactionInstruction
+     */
     withdraw(signer, vaultId, amount) {
         return __awaiter(this, void 0, void 0, function* () {
             const vault = PdaClient_1.PdaClient.deriveLpVault(0);

package/dist/classes/Stablecoin.d.ts

@@ -3,28 +3,166 @@ import BN from "bn.js";
 import { DriftClient } from "@drift-labs/sdk";
 import { Action } from "../generated/reflect_main";
 import { StablecoinMetadata, Collateral } from "../types";
+/**
+ * Abstract base class for all stablecoin implementations in the Reflect protocol.
+ * Provides common functionality for managing stablecoins including initialization,
+ * minting, redemption, rebalancing, and administrative operations.
+ *
+ * This class serves as the foundation for different stablecoin strategies:
+ * - USDC+ (Strategy 0): Simple USDC-backed stablecoin
+ * - JLP Hedged (Strategy 1): Jupiter LP token with perpetual hedging
+ * - LST Delta-Neutral (Strategy 2): Liquid staking tokens with delta-neutral strategies
+ */
 export declare abstract class Stablecoin {
+    /** Unique index identifier for the stablecoin strategy */
     index: number;
+    /** Human-readable name of the stablecoin */
     name: string;
+    /** Solana connection instance for RPC communication */
     connection: Connection;
+    /** Public key of the controller account for this stablecoin */
     controller: PublicKey;
+    /** Array of collateral assets backing this stablecoin */
     collaterals: Collateral[];
+    /** Public key of the stablecoin mint */
     stablecoinMint: PublicKey;
+    /** Optional Drift client instance for DeFi operations */
     driftClient?: DriftClient;
+    /**
+     * Creates a new Stablecoin instance.
+     *
+     * @param index - Unique strategy index (0: USDC+, 1: JLP, 2: LST)
+     * @param name - Human-readable name for the stablecoin
+     * @param connection - Solana connection instance
+     */
     constructor(index: number, name: string, connection: Connection);
+    /**
+     * Initializes token accounts for the specified owner and mints.
+     * Creates associated token accounts if they don't exist.
+     *
+     * @param owner - Public key of the token account owner
+     * @param mints - Array of mint public keys to create accounts for
+     * @param signer - Public key of the transaction signer
+     * @returns Promise resolving to an array of TransactionInstruction objects
+     */
     initializeTokenAccounts(owner: PublicKey, mints: PublicKey[], signer: PublicKey): Promise<TransactionInstruction[]>;
+    /**
+     * Updates the supply cap for this stablecoin strategy.
+     *
+     * @param signer - Public key of the admin signer
+     * @param newCap - New maximum supply cap as BN or number
+     * @returns Promise resolving to a TransactionInstruction
+     */
     updateCap(signer: PublicKey, newCap: BN | number): Promise<TransactionInstruction>;
+    /**
+     * Updates the recipient addresses and their fee cuts for this stablecoin.
+     *
+     * @param signer - Public key of the admin signer
+     * @param recipients - Map of recipient public keys to their fee (in basepoints)
+     * @returns Promise resolving to a TransactionInstruction
+     */
     updateRecipients(signer: PublicKey, recipients: Map<PublicKey, number>): Promise<TransactionInstruction>;
+    /**
+     * Initializes a Drift sub-account for this stablecoin controller.
+     *
+     * @param signer - Public key of the admin signer
+     * @param subAccountId - Sub-account identifier (default: 0)
+     * @returns Promise resolving to a TransactionInstruction
+     */
     initializeStablecoinDriftAccount(signer: PublicKey, subAccountId?: number): Promise<TransactionInstruction>;
+    /**
+     * Initializes the Drift user stats account for this stablecoin controller.
+     *
+     * @param signer - Public key of the admin signer
+     * @returns Promise resolving to a TransactionInstruction
+     */
     initializeStablecoinDriftStatsAccount(signer: PublicKey): Promise<TransactionInstruction>;
+    /**
+     * Freezes or unfreezes a specific action for this stablecoin strategy.
+     *
+     * @param signer - Public key of the admin signer
+     * @param freeze - Whether to freeze (true) or unfreeze (false) the action
+     * @param action - The action to freeze/unfreeze
+     * @returns Promise resolving to a TransactionInstruction
+     */
     freeze(signer: PublicKey, freeze: boolean, action: Action): Promise<TransactionInstruction>;
+    /**
+     * Initializes the stablecoin mint with optional metadata.
+     *
+     * @param signer - Public key of the admin signer
+     * @param tokenKeypair - Keypair for the new mint account
+     * @param metadata - Optional metadata for the stablecoin
+     * @returns Promise resolving to an array of TransactionInstruction objects
+     */
     initializeStablecoin(signer: PublicKey, tokenKeypair: Keypair, metadata?: StablecoinMetadata): Promise<TransactionInstruction[]>;
+    /**
+     * Updates the rebalance slippage tolerance for this stablecoin strategy.
+     *
+     * @param signer - Public key of the admin signer
+     * @param slippage - New slippage tolerance value
+     * @returns Promise resolving to a TransactionInstruction
+     */
     updateRebalanceSlippage(signer: PublicKey, slippage: number): Promise<TransactionInstruction>;
-    getCollateralPrice(mint: PublicKey): Promise<void>;
+    /**
+     * Fetches the current price of a collateral asset from Pyth oracle.
+     *
+     * @param mint - Public key of the collateral mint
+     * @returns Promise resolving to the collateral price data
+     */
+    getCollateralPrice(mint: PublicKey): Promise<import("axios").AxiosResponse<any, any>>;
+    /**
+     * Abstract method to construct required accounts for transactions.
+     * Must be implemented by concrete stablecoin classes.
+     *
+     * @param signer - Public key of the transaction signer
+     * @param args - Additional arguments specific to the stablecoin implementation
+     * @returns Promise resolving to the constructed accounts object of type T
+     */
     abstract constructAccounts<T>(signer: PublicKey, ...args: any[]): Promise<T>;
+    /**
+     * Abstract method to construct remaining accounts for transactions.
+     * Must be implemented by concrete stablecoin classes.
+     *
+     * @returns Promise resolving to an array of AccountMeta objects
+     */
     abstract constructRemainingAccounts(): Promise<AccountMeta[]>;
+    /**
+     * Abstract method to initialize the stablecoin strategy.
+     * Must be implemented by concrete stablecoin classes.
+     *
+     * @param signer - Public key of the admin signer
+     * @param args - Additional arguments specific to the stablecoin implementation
+     * @returns Promise resolving to an array of TransactionInstruction objects
+     */
     abstract initialize(signer: PublicKey, ...args: any[]): Promise<TransactionInstruction[]>;
+    /**
+     * Abstract method to create mint instructions for the stablecoin.
+     * Must be implemented by concrete stablecoin classes.
+     *
+     * @param signer - Public key of the user minting stablecoins
+     * @param amount - Amount of stablecoins to mint
+     * @param minimumReceived - Minimum amount of stablecoins to receive (slippage protection)
+     * @param args - Additional arguments specific to the stablecoin implementation
+     * @returns Promise resolving to an array of TransactionInstruction objects
+     */
     abstract mint(signer: PublicKey, amount: BN | number, minimumReceived: BN | number, ...args: any[]): Promise<TransactionInstruction[]>;
+    /**
+     * Abstract method to create redeem instructions for the stablecoin.
+     * Must be implemented by concrete stablecoin classes.
+     *
+     * @param signer - Public key of the user redeeming stablecoins
+     * @param amount - Amount of stablecoins to redeem
+     * @param minimumReceived - Minimum amount of collateral to receive (slippage protection)
+     * @param args - Additional arguments specific to the stablecoin implementation
+     * @returns Promise resolving to an array of TransactionInstruction objects
+     */
     abstract redeem(signer: PublicKey, amount: BN | number, minimumReceived: BN | number, ...args: any[]): Promise<TransactionInstruction[]>;
+    /**
+     * Abstract method to create rebalance instructions for the stablecoin.
+     * Must be implemented by concrete stablecoin classes.
+     *
+     * @param signer - Public key of the admin signer
+     * @returns Promise resolving to an array of TransactionInstruction objects
+     */
     abstract rebalance(signer: PublicKey): Promise<TransactionInstruction[]>;
 }

package/dist/classes/Stablecoin.js

@@ -22,13 +22,39 @@ const constants_1 = require("../constants");
 const mpl_token_metadata_1 = require("@metaplex-foundation/mpl-token-metadata");
 const axios_1 = __importDefault(require("axios"));
 const PYTH_API_URL = "https://xc-mainnet.pyth.network/api/v1/price_feed/";
+/**
+ * Abstract base class for all stablecoin implementations in the Reflect protocol.
+ * Provides common functionality for managing stablecoins including initialization,
+ * minting, redemption, rebalancing, and administrative operations.
+ *
+ * This class serves as the foundation for different stablecoin strategies:
+ * - USDC+ (Strategy 0): Simple USDC-backed stablecoin
+ * - JLP Hedged (Strategy 1): Jupiter LP token with perpetual hedging
+ * - LST Delta-Neutral (Strategy 2): Liquid staking tokens with delta-neutral strategies
+ */
 class Stablecoin {
+    /**
+     * Creates a new Stablecoin instance.
+     *
+     * @param index - Unique strategy index (0: USDC+, 1: JLP, 2: LST)
+     * @param name - Human-readable name for the stablecoin
+     * @param connection - Solana connection instance
+     */
     constructor(index, name, connection) {
         this.index = index;
         this.name = name;
         this.connection = connection;
         this.controller = PdaClient_1.PdaClient.deriveController(this.index);
     }
+    /**
+     * Initializes token accounts for the specified owner and mints.
+     * Creates associated token accounts if they don't exist.
+     *
+     * @param owner - Public key of the token account owner
+     * @param mints - Array of mint public keys to create accounts for
+     * @param signer - Public key of the transaction signer
+     * @returns Promise resolving to an array of TransactionInstruction objects
+     */
     initializeTokenAccounts(owner, mints, signer) {
         return __awaiter(this, void 0, void 0, function* () {
             const instructions = [];
@@ -49,6 +75,13 @@ class Stablecoin {
             return instructions;
         });
     }
+    /**
+     * Updates the supply cap for this stablecoin strategy.
+     *
+     * @param signer - Public key of the admin signer
+     * @param newCap - New maximum supply cap as BN or number
+     * @returns Promise resolving to a TransactionInstruction
+     */
     updateCap(signer, newCap) {
         return __awaiter(this, void 0, void 0, function* () {
             const ix = (0, reflect_main_1.createUpdateCapInstruction)({
@@ -63,6 +96,13 @@ class Stablecoin {
             return ix;
         });
     }
+    /**
+     * Updates the recipient addresses and their fee cuts for this stablecoin.
+     *
+     * @param signer - Public key of the admin signer
+     * @param recipients - Map of recipient public keys to their fee (in basepoints)
+     * @returns Promise resolving to a TransactionInstruction
+     */
     updateRecipients(signer, recipients) {
         return __awaiter(this, void 0, void 0, function* () {
             const ix = (0, reflect_main_1.createUpdateRecipientsInstruction)({
@@ -78,6 +118,13 @@ class Stablecoin {
             return ix;
         });
     }
+    /**
+     * Initializes a Drift sub-account for this stablecoin controller.
+     *
+     * @param signer - Public key of the admin signer
+     * @param subAccountId - Sub-account identifier (default: 0)
+     * @returns Promise resolving to a TransactionInstruction
+     */
     initializeStablecoinDriftAccount(signer_1) {
         return __awaiter(this, arguments, void 0, function* (signer, subAccountId = 0) {
             const userAccount = (0, sdk_1.getUserAccountPublicKeySync)(constants_1.DRIFT_PROGRAM_ID, this.controller, subAccountId);
@@ -97,6 +144,12 @@ class Stablecoin {
             return ix;
         });
     }
+    /**
+     * Initializes the Drift user stats account for this stablecoin controller.
+     *
+     * @param signer - Public key of the admin signer
+     * @returns Promise resolving to a TransactionInstruction
+     */
     initializeStablecoinDriftStatsAccount(signer) {
         return __awaiter(this, void 0, void 0, function* () {
             const userAccount = (0, sdk_1.getUserAccountPublicKeySync)(constants_1.DRIFT_PROGRAM_ID, this.controller, 0);
@@ -115,6 +168,14 @@ class Stablecoin {
             return ix;
         });
     }
+    /**
+     * Freezes or unfreezes a specific action for this stablecoin strategy.
+     *
+     * @param signer - Public key of the admin signer
+     * @param freeze - Whether to freeze (true) or unfreeze (false) the action
+     * @param action - The action to freeze/unfreeze
+     * @returns Promise resolving to a TransactionInstruction
+     */
     freeze(signer, freeze, action) {
         return __awaiter(this, void 0, void 0, function* () {
             const ix = (0, reflect_main_1.createFreezeStrategyActionInstruction)({
@@ -131,6 +192,14 @@ class Stablecoin {
             return ix;
         });
     }
+    /**
+     * Initializes the stablecoin mint with optional metadata.
+     *
+     * @param signer - Public key of the admin signer
+     * @param tokenKeypair - Keypair for the new mint account
+     * @param metadata - Optional metadata for the stablecoin
+     * @returns Promise resolving to an array of TransactionInstruction objects
+     */
     initializeStablecoin(signer, tokenKeypair, metadata) {
         return __awaiter(this, void 0, void 0, function* () {
             const instructions = [];
@@ -165,6 +234,13 @@ class Stablecoin {
             return instructions;
         });
     }
+    /**
+     * Updates the rebalance slippage tolerance for this stablecoin strategy.
+     *
+     * @param signer - Public key of the admin signer
+     * @param slippage - New slippage tolerance value
+     * @returns Promise resolving to a TransactionInstruction
+     */
     updateRebalanceSlippage(signer, slippage) {
         return __awaiter(this, void 0, void 0, function* () {
             const ix = (0, reflect_main_1.createUpdateRebalanceSlippageInstruction)({
@@ -179,6 +255,12 @@ class Stablecoin {
             return ix;
         });
     }
+    /**
+     * Fetches the current price of a collateral asset from Pyth oracle.
+     *
+     * @param mint - Public key of the collateral mint
+     * @returns Promise resolving to the collateral price data
+     */
     getCollateralPrice(mint) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a;
@@ -186,7 +268,7 @@ class Stablecoin {
             if (!oracle) {
                 throw new Error(`Oracle not found for collateral ${mint.toBase58()}`);
             }
-            axios_1.default.get(`${PYTH_API_URL}${oracle}`);
+            return axios_1.default.get(`${PYTH_API_URL}${oracle}`);
         });
     }
 }