@carrot-protocol/boost-http-client 0.2.0 → 0.2.1-data-fixes-dev-ec9782e

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { AnchorProvider, web3 } from "@coral-xyz/anchor";
-import { DepositLeverageRequest, GetBankResponse, GetUserResponse, AdjustLeverageRequest, WithdrawLeverageRequest, GetGroupResponse } from "./types";
+import { GetBankResponse, GetUserResponse, GetGroupResponse } from "./types";
 export * from "./types";
 /**
  * HTTP Client for Carrot Boost API
@@ -43,17 +43,17 @@ export declare class Client {
      * @param request Deposit leverage request parameters
      * @returns Deposit leverage operation result
      */
-    depositLeverage(params: DepositLeverageRequest): Promise<string>;
+    depositLeverage(selectedTokenMint: web3.PublicKey, uiAmount: number, leverage: number, slippageBps: number): Promise<string>;
     /**
      * Adjust the leverage of an existing position
      * @param request Adjust leverage request parameters
      * @returns Adjust leverage operation result
      */
-    adjustLeverage(params: AdjustLeverageRequest): Promise<any>;
+    adjustLeverage(leverage: number, slippageBps: number): Promise<any>;
     /**
      * Withdraw from or close a leveraged position
      * @param request Withdraw leverage request parameters
      * @returns Withdraw leverage operation result
      */
-    withdrawLeverage(params: WithdrawLeverageRequest): Promise<any>;
+    withdrawLeverage(selectedTokenMint: web3.PublicKey, uiAmount: number, slippageBps: number, withdrawAll: boolean): Promise<any>;
 }

package/dist/index.js

@@ -10,28 +10,6 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
 }));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
@@ -40,7 +18,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Client = void 0;
-const axios_1 = __importStar(require("axios"));
+const axios_1 = __importDefault(require("axios"));
 const anchor_1 = require("@coral-xyz/anchor");
 const bs58_1 = __importDefault(require("bs58"));
 // Re-export types
@@ -121,6 +99,7 @@ class Client {
             return {
                 wallet,
                 clendAccount: undefined,
+                events: [],
             };
         }
         // parse lending account balances
@@ -151,9 +130,33 @@ class Client {
             notionalLeverage: Number(jsonRawResponse.clendAccount.notionalLeverage),
             riskAdjustedLeverage: Number(jsonRawResponse.clendAccount.riskAdjustedLeverage),
         };
+        // get events for account
+        const events = [];
+        for (const event of jsonRawResponse.clendAccount.events) {
+            let closeBalance = null;
+            if (event.closeBalance !== null) {
+                closeBalance = Boolean(event.closeBalance);
+            }
+            const clendAccountEvent = {
+                txSig: event.txSig,
+                eventIndex: event.eventIndex,
+                time: event.time,
+                eventName: event.eventName,
+                clendAccount: new anchor_1.web3.PublicKey(event.clendAccount),
+                signer: event.signer ? new anchor_1.web3.PublicKey(event.signer) : null,
+                clendAccountAuthority: new anchor_1.web3.PublicKey(event.clendAccountAuthority),
+                clendGroup: new anchor_1.web3.PublicKey(event.clendGroup),
+                bank: event.bank ? new anchor_1.web3.PublicKey(event.bank) : null,
+                mint: event.mint ? new anchor_1.web3.PublicKey(event.mint) : null,
+                amount: event.amount ? new anchor_1.BN(event.amount, "hex") : null,
+                closeBalance,
+            };
+            events.push(clendAccountEvent);
+        }
         return {
             wallet,
             clendAccount,
+            events,
         };
     }
     /**
@@ -193,8 +196,15 @@ class Client {
      * @param request Deposit leverage request parameters
      * @returns Deposit leverage operation result
      */
