@reflectmoney/stable.ts 1.0.3 → 1.0.4

package/README.md

@@ -1,6 +1,6 @@
-# @reflectmoney/stable.ts | Reflect SDK
+# Reflect Money SDK
 
-A TypeScript SDK for interacting with the Reflect programs on Solana. This SDK provides high-level abstractions for minting, redeeming and managing stablecoins, administrative operations, and protocol integrations.
+A TypeScript SDK for interacting with the Reflect programs on Solana. This SDK provides high-level abstractions for minting, redeeming, and managing stablecoins, administrative operations, and protocol integrations.
 
 ## Installation
 
@@ -15,8 +15,8 @@ yarn add @reflectmoney/stable.ts
 The Reflect SDK enables developers to interact with the protocol via three main Reflect stablecoins:
 
 1. **USDC+ (Index 0)**: Stablecoin backed by USDC deployed in various money markets
-2. **JLP Hedged (Index 1)**: Stablecoin backed by the JLP token, neutralised with perpetual hedging strategies
-3. **LST Delta-Neutral (Index 2)**: Stablecoin backed by LSTs hedged by perpetual futures position
+2. **JLP Hedged (Index 1)**: Stablecoin backed by the JLP token, neutralized with perpetual hedging strategies
+3. **LST Delta-Neutral (Index 2)**: Stablecoin backed by LSTs hedged by perpetual futures positions
 
 ## Architecture
 
@@ -25,41 +25,28 @@ The SDK is organized into several key components:
 ### Core Classes
 
 #### `Stablecoin` (Abstract Base Class)
-The foundation for all stablecoin implementations. Provides abstract functions and common interface for:
-- minting,
-- redemption,
-- administrative operations.
+The foundation for all stablecoin implementations. Provides abstract functions and a common interface for:
+- Minting
+- Redemption
+- Administrative operations
 
 **Key Methods:**
-- `initialize()` - Initialize and set-up the stablecoin (admin-only)
 - `mint()` - Create mint instructions
 - `redeem()` - Create redemption instructions
-- `rebalance()` - Create rebalancing instructions (admin-only)
-- `updateCap()` - Update supply cap (admin-only)
-- `updateRecipients()` - Update fee recipients (admin-only)
+- `rebalance()` - Create rebalance instructions (admin-only or permissionless, depending on the strategy)
 
 #### `ReflectKeeper`
-Administrative client for protocol-level operations (admin-only):
-- Protocol initialization
-- Role and permission management
-- Action freezing/unfreezing
-- Admin account creation
-
-**Key Methods:**
-- `initializeMain()` - Initialize the main account with the program configuration
-- `freezeProtocolAction()` - Freeze/unfreeze protocol actions
-- `updateRoleHolderProtocol()` - Update protocol-level permissions
-- `createAdminAccount()` - Manage admin accounts
+Administrative client for protocol-level operations (admin-only).
 
 #### `PdaClient`
 Utility class for deriving PDAs:
 - Configuration program accounts
 - Stablecoin controllers
 - Permission accounts
-- External protocol integrations (Drift, Jupiter, Tokenised Bond)
+- External protocol integrations (Drift, Jupiter, Tokenized Bond)
 
-#### `ReflectTokenisedBond`
-Client for tokenized bonds program used for wrapping base stablecoins into yield-bearing receipts. Allows for:
+#### `ReflectTokenizedBond`
+Client for the tokenized bonds program used for wrapping base stablecoins into yield-bearing receipts. Allows for:
 - Vault creation and management
 - Receipt token generation
 - Deposit and withdrawal operations
@@ -68,33 +55,33 @@ Client for tokenized bonds program used for wrapping base stablecoins into yield
 
 #### `UsdcPlusStablecoin`
 USDC+ is a stablecoin backed by USDC deployed in money markets. Implementation details:
-- Live
+- Status: Live
 - Strategy ID: 0
 - Collateral: USDC
-- Integrated with tokenised bonds program on the protocol level. 
-- Users only receive the yield-bearing stablecoin.
-- Doesn't require rebalancing, as hedge is always preserved.
+- Integrated with the tokenized bonds program at the protocol level
+- Users only receive the yield-bearing stablecoin
+- Does not require rebalancing
 
 #### `UsdjStablecoin`
-Stablecoin backed by JLP neutralised with perpetual hedging:
-- Coming soon
+Stablecoin backed by JLP neutralized with perpetual hedging:
+- Status: Coming soon
 - Strategy ID: 1
 - Collateral: JLP (Jupiter LP tokens)
