@carrot-protocol/boost-http-client 0.1.1-api-impl-dev-409753c

package/dist/index.d.ts

@@ -0,0 +1,41 @@
+import { AnchorProvider, web3 } from "@coral-xyz/anchor";
+import { DepositLeverageRequest, ModifyLeverageRequest, WithdrawLeverageRequest } from "./types";
+export * from "./types";
+/**
+ * HTTP Client for Carrot Boost API
+ */
+export declare class Client {
+    private readonly baseUrl;
+    private readonly http;
+    private readonly provider?;
+    /**
+     * Create a new Carrot Boost API client
+     * @param baseUrl Base URL for the API
+     */
+    constructor(baseUrl: string, provider?: AnchorProvider);
+    private send;
+    /**
+     * Get obligation details for a wallet
+     * @param owner Owner wallet public key
+     * @returns Obligation details
+     */
+    getObligation(owner: web3.PublicKey): Promise<any>;
+    /**
+     * Deposit collateral and create a leveraged position
+     * @param request Deposit leverage request parameters
+     * @returns Deposit leverage operation result
+     */
+    depositLeverage(request: 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>;
+    /**
+     * Withdraw from or close a leveraged position
+     * @param request Withdraw leverage request parameters
+     * @returns Withdraw leverage operation result
+     */
+    withdrawLeverage(request: WithdrawLeverageRequest): Promise<any>;
+}

package/dist/index.js

@@ -0,0 +1,137 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Client = void 0;
+const axios_1 = __importDefault(require("axios"));
+const anchor_1 = require("@coral-xyz/anchor");
+const bs58_1 = __importDefault(require("bs58"));
+// Re-export types
+__exportStar(require("./types"), exports);
+/**
+ * HTTP Client for Carrot Boost API
+ */
+class Client {
+    /**
+     * Create a new Carrot Boost API client
+     * @param baseUrl Base URL for the API
+     */
+    constructor(baseUrl, provider) {
+        this.baseUrl = new URL(baseUrl).toString();
+        this.http = axios_1.default.create({
+            baseURL: this.baseUrl,
+            headers: {
+                "Content-Type": "application/json",
+            },
+        });
+        this.provider = provider;
+    }
+    // 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));
+        // sign tx
+        const signedTx = await this.provider.wallet.signTransaction(tx);
+        const txSig = signedTx.signatures[0];
+        // encode it back to base64
+        const encodedAndSignedTx = Buffer.from(signedTx.serialize()).toString("base64");
+        // create request obj
+        const sendRequest = {
+            tx: encodedAndSignedTx,
+        };
+        // send to api
+        const response = await this.http.post(`${this.baseUrl}/send`, sendRequest);
+        handleStatusCode(response.status);
+        // return txsig
+        return bs58_1.default.encode(txSig);
+    }
+    /**
+     * 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);
+    }
+    /**
+     * 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);
+        return txSig;
+    }
+    /**
+     * Modify the leverage of an existing position
+     * @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);
+        return txSig;
+    }
+    /**
+     * Withdraw from or close a leveraged position
+     * @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);
+        return txSig;
+    }
+}
+exports.Client = Client;
+function handleStatusCode(statusCode) {
+    switch (statusCode) {
+        case 200:
+            break;
+        default:
+            throw new Error(`unexpected status code${statusCode}`);
+    }
+}
+// Ensures that a provider is defined
+function requireProvider(provider) {
+    if (provider) {
+        return;
+    }
+    throw new Error(`provider is undefined`);
+}

package/dist/types.d.ts

@@ -0,0 +1,57 @@
+import { web3 } from "@coral-xyz/anchor";
+import Decimal from "decimal.js";
+export interface SendRequest {
+    tx: string;
+}
+/**
+ * Request to deposit collateral and create a leveraged position
+ */
+export interface DepositLeverageRequest {
+    owner: web3.PublicKey;
+    collateralMint: web3.PublicKey;
+    debtMint: web3.PublicKey;
+    selectedTokenMint: web3.PublicKey;
+    depositAmount: Decimal;
+    leverage: number;
+    slippagePct: number;
+}
+/**
+ * Response for deposit leverage operation
+ */
+export interface DepositLeverageResponse {
+    unsignedBase64Tx: string;
+}
+/**
+ * Request to modify the leverage of an existing position
+ */
+export interface ModifyLeverageRequest {
+    owner: web3.PublicKey;
+    collateralMint: web3.PublicKey;
+    debtMint: web3.PublicKey;
+    leverage: number;
+    slippagePct: number;
+}
+/**
+ * Response for modify leverage operation
+ */
+export interface ModifyLeverageResponse {
+    unsignedBase64Tx: string;
+}
+/**
+ * Request to withdraw from a leveraged position
+ */
+export interface WithdrawLeverageRequest {
+    owner: web3.PublicKey;
+    collateralMint: web3.PublicKey;
+    debtMint: web3.PublicKey;
+    selectedTokenMint: web3.PublicKey;
+    withdrawAmount: Decimal;
+    slippagePct: number;
+    closePosition: boolean;
+}
+/**
+ * Response for withdraw leverage operation
+ */
+export interface WithdrawLeverageResponse {
+    unsignedBase64Tx: string;
+}

package/dist/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/makefile

@@ -0,0 +1,16 @@
+.DEFAULT_GOAL := build
+
+.PHONY: build clean fmt fmt_check
+
+build:
+	npm run build
+
+clean:
+	npm run clean
+
+fmt:
+	npm run fmt
+
+fmt_check:
+	npm run fmt:check
+

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@carrot-protocol/boost-http-client",
+  "version": "0.1.1-api-impl-dev-409753c",
+  "description": "HTTP client for Carrot Boost API",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "clean": "rm -rf dist node_modules *.tgz package-lock.json",
+    "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/"
+  },
+  "dependencies": {
+    "@coral-xyz/anchor": "^0.29.0",
+    "axios": "^1.8.3",
+    "bs58": "^6.0.0",
+    "decimal.js": "^10.5.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.11.19",
+    "prettier": "^3.2.5",
+    "typescript": "^5.3.3"
+  }
+}

