Enhance robustness and UX with rebalancing and SDK improvements

.gitignore

@@ -2,6 +2,8 @@
 .DS_Store
 target
 **/node_modules/
+.pnpm-store
 .yarn
 .vscode
-dist
+dist
+.env

LICENSE

@@ -0,0 +1,11 @@
+Copyright 2025 Haven. All rights reserved.
+
+This source code is made publicly available for transparency, educational, and auditing purposes only.
+
+You may view and modify the code for personal or internal use.  
+You may **not** copy, redistribute, or use this code, in whole or in part, for any commercial purpose.
+
+Unauthorized commercial use or redistribution is strictly prohibited.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,  
+INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT.

README.md

@@ -1,19 +1,161 @@
 # Solauto
+All rights reserved @RichardPatterson
+## Overview
 
 Solauto is a program on the Solana blockchain that lets you manage leveraged longs & shorts on auto-pilot to maximize your gains and eliminate the risk of liquidation.
 
-[Go to program documentation](/programs/solauto)
-
+See the [Program documentation](/programs/solauto/README.md) for more info on the underlying Solana program.
 
 ### Repository Dependencies
 
 - Rust
 - PNPM
 
 ```
-crate install shank-idl
+cargo install shank-cli
 rustup component add rustfmt
 pnpm install -g ts-node
 ```
 
-Define `HELIUS_API_KEY` environment variable
+Define `IRONFORGE_API_KEY` environment variable for running package tests/scripts locally.
+
+### Building
+
+```bash
+# Build typescript
+pnpm build:ts
+
+# Build Solauto test program
+pnpm build:rs:test
+
+# Build Solauto prod program
+pnpm build:rs:prod
+```
+
+### Testing
+
+```bash
+# If running rust tests, build program first
+pnpm build:rs:local
+
+# Run all rust & typescript tests
+pnpm test:all
+
+# Run all rust tests
+pnpm test:rs:all
+
+# Run all typescript tests
+pnpm test:ts:all
+```
+
+## Solauto Typescript SDK
+
+The Solauto typescript SDK is made for interacting with the Solauto program. This SDK provides tools for managing, & reading Solauto state data, as well as executing transactions.
+
+```bash
+npm install @haven-fi/solauto-sdk
+# or
+yarn add @haven-fi/solauto-sdk
+# or
+pnpm add @haven-fi/solauto-sdk
+```
+
+## Basic Usage
+
+```typescript
+import { PublicKey } from "@solana/web3.js";
+import { NATIVE_MINT } from "@solana/spl-token";
+import * as solauto from "@haven-fi/solauto-sdk";
+
+// Create new Solauto client
+const client = solauto.getClient(solauto.LendingPlatform.MARGINFI, {
+  signer: yourSigner,
+  rpcUrl: "[YOUR_RPC_URL]",
+});
+
+// Initialize the client
+const supplyMint = NATIVE_MINT;
+const debtMint = new PublicKey(solauto.USDC);
+await client.initializeNewSolautoPosition({
+  positionId: 1,
+  lpPoolAccount: solauto.getMarginfiAccounts().defaultGroup,
+  supplyMint,
+  debtMint,
+});
+
+// Open a position with custom settings
+const [maxLtvBps, liqThresholdBps] =
+  await client.pos.maxLtvAndLiqThresholdBps();
+const settings: solauto.SolautoSettingsParametersInpArgs = {
+  boostToBps: solauto.maxBoostToBps(maxLtvBps, liqThresholdBps),
+  boostGap: 50,
+  repayToBps: solauto.maxRepayToBps(maxLtvBps, liqThresholdBps),
+  repayGap: 50,
+};
+
+const supplyUsdToDeposit = 100;
+const debtUsdToBorrow = 60;
+const [supplyPrice, debtPrice] = await solauto.fetchTokenPrices([
+  supplyMint,
+  debtMint,
+]);
+
+const transactionItems = [
+  // Open position
+  solauto.openSolautoPosition(client, settings),
+  // Deposit supply (SOL) transaction
+  solauto.deposit(
+    client,
+    toBaseUnit(
+      supplyUsdToDeposit / supplyPrice,
+      client.pos.supplyMintInfo.decimals
+    )
+  ),
+  // Borrow debt (USDC) transaction
+  solauto.borrow(
+    client,
+    toBaseUnit(debtUsdToBorrow / debtPrice, client.pos.debtMintInfo.decimals)
+  ),
+  // Rebalance to 0 LTV (repays all debt using collateral)
+  solauto.rebalance(client, 0),
+  // Withdraw remaining supply in position
+  solauto.withdraw(client, "All"),
+  // Close position
+  solauto.closeSolautoPosition(client),
+];
+
+// Send all transactions atomically
+const txManager = await new solauto.ClientTransactionsManager({
+  txHandler: client,
+});
+const statuses = txManager.send(transactionItems);
+```
+
+## Rebalancing an existing position
+
+```typescript
+import * as solauto from "@haven-fi/solauto-sdk";
+
+// Create new Solauto client
+const client = solauto.getClient(solauto.LendingPlatform.MARGINFI, {
+  signer: yourSigner,
+  rpcUrl: "[YOUR_RPC_URL]",
+});
+
+// Initialize the client
+await client.initializeExistingSolautoPosition({
+  positionId: myPositionId,
+});
+
+const transactionItems = [
+  solauto.rebalance(
+    client,
+    undefined // Provide target liquidation utilization rate if you want a specific LTV, otherwise it will rebalance according to position's settings (default)
+  ),
+];
+
+const txManager = await new solauto.ClientTransactionsManager({
+  txHandler: client,
+});
+const statuses = txManager.send(transactionItems);
+```

