@carrot-protocol/boost-http-client 0.4.4-handoff-dev-06f2933 → 0.4.4-handoff-dev-9a1c50a

package/dist/index.d.ts

@@ -54,32 +54,31 @@ export declare class Client extends ApiClient {
      * @returns Bank details
      */
     getBank(bankAddress: web3.PublicKey): Promise<GetBankResponse>;
-    deposit(clendGroup: web3.PublicKey, clendAccount: web3.PublicKey | null, inputTokenMint: web3.PublicKey, uiAmount: number): Promise<string>;
-    withdraw(clendAccount: web3.PublicKey, outputTokenMint: web3.PublicKey, uiAmount: number, withdrawAll: boolean): Promise<string>;
+    deposit(clendGroup: web3.PublicKey, clendAccount: web3.PublicKey | null, inputTokenMint: web3.PublicKey, uiAmount: number, useJito: boolean): Promise<string>;
+    withdraw(clendAccount: web3.PublicKey, outputTokenMint: web3.PublicKey, uiAmount: number, withdrawAll: boolean, useJito: boolean): Promise<string>;
     /**
      * Deposit collateral and create a leveraged position
      * @param request Deposit leverage request parameters
      * @returns Deposit leverage operation result
      */
-    depositLeverage(clendGroup: web3.PublicKey, clendAccount: web3.PublicKey | null, inputTokenMint: web3.PublicKey, assetTokenMint: web3.PublicKey, liabilityTokenMint: web3.PublicKey, uiAmount: number, leverage: number, slippageBps: number): Promise<string>;
+    depositLeverage(clendGroup: web3.PublicKey, clendAccount: web3.PublicKey | null, inputTokenMint: web3.PublicKey, assetTokenMint: web3.PublicKey, liabilityTokenMint: web3.PublicKey, uiAmount: number, leverage: number, slippageBps: number, useJito: boolean, isHandoff: boolean): Promise<string>;
     /**
      * Adjust the leverage of an existing position
      * @param request Adjust leverage request parameters
      * @returns Adjust leverage operation result
      */
-    adjustLeverage(clendAccount: web3.PublicKey, assetTokenMint: web3.PublicKey, liabilityTokenMint: web3.PublicKey, leverage: number, slippageBps: number): Promise<string>;
+    adjustLeverage(clendAccount: web3.PublicKey, assetTokenMint: web3.PublicKey, liabilityTokenMint: web3.PublicKey, leverage: number, slippageBps: number, useJito: boolean): Promise<string>;
     /**
      * Withdraw from or close a leveraged position
      * @param request Withdraw leverage request parameters
      * @returns Withdraw leverage operation result
      */
-    withdrawLeverage(clendAccount: web3.PublicKey, outputTokenMint: web3.PublicKey, assetTokenMint: web3.PublicKey, liabilityTokenMint: web3.PublicKey, uiAmount: number, slippageBps: number, withdrawAll: boolean): Promise<string>;
+    withdrawLeverage(clendAccount: web3.PublicKey, outputTokenMint: web3.PublicKey, assetTokenMint: web3.PublicKey, liabilityTokenMint: web3.PublicKey, uiAmount: number, slippageBps: number, withdrawAll: boolean, useJito: boolean): Promise<string>;
     /**
      * Withdraw emissions from a bank
      * @returns Withdraw emissions operation result
      */
     withdrawEmissions(clendAccount: web3.PublicKey): Promise<string>;
-    handoffDepositLeverage(): Promise<string>;
     getPerformanceChartingExtension(clendAccount: web3.PublicKey): Promise<PositionChartingExtension>;
     getGroupChartingExtension(group: web3.PublicKey): Promise<GroupChartingExtension>;
     getWalletChartingExtension(address?: web3.PublicKey): Promise<WalletChartingExtension>;

package/dist/index.js

@@ -72,29 +72,32 @@ class Client extends api_1.ApiClient {
         return this.provider.wallet.publicKey;
     }
     // sign and send tx to api for sending to network
-    async send(unsignedBase64Tx, userRequestId) {
+    async send(unsignedBase64Tx, userRequestId, useJito, handoffTxns = []) {
         if (this.dryRun) {
-            // for debugging purposes only
-            console.log("unsigedBase64Tx", unsignedBase64Tx);
+            console.log("unsignedBase64Tx", unsignedBase64Tx);
+            if (handoffTxns.length > 0)
+                console.log("handoffTxns", handoffTxns);
             console.log("dry run enabled, exiting before sending tx");
             return "";
         }
-        // deserialize into tx obj
+        // 1. Sign the primary transaction (User Transaction)
         const txBytes = Buffer.from(unsignedBase64Tx, "base64");
         const tx = anchor_1.web3.VersionedTransaction.deserialize(new Uint8Array(txBytes));
-        // sign tx
         const signedTx = await this.provider.wallet.signTransaction(tx);
+        // Grab signature for return value
         const txSig = signedTx.signatures[0];
-        // encode it back to base64
-        const encodedAndSignedTx = Buffer.from(signedTx.serialize()).toString("base64");
-        // create request obj
+        const encodedSignedUserTx = Buffer.from(signedTx.serialize()).toString("base64");
+        // 2. Construct the bundle
+        // The bundle consists of [UserSignedTx, ...PreSignedHandoffTxs]
+        const allTxns = [encodedSignedUserTx, ...handoffTxns];
+        // 3. Send to API
         const sendRequest = {
             userRequestId,
-            txns: [encodedAndSignedTx],
+            txns: allTxns,
+            useJito,
         };
-        // send to api
         await this.handleApiCall(() => this.http.post(`send`, sendRequest));
-        // return txsig
+        // Return signature of the user's transaction
         return bs58_1.default.encode(txSig);
     }
     /**
@@ -326,29 +329,31 @@ class Client extends api_1.ApiClient {
         };
         return response;
     }
-    async deposit(clendGroup, clendAccount, inputTokenMint, uiAmount) {
+    async deposit(clendGroup, clendAccount, inputTokenMint, uiAmount, useJito) {
         const req = {
             owner: this.address(),
             clendGroup,
             clendAccount,
             inputTokenMint,
             depositAmountUi: uiAmount,
+            useJito,
         };
         const body = await this.handleApiCall(() => this.http.post("deposit", JSON.stringify(req)));
         const depositResponse = JSON.parse(body);
-        const txSig = await this.send(depositResponse.unsignedBase64Tx, depositResponse.userRequestId);
+        const txSig = await this.send(depositResponse.unsignedBase64Tx, depositResponse.userRequestId, false);
         return txSig;
     }
-    async withdraw(clendAccount, outputTokenMint, uiAmount, withdrawAll) {
+    async withdraw(clendAccount, outputTokenMint, uiAmount, withdrawAll, useJito) {
         const req = {
             clendAccount,
             outputTokenMint,
             withdrawAmountUi: uiAmount,
             withdrawAll,
+            useJito,
         };
         const body = await this.handleApiCall(() => this.http.post("withdraw", JSON.stringify(req)));
         const withdrawResponse = JSON.parse(body);
-        const txSig = await this.send(withdrawResponse.unsignedBase64Tx, withdrawResponse.userRequestId);
+        const txSig = await this.send(withdrawResponse.unsignedBase64Tx, withdrawResponse.userRequestId, false);
         return txSig;
     }
     /**
@@ -356,7 +361,7 @@ class Client extends api_1.ApiClient {
      * @param request Deposit leverage request parameters
      * @returns Deposit leverage operation result
      */
-    async depositLeverage(clendGroup, clendAccount, inputTokenMint, assetTokenMint, liabilityTokenMint, uiAmount, leverage, slippageBps) {
+    async depositLeverage(clendGroup, clendAccount, inputTokenMint, assetTokenMint, liabilityTokenMint, uiAmount, leverage, slippageBps, useJito, isHandoff) {
         const req = {
             owner: this.address(),
             clendGroup,
@@ -367,10 +372,18 @@ class Client extends api_1.ApiClient {
             depositAmountUi: uiAmount,
             leverage,
             slippageBps,
+            useJito,
+            isHandoff,
         };
         const body = await this.handleApiCall(() => this.http.post("leverage/deposit", JSON.stringify(req)));
         const depositLeverageResponse = JSON.parse(body);
-        const txSig = await this.send(depositLeverageResponse.unsignedBase64Tx, depositLeverageResponse.userRequestId);
+        let handoffTxns = [];
+        if (depositLeverageResponse.txns.length > 1) {
+            handoffTxns = depositLeverageResponse.txns.slice(1);
+        }
+        const userTx = depositLeverageResponse.txns[0];
+        const txSig = await this.send(userTx, depositLeverageResponse.userRequestId, req.useJito, handoffTxns);
+        return txSig;
         return txSig;
     }
     /**
@@ -378,17 +391,18 @@ class Client extends api_1.ApiClient {
      * @param request Adjust leverage request parameters
      * @returns Adjust leverage operation result
      */
-    async adjustLeverage(clendAccount, assetTokenMint, liabilityTokenMint, leverage, slippageBps) {
+    async adjustLeverage(clendAccount, assetTokenMint, liabilityTokenMint, leverage, slippageBps, useJito) {
         const req = {
             clendAccount,
             assetTokenMint,
             liabilityTokenMint,
             leverage,
             slippageBps,
+            useJito,
         };
         const body = await this.handleApiCall(() => this.http.post("leverage/adjust", JSON.stringify(req)));
         const adjustLeverageResponse = JSON.parse(body);
-        const txSig = await this.send(adjustLeverageResponse.unsignedBase64Tx, adjustLeverageResponse.userRequestId);
+        const txSig = await this.send(adjustLeverageResponse.unsignedBase64Tx, adjustLeverageResponse.userRequestId, false);
         return txSig;
     }
     /**
@@ -396,7 +410,7 @@ class Client extends api_1.ApiClient {
      * @param request Withdraw leverage request parameters
      * @returns Withdraw leverage operation result
      */
-    async withdrawLeverage(clendAccount, outputTokenMint, assetTokenMint, liabilityTokenMint, uiAmount, slippageBps, withdrawAll) {
+    async withdrawLeverage(clendAccount, outputTokenMint, assetTokenMint, liabilityTokenMint, uiAmount, slippageBps, withdrawAll, useJito) {
         const req = {
             clendAccount,
             outputTokenMint,
@@ -405,10 +419,11 @@ class Client extends api_1.ApiClient {
             withdrawAmountUi: uiAmount,
             slippageBps,
             withdrawAll,
+            useJito,
         };
         const body = await this.handleApiCall(() => this.http.post("leverage/withdraw", JSON.stringify(req)));
         const withdrawLeverageResponse = JSON.parse(body);
-        const txSig = await this.send(withdrawLeverageResponse.unsignedBase64Tx, withdrawLeverageResponse.userRequestId);
+        const txSig = await this.send(withdrawLeverageResponse.unsignedBase64Tx, withdrawLeverageResponse.userRequestId, true);
         return txSig;
     }
     /**
@@ -418,15 +433,13 @@ class Client extends api_1.ApiClient {
     async withdrawEmissions(clendAccount) {
         const req = {
             clendAccount,
+            useJito: false,
         };
         const body = await this.handleApiCall(() => this.http.post("emissions/withdraw", JSON.stringify(req)));
         const withdrawEmissionsResponse = JSON.parse(body);
-        const txSig = await this.send(withdrawEmissionsResponse.unsignedBase64Tx, withdrawEmissionsResponse.userRequestId);
+        const txSig = await this.send(withdrawEmissionsResponse.unsignedBase64Tx, withdrawEmissionsResponse.userRequestId, false);
         return txSig;
     }
-    async handoffDepositLeverage() {
-        return "";
-    }
     async getPerformanceChartingExtension(clendAccount) {
         return new position_1.PositionChartingExtension(this.baseUrl, clendAccount);
     }

package/dist/types.d.ts

@@ -6,6 +6,7 @@ import { GroupChartingExtension } from "./charting/group";
 export interface SendRequest {
     userRequestId: string;
     txns: string[];
+    useJito: boolean;
 }
 /**
  * Request to deposit collateral
@@ -16,6 +17,7 @@ export interface DepositRequest {
     clendAccount: web3.PublicKey | null;
     inputTokenMint: web3.PublicKey;
     depositAmountUi: number;
+    useJito: boolean;
 }
 export interface DepositResponse {
     userRequestId: string;
@@ -29,6 +31,7 @@ export interface WithdrawRequest {
     outputTokenMint: web3.PublicKey;
     withdrawAmountUi: number;
     withdrawAll: boolean;
+    useJito: boolean;
 }
 export interface WithdrawResponse {
     userRequestId: string;
@@ -47,13 +50,15 @@ export interface DepositLeverageRequest {
     depositAmountUi: number;
     leverage: number;
     slippageBps: number;
+    useJito: boolean;
+    isHandoff: boolean;
 }
 /**
  * Response for deposit leverage operation
  */
 export interface DepositLeverageResponse {
     userRequestId: string;
-    unsignedBase64Tx: string;
+    txns: string[];
 }
 /**
  * Request to adjust the leverage of an existing position
@@ -64,6 +69,7 @@ export interface AdjustLeverageRequest {
     liabilityTokenMint: web3.PublicKey;
     leverage: number;
     slippageBps: number;
+    useJito: boolean;
 }
 /**
  * Response for adjust leverage operation
@@ -83,6 +89,7 @@ export interface WithdrawLeverageRequest {
     withdrawAmountUi: number;
     slippageBps: number;
     withdrawAll: boolean;
+    useJito: boolean;
 }
 /**
  * Response for withdraw leverage operation
@@ -96,6 +103,7 @@ export interface WithdrawLeverageResponse {
  */
 export interface WithdrawEmissionsRequest {
     clendAccount: web3.PublicKey;
+    useJito: boolean;
 }
 /**
  * Response for withdraw emissions operation

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@carrot-protocol/boost-http-client",
-  "version": "0.4.4-handoff-dev-06f2933",
+  "version": "0.4.4-handoff-dev-9a1c50a",
   "description": "HTTP client for Carrot Boost",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/index.ts

@@ -75,37 +75,41 @@ export class Client extends ApiClient {
   private async send(
     unsignedBase64Tx: string,
     userRequestId: string,
+    useJito: boolean,
+    handoffTxns: string[] = [], // Optional extra signed txs
   ): Promise<string> {
     if (this.dryRun) {
-      // for debugging purposes only
-      console.log("unsigedBase64Tx", unsignedBase64Tx);
+      console.log("unsignedBase64Tx", unsignedBase64Tx);
+      if (handoffTxns.length > 0) console.log("handoffTxns", handoffTxns);
       console.log("dry run enabled, exiting before sending tx");
       return "";
     }
 
-    // deserialize into tx obj
+    // 1. Sign the primary transaction (User Transaction)
     const txBytes = Buffer.from(unsignedBase64Tx, "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(
+    // Grab signature for return value
+    const txSig = signedTx.signatures[0];
+    const encodedSignedUserTx = Buffer.from(signedTx.serialize()).toString(
       "base64",
     );
 
-    // create request obj
+    // 2. Construct the bundle
+    // The bundle consists of [UserSignedTx, ...PreSignedHandoffTxs]
+    const allTxns = [encodedSignedUserTx, ...handoffTxns];
+
+    // 3. Send to API
     const sendRequest: SendRequest = {
       userRequestId,
-      txns: [encodedAndSignedTx],
+      txns: allTxns,
+      useJito,
     };
 
-    // send to api
     await this.handleApiCall(() => this.http.post(`send`, sendRequest));
 
-    // return txsig
+    // Return signature of the user's transaction
     return encode.encode(txSig);
   }
 
@@ -411,6 +415,7 @@ export class Client extends ApiClient {
     clendAccount: web3.PublicKey | null,
     inputTokenMint: web3.PublicKey,
     uiAmount: number,
+    useJito: boolean,
   ): Promise<string> {
     const req: DepositRequest = {
       owner: this.address(),
@@ -418,6 +423,7 @@ export class Client extends ApiClient {
       clendAccount,
       inputTokenMint,
       depositAmountUi: uiAmount,
+      useJito,
     };
 
     const body = await this.handleApiCall(() =>
@@ -429,6 +435,7 @@ export class Client extends ApiClient {
     const txSig = await this.send(
       depositResponse.unsignedBase64Tx,
       depositResponse.userRequestId,
+      false,
     );
 
     return txSig;
@@ -439,12 +446,14 @@ export class Client extends ApiClient {
     outputTokenMint: web3.PublicKey,
     uiAmount: number,
     withdrawAll: boolean,
+    useJito: boolean,
   ): Promise<string> {
     const req: WithdrawRequest = {
       clendAccount,
       outputTokenMint,
       withdrawAmountUi: uiAmount,
       withdrawAll,
+      useJito,
     };
 
     const body = await this.handleApiCall(() =>
@@ -456,6 +465,7 @@ export class Client extends ApiClient {
     const txSig = await this.send(
       withdrawResponse.unsignedBase64Tx,
       withdrawResponse.userRequestId,
+      false,
     );
 
     return txSig;
@@ -475,6 +485,8 @@ export class Client extends ApiClient {
     uiAmount: number,
     leverage: number,
     slippageBps: number,
+    useJito: boolean,
+    isHandoff: boolean,
   ): Promise<string> {
     const req: DepositLeverageRequest = {
       owner: this.address(),
@@ -486,6 +498,8 @@ export class Client extends ApiClient {
       depositAmountUi: uiAmount,
       leverage,
       slippageBps,
+      useJito,
+      isHandoff,
     };
     const body = await this.handleApiCall(() =>
       this.http.post("leverage/deposit", JSON.stringify(req)),
@@ -493,12 +507,22 @@ export class Client extends ApiClient {
 
     const depositLeverageResponse: DepositLeverageResponse = JSON.parse(body);
 
+    let handoffTxns: string[] = [];
+    if (depositLeverageResponse.txns.length > 1) {
+      handoffTxns = depositLeverageResponse.txns.slice(1);
+    }
+    const userTx = depositLeverageResponse.txns[0];
+
     const txSig = await this.send(
-      depositLeverageResponse.unsignedBase64Tx,
+      userTx,
       depositLeverageResponse.userRequestId,
+      req.useJito,
+      handoffTxns,
     );
 
     return txSig;
+
+    return txSig;
   }
 
   /**
@@ -512,6 +536,7 @@ export class Client extends ApiClient {
     liabilityTokenMint: web3.PublicKey,
     leverage: number,
     slippageBps: number,
+    useJito: boolean,
   ): Promise<string> {
     const req: AdjustLeverageRequest = {
       clendAccount,
@@ -519,6 +544,7 @@ export class Client extends ApiClient {
       liabilityTokenMint,
       leverage,
       slippageBps,
+      useJito,
     };
     const body = await this.handleApiCall(() =>
       this.http.post("leverage/adjust", JSON.stringify(req)),
@@ -529,6 +555,7 @@ export class Client extends ApiClient {
     const txSig = await this.send(
       adjustLeverageResponse.unsignedBase64Tx,
       adjustLeverageResponse.userRequestId,
+      false,
     );
 
     return txSig;
@@ -547,6 +574,7 @@ export class Client extends ApiClient {
     uiAmount: number,
     slippageBps: number,
     withdrawAll: boolean,
+    useJito: boolean,
   ): Promise<string> {
     const req: WithdrawLeverageRequest = {
       clendAccount,
@@ -556,6 +584,7 @@ export class Client extends ApiClient {
       withdrawAmountUi: uiAmount,
       slippageBps,
       withdrawAll,
+      useJito,
     };
     const body = await this.handleApiCall(() =>
       this.http.post("leverage/withdraw", JSON.stringify(req)),
@@ -566,6 +595,7 @@ export class Client extends ApiClient {
     const txSig = await this.send(
       withdrawLeverageResponse.unsignedBase64Tx,
       withdrawLeverageResponse.userRequestId,
+      true,
     );
 
     return txSig;
@@ -578,6 +608,7 @@ export class Client extends ApiClient {
   async withdrawEmissions(clendAccount: web3.PublicKey): Promise<string> {
     const req: WithdrawEmissionsRequest = {
       clendAccount,
+      useJito: false,
     };
 
     const body = await this.handleApiCall(() =>
@@ -590,15 +621,12 @@ export class Client extends ApiClient {
     const txSig = await this.send(
       withdrawEmissionsResponse.unsignedBase64Tx,
       withdrawEmissionsResponse.userRequestId,
+      false,
     );
 
     return txSig;
   }
 
-  async handoffDepositLeverage(): Promise<string> {
-    return "";
-  }
-
   public async getPerformanceChartingExtension(
     clendAccount: web3.PublicKey,
   ): Promise<PositionChartingExtension> {

package/src/types.ts

@@ -8,6 +8,7 @@ import { GroupChartingExtension } from "./charting/group";
 export interface SendRequest {
   userRequestId: string;
   txns: string[];
+  useJito: boolean;
 }
 
 /**
@@ -19,6 +20,7 @@ export interface DepositRequest {
   clendAccount: web3.PublicKey | null;
   inputTokenMint: web3.PublicKey;
   depositAmountUi: number;
+  useJito: boolean;
 }
 
 export interface DepositResponse {
@@ -34,6 +36,7 @@ export interface WithdrawRequest {
   outputTokenMint: web3.PublicKey;
   withdrawAmountUi: number;
   withdrawAll: boolean;
+  useJito: boolean;
 }
 
 export interface WithdrawResponse {
@@ -54,6 +57,8 @@ export interface DepositLeverageRequest {
   depositAmountUi: number;
   leverage: number;
   slippageBps: number;
+  useJito: boolean;
+  isHandoff: boolean;
 }
 
 /**
@@ -61,7 +66,7 @@ export interface DepositLeverageRequest {
  */
 export interface DepositLeverageResponse {
   userRequestId: string;
-  unsignedBase64Tx: string;
+  txns: string[];
 }
 
 /**
@@ -73,6 +78,7 @@ export interface AdjustLeverageRequest {
   liabilityTokenMint: web3.PublicKey;
   leverage: number;
   slippageBps: number;
+  useJito: boolean;
 }
 
 /**
@@ -94,6 +100,7 @@ export interface WithdrawLeverageRequest {
   withdrawAmountUi: number;
   slippageBps: number;
   withdrawAll: boolean;
+  useJito: boolean;
 }
 
 /**
@@ -109,6 +116,7 @@ export interface WithdrawLeverageResponse {
  */
 export interface WithdrawEmissionsRequest {
   clendAccount: web3.PublicKey;
+  useJito: boolean;
 }
 
 /**