@across-protocol/sdk 4.1.15 → 4.1.17

package/dist/types/providers/solana/defaultRpcFactory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"defaultRpcFactory.d.ts","sourceRoot":"","sources":["../../../../src/providers/solana/defaultRpcFactory.ts"],"names":[],"mappings":"AAAA,OAAO,EAA6B,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC1E,OAAO,EAAE,uBAAuB,EAAE,MAAM,oBAAoB,CAAC;AAG7D,qBAAa,uBAAwB,SAAQ,uBAAuB;gBACtD,GAAG,wBAAwB,EAAE,qBAAqB,CAAC,OAAO,uBAAuB,CAAC;IAIvF,eAAe,IAAI,YAAY;CAGvC"}

package/dist/types/providers/solana/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./baseRpcFactories";
+export * from "./defaultRpcFactory";
+export * from "./rateLimitedRpcFactory";
+export * from "./utils";
+//# sourceMappingURL=index.d.ts.map

package/dist/types/providers/solana/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/providers/solana/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,yBAAyB,CAAC;AACxC,cAAc,SAAS,CAAC"}

package/dist/types/providers/solana/rateLimitedRpcFactory.d.ts

@@ -0,0 +1,17 @@
+import { RpcResponse } from "@solana/web3.js";
+import { Logger } from "winston";
+import { SolanaClusterRpcFactory } from "./baseRpcFactories";
+import { SolanaDefaultRpcFactory } from "./defaultRpcFactory";
+export declare class RateLimitedSolanaRpcFactory extends SolanaClusterRpcFactory {
+    readonly pctRpcCallsLogged: number;
+    readonly logger: Logger;
+    private queue;
+    private readonly defaultTransport;
+    constructor(maxConcurrency: number, pctRpcCallsLogged: number, logger: Logger, ...defaultConstructorParams: ConstructorParameters<typeof SolanaDefaultRpcFactory>);
+    private wrapSendWithLog;
+    createTransport(): <TResponse>(config: Readonly<{
+        payload: unknown;
+        signal?: AbortSignal | undefined;
+    }>) => Promise<TResponse>;
+}
+//# sourceMappingURL=rateLimitedRpcFactory.d.ts.map

package/dist/types/providers/solana/rateLimitedRpcFactory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rateLimitedRpcFactory.d.ts","sourceRoot":"","sources":["../../../../src/providers/solana/rateLimitedRpcFactory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAgB,MAAM,iBAAiB,CAAC;AAE5D,OAAgB,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAC1C,OAAO,EAAE,uBAAuB,EAAE,MAAM,oBAAoB,CAAC;AAC7D,OAAO,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAC;AAM9D,qBAAa,2BAA4B,SAAQ,uBAAuB;IAWpE,QAAQ,CAAC,iBAAiB,EAAE,MAAM;IAClC,QAAQ,CAAC,MAAM,EAAE,MAAM;IAVzB,OAAO,CAAC,KAAK,CAAmC;IAGhD,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAe;gBAK9C,cAAc,EAAE,MAAM,EACb,iBAAiB,EAAE,MAAM,EACzB,MAAM,EAAE,MAEf,EACF,GAAG,wBAAwB,EAAE,qBAAqB,CAAC,OAAO,uBAAuB,CAAC;YAkBtE,eAAe;IA0CtB,eAAe;;;;CAevB"}

package/dist/types/providers/solana/utils.d.ts

@@ -0,0 +1,10 @@
+import { RpcTransport } from "@solana/rpc-spec";
+/**
+ * This is the type we pass to define a Solana RPC request "task".
+ */
+export interface SolanaRateLimitTask {
+    rpcArgs: Parameters<RpcTransport>;
+    resolve: (result: unknown) => void;
+    reject: (err: unknown) => void;
+}
+//# sourceMappingURL=utils.d.ts.map

package/dist/types/providers/solana/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../../src/providers/solana/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAEhD;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAElC,OAAO,EAAE,UAAU,CAAC,YAAY,CAAC,CAAC;IAIlC,OAAO,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI,CAAC;IACnC,MAAM,EAAE,CAAC,GAAG,EAAE,OAAO,KAAK,IAAI,CAAC;CAChC"}