-    async depositLeverage(params) {
-        const body = await handleApiCall(() => this.http.post("leverage/deposit", JSON.stringify(params)));
+    async depositLeverage(selectedTokenMint, uiAmount, leverage, slippageBps) {
+        const req = {
+            owner: this.address(),
+            selectedTokenMint,
+            depositAmountUi: uiAmount,
+            leverage,
+            slippageBps,
+        };
+        const body = await handleApiCall(() => this.http.post("leverage/deposit", JSON.stringify(req)));
         const depositLeverageResponse = JSON.parse(body);
         const txSig = await this.send(depositLeverageResponse.unsignedBase64Tx);
         return txSig;
@@ -204,8 +214,13 @@ class Client {
      * @param request Adjust leverage request parameters
      * @returns Adjust leverage operation result
      */
-    async adjustLeverage(params) {
-        const body = await handleApiCall(() => this.http.post("leverage/adjust", JSON.stringify(params)));
+    async adjustLeverage(leverage, slippageBps) {
+        const req = {
+            owner: this.address(),
+            leverage,
+            slippageBps,
+        };
+        const body = await handleApiCall(() => this.http.post("leverage/adjust", JSON.stringify(req)));
         const adjustLeverageResponse = JSON.parse(body);
         const txSig = await this.send(adjustLeverageResponse.unsignedBase64Tx);
         return txSig;
@@ -215,8 +230,15 @@ class Client {
      * @param request Withdraw leverage request parameters
      * @returns Withdraw leverage operation result
      */
-    async withdrawLeverage(params) {
-        const body = await handleApiCall(() => this.http.post("leverage/withdraw", JSON.stringify(params)));
+    async withdrawLeverage(selectedTokenMint, uiAmount, slippageBps, withdrawAll) {
+        const req = {
+            owner: this.address(),
+            selectedTokenMint,
+            withdrawAmountUi: uiAmount,
+            slippageBps,
+            withdrawAll,
+        };
+        const body = await handleApiCall(() => this.http.post("leverage/withdraw", JSON.stringify(req)));
         const withdrawLeverageResponse = JSON.parse(body);
         const txSig = await this.send(withdrawLeverageResponse.unsignedBase64Tx);
         return txSig;
@@ -232,23 +254,21 @@ function handleStatusCode(statusCode) {
     }
 }
 // Helper function to handle API calls
-async function handleApiCall(apiCall) {
+async function handleApiCall(call) {
     try {
-        const response = await apiCall();
-        handleStatusCode(response.status);
-        return JSON.stringify(response.data);
+        const { data } = await call();
+        return JSON.stringify(data);
     }
-    catch (error) {
-        if (error instanceof axios_1.AxiosError) {
-            const simplifiedError = {
-                status: error.response?.status,
-                message: error.message,
-                url: error.config?.url,
-            };
-            console.error(simplifiedError);
-            throw new Error(JSON.stringify(simplifiedError));
+    catch (e) {
+        if (axios_1.default.isAxiosError(e)) {
+            const res = e.response;
+            if (res && typeof res.data === "object") {
+                const payload = res.data;
+                throw new Error(`${payload.error}${payload.details ? ` ${payload.details}` : ""}`);
+            }
+            throw new Error(`${e.message}`);
         }
-        throw error;
+        throw e;
     }
 }
 function getDummyProvider() {

package/dist/types.d.ts

@@ -2,19 +2,13 @@ import { BN, web3 } from "@coral-xyz/anchor";
 export interface SendRequest {
     txns: string[];
 }
-export interface CreateObligationRequest {
-    owner: web3.PublicKey;
-}
-export interface CreateObligationResponse {
-    unsignedBase64Tx: string;
-}
 /**
  * Request to deposit collateral and create a leveraged position
  */
 export interface DepositLeverageRequest {
     owner: web3.PublicKey;
     selectedTokenMint: web3.PublicKey;
-    depositAmount: BN;
+    depositAmountUi: number;
     leverage: number;
     slippageBps: number;
 }
@@ -44,7 +38,7 @@ export interface AdjustLeverageResponse {
 export interface WithdrawLeverageRequest {
     owner: web3.PublicKey;
     selectedTokenMint: web3.PublicKey;
-    withdrawAmount: BN;
+    withdrawAmountUi: number;
     slippageBps: number;
     withdrawAll: boolean;
 }
@@ -60,6 +54,7 @@ export interface GetGroupResponse {
 export interface GetUserResponse {
     wallet: UserWallet;
     clendAccount: ClendAccount | undefined;
+    events: ClendAccountEvent[];
 }
 export interface UserWallet {
     usdcBalance: BN;
@@ -108,3 +103,17 @@ export interface Bank {
     liabilityAmountUi: number;
     price: number;
 }
+export interface ClendAccountEvent {
+    txSig: string;
+    eventIndex: number;
+    time: Date;
+    eventName: string;
+    clendAccount: web3.PublicKey;
+    signer: web3.PublicKey | null;
+    clendAccountAuthority: web3.PublicKey;
+    clendGroup: web3.PublicKey;
+    bank: web3.PublicKey | null;
+    mint: web3.PublicKey | null;
+    amount: BN | null;
+    closeBalance: boolean | null;
+}

package/makefile

@@ -14,3 +14,5 @@ fmt:
 fmt_check:
 	npm run fmt:check
 
+version_check:
+	npm run version-check

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@carrot-protocol/boost-http-client",
-  "version": "0.2.0",
+  "version": "0.2.1-data-fixes-dev-ec9782e",
   "description": "HTTP client for Carrot Boost API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -9,7 +9,8 @@
     "build": "npm run clean && npm i && tsc && npm pack",
     "build:dirty": "npm i && tsc && npm pack",
     "fmt:check": "prettier --check src/",
-    "fmt": "prettier --write src/"
+    "fmt": "prettier --write src/",
+    "version-check": "current_version=$(node -p -e \"require('./package.json').version\") && if npm view @carrot-protocol/boost-http-client@$current_version > /dev/null 2>&1; then echo \"Version $current_version already exists. Please bump it in package.json\"; exit 1; fi"
   },
   "dependencies": {
     "@coral-xyz/anchor": "^0.29.0",

package/src/index.ts

@@ -15,6 +15,7 @@ import {
   Balance,
   Bank,
   GetGroupResponse,
+  ClendAccountEvent,
 } from "./types";
 import encode from "bs58";
 
@@ -118,6 +119,7 @@ export class Client {
       return {
         wallet,
         clendAccount: undefined,
+        events: [],
       };
     }
 
@@ -159,9 +161,35 @@ export class Client {
       ),
     };
 
+    // get events for account
+    const events: ClendAccountEvent[] = [];
+    for (const event of jsonRawResponse.clendAccount.events) {
+      let closeBalance: boolean | null = null;
+      if (event.closeBalance !== null) {
+        closeBalance = Boolean(event.closeBalance);
+      }
+
+      const clendAccountEvent: ClendAccountEvent = {
+        txSig: event.txSig,
+        eventIndex: event.eventIndex,
+        time: event.time,
+        eventName: event.eventName,
+        clendAccount: new web3.PublicKey(event.clendAccount),
+        signer: event.signer ? new web3.PublicKey(event.signer) : null,
+        clendAccountAuthority: new web3.PublicKey(event.clendAccountAuthority),
+        clendGroup: new web3.PublicKey(event.clendGroup),
+        bank: event.bank ? new web3.PublicKey(event.bank) : null,
+        mint: event.mint ? new web3.PublicKey(event.mint) : null,
+        amount: event.amount ? new BN(event.amount, "hex") : null,
+        closeBalance,
+      };
+      events.push(clendAccountEvent);
+    }
+
     return {
       wallet,
       clendAccount,
+      events,
     };
   }
 
@@ -215,9 +243,21 @@ export class Client {
    * @param request Deposit leverage request parameters
    * @returns Deposit leverage operation result
    */
-  async depositLeverage(params: DepositLeverageRequest): Promise<string> {
+  async depositLeverage(
+    selectedTokenMint: web3.PublicKey,
+    uiAmount: number,
+    leverage: number,
+    slippageBps: number,
+  ): Promise<string> {
+    const req: DepositLeverageRequest = {
+      owner: this.address(),
+      selectedTokenMint,
+      depositAmountUi: uiAmount,
+      leverage,
+      slippageBps,
+    };
     const body = await handleApiCall(() =>
-      this.http.post("leverage/deposit", JSON.stringify(params)),
+      this.http.post("leverage/deposit", JSON.stringify(req)),
     );
 
     const depositLeverageResponse: DepositLeverageResponse = JSON.parse(body);
@@ -232,9 +272,14 @@ export class Client {
    * @param request Adjust leverage request parameters
    * @returns Adjust leverage operation result
    */
-  async adjustLeverage(params: AdjustLeverageRequest): Promise<any> {
+  async adjustLeverage(leverage: number, slippageBps: number): Promise<any> {
+    const req: AdjustLeverageRequest = {
+      owner: this.address(),
+      leverage,
+      slippageBps,
+    };
     const body = await handleApiCall(() =>
-      this.http.post("leverage/adjust", JSON.stringify(params)),
+      this.http.post("leverage/adjust", JSON.stringify(req)),
     );
 
     const adjustLeverageResponse: AdjustLeverageResponse = JSON.parse(body);
@@ -249,9 +294,21 @@ export class Client {
    * @param request Withdraw leverage request parameters
    * @returns Withdraw leverage operation result
    */
-  async withdrawLeverage(params: WithdrawLeverageRequest): Promise<any> {
+  async withdrawLeverage(
+    selectedTokenMint: web3.PublicKey,
+    uiAmount: number,
+    slippageBps: number,
+    withdrawAll: boolean,
+  ): Promise<any> {
+    const req: WithdrawLeverageRequest = {
+      owner: this.address(),
+      selectedTokenMint,
+      withdrawAmountUi: uiAmount,
+      slippageBps,
+      withdrawAll,
+    };
     const body = await handleApiCall(() =>
-      this.http.post("leverage/withdraw", JSON.stringify(params)),
+      this.http.post("leverage/withdraw", JSON.stringify(req)),
     );
 
     const withdrawLeverageResponse: WithdrawLeverageResponse = JSON.parse(body);
@@ -262,6 +319,13 @@ export class Client {
   }
 }
 
+type ApiErrorPayload = {
+  error: string;
+  details?: unknown;
+  path: string;
+  timestamp: string;
+};
+
 function handleStatusCode(statusCode: number): void {
   switch (statusCode) {
     case 200:
@@ -273,23 +337,23 @@ function handleStatusCode(statusCode: number): void {
 
 // Helper function to handle API calls
 async function handleApiCall<T>(
-  apiCall: () => Promise<AxiosResponse<T>>,
-): Promise<any> {
+  call: () => Promise<AxiosResponse<T>>,
+): Promise<string> {
   try {
-    const response = await apiCall();
-    handleStatusCode(response.status);
-    return JSON.stringify(response.data);
-  } catch (error) {
-    if (error instanceof AxiosError) {
-      const simplifiedError = {
-        status: error.response?.status,
-        message: error.message,
-        url: error.config?.url,
-      };
-      console.error(simplifiedError);
-      throw new Error(JSON.stringify(simplifiedError));
+    const { data } = await call();
+    return JSON.stringify(data);
+  } catch (e) {
+    if (axios.isAxiosError(e)) {
+      const res = e.response;
+      if (res && typeof res.data === "object") {
+        const payload = res.data as ApiErrorPayload;
+        throw new Error(
+          `${payload.error}${payload.details ? ` ${payload.details}` : ""}`,
+        );
+      }
+      throw new Error(`${e.message}`);
     }
-    throw error;
+    throw e;
   }
 }
 

package/src/types.ts

@@ -6,21 +6,13 @@ export interface SendRequest {
   txns: string[];
 }
 
-export interface CreateObligationRequest {
-  owner: web3.PublicKey;
-}
-
-export interface CreateObligationResponse {
-  unsignedBase64Tx: string;
-}
-
 /**
  * Request to deposit collateral and create a leveraged position
  */
 export interface DepositLeverageRequest {
   owner: web3.PublicKey;
   selectedTokenMint: web3.PublicKey;
-  depositAmount: BN;
+  depositAmountUi: number;
   leverage: number;
   slippageBps: number;
 }
@@ -54,7 +46,7 @@ export interface AdjustLeverageResponse {
 export interface WithdrawLeverageRequest {
   owner: web3.PublicKey;
   selectedTokenMint: web3.PublicKey;
-  withdrawAmount: BN;
+  withdrawAmountUi: number;
   slippageBps: number;
   withdrawAll: boolean;
 }
@@ -73,6 +65,7 @@ export interface GetGroupResponse {
 export interface GetUserResponse {
   wallet: UserWallet;
   clendAccount: ClendAccount | undefined;
+  events: ClendAccountEvent[];
 }
 
 export interface UserWallet {
@@ -126,3 +119,18 @@ export interface Bank {
   liabilityAmountUi: number;
   price: number;
 }
+
+export interface ClendAccountEvent {
+  txSig: string;
+  eventIndex: number;
+  time: Date;
+  eventName: string;
+  clendAccount: web3.PublicKey;
+  signer: web3.PublicKey | null;
+  clendAccountAuthority: web3.PublicKey;
+  clendGroup: web3.PublicKey;
+  bank: web3.PublicKey | null;
+  mint: web3.PublicKey | null;
+  amount: BN | null;
+  closeBalance: boolean | null;
+}