-- Requires manual wrapping via the Tokenised Bonds program.
-- Requires rebalancing, currently permissioned.
-
+- Requires manual wrapping via the Tokenized Bonds program
+- Requires rebalancing, currently permissioned
 
 #### `LstStablecoin`
 Liquid staking token delta-neutral strategy:
-- Live
+- Status: Live
 - Strategy ID: 2
-- Collateral: Various LSTs (mSOL, jitoSOL, etc.) - use `load()` functionality to fetch currently supported list of collateral assets.
-- Requires manual wrapping via the Tokenised Bonds program.
-- Requires rebalancing, currently permissioned.
+- Collateral: Various LSTs (mSOL, jitoSOL, etc.) - use `load()` functionality to fetch the currently supported list of collateral assets
+- Requires manual wrapping via the Tokenized Bonds program
+- Requires rebalancing, currently permissioned
 
 ## Usage
 
-Follow snippets below to mint and redeem Reflect stablecoins. All Stablecoin subclasses expose methods following the same schema, so the code below works interchangeably with minor changes - simply change between the three:
+Follow the snippets below to mint and redeem Reflect stablecoins. All Stablecoin subclasses expose methods following the same schema, so the code below works interchangeably with minor changes - simply change between the three:
+
 ```typescript
 const stablecoin = new UsdcPlusStablecoin(connection);
 const stablecoin = new UsdjStablecoin(connection);
@@ -105,19 +92,19 @@ const stablecoin = new LstStablecoin(connection);
 
 ```typescript
 import { UsdcPlusStablecoin } from '@reflectmoney/stable.ts';
-import { PublicKey } from '@solana/web3.js';
+import { PublicKey, Keypair, Connection, TransactionMessage, VersionedTransaction } from '@solana/web3.js';
 import BN from 'bn.js';
 
 // Use an actual user's public key, read from wallet adapter or local environment.
 const user = Keypair.generate();
 const stablecoin = new UsdcPlusStablecoin(connection);
 
-// Load controller data for most up-to-date stablecoin setup.
+// Load controller data for the most up-to-date stablecoin setup.
 await stablecoin.load(connection);
 
-// Mint stablecoins against LST collateral
+// Mint stablecoins against USDC collateral
 const instructions = await stablecoin.mint(
-    userPublicKey,
+    user.publicKey,
     new BN(1000 * 1_000_000), // Deposit collateral of 1,000 USDC (6 decimals)
     new BN(999 * 1_000_000),  // Minimum received USDC+ (0.1% slippage protection)
 );
@@ -138,7 +125,7 @@ const message = new TransactionMessage({
 
 const transaction = new VersionedTransaction(message);
 
-// Transaction signature and landing logic, adjust for your needs.
+// Transaction signature and confirmation logic, adjust for your needs.
 transaction.sign([user]);
 await connection.sendRawTransaction(transaction.serialize());
 ```
@@ -147,20 +134,20 @@ await connection.sendRawTransaction(transaction.serialize());
 
 ```typescript
 import { UsdcPlusStablecoin } from '@reflectmoney/stable.ts';
-import { PublicKey } from '@solana/web3.js';
+import { PublicKey, Keypair, Connection, TransactionMessage, VersionedTransaction } from '@solana/web3.js';
 import BN from 'bn.js';
 
 // Use an actual user's public key, read from wallet adapter or local environment.
 const user = Keypair.generate();
 const stablecoin = new UsdcPlusStablecoin(connection);
 
-// Load controller data for most up-to-date stablecoin setup.
+// Load controller data for the most up-to-date stablecoin setup.
 await stablecoin.load(connection);
 
-// Redeems USDC+ into USDC
+// Redeem USDC+ into USDC
 const instructions = await stablecoin.redeem(
-    userPublicKey,
-    new BN(999 * 1_000_000), // Burn 1,000 of USDC+
+    user.publicKey,
+    new BN(999 * 1_000_000), // Burn 999 of USDC+
     new BN(1_000 * 1_000_000),  // Minimum received USDC (USDC+ is yield bearing, so you'll receive more USDC over time)
 );
 
@@ -180,14 +167,14 @@ const message = new TransactionMessage({
 
 const transaction = new VersionedTransaction(message);
 
-// Transaction signature and landing logic, adjust for your needs.
+// Transaction signature and confirmation logic, adjust for your needs.
 transaction.sign([user]);
 await connection.sendRawTransaction(transaction.serialize());
 ```
 
 ### Integration with External Protocols
 
-The SDK is built in integration with:
+The SDK is built with integration for:
 - **Drift Protocol**: For perpetual futures and spot trading
 - **Jupiter Protocol**: For LP token operations and swaps
 - **Pyth Network**: For price oracle data

package/package.json

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