generateClients.cjs

@@ -28,6 +28,49 @@ function fixAnchorIDL(idlFilename, programId) {
     origin: "anchor",
     address: programId,
   };
+
+  function flattenDefined(data) {
+    if (typeof data === "object" && data !== null) {
+      if (Array.isArray(data)) {
+        return data.map(flattenDefined);
+      } else if (data.defined && typeof data.defined === "object") {
+        return { ...data, defined: data.defined.name };
+      } else {
+        return Object.keys(data).reduce((acc, key) => {
+          acc[key] = flattenDefined(data[key]);
+          return acc;
+        }, {});
+      }
+    }
+    return data;
+  }
+
+  data = flattenDefined(data);
+
+  function replacePubkeyWithPublicKey(data) {
+    if (typeof data === "object" && data !== null) {
+      if (Array.isArray(data)) {
+        return data.map(replacePubkeyWithPublicKey);
+      } else {
+        return Object.keys(data).reduce((acc, key) => {
+          if (key === "pubkey") {
+            acc["publicKey"] = data[key];
+          } else if (typeof data[key] === "string" && data[key] === "pubkey") {
+            acc[key] = "publicKey";
+          } else {
+            acc[key] = replacePubkeyWithPublicKey(data[key]);
+          }
+          return acc;
+        }, {});
+      }
+    } else if (data === "pubkey") {
+      return "publicKey";
+    }
+    return data;
+  }
+
+  data = replacePubkeyWithPublicKey(data);
+
   fs.writeFileSync(idlFilePath, JSON.stringify(data, null, 2), "utf8");
 }
 
@@ -50,7 +93,9 @@ function generateTypescriptSDKForAnchorIDL(sdkDirName, idlFilename, programId) {
   const kinobi = k.createFromIdls([idlFilePath]);
 
   kinobi.accept(
-    new k.renderJavaScriptVisitor(path.join(typescriptSdkDir, sdkDirName))
+    new k.renderJavaScriptVisitor(
+      path.join(typescriptSdkDir, "externalSdks", sdkDirName)
+    )
   );
 }
 
@@ -92,25 +137,30 @@ async function cleanJupiterTsSDK(exclusions = []) {
 
 generateSolautoSDK();
 
-// generateRustSDKForAnchorIDL(
-//   "marginfi-sdk",
-//   "marginfi.json",
-//   "MFv2hWf31Z9kbCa1snEPYctwafyhdvnV7FZnsebVacA"
-// );
-// generateTypescriptSDKForAnchorIDL(
-//   "marginfi-sdk",
-//   "marginfi.json",
-//   "MFv2hWf31Z9kbCa1snEPYctwafyhdvnV7FZnsebVacA"
-// );
-
 generateRustSDKForAnchorIDL(
-  "jupiter-sdk",
-  "jupiter.json",
-  "JUP6LkbZbjS1jKKwapdHNy74zcZ3tLUZoi5QNyVTaV4"
+  "marginfi-sdk",
+  "marginfi.json",
+  "MFv2hWf31Z9kbCa1snEPYctwafyhdvnV7FZnsebVacA"
 );
-// generateTypescriptSDKForAnchorIDL(
+generateTypescriptSDKForAnchorIDL(
+  "marginfi",
+  "marginfi.json",
+  "MFv2hWf31Z9kbCa1snEPYctwafyhdvnV7FZnsebVacA"
+);
+
+// generateRustSDKForAnchorIDL(
 //   "jupiter-sdk",
 //   "jupiter.json",
 //   "JUP6LkbZbjS1jKKwapdHNy74zcZ3tLUZoi5QNyVTaV4"
 // );
+// generateTypescriptSDKForAnchorIDL(
+//   "jupiter",
+//   "jupiter.json",
+//   "JUP6LkbZbjS1jKKwapdHNy74zcZ3tLUZoi5QNyVTaV4"
+// );
+// generateTypescriptSDKForAnchorIDL(
+//   "pyth",
+//   "pyth.json",
+//   "pythWSnswVUd12oZpeFP8e9CVaEqJg25g1Vtc2biRsT"
+// );
 // cleanJupiterTsSDK(["programs", "errors", "index.ts"]);