@gearbox-protocol/sdk 10.4.4 → 10.5.0

package/dist/cjs/dev/RevolverTransport.js

@@ -29,11 +29,11 @@ class NoAvailableTransportsError extends import_viem.BaseError {
   }
 }
 class RevolverTransport {
-  #transports;
-  #index = 0;
   #config;
-  #rotating = false;
   #requests = /* @__PURE__ */ new WeakMap();
+  #selector;
+  #rotating = false;
+  #isSingle;
   overrides;
   /**
    * Create a new RevolverTransport
@@ -57,9 +57,9 @@ class RevolverTransport {
       ...config,
       shouldRetry: config.shouldRetry ?? defaultShouldRetry
     };
-    this.#transports = config.providers.map(
+    const transports = config.providers.map(
       ({ url, name, cooldown }) => ({
-        provider: name,
+        name,
         transport: (0, import_viem.http)(url, {
           retryCount: config.retryCount,
           retryDelay: config.retryDelay,
@@ -73,40 +73,45 @@ class RevolverTransport {
         cooldown: cooldown ?? 0
       })
     );
-    if (this.#transports.length === 0) {
+    if (transports.length === 0) {
       throw new NoAvailableTransportsError();
     }
+    this.#isSingle = transports.length === 1;
+    const selectionStrategy = config.selectionStrategy ?? "simple";
+    this.#selector = selectionStrategy === "simple" ? new SimpleTransportSelector(transports, config.cooldown) : new OrderedTransportSelector(transports, config.cooldown);
   }
   get value() {
     return {
       rotate: (reason) => this.rotate(reason),
-      currentTransportName: () => this.currentTransportName(),
-      statuses: () => this.statuses()
+      currentTransportName: () => this.#selector.transportName(),
+      statuses: () => this.#selector.statuses()
     };
   }
   request = async (r) => {
-    if (this.#transports.length === 1) {
-      return this.#transport({ ...this.overrides }).request(r);
+    if (this.#isSingle) {
+      return this.#selector.select()({
+        ...this.overrides
+      }).request(r);
     }
     let error;
     do {
       try {
-        this.#requests.set(r, this.currentTransportName());
-        const resp = await (0, import_viem.withRetry)(
-          () => this.#transport({ ...this.overrides }).request(r),
-          {
-            delay: this.#config.retryDelay,
-            retryCount: this.#config.retryCount,
-            shouldRetry: this.#config.shouldRetry
-          }
-        );
+        this.#requests.set(r, this.#selector.transportName());
+        const transport = this.#selector.select()({
+          ...this.overrides
+        });
+        const resp = await (0, import_viem.withRetry)(() => transport.request(r), {
+          delay: this.#config.retryDelay,
+          retryCount: this.#config.retryCount,
+          shouldRetry: this.#config.shouldRetry
+        });
         this.#requests.delete(r);
         return resp;
       } catch (e) {
         error = error ?? e;
         if (e instanceof import_viem.RpcError || e instanceof import_viem.HttpRequestError) {
           const reqTransport = this.#requests.get(r);
-          if (reqTransport === this.currentTransportName()) {
+          if (reqTransport === this.#selector.transportName()) {
             await this.rotate(e);
           } else {
             this.#logger?.debug(
@@ -118,7 +123,7 @@ class RevolverTransport {
           throw e;
         }
       }
-    } while (this.#hasAvailableTransports);
+    } while (this.#selector.canRotate());
     this.#requests.delete(r);
     throw new NoAvailableTransportsError(error);
   };
@@ -140,82 +145,34 @@ class RevolverTransport {
    * @returns true if rotation was successful
    */
   async rotate(reason) {
-    if (this.#transports.length === 1) {
-      return true;
-    }
     if (this.#rotating) {
       this.#logger?.debug("already rotating, skipping");
-      return false;
+      return;
     }
     this.#rotating = true;
-    this.#logger?.debug(
-      {
-        reason,
-        current: this.currentTransportName,
-        total: this.#transports.length
-      },
-      "rotating transport"
-    );
-    const oldTransportName = this.currentTransportName();
-    const now = Date.now();
-    this.#transports[this.#index].cooldown = now + (this.#config.cooldown ?? 6e4);
-    for (let i = 0; i < this.#transports.length - 1; i++) {
-      this.#index = (this.#index + 1) % this.#transports.length;
-      if (this.#transports[this.#index].cooldown < now) {
-        this.#logger?.info(
-          {
-            current: this.currentTransportName,
-            total: this.#transports.length
-          },
-          "switched to next transport"
-        );
+    const from = this.#selector.transportName();
+    const success = this.#selector.rotate();
+    const to = this.#selector.transportName();
+    if (success) {
+      if (from !== to) {
+        this.#logger?.debug({ from, to, reason }, "transport rotated");
         try {
-          await this.#config.onRotateSuccess?.(
-            oldTransportName,
-            this.currentTransportName(),
-            reason
-          );
+          await this.#config.onRotateSuccess?.(from, to, reason);
         } catch {
         }
-        this.#rotating = false;
-        return true;
-      } else {
-        this.#logger?.warn(
-          {
-            current: this.currentTransportName,
-            total: this.#transports.length
-          },
-          "transport is still on cooldown"
-        );
       }
-    }
-    try {
-      await this.#config.onRotateFailed?.(oldTransportName, reason);
-    } catch {
+    } else {
+      this.#logger?.warn({ from, reason }, "transport rotation failed");
+      try {
+        await this.#config.onRotateFailed?.(from, reason);
+      } catch {
+      }
     }
     this.#rotating = false;