package/dist/types/providers/utils.d.ts

@@ -51,6 +51,7 @@ export declare function compareRpcResults(method: string, rpcResultA: unknown, r
 export declare enum CacheType {
     NONE = 0,
     WITH_TTL = 1,
-    NO_TTL = 2
+    NO_TTL = 2,
+    DECIDE_TTL_POST_SEND = 3
 }
 //# sourceMappingURL=utils.d.ts.map

package/dist/types/providers/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/providers/utils.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AAGnC,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAepD;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,MAAM,GAAG,QAAQ,IAAI,WAAW,CAE7E;AAED;;;;;;;GAOG;AACH,wBAAgB,MAAM,CACpB,QAAQ,EAAE,WAAW,EACrB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,EACd,SAAS,GAAE,YAAsB,GAChC,MAAM,CAIR;AAmBD,wBAAgB,kCAAkC,CAChD,WAAW,EAAE,MAAM,EAAE,EACrB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC9B,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC7B,OAAO,CAOT;AAED,wBAAgB,kCAAkC,CAAC,WAAW,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,OAAO,CAOnH;AAyBD;;GAEG;AACH,MAAM,WAAW,aAAa;IAE5B,QAAQ,EAAE,CAAC,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;IAInC,OAAO,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI,CAAC;IACnC,MAAM,EAAE,CAAC,GAAG,EAAE,OAAO,KAAK,IAAI,CAAC;CAChC;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,SAAS,CAAC,qBAAqB,EAAE,YAAY,EAAE,MAAM,UAElG;AAED,wBAAgB,0BAA0B,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;;;;;EAG7F;AAED;;;;;;;;GAQG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,GAAG,OAAO,CAkBnG;AAED,oBAAY,SAAS;IACnB,IAAI,IAAA;IACJ,QAAQ,IAAA;IACR,MAAM,IAAA;CACP"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/providers/utils.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AAGnC,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAepD;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,MAAM,GAAG,QAAQ,IAAI,WAAW,CAE7E;AAED;;;;;;;GAOG;AACH,wBAAgB,MAAM,CACpB,QAAQ,EAAE,WAAW,EACrB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,EACd,SAAS,GAAE,YAAsB,GAChC,MAAM,CAIR;AAmBD,wBAAgB,kCAAkC,CAChD,WAAW,EAAE,MAAM,EAAE,EACrB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC9B,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC7B,OAAO,CAOT;AAED,wBAAgB,kCAAkC,CAAC,WAAW,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,OAAO,CAOnH;AAyBD;;GAEG;AACH,MAAM,WAAW,aAAa;IAE5B,QAAQ,EAAE,CAAC,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;IAInC,OAAO,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI,CAAC;IACnC,MAAM,EAAE,CAAC,GAAG,EAAE,OAAO,KAAK,IAAI,CAAC;CAChC;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,SAAS,CAAC,qBAAqB,EAAE,YAAY,EAAE,MAAM,UAElG;AAED,wBAAgB,0BAA0B,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;;;;;EAG7F;AAED;;;;;;;;GAQG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,GAAG,OAAO,CAkBnG;AAED,oBAAY,SAAS;IACnB,IAAI,IAAA;IACJ,QAAQ,IAAA;IACR,MAAM,IAAA;IACN,oBAAoB,IAAA;CACrB"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@across-protocol/sdk",
   "author": "UMA Team",
-  "version": "4.1.15",
+  "version": "4.1.17",
   "license": "AGPL-3.0",
   "homepage": "https://docs.across.to/reference/sdk",
   "files": [
@@ -48,6 +48,7 @@
     }
   ],
   "devDependencies": {
+    "@coral-xyz/borsh": "^0.30.1",
     "@defi-wonderland/smock": "^2.3.5",
     "@eth-optimism/contracts": "^0.5.37",
     "@nomiclabs/hardhat-ethers": "^2.2.1",
@@ -104,6 +105,7 @@
     "@eth-optimism/sdk": "^3.3.1",
     "@ethersproject/bignumber": "^5.7.0",
     "@pinata/sdk": "^2.1.0",
+    "@solana/web3.js": "^2.0.0",
     "@types/mocha": "^10.0.1",
     "@uma/sdk": "^0.34.10",
     "arweave": "^1.14.4",

package/src/providers/cachedProvider.ts

@@ -8,6 +8,7 @@ export class CacheProvider extends RateLimitedProvider {
   public readonly getBlockByNumberPrefix: string;
   public readonly getLogsCachePrefix: string;
   public readonly callCachePrefix: string;
+  public readonly getTransactionReceiptPrefix: string;
   public readonly baseTTL: number;
 
   constructor(
@@ -29,6 +30,7 @@ export class CacheProvider extends RateLimitedProvider {
     this.getBlockByNumberPrefix = `${cachePrefix}:getBlockByNumber,`;
     this.getLogsCachePrefix = `${cachePrefix}:eth_getLogs,`;
     this.callCachePrefix = `${cachePrefix}:eth_call,`;
+    this.getTransactionReceiptPrefix = `${cachePrefix}:eth_getTransactionReceipt,`;
 
     const _ttlVar = providerCacheTtl;
     const _ttl = Number(_ttlVar);
@@ -38,7 +40,7 @@ export class CacheProvider extends RateLimitedProvider {
     this.baseTTL = _ttl;
   }
   override async send(method: string, params: Array<unknown>): Promise<unknown> {
-    const cacheType = this.redisClient ? await this.cacheType(method, params) : CacheType.NONE;
+    let cacheType = this.redisClient ? await this.cacheType(method, params) : CacheType.NONE;
 
     if (cacheType !== CacheType.NONE) {
       const redisKey = this.buildRedisKey(method, params);
@@ -54,6 +56,11 @@ export class CacheProvider extends RateLimitedProvider {
       // Cache does not have the result. Query it directly and cache.
       const result = await super.send(method, params);
 
+      if (cacheType === CacheType.DECIDE_TTL_POST_SEND) {
+        const blockNumber = this.getBlockNumberFromRpcResponse(method, result);
+        cacheType = await this.cacheTypeForBlock(blockNumber);
+      }
+
       // Note: use swtich to ensure all enum cases are handled.
       switch (cacheType) {
         case CacheType.WITH_TTL:
@@ -78,7 +85,6 @@ export class CacheProvider extends RateLimitedProvider {
   }
 
   private buildRedisKey(method: string, params: Array<unknown>) {
-    // Only handles eth_getLogs and eth_call right now.
     switch (method) {
       case "eth_getBlockByNumber":
         return this.getBlockByNumberPrefix + JSON.stringify(params);
@@ -86,6 +92,8 @@ export class CacheProvider extends RateLimitedProvider {
         return this.getLogsCachePrefix + JSON.stringify(params);
       case "eth_call":
         return this.callCachePrefix + JSON.stringify(params);
+      case "eth_getTransactionReceipt":
+        return this.getTransactionReceiptPrefix + JSON.stringify(params);
       default:
         throw new Error(`CacheProvider::buildRedisKey: invalid JSON-RPC method ${method}`);
     }
@@ -125,11 +133,24 @@ export class CacheProvider extends RateLimitedProvider {
 
       // If the block is old enough to cache, cache the call.
       return this.cacheTypeForBlock(blockNumber);
+    } else if ("eth_getTransactionReceipt" === method) {
+      // The only param to this request is "hash" so we can't determine how old the data we want is until after
+      // we receive the RPC result. Therefore we'll defer the TTL decision.
+      return Promise.resolve(CacheType.DECIDE_TTL_POST_SEND);
     } else {
       return Promise.resolve(CacheType.NONE);
     }
   }
 
+  private getBlockNumberFromRpcResponse(method: string, result: unknown): number {
+    if (method === "eth_getTransactionReceipt") {
+      const receipt = result as { blockNumber: number | string };
+      return Number(receipt.blockNumber);
+    } else {
+      throw new Error(`CacheProvider::getBlockNumberFromRpcResponse: unsupported JSON-RPC method ${method}`);
+    }
+  }
+
   private async cacheTypeForBlock(blockNumber: number): Promise<CacheType> {
     // Note: this method is an internal method provided by the BaseProvider. It allows the caller to specify a maxAge of
     // the block that is allowed. This means if a block has been retrieved within the last n seconds, no provider

package/src/providers/index.ts

@@ -6,3 +6,4 @@ export * from "./constants";
 export * from "./types";
 export * from "./utils";
 export * as mocks from "./mockProvider";
+export * from "./solana";

package/src/providers/retryProvider.ts

@@ -302,13 +302,14 @@ export class RetryProvider extends ethers.providers.StaticJsonRpcProvider {
     }
 
     // The `data` member of err _may_ be populated but would need to be verified.
-    const { message } = err;
+    const message = err.message.toLowerCase();
     switch (method) {
       case "eth_call":
       case "eth_estimateGas":
-        return message.toLowerCase().includes("revert"); // Transaction will fail.
+        return message.includes("revert"); // Transaction will fail.
       case "eth_sendRawTransaction":
-        return message.toLowerCase().includes("nonce"); // Nonce too low.
+        // Nonce too low or gas price is too low.
+        return message.includes("nonce") || message.includes("underpriced");
       default:
         break;
     }

package/src/providers/solana/baseRpcFactories.ts

@@ -0,0 +1,25 @@
+import { ClusterUrl, createSolanaRpcFromTransport, RpcTransport } from "@solana/web3.js";
+
+// This is abstract base class for creating Solana RPC clients and transports.
+export abstract class SolanaBaseRpcFactory {
+  constructor(readonly chainId: number) {}
+
+  // This method must be implemented by the derived class to create a transport.
+  public abstract createTransport(): RpcTransport;
+
+  // This method creates a Solana RPC client from the implemented transport.
+  public createRpcClient() {
+    return createSolanaRpcFromTransport(this.createTransport());
+  }
+}
+
+// Enhanced class for creating Solana RPC clients and transports storing additional cluster info.
+// This can be used by derived classes that are connected to a single base transport.
+export abstract class SolanaClusterRpcFactory extends SolanaBaseRpcFactory {
+  constructor(
+    readonly clusterUrl: ClusterUrl,
+    ...baseConstructorParams: ConstructorParameters<typeof SolanaBaseRpcFactory>
+  ) {
+    super(...baseConstructorParams);
+  }
+}

package/src/providers/solana/defaultRpcFactory.ts

@@ -0,0 +1,13 @@
+import { createDefaultRpcTransport, RpcTransport } from "@solana/web3.js";
+import { SolanaClusterRpcFactory } from "./baseRpcFactories";
+
+// Exposes default RPC transport for Solana in the SolanaClusterRpcFactory class.
+export class SolanaDefaultRpcFactory extends SolanaClusterRpcFactory {
+  constructor(...clusterConstructorParams: ConstructorParameters<typeof SolanaClusterRpcFactory>) {
+    super(...clusterConstructorParams);
+  }
+
+  public createTransport(): RpcTransport {
+    return createDefaultRpcTransport({ url: this.clusterUrl });
+  }
+}

package/src/providers/solana/index.ts

@@ -0,0 +1,4 @@
+export * from "./baseRpcFactories";
+export * from "./defaultRpcFactory";
+export * from "./rateLimitedRpcFactory";
+export * from "./utils";

package/src/providers/solana/rateLimitedRpcFactory.ts

@@ -0,0 +1,101 @@
+import { RpcResponse, RpcTransport } from "@solana/web3.js";
+import { QueueObject, queue } from "async";
+import winston, { Logger } from "winston";
+import { SolanaClusterRpcFactory } from "./baseRpcFactories";
+import { SolanaDefaultRpcFactory } from "./defaultRpcFactory";
+import { SolanaRateLimitTask } from "./utils";
+import { getOriginFromURL } from "../../utils";
+
+// This factory is a very small addition to the SolanaDefaultRpcFactory that ensures that no more than maxConcurrency
+// requests are ever in flight. It uses the async/queue library to manage this.
+export class RateLimitedSolanaRpcFactory extends SolanaClusterRpcFactory {
+  // The queue object that manages the tasks.
+  private queue: QueueObject<SolanaRateLimitTask>;
+
+  // Holds the underlying transport that the rate limiter wraps.
+  private readonly defaultTransport: RpcTransport;
+
+  // Takes the same arguments as the SolanaDefaultRpcFactory, but it has an additional parameters to control
+  // concurrency and logging at the beginning of the list.
+  constructor(
+    maxConcurrency: number,
+    readonly pctRpcCallsLogged: number,
+    readonly logger: Logger = winston.createLogger({
+      transports: [new winston.transports.Console()],
+    }),
+    ...defaultConstructorParams: ConstructorParameters<typeof SolanaDefaultRpcFactory>
+  ) {
+    super(...defaultConstructorParams);
+    this.defaultTransport = new SolanaDefaultRpcFactory(...defaultConstructorParams).createTransport();
+
+    // This sets up the queue. Each task is executed by forwarding the RPC request to the underlying base transport.
+    // This queue sends out requests concurrently, but stops once the concurrency limit is reached. The maxConcurrency
+    // is configured here.
+    this.queue = queue(async ({ rpcArgs, resolve, reject }: SolanaRateLimitTask, callback: () => void) => {
+      await this.wrapSendWithLog(...rpcArgs)
+        .then(resolve)
+        .catch(reject);
+      // we need this for the queue to know that the task is done
+      // @see: https://caolan.github.io/async/v3/global.html
+      callback();
+    }, maxConcurrency);
+  }
+
+  private async wrapSendWithLog(...rpcArgs: Parameters<RpcTransport>) {
+    if (this.pctRpcCallsLogged <= 0 || Math.random() > this.pctRpcCallsLogged / 100) {
+      // Non sample path: no logging or timing, just issue the request.
+      return await this.defaultTransport(...rpcArgs);
+    } else {
+      const payload = rpcArgs[0].payload as { method: string; params?: unknown[] };
+      const loggerArgs = {
+        at: "SolanaProviderUtils",
+        message: "Solana provider response sample",
+        provider: getOriginFromURL(this.clusterUrl),
+        method: payload.method,
+        params: payload.params,
+        chainId: this.chainId,
+        datadog: true,
+      };
+
+      // In this path we log an rpc response sample.
+      // Note: use performance.now() to ensure a purely monotonic clock.
+      const startTime = performance.now();
+      try {
+        const result = await this.defaultTransport(...rpcArgs);
+        const elapsedTimeS = (performance.now() - startTime) / 1000;
+        this.logger.debug({
+          ...loggerArgs,
+          success: true,
+          timeElapsed: elapsedTimeS,
+        });
+        return result;
+      } catch (error) {
+        // Log errors as well.
+        // For now, to keep logs light, don't log the error itself, just propagate and let it be handled higher up.
+        const elapsedTimeS = (performance.now() - startTime) / 1000;
+        this.logger.debug({
+          ...loggerArgs,
+          success: false,
+          timeElapsed: elapsedTimeS,
+        });
+        throw error;
+      }
+    }
+  }
+
+  public createTransport() {
+    return <TResponse>(...args: Parameters<RpcTransport>): Promise<RpcResponse<TResponse>> => {
+      // This simply creates a promise and adds the arguments and resolve and reject handlers to the task.
+      return new Promise<RpcResponse<TResponse>>((resolve, reject) => {
+        const task: SolanaRateLimitTask = {
+          rpcArgs: args,
+          resolve: resolve as (value: unknown) => void,
+          reject,
+        };
+        // We didn't previously wait for this push so we can emulate
+        // the same behavior with the `void` keyword.
+        void this.queue.push(task);
+      });
+    };
+  }
+}

package/src/providers/solana/utils.ts

@@ -0,0 +1,14 @@
+import { RpcTransport } from "@solana/rpc-spec";
+
+/**
+ * This is the type we pass to define a Solana RPC request "task".
+ */
+export interface SolanaRateLimitTask {
+  // These are the arguments to be passed to base transport when making the RPC request.
+  rpcArgs: Parameters<RpcTransport>;
+
+  // These are the promise callbacks that will cause the initial RPC call made by the user to either return a result
+  // or fail.
+  resolve: (result: unknown) => void;
+  reject: (err: unknown) => void;
+}

package/src/providers/utils.ts

@@ -169,4 +169,5 @@ export enum CacheType {
   NONE, // Do not cache
   WITH_TTL, // Cache with TTL
   NO_TTL, // Cache with infinite TTL
+  DECIDE_TTL_POST_SEND, // Decide which TTL to cache with after we receive the RPC response
 }