@carrot-protocol/boost-http-client 0.1.1 → 0.1.2-test-api-dev-1a330b5

package/dist/index.d.ts

@@ -7,35 +7,51 @@ export * from "./types";
 export declare class Client {
     private readonly baseUrl;
     private readonly http;
-    private readonly provider?;
+    private readonly provider;
     /**
      * Create a new Carrot Boost API client
      * @param baseUrl Base URL for the API
      */
     constructor(baseUrl: string, provider?: AnchorProvider);
+    address(): web3.PublicKey;
     private send;
+    /**
+     * Get index details
+     * @returns Index details
+     */
+    index(): Promise<any>;
     /**
      * Get obligation details for a wallet
      * @param owner Owner wallet public key
      * @returns Obligation details
      */
     getObligation(owner: web3.PublicKey): Promise<any>;
+    /**
+     * Get market details for the carrot boost market
+     * @returns Market details
+     */
+    getMarket(): Promise<any>;
+    /**
+     * Create an obligation for the client
+     * @returns Transaction signature
+     */
+    createObligation(): Promise<string>;
     /**
      * Deposit collateral and create a leveraged position
      * @param request Deposit leverage request parameters
      * @returns Deposit leverage operation result
      */
-    depositLeverage(request: DepositLeverageRequest): Promise<string>;
+    depositLeverage(params: DepositLeverageRequest): Promise<string>;
     /**
      * Modify the leverage of an existing position
      * @param request Modify leverage request parameters
      * @returns Modify leverage operation result
      */
-    modifyLeverage(request: ModifyLeverageRequest): Promise<any>;
+    modifyLeverage(params: ModifyLeverageRequest): Promise<any>;
     /**
      * Withdraw from or close a leveraged position
      * @param request Withdraw leverage request parameters
      * @returns Withdraw leverage operation result
      */
-    withdrawLeverage(request: WithdrawLeverageRequest): Promise<any>;
+    withdrawLeverage(params: WithdrawLeverageRequest): Promise<any>;
 }

package/dist/index.js

@@ -10,6 +10,28 @@ 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);
 };
@@ -18,7 +40,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Client = void 0;
-const axios_1 = __importDefault(require("axios"));
+const axios_1 = __importStar(require("axios"));
 const anchor_1 = require("@coral-xyz/anchor");
 const bs58_1 = __importDefault(require("bs58"));
 // Re-export types
@@ -39,12 +61,16 @@ class Client {
                 "Content-Type": "application/json",
             },
         });
+        if (!provider) {
+            provider = getDummyProvider();
+        }
         this.provider = provider;
     }
+    address() {
+        return this.provider.wallet.publicKey;
+    }
     // sign and send tx to api for sending to network
     async send(base64Tx) {
-        // error if provider is undefined
-        requireProvider(this.provider);
         // deserialize into tx obj
         const txBytes = Buffer.from(base64Tx, "base64");
         const tx = anchor_1.web3.VersionedTransaction.deserialize(new Uint8Array(txBytes));
@@ -58,34 +84,53 @@ class Client {
             tx: encodedAndSignedTx,
         };
         // send to api
-        const response = await this.http.post(`${this.baseUrl}/send`, sendRequest);
-        handleStatusCode(response.status);
+        await handleApiCall(() => this.http.post(`send`, sendRequest));
         // return txsig
         return bs58_1.default.encode(txSig);
     }
