@reflectmoney/stable.ts 1.1.3 → 1.1.4

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+export * from "./stablecoins";
+export * from "./classes";
+export * from "./types";
+export { PROGRAM_ID as DELTA_NEUTRAL_PROGRAM_ID, } from "./generated/reflect_main";
+export { PROGRAM_ID as TOKENISED_BONDS_PROGRAM_ID, } from "./generated/reflect_tokenised_bonds";
+export * from "./generated/reflect_main/accounts";
+export * from "./generated/reflect_main/errors";
+export * from "./generated/reflect_main/instructions";
+export * from "./generated/reflect_main/types";

package/dist/stablecoins/LstStablecoin.d.ts

@@ -0,0 +1,103 @@
+import { Stablecoin } from "../classes/Stablecoin";
+import { Connection, PublicKey, TransactionInstruction } from "@solana/web3.js";
+import { DriftLstController } from "../generated/reflect_main";
+import BN from "bn.js";
+import { Collateral } from "../types";
+/**
+ * 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<DriftLstController> {
+    private tokenisedBondsClient;
+    /**
+     * 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?: Collateral[]);
+    /**
+     * Loads the LST controller data from the blockchain.
+     * Updates the stablecoin mint and LST mapping information.
+     */
+    load(): 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;
+        isSigner: boolean;
+    }[]>;
+    /**
+     * Creates a mint instruction for the LST stablecoin.
+     *
+     * @param signer - Public key of the signer
+     * @param amount - Amount of LST to deposit
+     * @param minimumReceived - Minimum amount of stablecoins to receive (slippage protection)
+     * @param lst - Public key of the LST being used as collateral
+     * @returns Promise resolving to an array containing a single TransactionInstruction
+     */
+    mint(signer: PublicKey, amount: BN | number, minimumReceived: number | BN, lst: PublicKey): Promise<TransactionInstruction[]>;
+    /**
+     * Creates a redeem instruction for the LST-backed stablecoin.
+     *
+     * @param signer - Public key of the signer
+     * @param amount - Amount of stablecoin to redeem
+     * @param minimumReceived - Minimum amount of LST to receive (slippage protection)
+     * @param lst - Public key of the LST being used as collateral
+     * @returns Promise resolving to an array containing a single TransactionInstruction
+     */
+    redeem(signer: PublicKey, amount: BN | number, minimumReceived: number | BN, lst: PublicKey): Promise<TransactionInstruction[]>;
+    /**
+     * Creates a rebalance instruction for the LST stablecoin.
+     * Currently returns an empty instruction, as the rebalance is unnecessary.
+     *
+     * @returns Promise resolving to an array containing a single, empty TransactionInstruction.
+     */
+    rebalance(): Promise<TransactionInstruction[]>;
+    /**
+     * Whitelists a new collateral for the LST stablecoin.
+     *
+     * @param signer - Public key of the admin
+     * @param mint - Public key of the collateral mint to whitelist
+     * @returns Promise resolving to an array containing a single TransactionInstruction
+     */
+    whitelistCollateral(signer: PublicKey, mint: PublicKey): Promise<TransactionInstruction[]>;
+    /**
+     * Gets the USD exchange rate for the LST-backed stablecoin.
+     *
+     * @returns Promise resolving to the USD exchange rate as a number
+     */
+    getBaseUsdExchangeRate(): Promise<number>;
+    getReceiptUsdExchangeRate(): Promise<number>;
+}

package/dist/stablecoins/UsdcPlusStablecoin.d.ts

@@ -0,0 +1,86 @@
+import { Stablecoin } from "../classes/Stablecoin";
+import { AccountMeta, Connection, PublicKey, TransactionInstruction } from "@solana/web3.js";
+import { DriftUsdcController } from "../generated/reflect_main";
+import BN from "bn.js";
+/**
+ * USDC+ Stablecoin implementation for the Reflect protocol.
+ * Extends the base Stablecoin class to provide USDC-specific functionality
+ * including initialization, minting, redemption, and rebalancing operations.
+ */
+export declare class UsdcPlusStablecoin extends Stablecoin<DriftUsdcController> {
+    /**
+     * Creates a new USDC+ Stablecoin instance.
+     *
+     * @param connection - Solana connection instance for RPC communication
+     * @param stablecoinMintOverride - Optional override for the stablecoin mint address
+     */
+    constructor(connection: Connection, stablecoinMintOverride?: PublicKey);
+    /**
+     * Loads the USDC+ controller data from the blockchain.
+     * Updates the stablecoin mint and strategy information.
+     */
+    load(): Promise<void>;
+    /**
+     * Initializes the USDC stablecoin with the specified parameters.
+     * Creates receipt tokens, initializes vault, and initializes the stablecoin.
+     *
+     * @param signer - Public key of the signer/initializer
+     * @param mint - Public key of the mint to be used for the stablecoin
+     * @param cap - Maximum supply cap as a BN (Big Number)
+     * @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, mint: PublicKey, cap: BN, recipientAddresses: PublicKey[], recipientCuts: number[]): Promise<TransactionInstruction[]>;
+    /**
+     * Initializes the stablecoin drift account for the USDC+ controller.
+     *
+     * @param signer - Public key of the signer/initializer
+     * @returns Promise resolving to a TransactionInstruction
+     */
+    initializeStablecoinDriftAccount(signer: PublicKey): Promise<TransactionInstruction>;
+    /**
+     * Constructs the required accounts for the InitDriftControllerS1 instruction.
+     *
+     * @param signer - Public key of the signer
+     * @returns Promise resolving to the constructed accounts object of type T
+     */
+    constructAccounts<T>(signer: PublicKey): Promise<T>;
+    /**
+     * Constructs remaining accounts for transactions.
+     * Currently returns an empty array as no additional accounts are needed.
+     *
+     * @returns Promise resolving to an empty array of AccountMeta objects
+     */
+    constructRemainingAccounts(): Promise<AccountMeta[]>;
+    /**
+     * Creates a mint instruction for the USDC+ stablecoin.
+     *
+     * @param signer - Public key of the signer
+     * @param amount - Amount of USDC to deposit
+     * @param minimumReceived - Minimum amount of USDC+ stablecoins to receive (slippage protection)
+     * @returns Promise resolving to an array containing a single TransactionInstruction
+     */
+    mint(signer: PublicKey, amount: BN | number, minimumReceived: BN | number): Promise<TransactionInstruction[]>;
+    /**
+     * Creates a redeem instruction for the USDC stablecoin.
+     * Currently returns a placeholder instruction - implementation needed.
+     *
+     * @returns Promise resolving to an array containing a single TransactionInstruction
+     */
+    redeem(signer: PublicKey, amount: BN | number, minimumReceived: BN | number): Promise<TransactionInstruction[]>;
+    /**
+     * Creates a rebalance instruction for the USDC+ stablecoin.
+     * Currently returns an empty instruction, as the rebalance is unnecessary.
+     *
+     * @returns Promise resolving to an array containing a single, empty TransactionInstruction.
+     */
+    rebalance(): Promise<TransactionInstruction[]>;
+    /**
+     * Gets the USD exchange rate for the USDC+ stablecoin.
+     *
+     * @returns Promise resolving to the USD exchange rate as a number
+     */
+    getBaseUsdExchangeRate(): Promise<number>;
+    getReceiptUsdExchangeRate(): Promise<number>;
+}

package/dist/stablecoins/UsdjStablecoin.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/stablecoins/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./UsdjStablecoin";
+export * from "./LstStablecoin";
+export * from "./UsdcPlusStablecoin";