@reflectmoney/stable.ts 1.0.0 → 1.0.1

package/dist/stablecoins/LstStablecoin.d.ts

@@ -2,12 +2,59 @@ import { Stablecoin } from "../classes/Stablecoin";
 import { Connection, PublicKey, TransactionInstruction } from "@solana/web3.js";
 import { DriftLstData } from "../generated/reflect_main";
 import BN from "bn.js";
+/**
+ * LST (Liquid Staking Token) Delta-Neutral Stablecoin implementation.
+ * Extends the base Stablecoin class to provide LST-specific functionality
+ * including delta-neutral strategies with perpetual hedging.
+ *
+ * This stablecoin allows users to mint stablecoins against LST collateral
+ * while maintaining delta-neutral exposure through perpetual futures hedging.
+ * Strategy ID: 2
+ */
 export declare class LstStablecoin extends Stablecoin {
+    /** Array of LST data containing market indices and sub-account mappings */
     lstMap: DriftLstData[];
+    /**
+     * Creates a new LST Stablecoin instance.
+     *
+     * @param connection - Solana connection instance for RPC communication
+     * @param stablecoinMintOverride - Optional override for the stablecoin mint address
+     * @param collateralMintsOverride - Optional override for collateral mint addresses
+     */
     constructor(connection: Connection, stablecoinMintOverride?: PublicKey, collateralMintsOverride?: PublicKey[]);
+    /**
+     * Loads the LST controller data from the blockchain.
+     * Updates the stablecoin mint and LST mapping information.
+     *
+     * @param connection - Solana connection instance
+     */
     load(connection: Connection): Promise<void>;
+    /**
+     * Initializes the LST stablecoin with the specified parameters.
+     * Sets up the controller with cap, mint, and recipient information.
+     *
+     * @param signer - Public key of the signer/initializer
+     * @param cap - Maximum supply cap as a BN
+     * @param mint - Public key of the stablecoin mint
+     * @param recipientAddresses - Array of recipient public keys for fee distribution
+     * @param recipientCuts - Array of fee cuts (percentages) corresponding to each recipient
+     * @returns Promise resolving to an array of TransactionInstruction objects
+     */
     initialize(signer: PublicKey, cap: BN, mint: PublicKey, recipientAddresses: PublicKey[], recipientCuts: number[]): Promise<TransactionInstruction[]>;
+    /**
+     * Constructs the required accounts for LST mint/redeem transactions.
+     *
+     * @param signer - Public key of the transaction signer
+     * @param lst - Public key of the LST being used as collateral
+     * @returns Promise resolving to the constructed accounts object of type T
+     */
     constructAccounts<T>(signer: PublicKey, lst: PublicKey): Promise<T>;
+    /**
+     * Constructs remaining accounts for LST transactions.
+     * Includes USDC spot market, SOL oracle, and SOL perpetual market accounts.
+     *
+     * @returns Promise resolving to an array of AccountMeta objects
+     */
     constructRemainingAccounts(): Promise<{
         pubkey: PublicKey;
         isWritable: boolean;

package/dist/stablecoins/LstStablecoin.js

@@ -21,7 +21,23 @@ const reflect_main_1 = require("../generated/reflect_main");
 const sdk_1 = require("@drift-labs/sdk");
 const spl_token_1 = require("@solana/spl-token");
 const nodewallet_1 = __importDefault(require("@coral-xyz/anchor/dist/cjs/nodewallet"));
+/**
+ * LST (Liquid Staking Token) Delta-Neutral Stablecoin implementation.
+ * Extends the base Stablecoin class to provide LST-specific functionality
+ * including delta-neutral strategies with perpetual hedging.
+ *
+ * This stablecoin allows users to mint stablecoins against LST collateral
+ * while maintaining delta-neutral exposure through perpetual futures hedging.
+ * Strategy ID: 2
+ */
 class LstStablecoin extends Stablecoin_1.Stablecoin {
+    /**
+     * Creates a new LST Stablecoin instance.
+     *
+     * @param connection - Solana connection instance for RPC communication
+     * @param stablecoinMintOverride - Optional override for the stablecoin mint address
+     * @param collateralMintsOverride - Optional override for collateral mint addresses
+     */
     constructor(connection, stablecoinMintOverride, collateralMintsOverride) {
         super(2, "Single-Sided LST Delta-Neutral", connection);
         this.driftClient = new sdk_1.DriftClient({
@@ -35,6 +51,12 @@ class LstStablecoin extends Stablecoin_1.Stablecoin {
         if (collateralMintsOverride)
             this.collaterals = collateralMintsOverride.map(mint => ({ mint, oracle: "" }));
     }
+    /**
+     * Loads the LST controller data from the blockchain.
+     * Updates the stablecoin mint and LST mapping information.
+     *
+     * @param connection - Solana connection instance
+     */
     load(connection) {
         return __awaiter(this, void 0, void 0, function* () {
             const { lsts, baseStrategy: { mint } } = yield reflect_main_1.DriftLstController.fromAccountAddress(connection, this.controller);
@@ -48,6 +70,17 @@ class LstStablecoin extends Stablecoin_1.Stablecoin {
             });
         });
     }
+    /**
+     * Initializes the LST stablecoin with the specified parameters.
+     * Sets up the controller with cap, mint, and recipient information.
+     *
+     * @param signer - Public key of the signer/initializer
+     * @param cap - Maximum supply cap as a BN
+     * @param mint - Public key of the stablecoin mint
+     * @param recipientAddresses - Array of recipient public keys for fee distribution
+     * @param recipientCuts - Array of fee cuts (percentages) corresponding to each recipient
+     * @returns Promise resolving to an array of TransactionInstruction objects
+     */
     initialize(signer, cap, mint, recipientAddresses, recipientCuts) {
         return __awaiter(this, void 0, void 0, function* () {
             const ix = (0, reflect_main_1.createInitDriftControllerS3Instruction)({
@@ -65,6 +98,13 @@ class LstStablecoin extends Stablecoin_1.Stablecoin {
             return [ix];
         });
     }
+    /**
+     * Constructs the required accounts for LST mint/redeem transactions.
+     *
+     * @param signer - Public key of the transaction signer
+     * @param lst - Public key of the LST being used as collateral
+     * @returns Promise resolving to the constructed accounts object of type T
+     */
     constructAccounts(signer, lst) {
         return __awaiter(this, void 0, void 0, function* () {
             const { marketIndex: lstMarketIndex } = sdk_1.SpotMarkets["mainnet-beta"]
@@ -101,6 +141,12 @@ class LstStablecoin extends Stablecoin_1.Stablecoin {
             return accounts;
         });
     }
+    /**
+     * Constructs remaining accounts for LST transactions.
+     * Includes USDC spot market, SOL oracle, and SOL perpetual market accounts.
+     *
+     * @returns Promise resolving to an array of AccountMeta objects
+     */
     constructRemainingAccounts() {
         return __awaiter(this, void 0, void 0, function* () {
             const { marketIndex: usdcMarketIndex, oracle: usdcOracle, } = sdk_1.SpotMarkets["mainnet-beta"]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reflectmoney/stable.ts",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "type": "module",
   "author": "stablecoinjesus @ Palindrome Engineering",
   "repository": {