@solana/web3.js 1.5.1 → 1.6.1

package/lib/index.d.ts

@@ -1041,6 +1041,31 @@ declare module '@solana/web3.js' {
     /** The unix timestamp of when the transaction was processed */
     blockTime?: number | null;
   };
+  /**
+   * An object defining headers to be passed to the RPC server
+   */
+  export type HttpHeaders = {
+    [header: string]: string;
+  };
+  /**
+   * A callback used to augment the outgoing HTTP request
+   */
+  export type FetchMiddleware = (
+    url: string,
+    options: any,
+    fetch: Function,
+  ) => void;
+  /**
+   * Configuration for instantiating a Connection
+   */
+  export type ConnectionConfig = {
+    /** Optional commitment level */
+    commitment?: Commitment;
+    /** Optional HTTP headers object */
+    httpHeaders?: HttpHeaders;
+    /** Optional fetch middleware callback */
+    fetchMiddleware?: FetchMiddleware;
+  };
   /**
    * A connection to a fullnode JSON RPC endpoint
    */
@@ -1049,9 +1074,12 @@ declare module '@solana/web3.js' {
      * Establish a JSON RPC connection
      *
      * @param endpoint URL to the fullnode JSON RPC endpoint
-     * @param commitment optional default commitment level
+     * @param commitmentOrConfig optional default commitment level or optional ConnectionConfig configuration object
      */
-    constructor(endpoint: string, commitment?: Commitment);
+    constructor(
+      endpoint: string,
+      commitmentOrConfig?: Commitment | ConnectionConfig,
+    );
     /**
      * The default commitment used for requests
      */

package/lib/index.esm.js

@@ -2450,22 +2450,38 @@ const SimulatedTransactionResponseStruct = jsonRpcResultAndContext(type({
   logs: nullable(array(string()))
 }));
 
-function createRpcClient(url, useHttps) {
+function createRpcClient(url, useHttps, httpHeaders, fetchMiddleware) {
   let agentManager;
 
   {
     agentManager = new AgentManager(useHttps);
   }
 
+  let fetchWithMiddleware;
+
+  if (fetchMiddleware) {
+    fetchWithMiddleware = (url, options) => {
+      return new Promise((resolve, reject) => {
+        fetchMiddleware(url, options, async (url, options) => {
+          try {
+            resolve(await fetch(url, options));
+          } catch (error) {
+            reject(error);
+          }
+        });
+      });
+    };
+  }
+
   const clientBrowser = new RpcClient(async (request, callback) => {
     const agent = agentManager ? agentManager.requestStart() : undefined;
     const options = {
       method: 'POST',
       body: request,
       agent,
-      headers: {
+      headers: Object.assign({
         'Content-Type': 'application/json'
-      }
+      }, httpHeaders || {})
     };
 
     try {
@@ -2474,7 +2490,11 @@ function createRpcClient(url, useHttps) {
       let waitTime = 500;
 
       for (;;) {
-        res = await fetch(url, options);
+        if (fetchWithMiddleware) {
+          res = await fetchWithMiddleware(url, options);
+        } else {
+          res = await fetch(url, options);
+        }
 
         if (res.status !== 429
         /* Too many requests */
@@ -3102,9 +3122,9 @@ class Connection {
    * Establish a JSON RPC connection
    *
    * @param endpoint URL to the fullnode JSON RPC endpoint
-   * @param commitment optional default commitment level
+   * @param commitmentOrConfig optional default commitment level or optional ConnectionConfig configuration object
    */
-  constructor(endpoint, commitment) {
+  constructor(endpoint, commitmentOrConfig) {
     _defineProperty(this, "_commitment", void 0);
 
     _defineProperty(this, "_rpcEndpoint", void 0);
@@ -3156,10 +3176,20 @@ class Connection {
     this._rpcEndpoint = endpoint;
     let url = parse(endpoint);
     const useHttps = url.protocol === 'https:';
-    this._rpcClient = createRpcClient(url.href, useHttps);
+    let httpHeaders;
+    let fetchMiddleware;
+
+    if (commitmentOrConfig && typeof commitmentOrConfig === 'string') {
+      this._commitment = commitmentOrConfig;
+    } else if (commitmentOrConfig) {
+      this._commitment = commitmentOrConfig.commitment;
+      httpHeaders = commitmentOrConfig.httpHeaders;
+      fetchMiddleware = commitmentOrConfig.fetchMiddleware;
+    }
+
+    this._rpcClient = createRpcClient(url.href, useHttps, httpHeaders, fetchMiddleware);
     this._rpcRequest = createRpcRequest(this._rpcClient);
     this._rpcBatchRequest = createRpcBatchRequest(this._rpcClient);
-    this._commitment = commitment;
     this._blockhashInfo = {
       recentBlockhash: null,
       lastFetch: 0,