-    return false;
-  }
-  currentTransportName() {
-    return this.#transport({}).config.name;
-  }
-  statuses() {
-    const now = Date.now();
-    return this.#transports.map((t, i) => ({
-      id: t.transport({}).config.name,
-      status: t.cooldown < now ? this.#index === i ? "active" : "standby" : "cooldown"
-    }));
   }
   get #logger() {
     return this.#config.logger;
   }
-  get #transport() {
-    return this.#transports[this.#index].transport;
-  }
-  get #hasAvailableTransports() {
-    const now = Date.now();
-    return this.#transports.some((t) => t.cooldown < now);
-  }
 }
 const retryCodes = /* @__PURE__ */ new Set([
   import_viem.InvalidRequestRpcError.code,
@@ -232,6 +189,87 @@ const defaultShouldRetry = ({
   }
   return false;
 };
+class AbstractTransportSelector {
+  transports;
+  cooldown;
+  index = 0;
+  constructor(transports, cooldown = 6e4) {
+    this.transports = transports;
+    this.cooldown = cooldown;
+  }
+  transportName() {
+    return this.transports[this.index].name;
+  }
+  canRotate() {
+    const now = Date.now();
+    return this.transports.some((t) => t.cooldown < now);
+  }
+  statuses() {
+    const now = Date.now();
+    return this.transports.map((t, i) => ({
+      id: t.name,
+      status: t.cooldown < now ? this.index === i ? "active" : "standby" : "cooldown"
+    }));
+  }
+}
+class SimpleTransportSelector extends AbstractTransportSelector {
+  /**
+   * For simple selector, transport status is not re-evaluated on each request
+   * @returns
+   */
+  select() {
+    return this.transports[this.index].transport;
+  }
+  /**
+   * Simply selects next transport that is not in cooldown by checking all transports in cyclic order
+   * @returns true if rotation was successful
+   */
+  rotate() {
+    if (this.transports.length === 1) {
+      return true;
+    }
+    const now = Date.now();
+    this.transports[this.index].cooldown = now + this.cooldown;
+    for (let i = 0; i < this.transports.length - 1; i++) {
+      this.index = (this.index + 1) % this.transports.length;
+      if (this.transports[this.index].cooldown < now) {
+        return true;
+      }
+    }
+    return false;
+  }
+}
+class OrderedTransportSelector extends AbstractTransportSelector {
+  /**
+   * Will select first transport that is not in cooldown
+   * @returns
+   */
+  select() {
+    this.#updateIndex(Date.now());
+    return this.transports[this.index].transport;
+  }
+  /**
+   * Will put current transport into cooldown and select first available transport that is not in cooldown
+   * @returns true if rotation was successful
+   */
+  rotate() {
+    if (this.transports.length === 1) {
+      return true;
+    }
+    const now = Date.now();
+    this.transports[this.index].cooldown = now + this.cooldown;
+    return this.#updateIndex(now);
+  }
+  #updateIndex(now) {
+    for (let i = 0; i < this.transports.length; i++) {
+      if (this.transports[i].cooldown < now) {
+        this.index = i;
+        return true;
+      }
+    }
+    return false;
+  }
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   NoAvailableTransportsError,

package/dist/cjs/sdk/router/RouterV310Contract.js

@@ -146,11 +146,6 @@ class RouterV310Contract extends import_AbstractRouterContract.AbstractRouterCon
    * Implements {@link IRouterContract.findClaimAllRewards}
    */
   async findClaimAllRewards(props) {
-    if (props.calls.length > 0 && !!props.forceCalls) {
-      return {
-        calls: [...props.calls]
-      };
-    }
     const tData = props.tokensToClaim.map((a) => ({
       balance: 0n,
       claimRewards: true,
@@ -162,6 +157,11 @@ class RouterV310Contract extends import_AbstractRouterContract.AbstractRouterCon
       props.creditAccount.creditAccount,
       tData
     ]);
+    if (props.calls.length > 0 && result.length === 0 && !!props.forceCalls) {
+      return {
+        calls: [...props.calls]
+      };
+    }
     return {
       calls: [...result]
     };

package/dist/esm/dev/RevolverTransport.js

@@ -16,11 +16,11 @@ class NoAvailableTransportsError extends BaseError {
   }
 }
 class RevolverTransport {
-  #transports;
-  #index = 0;
   #config;
-  #rotating = false;
   #requests = /* @__PURE__ */ new WeakMap();
+  #selector;
+  #rotating = false;
+  #isSingle;
   overrides;
   /**
    * Create a new RevolverTransport
@@ -44,9 +44,9 @@ class RevolverTransport {
       ...config,
       shouldRetry: config.shouldRetry ?? defaultShouldRetry
     };
-    this.#transports = config.providers.map(
+    const transports = config.providers.map(
       ({ url, name, cooldown }) => ({
-        provider: name,
+        name,
         transport: http(url, {
           retryCount: config.retryCount,
           retryDelay: config.retryDelay,
@@ -60,40 +60,45 @@ class RevolverTransport {
         cooldown: cooldown ?? 0
       })
     );
-    if (this.#transports.length === 0) {
+    if (transports.length === 0) {
       throw new NoAvailableTransportsError();
     }
+    this.#isSingle = transports.length === 1;
+    const selectionStrategy = config.selectionStrategy ?? "simple";
+    this.#selector = selectionStrategy === "simple" ? new SimpleTransportSelector(transports, config.cooldown) : new OrderedTransportSelector(transports, config.cooldown);
   }
   get value() {
     return {
       rotate: (reason) => this.rotate(reason),
-      currentTransportName: () => this.currentTransportName(),
-      statuses: () => this.statuses()
+      currentTransportName: () => this.#selector.transportName(),
+      statuses: () => this.#selector.statuses()
     };
   }
   request = async (r) => {
-    if (this.#transports.length === 1) {
-      return this.#transport({ ...this.overrides }).request(r);
+    if (this.#isSingle) {
+      return this.#selector.select()({
+        ...this.overrides
+      }).request(r);
     }
     let error;
     do {
       try {
-        this.#requests.set(r, this.currentTransportName());
-        const resp = await withRetry(
-          () => this.#transport({ ...this.overrides }).request(r),
-          {
-            delay: this.#config.retryDelay,
-            retryCount: this.#config.retryCount,
-            shouldRetry: this.#config.shouldRetry
-          }
-        );
+        this.#requests.set(r, this.#selector.transportName());
+        const transport = this.#selector.select()({
+          ...this.overrides
+        });
+        const resp = await withRetry(() => transport.request(r), {
+          delay: this.#config.retryDelay,
+          retryCount: this.#config.retryCount,
+          shouldRetry: this.#config.shouldRetry
+        });
         this.#requests.delete(r);
         return resp;
       } catch (e) {
         error = error ?? e;
         if (e instanceof RpcError || e instanceof HttpRequestError) {
           const reqTransport = this.#requests.get(r);
-          if (reqTransport === this.currentTransportName()) {
+          if (reqTransport === this.#selector.transportName()) {
             await this.rotate(e);
           } else {
             this.#logger?.debug(
@@ -105,7 +110,7 @@ class RevolverTransport {
           throw e;
         }
       }
-    } while (this.#hasAvailableTransports);
+    } while (this.#selector.canRotate());
     this.#requests.delete(r);
     throw new NoAvailableTransportsError(error);
   };
@@ -127,82 +132,34 @@ class RevolverTransport {
    * @returns true if rotation was successful
    */
   async rotate(reason) {
-    if (this.#transports.length === 1) {
-      return true;
-    }
     if (this.#rotating) {
       this.#logger?.debug("already rotating, skipping");
-      return false;
+      return;
     }
     this.#rotating = true;
-    this.#logger?.debug(
-      {
-        reason,
-        current: this.currentTransportName,
-        total: this.#transports.length
-      },
-      "rotating transport"
-    );
-    const oldTransportName = this.currentTransportName();
-    const now = Date.now();
-    this.#transports[this.#index].cooldown = now + (this.#config.cooldown ?? 6e4);
-    for (let i = 0; i < this.#transports.length - 1; i++) {
-      this.#index = (this.#index + 1) % this.#transports.length;
-      if (this.#transports[this.#index].cooldown < now) {
-        this.#logger?.info(
-          {
-            current: this.currentTransportName,
-            total: this.#transports.length
-          },
-          "switched to next transport"
-        );
+    const from = this.#selector.transportName();
+    const success = this.#selector.rotate();
+    const to = this.#selector.transportName();
+    if (success) {
+      if (from !== to) {
+        this.#logger?.debug({ from, to, reason }, "transport rotated");
         try {
-          await this.#config.onRotateSuccess?.(
-            oldTransportName,
-            this.currentTransportName(),
-            reason
-          );
+          await this.#config.onRotateSuccess?.(from, to, reason);
         } catch {
         }
-        this.#rotating = false;
-        return true;
-      } else {
-        this.#logger?.warn(
-          {
-            current: this.currentTransportName,
-            total: this.#transports.length
-          },
-          "transport is still on cooldown"
-        );
       }
-    }
-    try {
-      await this.#config.onRotateFailed?.(oldTransportName, reason);
-    } catch {
+    } else {
+      this.#logger?.warn({ from, reason }, "transport rotation failed");
+      try {
+        await this.#config.onRotateFailed?.(from, reason);
+      } catch {
+      }
     }
     this.#rotating = false;
-    return false;
-  }
-  currentTransportName() {
-    return this.#transport({}).config.name;
-  }
-  statuses() {
-    const now = Date.now();
-    return this.#transports.map((t, i) => ({
-      id: t.transport({}).config.name,
-      status: t.cooldown < now ? this.#index === i ? "active" : "standby" : "cooldown"
-    }));
   }
   get #logger() {
     return this.#config.logger;
   }
