@haven-fi/solauto-sdk 1.0.837 → 1.0.838

package/README.md

@@ -75,6 +75,10 @@ const statuses = txManager.send(transactionItems);
 
 ## Rebalancing an existing position
 
+For automated rebalancers, set `autoUpdateLookupTable: false` on
+`ClientTransactionsManager` to skip creating or extending the authority lookup
+table. Existing lookup tables are still used. The option defaults to `true`.
+
 ```typescript
 import * as solauto from "@haven-fi/solauto-sdk";
 

package/dist/services/transactions/manager/clientTransactionsManager.d.ts

@@ -1,7 +1,16 @@
 import { SolautoClient } from "../../solauto";
-import { TransactionsManager } from "./transactionsManager";
+import { TransactionsManager, TransactionsManagerArgs } from "./transactionsManager";
 import { TransactionItem } from "../types";
+export interface ClientTransactionsManagerArgs extends TransactionsManagerArgs<SolautoClient> {
+    /**
+     * Create or extend the authority lookup table before sending. Defaults to true.
+     * Existing lookup tables are still used when false.
+     */
+    autoUpdateLookupTable?: boolean;
+}
 export declare class ClientTransactionsManager extends TransactionsManager<SolautoClient> {
+    private readonly autoUpdateLookupTable;
+    constructor(args: ClientTransactionsManagerArgs);
     private updateLut;
     private addChoreTxs;
     send(transactions: TransactionItem[]): Promise<import("./transactionsManager").TransactionManagerStatuses>;

package/dist/services/transactions/manager/clientTransactionsManager.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"clientTransactionsManager.d.ts","sourceRoot":"","sources":["../../../../src/services/transactions/manager/clientTransactionsManager.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAI5D,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAI3C,qBAAa,yBAA0B,SAAQ,mBAAmB,CAAC,aAAa,CAAC;YACjE,SAAS;YAmBT,WAAW;IA4CZ,IAAI,CAAC,YAAY,EAAE,eAAe,EAAE;CAmClD"}
+{"version":3,"file":"clientTransactionsManager.d.ts","sourceRoot":"","sources":["../../../../src/services/transactions/manager/clientTransactionsManager.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,EACL,mBAAmB,EACnB,uBAAuB,EACxB,MAAM,uBAAuB,CAAC;AAI/B,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAI3C,MAAM,WAAW,6BACf,SAAQ,uBAAuB,CAAC,aAAa,CAAC;IAC9C;;;OAGG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACjC;AAED,qBAAa,yBAA0B,SAAQ,mBAAmB,CAAC,aAAa,CAAC;IAC/E,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAAU;gBAEpC,IAAI,EAAE,6BAA6B;YAKjC,SAAS;YAmBT,WAAW;IA4CZ,IAAI,CAAC,YAAY,EAAE,eAAe,EAAE;CAqClD"}

package/dist/services/transactions/manager/clientTransactionsManager.js

@@ -8,6 +8,10 @@ const types_1 = require("../types");
 const transactionUtils_1 = require("../transactionUtils");
 const constants_1 = require("../../../constants");
 class ClientTransactionsManager extends transactionsManager_1.TransactionsManager {
+    constructor(args) {
+        super(args);
+        this.autoUpdateLookupTable = args.autoUpdateLookupTable ?? true;
+    }
     async updateLut(tx, newLut) {
         const lutInputs = await this.lookupTables.getLutInputs();
         const updateLutTxName = `${newLut ? "create" : "update"} lookup table`;
@@ -37,7 +41,9 @@ class ClientTransactionsManager extends transactionsManager_1.TransactionsManage
     async send(transactions) {
         const items = [...transactions];
         const client = this.txHandler;
-        const updateLut = await client.updateLookupTable();
+        const updateLut = this.autoUpdateLookupTable
+            ? await client.updateLookupTable()
+            : undefined;
         const updateLutInSepTx = updateLut?.new || (updateLut?.accountsToAdd ?? []).length > 4;
         if (updateLut && updateLutInSepTx) {
             await this.updateLut(updateLut.tx, updateLut.new);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@haven-fi/solauto-sdk",
-  "version": "1.0.837",
+  "version": "1.0.838",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "description": "Typescript SDK for the Solauto program on the Solana blockchain",

package/src/services/transactions/manager/clientTransactionsManager.ts

@@ -3,7 +3,10 @@ import {
   TransactionBuilder,
 } from "@metaplex-foundation/umi";
 import { SolautoClient } from "../../solauto";
-import { TransactionsManager } from "./transactionsManager";
+import {
+  TransactionsManager,
+  TransactionsManagerArgs,
+} from "./transactionsManager";
 import {
   retryWithExponentialBackoff,
 } from "../../../utils";
@@ -11,7 +14,23 @@ import { TransactionItem } from "../types";
 import { getTransactionChores } from "../transactionUtils";
 import { CHORES_TX_NAME } from "../../../constants";
 
+export interface ClientTransactionsManagerArgs
+  extends TransactionsManagerArgs<SolautoClient> {
+  /**
+   * Create or extend the authority lookup table before sending. Defaults to true.
+   * Existing lookup tables are still used when false.
+   */
+  autoUpdateLookupTable?: boolean;
+}
+
 export class ClientTransactionsManager extends TransactionsManager<SolautoClient> {
+  private readonly autoUpdateLookupTable: boolean;
+
+  constructor(args: ClientTransactionsManagerArgs) {
+    super(args);
+    this.autoUpdateLookupTable = args.autoUpdateLookupTable ?? true;
+  }
+
   private async updateLut(tx: TransactionBuilder, newLut: boolean) {
     const lutInputs = await this.lookupTables.getLutInputs();
     const updateLutTxName = `${newLut ? "create" : "update"} lookup table`;
@@ -79,7 +98,9 @@ export class ClientTransactionsManager extends TransactionsManager<SolautoClient
     const items = [...transactions];
     const client = this.txHandler as SolautoClient;
 
-    const updateLut = await client.updateLookupTable();
+    const updateLut = this.autoUpdateLookupTable
+      ? await client.updateLookupTable()
+      : undefined;
 
     const updateLutInSepTx =
       updateLut?.new || (updateLut?.accountsToAdd ?? []).length > 4;

package/tests/unit/clientTransactionsManager.ts

@@ -0,0 +1,140 @@
+import { expect } from "chai";
+import { afterEach, beforeEach, describe, it } from "mocha";
+import {
+  publicKey,
+  transactionBuilder,
+  TransactionBuilder,
+} from "@metaplex-foundation/umi";
+import { AddressLookupTableProgram, PublicKey } from "@solana/web3.js";
+import {
+  ClientTransactionsManager,
+  SolautoClient,
+  TransactionItem,
+  TransactionsManager,
+} from "../../src";
+import * as transactionUtils from "../../src/services/transactions/transactionUtils";
+
+describe("ClientTransactionsManager lookup table updates", () => {
+  const originalSend = TransactionsManager.prototype.send;
+  const originalChores = transactionUtils.getTransactionChores;
+  let submittedItems: TransactionItem[];
+
+  beforeEach(() => {
+    submittedItems = [];
+    TransactionsManager.prototype.send = async (items) => {
+      submittedItems = items;
+      return [];
+    };
+    (transactionUtils as any).getTransactionChores = async () => [
+      transactionBuilder(),
+      transactionBuilder(),
+    ];
+  });
+
+  afterEach(() => {
+    TransactionsManager.prototype.send = originalSend;
+    (transactionUtils as any).getTransactionChores = originalChores;
+  });
+
+  function createManager(
+    updateLookupTable: SolautoClient["updateLookupTable"],
+    autoUpdateLookupTable?: boolean
+  ) {
+    let resets = 0;
+    const client = {
+      defaultLookupTables: () => ["existing-authority-table"],
+      updateLookupTable,
+      resetLiveTxUpdates: async () => {
+        resets++;
+      },
+      log: () => {},
+      umi: {},
+    } as unknown as SolautoClient;
+    const manager = new ClientTransactionsManager({
+      txHandler: client,
+      autoUpdateLookupTable,
+    });
+    const separateUpdates: TransactionBuilder[] = [];
+    (manager as any).updateLut = async (tx: TransactionBuilder) => {
+      separateUpdates.push(tx);
+    };
+    return { manager, separateUpdates, resets: () => resets };
+  }
+
+  it("skips lookup table writes while keeping existing tables and processing transactions", async () => {
+    const { manager, separateUpdates, resets } = createManager(
+      async () => {
+        throw new Error("A full lookup table must never be extended");
+      },
+      false
+    );
+    const item = new TransactionItem(
+      async () => ({ tx: transactionBuilder() }),
+      "rebalance"
+    );
+
+    await manager.send([item]);
+
+    expect(item.initialized).to.equal(true);
+    expect(submittedItems).to.deep.equal([item]);
+    expect(separateUpdates).to.deep.equal([]);
+    expect((manager as any).lookupTables.defaultLuts).to.deep.equal([
+      "existing-authority-table",
+    ]);
+    expect(resets()).to.equal(1);
+  });
+
+  for (const scenario of [
+    {
+      name: "a small extension in the chores transaction",
+      new: false,
+      count: 1,
+      separate: false,
+    },
+    {
+      name: "a large extension separately",
+      new: false,
+      count: 5,
+      separate: true,
+    },
+    {
+      name: "a new lookup table separately",
+      new: true,
+      count: 1,
+      separate: true,
+    },
+  ]) {
+    it(`still sends ${scenario.name} by default`, async () => {
+      const updateTx = transactionBuilder().add({
+        instruction: {
+          programId: publicKey(AddressLookupTableProgram.programId.toBase58()),
+          keys: [],
+          data: new Uint8Array([2, 0, 0, 0]),
+        },
+        signers: [],
+        bytesCreatedOnChain: 0,
+      });
+      let updateCalls = 0;
+      const { manager, separateUpdates } = createManager(async () => {
+        updateCalls++;
+        return {
+          tx: updateTx,
+          new: scenario.new,
+          accountsToAdd: Array(scenario.count).fill(PublicKey.default),
+        };
+      });
+
+      await manager.send([]);
+
+      expect(updateCalls).to.equal(1);
+      expect(separateUpdates).to.deep.equal(
+        scenario.separate ? [updateTx] : []
+      );
+      expect(
+        submittedItems.flatMap((item) => item.tx!.getInstructions())
+      ).to.deep.equal(
+        scenario.separate ? [] : updateTx.getInstructions()
+      );
+    });
+  }
+});