+    /**
+     * Get index details
+     * @returns Index details
+     */
+    async index() {
+        return handleApiCall(() => this.http.get(""));
+    }
     /**
      * Get obligation details for a wallet
      * @param owner Owner wallet public key
      * @returns Obligation details
      */
     async getObligation(owner) {
-        const response = await this.http.get(`/obligation?owner=${owner.toString()}`);
-        handleStatusCode(response.status);
-        return JSON.stringify(response.data);
+        const body = await handleApiCall(() => this.http.get(`/obligation?owner=${owner.toString()}`));
+        return body;
+    }
+    /**
+     * Get market details for the carrot boost market
+     * @returns Market details
+     */
+    async getMarket() {
+        const body = await handleApiCall(() => this.http.get(`market`));
+        return body;
+    }
+    /**
+     * Create an obligation for the client
+     * @returns Transaction signature
+     */
+    async createObligation() {
+        const body = await handleApiCall(() => this.http.post("createObligation", JSON.stringify({ owner: this.address() })));
+        const createObligationResponse = JSON.parse(body);
+        const txSig = await this.send(createObligationResponse.unsignedBase64Tx);
+        return txSig;
     }
     /**
      * Deposit collateral and create a leveraged position
      * @param request Deposit leverage request parameters
      * @returns Deposit leverage operation result
      */
-    async depositLeverage(request) {
-        const response = await this.http.post("/leverage/deposit", request);
-        // check http status code
-        handleStatusCode(response.status);
-        // parse response
-        const responseData = JSON.parse(response.data);
-        // sign and send signed tx back to api for sending to network
-        const txSig = await this.send(responseData.unsignedBase64Tx);
+    async depositLeverage(params) {
+        const body = await handleApiCall(() => this.http.post("leverage/deposit", JSON.stringify(params)));
+        const depositLeverageResponse = JSON.parse(body);
+        const txSig = await this.send(depositLeverageResponse.unsignedBase64Tx);
         return txSig;
     }
     /**
@@ -93,14 +138,10 @@ class Client {
      * @param request Modify leverage request parameters
      * @returns Modify leverage operation result
      */
-    async modifyLeverage(request) {
-        const response = await this.http.post("/leverage/modify", request);
-        // check http status code
-        handleStatusCode(response.status);
-        // parse response
-        const responseData = JSON.parse(response.data);
-        // sign and send signed tx back to api for sending to network
-        const txSig = await this.send(responseData.unsignedBase64Tx);
+    async modifyLeverage(params) {
+        const body = await handleApiCall(() => this.http.post("leverage/modify", JSON.stringify(params)));
+        const modifyLeverageResponse = JSON.parse(body);
+        const txSig = await this.send(modifyLeverageResponse.unsignedBase64Tx);
         return txSig;
     }
     /**
@@ -108,14 +149,10 @@ class Client {
      * @param request Withdraw leverage request parameters
      * @returns Withdraw leverage operation result
      */
-    async withdrawLeverage(request) {
-        const response = await this.http.post("/leverage/withdraw", request);
-        // check http status code
-        handleStatusCode(response.status);
-        // parse response
-        const responseData = JSON.parse(response.data);
-        // sign and send signed tx back to api for sending to network
-        const txSig = await this.send(responseData.unsignedBase64Tx);
+    async withdrawLeverage(params) {
+        const body = await handleApiCall(() => this.http.post("leverage/withdraw", JSON.stringify(params)));
+        const withdrawLeverageResponse = JSON.parse(body);
+        const txSig = await this.send(withdrawLeverageResponse.unsignedBase64Tx);
         return txSig;
     }
 }
@@ -125,13 +162,31 @@ function handleStatusCode(statusCode) {
         case 200:
             break;
         default:
-            throw new Error(`unexpected status code${statusCode}`);
+            throw new Error(`unexpected status code: ${statusCode}`);
     }
 }
-// Ensures that a provider is defined
-function requireProvider(provider) {
-    if (provider) {
-        return;
+// Helper function to handle API calls
+async function handleApiCall(apiCall) {
+    try {
+        const response = await apiCall();
+        handleStatusCode(response.status);
+        return JSON.stringify(response.data);
     }
-    throw new Error(`provider is undefined`);
+    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));
+        }
+        throw error;
+    }
+}
+function getDummyProvider() {
+    return new anchor_1.AnchorProvider(new anchor_1.web3.Connection("http://localhost:8899"), new anchor_1.Wallet(anchor_1.web3.Keypair.generate()), {
+        skipPreflight: false,
+    });
 }

package/dist/types.d.ts