package/src/index.ts

@@ -0,0 +1,160 @@
+import axios, { AxiosInstance } from "axios";
+import { AnchorProvider, web3 } from "@coral-xyz/anchor";
+import {
+  DepositLeverageRequest,
+  DepositLeverageResponse,
+  ModifyLeverageRequest,
+  ModifyLeverageResponse,
+  SendRequest,
+  WithdrawLeverageRequest,
+  WithdrawLeverageResponse,
+} from "./types";
+import encode from "bs58";
+
+// Re-export types
+export * from "./types";
+
+/**
+ * HTTP Client for Carrot Boost API
+ */
+export class Client {
+  private readonly baseUrl: string;
+  private readonly http: AxiosInstance;
+  private readonly provider?: AnchorProvider;
+
+  /**
+   * Create a new Carrot Boost API client
+   * @param baseUrl Base URL for the API
+   */
+  constructor(baseUrl: string, provider?: AnchorProvider) {
+    this.baseUrl = new URL(baseUrl).toString();
+    this.http = axios.create({
+      baseURL: this.baseUrl,
+      headers: {
+        "Content-Type": "application/json",
+      },
+    });
+    this.provider = provider;
+  }
+
+  // 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));
+
+    // sign tx
+    const signedTx = await this.provider!.wallet.signTransaction(tx);
+    const txSig = signedTx.signatures[0];
+
+    // encode it back to base64
+    const encodedAndSignedTx = Buffer.from(signedTx.serialize()).toString(
+      "base64",
+    );
+
+    // create request obj
+    const sendRequest: SendRequest = {
+      tx: encodedAndSignedTx,
+    };
+
+    // send to api
+    const response = await this.http.post(`${this.baseUrl}/send`, sendRequest);
+    handleStatusCode(response.status);
+
+    // return txsig
+    return encode.encode(txSig);
+  }
+
+  /**
+   * 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()}`,
+    );
+    handleStatusCode(response.status);
+    return JSON.stringify(response.data);
+  }
+
+  /**
+   * Deposit collateral and create a leveraged position
+   * @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);
+
+    // parse response
+    const responseData: DepositLeverageResponse = JSON.parse(response.data);
+
+    // sign and send signed tx back to api for sending to network
+    const txSig = await this.send(responseData.unsignedBase64Tx);
+
+    return txSig;
+  }
+
+  /**
+   * Modify the leverage of an existing position
+   * @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);
+
+    // parse response
+    const responseData: ModifyLeverageResponse = JSON.parse(response.data);
+
+    // sign and send signed tx back to api for sending to network
+    const txSig = await this.send(responseData.unsignedBase64Tx);
+
+    return txSig;
+  }
+
+  /**
+   * Withdraw from or close a leveraged position
+   * @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);
+
+    // parse response
+    const responseData: WithdrawLeverageResponse = JSON.parse(response.data);
+
+    // sign and send signed tx back to api for sending to network
+    const txSig = await this.send(responseData.unsignedBase64Tx);
+
+    return txSig;
+  }
+}
+
+function handleStatusCode(statusCode: number): void {
+  switch (statusCode) {
+    case 200:
+      break;
+    default:
+      throw new Error(`unexpected status code${statusCode}`);
+  }
+}
+
+// Ensures that a provider is defined
+function requireProvider(provider?: AnchorProvider): void {
+  if (provider) {
+    return;
+  }
+  throw new Error(`provider is undefined`);
+}

package/src/types.ts

@@ -0,0 +1,65 @@
+import { BN, web3 } from "@coral-xyz/anchor";
+import Decimal from "decimal.js";
+
+// Represents a request to send a transaction
+export interface SendRequest {
+  tx: string;
+}
+
+/**
+ * Request to deposit collateral and create a leveraged position
+ */
+export interface DepositLeverageRequest {
+  owner: web3.PublicKey;
+  collateralMint: web3.PublicKey;
+  debtMint: web3.PublicKey;
+  selectedTokenMint: web3.PublicKey;
+  depositAmount: Decimal;
+  leverage: number;
+  slippagePct: number;
+}
+
+/**
+ * Response for deposit leverage operation
+ */
+export interface DepositLeverageResponse {
+  unsignedBase64Tx: string;
+}
+
+/**
+ * Request to modify the leverage of an existing position
+ */
+export interface ModifyLeverageRequest {
+  owner: web3.PublicKey;
+  collateralMint: web3.PublicKey;
+  debtMint: web3.PublicKey;
+  leverage: number;
+  slippagePct: number;
+}
+
+/**
+ * Response for modify leverage operation
+ */
+export interface ModifyLeverageResponse {
+  unsignedBase64Tx: string;
+}
+
+/**
+ * Request to withdraw from a leveraged position
+ */
+export interface WithdrawLeverageRequest {
+  owner: web3.PublicKey;
+  collateralMint: web3.PublicKey;
+  debtMint: web3.PublicKey;
+  selectedTokenMint: web3.PublicKey;
+  withdrawAmount: Decimal;
+  slippagePct: number;
+  closePosition: boolean;
+}
+
+/**
+ * Response for withdraw leverage operation
+ */
+export interface WithdrawLeverageResponse {
+  unsignedBase64Tx: string;
+}

package/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "target": "es2020",
+    "module": "commonjs",
+    "declaration": true,
+    "outDir": "./dist",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist"]
+}