-  get #transport() {
-    return this.#transports[this.#index].transport;
-  }
-  get #hasAvailableTransports() {
-    const now = Date.now();
-    return this.#transports.some((t) => t.cooldown < now);
-  }
 }
 const retryCodes = /* @__PURE__ */ new Set([
   InvalidRequestRpcError.code,
@@ -219,6 +176,87 @@ const defaultShouldRetry = ({
   }
   return false;
 };
+class AbstractTransportSelector {
+  transports;
+  cooldown;
+  index = 0;
+  constructor(transports, cooldown = 6e4) {
+    this.transports = transports;
+    this.cooldown = cooldown;
+  }
+  transportName() {
+    return this.transports[this.index].name;
+  }
+  canRotate() {
+    const now = Date.now();
+    return this.transports.some((t) => t.cooldown < now);
+  }
+  statuses() {
+    const now = Date.now();
+    return this.transports.map((t, i) => ({
+      id: t.name,
+      status: t.cooldown < now ? this.index === i ? "active" : "standby" : "cooldown"
+    }));
+  }
+}
+class SimpleTransportSelector extends AbstractTransportSelector {
+  /**
+   * For simple selector, transport status is not re-evaluated on each request
+   * @returns
+   */
+  select() {
+    return this.transports[this.index].transport;
+  }
+  /**
+   * Simply selects next transport that is not in cooldown by checking all transports in cyclic order
+   * @returns true if rotation was successful
+   */
+  rotate() {
+    if (this.transports.length === 1) {
+      return true;
+    }
+    const now = Date.now();
+    this.transports[this.index].cooldown = now + this.cooldown;
+    for (let i = 0; i < this.transports.length - 1; i++) {
+      this.index = (this.index + 1) % this.transports.length;
+      if (this.transports[this.index].cooldown < now) {
+        return true;
+      }
+    }
+    return false;
+  }
+}
+class OrderedTransportSelector extends AbstractTransportSelector {
+  /**
+   * Will select first transport that is not in cooldown
+   * @returns
+   */
+  select() {
+    this.#updateIndex(Date.now());
+    return this.transports[this.index].transport;
+  }
+  /**
+   * Will put current transport into cooldown and select first available transport that is not in cooldown
+   * @returns true if rotation was successful
+   */
+  rotate() {
+    if (this.transports.length === 1) {
+      return true;
+    }
+    const now = Date.now();
+    this.transports[this.index].cooldown = now + this.cooldown;
+    return this.#updateIndex(now);
+  }
+  #updateIndex(now) {
+    for (let i = 0; i < this.transports.length; i++) {
+      if (this.transports[i].cooldown < now) {
+        this.index = i;
+        return true;
+      }
+    }
+    return false;
+  }
+}
 export {
   NoAvailableTransportsError,
   RevolverTransport

package/dist/esm/sdk/router/RouterV310Contract.js

@@ -123,11 +123,6 @@ class RouterV310Contract extends AbstractRouterContract {
    * Implements {@link IRouterContract.findClaimAllRewards}
    */
   async findClaimAllRewards(props) {
-    if (props.calls.length > 0 && !!props.forceCalls) {
-      return {
-        calls: [...props.calls]
-      };
-    }
     const tData = props.tokensToClaim.map((a) => ({
       balance: 0n,
       claimRewards: true,
@@ -139,6 +134,11 @@ class RouterV310Contract extends AbstractRouterContract {
       props.creditAccount.creditAccount,
       tData
     ]);
+    if (props.calls.length > 0 && result.length === 0 && !!props.forceCalls) {
+      return {
+        calls: [...props.calls]
+      };
+    }
     return {
       calls: [...result]
     };

package/dist/types/dev/RevolverTransport.d.ts

@@ -12,6 +12,12 @@ export interface ProviderStatus {
 }
 type OnRequestFn = (providerName: string, ...args: Parameters<Required<HttpRpcClientOptions>["onRequest"]>) => ReturnType<Required<HttpRpcClientOptions>["onRequest"]>;
 type OnResponseFn = (providerName: string, ...args: Parameters<Required<HttpRpcClientOptions>["onResponse"]>) => ReturnType<Required<HttpRpcClientOptions>["onResponse"]>;
+/**
+ * How to select the next transport
+ * - simple: selects next transport after current that is not in cooldown by checking all transports in cyclic order
+ * - ordered: will select first available transport that is not in cooldown
+ */
+export type SelectionStrategy = "simple" | "ordered";
 export interface RevolverTransportConfig {
     network: NetworkType;
     providers: ProviderConfig[];
@@ -59,17 +65,21 @@ export interface RevolverTransportConfig {
      * How long, in milliseconds, to wait before try this transport again
      */
     cooldown?: number | undefined;
+    /**
+     * How to select the next transport
+     * Defaults to "simple"
+     */
+    selectionStrategy?: SelectionStrategy;
 }
 export declare class NoAvailableTransportsError extends BaseError {
     constructor(cause?: Error);
 }
 export interface RevolverTransportValue {
     /**
-     * Manually rotate the transport
+     * Manually try to rotate the transport
      * @param reason
-     * @returns true if rotation was successful
      */
-    rotate: (reason?: BaseError) => Promise<boolean>;
+    rotate: (reason?: BaseError) => Promise<void>;
     /**
      * Returns the name of the current transport
      */
@@ -100,8 +110,6 @@ export declare class RevolverTransport implements ReturnType<Transport<"revolver
      * @param reason
      * @returns true if rotation was successful
      */
-    rotate(reason?: BaseError): Promise<boolean>;
-    currentTransportName(): string;
-    statuses(): ProviderStatus[];
+    rotate(reason?: BaseError): Promise<void>;
 }
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gearbox-protocol/sdk",
-  "version": "10.4.4",
+  "version": "10.5.0",
   "description": "Gearbox SDK",
   "license": "MIT",
   "main": "./dist/cjs/sdk/index.js",