@@ -3,6 +3,12 @@ import Decimal from "decimal.js";
 export interface SendRequest {
     tx: string;
 }
+export interface CreateObligationRequest {
+    owner: web3.PublicKey;
+}
+export interface CreateObligationResponse {
+    unsignedBase64Tx: string;
+}
 /**
  * Request to deposit collateral and create a leveraged position
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@carrot-protocol/boost-http-client",
-  "version": "0.1.1",
+  "version": "0.1.2-test-api-dev-1a330b5",
   "description": "HTTP client for Carrot Boost API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/index.ts

@@ -1,6 +1,7 @@
-import axios, { AxiosInstance } from "axios";
-import { AnchorProvider, web3 } from "@coral-xyz/anchor";
+import axios, { AxiosInstance, AxiosError, AxiosResponse } from "axios";
+import { AnchorProvider, Wallet, web3 } from "@coral-xyz/anchor";
 import {
+  CreateObligationResponse,
   DepositLeverageRequest,
   DepositLeverageResponse,
   ModifyLeverageRequest,
@@ -20,7 +21,7 @@ export * from "./types";
 export class Client {
   private readonly baseUrl: string;
   private readonly http: AxiosInstance;
-  private readonly provider?: AnchorProvider;
+  private readonly provider: AnchorProvider;
 
   /**
    * Create a new Carrot Boost API client
@@ -34,14 +35,18 @@ export class Client {
         "Content-Type": "application/json",
       },
     });
+    if (!provider) {
+      provider = getDummyProvider();
+    }
     this.provider = provider;
   }
 
+  address(): web3.PublicKey {
+    return this.provider!.wallet.publicKey;
+  }
+
   // sign and send tx to api for sending to network
   private async send(base64Tx: string): Promise<string> {
-    // error if provider is undefined
-    requireProvider(this.provider);
-
     // deserialize into tx obj
     const txBytes = Buffer.from(base64Tx, "base64");
     const tx = web3.VersionedTransaction.deserialize(new Uint8Array(txBytes));
@@ -61,24 +66,58 @@ export class Client {
     };
 
     // send to api
-    const response = await this.http.post(`${this.baseUrl}/send`, sendRequest);
-    handleStatusCode(response.status);
+    await handleApiCall(() => this.http.post(`send`, sendRequest));
 
     // return txsig
     return encode.encode(txSig);
   }
 
+  /**
+   * Get index details
+   * @returns Index details
+   */
+  async index(): Promise<any> {
+    return handleApiCall(() => this.http.get(""));
+  }
+
   /**
    * Get obligation details for a wallet
    * @param owner Owner wallet public key
    * @returns Obligation details
    */
   async getObligation(owner: web3.PublicKey): Promise<any> {
-    const response = await this.http.get(
-      `/obligation?owner=${owner.toString()}`,
+    const body = await handleApiCall(() =>
+      this.http.get(`/obligation?owner=${owner.toString()}`),
     );
-    handleStatusCode(response.status);
-    return JSON.stringify(response.data);
+    return body;
+  }
+
+  /**
+   * Get market details for the carrot boost market
+   * @returns Market details
+   */
+  async getMarket(): Promise<any> {
+    const body = await handleApiCall(() => this.http.get(`market`));
+    return body;
+  }
+
+  /**
+   * Create an obligation for the client
+   * @returns Transaction signature
+   */
+  async createObligation(): Promise<string> {
+    const body = await handleApiCall(() =>
+      this.http.post(
+        "createObligation",
+        JSON.stringify({ owner: this.address() }),
+      ),
+    );
+
+    const createObligationResponse: CreateObligationResponse = JSON.parse(body);
+
+    const txSig = await this.send(createObligationResponse.unsignedBase64Tx);
+
+    return txSig;
   }
 
   /**
@@ -86,17 +125,14 @@ export class Client {
    * @param request Deposit leverage request parameters
    * @returns Deposit leverage operation result
    */
-  async depositLeverage(request: DepositLeverageRequest): Promise<string> {
-    const response = await this.http.post("/leverage/deposit", request);
-
-    // check http status code
-    handleStatusCode(response.status);
+  async depositLeverage(params: DepositLeverageRequest): Promise<string> {
+    const body = await handleApiCall(() =>
+      this.http.post("leverage/deposit", JSON.stringify(params)),
+    );
 
-    // parse response
-    const responseData: DepositLeverageResponse = JSON.parse(response.data);
+    const depositLeverageResponse: DepositLeverageResponse = JSON.parse(body);
 
-    // sign and send signed tx back to api for sending to network
-    const txSig = await this.send(responseData.unsignedBase64Tx);
+    const txSig = await this.send(depositLeverageResponse.unsignedBase64Tx);
 
     return txSig;
   }
@@ -106,17 +142,14 @@ export class Client {
    * @param request Modify leverage request parameters
    * @returns Modify leverage operation result
    */
-  async modifyLeverage(request: ModifyLeverageRequest): Promise<any> {
-    const response = await this.http.post("/leverage/modify", request);
-
-    // check http status code
-    handleStatusCode(response.status);
+  async modifyLeverage(params: ModifyLeverageRequest): Promise<any> {
+    const body = await handleApiCall(() =>
+      this.http.post("leverage/modify", JSON.stringify(params)),
+    );
 
-    // parse response
-    const responseData: ModifyLeverageResponse = JSON.parse(response.data);
+    const modifyLeverageResponse: ModifyLeverageResponse = JSON.parse(body);
 
-    // sign and send signed tx back to api for sending to network
-    const txSig = await this.send(responseData.unsignedBase64Tx);
+    const txSig = await this.send(modifyLeverageResponse.unsignedBase64Tx);
 
     return txSig;
   }
@@ -126,17 +159,14 @@ export class Client {
    * @param request Withdraw leverage request parameters
    * @returns Withdraw leverage operation result
    */
-  async withdrawLeverage(request: WithdrawLeverageRequest): Promise<any> {
-    const response = await this.http.post("/leverage/withdraw", request);
-
-    // check http status code
-    handleStatusCode(response.status);
+  async withdrawLeverage(params: WithdrawLeverageRequest): Promise<any> {
+    const body = await handleApiCall(() =>
+      this.http.post("leverage/withdraw", JSON.stringify(params)),
+    );
 
-    // parse response
-    const responseData: WithdrawLeverageResponse = JSON.parse(response.data);
+    const withdrawLeverageResponse: WithdrawLeverageResponse = JSON.parse(body);
 
-    // sign and send signed tx back to api for sending to network
-    const txSig = await this.send(responseData.unsignedBase64Tx);
+    const txSig = await this.send(withdrawLeverageResponse.unsignedBase64Tx);
 
     return txSig;
   }
@@ -147,14 +177,38 @@ function handleStatusCode(statusCode: number): void {
     case 200:
       break;
     default:
-      throw new Error(`unexpected status code${statusCode}`);
+      throw new Error(`unexpected status code: ${statusCode}`);
   }
 }
 
-// Ensures that a provider is defined
-function requireProvider(provider?: AnchorProvider): void {
-  if (provider) {
-    return;
+// Helper function to handle API calls
+async function handleApiCall<T>(
+  apiCall: () => Promise<AxiosResponse<T>>,
+): Promise<any> {
+  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));
+    }
+    throw error;
   }
-  throw new Error(`provider is undefined`);
+}
+
+function getDummyProvider(): AnchorProvider {
+  return new AnchorProvider(
+    new web3.Connection("http://localhost:8899"),
+    new Wallet(web3.Keypair.generate()),
+    {
+      skipPreflight: false,
+    },
+  );
 }

package/src/types.ts

@@ -6,6 +6,14 @@ export interface SendRequest {
   tx: string;
 }
 
+export interface CreateObligationRequest {
+  owner: web3.PublicKey;
+}
+
+export interface CreateObligationResponse {
+  unsignedBase64Tx: string;
+}
+
 /**
  * Request to deposit collateral and create a leveraged position
  */