@solana/web3.js 2.0.0-experimental.78768fc → 2.0.0-experimental.7adc22b

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2018 Solana Labs, Inc
+Copyright (c) 2023 Solana Labs, Inc
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

package/README.md

@@ -77,19 +77,19 @@ Unimplemented.
 
 Client applications primarily deal with addresses and public keys in the form of base58-encoded strings. Addresses and public keys returned from the RPC API conform to the type `Base58EncodedAddress`. You can use a value of that type wherever a base58-encoded address or key is expected.
 
-From time to time you might acquire a string, that you expect to validate as an address, from an untrusted network API or user input. To assert that such an arbitrary string is a base58-encoded address, use the `assertIsBase58EncodedAddress` function.
+From time to time you might acquire a string, that you expect to validate as an address, from an untrusted network API or user input. To assert that such an arbitrary string is a base58-encoded address, use the `assertIsAddress` function.
 
 ```ts
-import { assertIsBase58EncodedAddress } from '@solana/web3.js`;
+import { assertIsAddress } from '@solana/web3.js';
 
 // Imagine a function that fetches an account's balance when a user submits a form.
-function handleSubmit() {
+async function handleSubmit() {
     // We know only that what the user typed conforms to the `string` type.
     const address: string = accountAddressInput.value;
     try {
         // If this type assertion function doesn't throw, then
         // Typescript will upcast `address` to `Base58EncodedAddress`.
-        assertIsBase58EncodedAddress(address);
+        assertIsAddress(address);
         // At this point, `address` is a `Base58EncodedAddress` that can be used with the RPC.
         const balanceInLamports = await rpc.getBalance(address).send();
     } catch (e) {

package/dist/index.browser.cjs

@@ -4,15 +4,18 @@ var addresses = require('@solana/addresses');
 var instructions = require('@solana/instructions');
 var keys = require('@solana/keys');
 var transactions = require('@solana/transactions');
+var functional = require('@solana/functional');
 var rpcCore = require('@solana/rpc-core');
 var rpcTransport = require('@solana/rpc-transport');
 var fastStableStringify = require('fast-stable-stringify');
+var umiSerializers = require('@metaplex-foundation/umi-serializers');
 
 function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
 
 var fastStableStringify__default = /*#__PURE__*/_interopDefault(fastStableStringify);
 
-// src/index.ts
+// ../build-scripts/env-shim.ts
+var __DEV__ = /* @__PURE__ */ (() => process["env"].NODE_ENV === "development")();
 
 // src/rpc-integer-overflow-error.ts
 var SolanaJsonRpcIntegerOverflowError = class extends Error {
@@ -50,6 +53,193 @@ var DEFAULT_RPC_CONFIG = {
   }
 };
 
+// src/cached-abortable-iterable.ts
+function registerIterableCleanup(iterable, cleanupFn) {
+  (async () => {
+    try {
+      for await (const _ of iterable)
+        ;
+    } catch {
+    } finally {
+      cleanupFn();
+    }
+  })();
+}
+function getCachedAbortableIterableFactory({
+  getAbortSignalFromInputArgs,
+  getCacheEntryMissingError,
+  getCacheKeyFromInputArgs,
+  onCacheHit,
+  onCreateIterable
+}) {
+  const cache = /* @__PURE__ */ new Map();
+  function getCacheEntryOrThrow(cacheKey) {
+    const currentCacheEntry = cache.get(cacheKey);
+    if (!currentCacheEntry) {
+      throw getCacheEntryMissingError(cacheKey);
+    }
+    return currentCacheEntry;
+  }
+  return async (...args) => {
+    const cacheKey = getCacheKeyFromInputArgs(...args);
+    const signal = getAbortSignalFromInputArgs(...args);
+    if (cacheKey === void 0) {
+      return await onCreateIterable(signal, ...args);
+    }
+    const cleanup = () => {
+      cache.delete(cacheKey);
+      signal.removeEventListener("abort", handleAbort);
+    };
+    const handleAbort = () => {
+      const cacheEntry = getCacheEntryOrThrow(cacheKey);
+      if (cacheEntry.purgeScheduled !== true) {
+        cacheEntry.purgeScheduled = true;
+        globalThis.queueMicrotask(() => {
+          cacheEntry.purgeScheduled = false;
+          if (cacheEntry.referenceCount === 0) {
+            cacheEntry.abortController.abort();
+            cleanup();
+          }
+        });
+      }
+      cacheEntry.referenceCount--;
+    };
+    signal.addEventListener("abort", handleAbort);
+    try {
+      const cacheEntry = cache.get(cacheKey);
+      if (!cacheEntry) {
+        const singletonAbortController = new AbortController();
+        const newIterablePromise = onCreateIterable(singletonAbortController.signal, ...args);
+        const newCacheEntry = {
+          abortController: singletonAbortController,
+          iterable: newIterablePromise,
+          purgeScheduled: false,
+          referenceCount: 1
+        };
+        cache.set(cacheKey, newCacheEntry);
+        const newIterable = await newIterablePromise;
+        registerIterableCleanup(newIterable, cleanup);
+        newCacheEntry.iterable = newIterable;
+        return newIterable;
+      } else {
+        cacheEntry.referenceCount++;
+        const iterableOrIterablePromise = cacheEntry.iterable;
+        const cachedIterable = "then" in iterableOrIterablePromise ? await iterableOrIterablePromise : iterableOrIterablePromise;
+        await onCacheHit(cachedIterable, ...args);
+        return cachedIterable;
+      }
+    } catch (e) {
+      cleanup();
+      throw e;
+    }
+  };
+}
+
+// src/rpc-subscription-coalescer.ts
+var EXPLICIT_ABORT_TOKEN = Symbol(
+  __DEV__ ? "This symbol is thrown from a subscription's iterator when the subscription is explicitly aborted by the user" : void 0
+);
+function registerIterableCleanup2(iterable, cleanupFn) {
+  (async () => {
+    try {
+      for await (const _ of iterable)
+        ;
+    } catch {
+    } finally {
+      cleanupFn();
+    }
+  })();
+}
+function getRpcSubscriptionsWithSubscriptionCoalescing({
+  getDeduplicationKey,
+  rpcSubscriptions
+}) {
+  const cache = /* @__PURE__ */ new Map();
+  return new Proxy(rpcSubscriptions, {
+    defineProperty() {
+      return false;
+    },
+    deleteProperty() {
+      return false;
+    },
+    get(target, p, receiver) {
+      const subscriptionMethod = Reflect.get(target, p, receiver);
+      if (typeof subscriptionMethod !== "function") {
+        return subscriptionMethod;
+      }
+      return function(...rawParams) {
+        const deduplicationKey = getDeduplicationKey(p, rawParams);
+        if (deduplicationKey === void 0) {
+          return subscriptionMethod(...rawParams);
+        }
+        if (cache.has(deduplicationKey)) {
+          return cache.get(deduplicationKey);
+        }
+        const iterableFactory = getCachedAbortableIterableFactory({
+          getAbortSignalFromInputArgs: ({ abortSignal }) => abortSignal,
+          getCacheEntryMissingError(deduplicationKey2) {
+            return new Error(
+              `Found no cache entry for subscription with deduplication key \`${deduplicationKey2?.toString()}\``
+            );
+          },
+          getCacheKeyFromInputArgs: () => deduplicationKey,
+          async onCacheHit(_iterable, _config) {
+          },
+          async onCreateIterable(abortSignal, config) {
+            const pendingSubscription2 = subscriptionMethod(
+              ...rawParams
+            );
+            const iterable = await pendingSubscription2.subscribe({
+              ...config,
+              abortSignal
+            });
+            registerIterableCleanup2(iterable, () => {
+              cache.delete(deduplicationKey);
+            });
+            return iterable;
+          }
+        });
+        const pendingSubscription = {
+          async subscribe(...args) {
+            const iterable = await iterableFactory(...args);
+            const { abortSignal } = args[0];
+            let abortPromise;
+            return {
+              ...iterable,
+              async *[Symbol.asyncIterator]() {
+                abortPromise || (abortPromise = abortSignal.aborted ? Promise.reject(EXPLICIT_ABORT_TOKEN) : new Promise((_, reject) => {
+                  abortSignal.addEventListener("abort", () => {
+                    reject(EXPLICIT_ABORT_TOKEN);
+                  });
+                }));
+                try {
+                  const iterator = iterable[Symbol.asyncIterator]();
+                  while (true) {
+                    const iteratorResult = await Promise.race([iterator.next(), abortPromise]);
+                    if (iteratorResult.done) {
+                      return;
+                    } else {
+                      yield iteratorResult.value;
+                    }
+                  }
+                } catch (e) {
+                  if (e === EXPLICIT_ABORT_TOKEN) {
+                    return;
+                  }
+                  cache.delete(deduplicationKey);
+                  throw e;
+                }
+              }
+            };
+          }
+        };
+        cache.set(deduplicationKey, pendingSubscription);
+        return pendingSubscription;
+      };
+    }
+  });
+}
+
 // src/rpc.ts
 function createSolanaRpc(config) {
   return rpcTransport.createJsonRpc({
@@ -57,6 +247,24 @@ function createSolanaRpc(config) {
     api: rpcCore.createSolanaRpcApi(DEFAULT_RPC_CONFIG)
   });
 }
+function createSolanaRpcSubscriptions(config) {
+  return functional.pipe(
+    rpcTransport.createJsonSubscriptionRpc({
+      ...config,
+      api: rpcCore.createSolanaRpcSubscriptionsApi(DEFAULT_RPC_CONFIG)
+    }),
+    (rpcSubscriptions) => getRpcSubscriptionsWithSubscriptionCoalescing({
+      getDeduplicationKey: (...args) => fastStableStringify__default.default(args),
+      rpcSubscriptions
+    })
+  );
+}
+function createSolanaRpcSubscriptions_UNSTABLE(config) {
+  return rpcTransport.createJsonSubscriptionRpc({
+    ...config,
+    api: rpcCore.createSolanaRpcSubscriptionsApi_UNSTABLE(DEFAULT_RPC_CONFIG)
+  });
+}
 
 // src/rpc-request-coalescer.ts
 function getRpcTransportWithRequestCoalescing(transport, getDeduplicationKey) {
@@ -109,13 +317,14 @@ function getRpcTransportWithRequestCoalescing(transport, getDeduplicationKey) {
     }
   };
 }
-function getSolanaRpcPayloadDeduplicationKey(payload) {
+function isJsonRpcPayload(payload) {
   if (payload == null || typeof payload !== "object" || Array.isArray(payload)) {
-    return;
-  }
-  if ("jsonrpc" in payload && payload.jsonrpc === "2.0" && "method" in payload && "params" in payload) {
-    return fastStableStringify__default.default([payload.method, payload.params]);
+    return false;
   }
+  return "jsonrpc" in payload && payload.jsonrpc === "2.0" && "method" in payload && typeof payload.method === "string" && "params" in payload;
+}
+function getSolanaRpcPayloadDeduplicationKey(payload) {
+  return isJsonRpcPayload(payload) ? fastStableStringify__default.default([payload.method, payload.params]) : void 0;
 }
 
 // src/rpc-transport.ts
@@ -127,7 +336,7 @@ function normalizeHeaders(headers) {
   return out;
 }
 function createDefaultRpcTransport(config) {
-  return getRpcTransportWithRequestCoalescing(
+  return functional.pipe(
     rpcTransport.createHttpTransport({
       ...config,
       headers: {
@@ -138,12 +347,325 @@ function createDefaultRpcTransport(config) {
         }
       }
     }),
-    getSolanaRpcPayloadDeduplicationKey
+    (transport) => getRpcTransportWithRequestCoalescing(transport, getSolanaRpcPayloadDeduplicationKey)
+  );
+}
+
+// src/rpc-websocket-autopinger.ts
+var PING_PAYLOAD = {
+  jsonrpc: "2.0",
+  method: "ping"
+};
+function getWebSocketTransportWithAutoping({ intervalMs, transport }) {
+  const pingableConnections = /* @__PURE__ */ new Map();
+  return async (...args) => {
+    const connection = await transport(...args);
+    let intervalId;
+    function sendPing() {
+      connection.send_DO_NOT_USE_OR_YOU_WILL_BE_FIRED(PING_PAYLOAD);
+    }
+    function restartPingTimer() {
+      clearInterval(intervalId);
+      intervalId = setInterval(sendPing, intervalMs);
+    }
+    if (pingableConnections.has(connection) === false) {
+      pingableConnections.set(connection, {
+        [Symbol.asyncIterator]: connection[Symbol.asyncIterator].bind(connection),
+        send_DO_NOT_USE_OR_YOU_WILL_BE_FIRED: (...args2) => {
+          restartPingTimer();
+          return connection.send_DO_NOT_USE_OR_YOU_WILL_BE_FIRED(...args2);
+        }
+      });
+      (async () => {
+        try {
+          for await (const _ of connection) {
+            restartPingTimer();
+          }
+        } catch {
+        } finally {
+          pingableConnections.delete(connection);
+          clearInterval(intervalId);
+          if (handleOffline) {
+            globalThis.window.removeEventListener("offline", handleOffline);
+          }
+          if (handleOnline) {
+            globalThis.window.removeEventListener("online", handleOnline);
+          }
+        }
+      })();
+      if (globalThis.navigator.onLine) {
+        restartPingTimer();
+      }
+      let handleOffline;
+      let handleOnline;
+      {
+        handleOffline = () => {
+          clearInterval(intervalId);
+        };
+        handleOnline = () => {
+          sendPing();
+          restartPingTimer();
+        };
+        globalThis.window.addEventListener("offline", handleOffline);
+        globalThis.window.addEventListener("online", handleOnline);
+      }
+    }
+    return pingableConnections.get(connection);
+  };
+}
+
+// src/rpc-websocket-connection-sharding.ts
+var NULL_SHARD_CACHE_KEY = Symbol(
+  __DEV__ ? "Cache key to use when there is no connection sharding strategy" : void 0
+);
+function getWebSocketTransportWithConnectionSharding({ getShard, transport }) {
+  return getCachedAbortableIterableFactory({
+    getAbortSignalFromInputArgs: ({ signal }) => signal,
+    getCacheEntryMissingError(shardKey) {
+      return new Error(`Found no cache entry for connection with shard key \`${shardKey?.toString()}\``);
+    },
+    getCacheKeyFromInputArgs: ({ payload }) => getShard ? getShard(payload) : NULL_SHARD_CACHE_KEY,
+    onCacheHit: (connection, { payload }) => connection.send_DO_NOT_USE_OR_YOU_WILL_BE_FIRED(payload),
+    onCreateIterable: (abortSignal, config) => transport({
+      ...config,
+      signal: abortSignal
+    })
+  });
+}
+
+// src/rpc-websocket-transport.ts
+function createDefaultRpcSubscriptionsTransport(config) {
+  const { getShard, intervalMs, ...rest } = config;
+  return functional.pipe(
+    rpcTransport.createWebSocketTransport({
+      ...rest,
+      sendBufferHighWatermark: config.sendBufferHighWatermark ?? // Let 128KB of data into the WebSocket buffer before buffering it in the app.
+      131072
+    }),
+    (transport) => getWebSocketTransportWithAutoping({
+      intervalMs: intervalMs ?? 5e3,
+      transport
+    }),
+    (transport) => getWebSocketTransportWithConnectionSharding({
+      getShard,
+      transport
+    })
+  );
+}
+
+// src/transaction-confirmation-strategy-blockheight.ts
+function createBlockHeightExceedencePromiseFactory(rpcSubscriptions) {
+  return async function getBlockHeightExceedencePromise({ abortSignal: callerAbortSignal, lastValidBlockHeight }) {
+    const abortController = new AbortController();
+    function handleAbort() {
+      abortController.abort();
+    }
+    callerAbortSignal.addEventListener("abort", handleAbort, { signal: abortController.signal });
+    const slotNotifications = await rpcSubscriptions.slotNotifications().subscribe({ abortSignal: abortController.signal });
+    try {
+      for await (const slotNotification of slotNotifications) {
+        if (slotNotification.slot > lastValidBlockHeight) {
+          throw new Error(
+            "The network has progressed past the last block for which this transaction could have committed."
+          );
+        }
+      }
+    } finally {
+      abortController.abort();
+    }
+  };
+}
+var NONCE_VALUE_OFFSET = 4 + // version(u32)
+4 + // state(u32)
+32;
+function createNonceInvalidationPromiseFactory(rpc, rpcSubscriptions) {
+  return async function getNonceInvalidationPromise({
+    abortSignal: callerAbortSignal,
+    commitment,
+    currentNonceValue,
+    nonceAccountAddress
+  }) {
+    const abortController = new AbortController();
+    function handleAbort() {
+      abortController.abort();
+    }
+    callerAbortSignal.addEventListener("abort", handleAbort, { signal: abortController.signal });
+    const accountNotifications = await rpcSubscriptions.accountNotifications(nonceAccountAddress, { commitment, encoding: "base64" }).subscribe({ abortSignal: abortController.signal });
+    function getNonceFromAccountData([base64EncodedBytes]) {
+      const data = umiSerializers.base64.serialize(base64EncodedBytes);
+      const nonceValueBytes = data.slice(NONCE_VALUE_OFFSET, NONCE_VALUE_OFFSET + 32);
+      return umiSerializers.base58.deserialize(nonceValueBytes)[0];
+    }
+    const nonceAccountDidAdvancePromise = (async () => {
+      for await (const accountNotification of accountNotifications) {
+        const nonceValue = getNonceFromAccountData(accountNotification.value.data);
+        if (nonceValue !== currentNonceValue) {
+          throw new Error(
+            `The nonce \`${currentNonceValue}\` is no longer valid. It has advanced to \`${nonceValue}\`.`
+          );
+        }
+      }
+    })();
+    const nonceIsAlreadyInvalidPromise = (async () => {
+      const { value: nonceAccount } = await rpc.getAccountInfo(nonceAccountAddress, {
+        commitment,
+        dataSlice: { length: 32, offset: NONCE_VALUE_OFFSET },
+        encoding: "base58"
+      }).send({ abortSignal: abortController.signal });
+      if (!nonceAccount) {
+        throw new Error(`No nonce account could be found at address \`${nonceAccountAddress}\`.`);
+      }
+      const nonceValue = (
+        // This works because we asked for the exact slice of data representing the nonce
+        // value, and furthermore asked for it in `base58` encoding.
+        nonceAccount.data[0]
+      );
+      if (nonceValue !== currentNonceValue) {
+        throw new Error(
+          `The nonce \`${currentNonceValue}\` is no longer valid. It has advanced to \`${nonceValue}\`.`
+        );
+      } else {
+        await new Promise(() => {
+        });
+      }
+    })();
+    try {
+      return await Promise.race([nonceAccountDidAdvancePromise, nonceIsAlreadyInvalidPromise]);
+    } finally {
+      abortController.abort();
+    }
+  };
+}
+function createSignatureConfirmationPromiseFactory(rpc, rpcSubscriptions) {
+  return async function getSignatureConfirmationPromise({ abortSignal: callerAbortSignal, commitment, signature }) {
+    const abortController = new AbortController();
+    function handleAbort() {
+      abortController.abort();
+    }
+    callerAbortSignal.addEventListener("abort", handleAbort, { signal: abortController.signal });
+    const signatureStatusNotifications = await rpcSubscriptions.signatureNotifications(signature, { commitment }).subscribe({ abortSignal: abortController.signal });
+    const signatureDidCommitPromise = (async () => {
+      for await (const signatureStatusNotification of signatureStatusNotifications) {
+        if (signatureStatusNotification.value.err) {
+          throw new Error(`The transaction with signature \`${signature}\` failed.`, {
+            cause: signatureStatusNotification.value.err
+          });
+        } else {
+          return;
+        }
+      }
+    })();
+    const signatureStatusLookupPromise = (async () => {
+      const { value: signatureStatusResults } = await rpc.getSignatureStatuses([signature]).send({ abortSignal: abortController.signal });
+      const signatureStatus = signatureStatusResults[0];
+      if (signatureStatus && signatureStatus.confirmationStatus && rpcCore.commitmentComparator(signatureStatus.confirmationStatus, commitment) >= 0) {
+        return;
+      } else {
+        await new Promise(() => {
+        });
+      }
+    })();
+    try {
+      return await Promise.race([signatureDidCommitPromise, signatureStatusLookupPromise]);
+    } finally {
+      abortController.abort();
+    }
+  };
+}
+
+// src/transaction-confirmation.ts
+async function raceStrategies(config, getSpecificStrategiesForRace) {
+  const { abortSignal: callerAbortSignal, commitment, getSignatureConfirmationPromise, transaction } = config;
+  callerAbortSignal.throwIfAborted();
+  const signature = transactions.getSignatureFromTransaction(transaction);
+  const abortController = new AbortController();
+  function handleAbort() {
+    abortController.abort();
+  }
+  callerAbortSignal.addEventListener("abort", handleAbort, { signal: abortController.signal });
+  try {
+    const specificStrategies = getSpecificStrategiesForRace({
+      ...config,
+      abortSignal: abortController.signal
+    });
+    return await Promise.race([
+      getSignatureConfirmationPromise({
+        abortSignal: abortController.signal,
+        commitment,
+        signature
+      }),
+      ...specificStrategies
+    ]);
+  } finally {
+    abortController.abort();
+  }
+}
+function createDefaultDurableNonceTransactionConfirmer({
+  rpc,
+  rpcSubscriptions
+}) {
+  const getNonceInvalidationPromise = createNonceInvalidationPromiseFactory(rpc, rpcSubscriptions);
+  const getSignatureConfirmationPromise = createSignatureConfirmationPromiseFactory(rpc, rpcSubscriptions);
+  return async function confirmTransaction(config) {
+    await waitForDurableNonceTransactionConfirmation({
+      ...config,
+      getNonceInvalidationPromise,
+      getSignatureConfirmationPromise
+    });
+  };
+}
+function createDefaultTransactionConfirmer({ rpc, rpcSubscriptions }) {
+  const getBlockHeightExceedencePromise = createBlockHeightExceedencePromiseFactory(rpcSubscriptions);
+  const getSignatureConfirmationPromise = createSignatureConfirmationPromiseFactory(rpc, rpcSubscriptions);
+  return async function confirmTransaction(config) {
+    await waitForTransactionConfirmation({
+      ...config,
+      getBlockHeightExceedencePromise,
+      getSignatureConfirmationPromise
+    });
+  };
+}
+async function waitForDurableNonceTransactionConfirmation(config) {
+  await raceStrategies(
+    config,
+    function getSpecificStrategiesForRace({ abortSignal, commitment, getNonceInvalidationPromise, transaction }) {
+      return [
+        getNonceInvalidationPromise({
+          abortSignal,
+          commitment,
+          currentNonceValue: transaction.lifetimeConstraint.nonce,
+          nonceAccountAddress: transaction.instructions[0].accounts[0].address
+        })
+      ];
+    }
+  );
+}
+async function waitForTransactionConfirmation(config) {
+  await raceStrategies(
+    config,
+    function getSpecificStrategiesForRace({ abortSignal, getBlockHeightExceedencePromise, transaction }) {
+      return [
+        getBlockHeightExceedencePromise({
+          abortSignal,
+          lastValidBlockHeight: transaction.lifetimeConstraint.lastValidBlockHeight
+        })
+      ];
+    }
   );
 }
 
+exports.createBlockHeightExceedencePromiseFactory = createBlockHeightExceedencePromiseFactory;
+exports.createDefaultDurableNonceTransactionConfirmer = createDefaultDurableNonceTransactionConfirmer;
+exports.createDefaultRpcSubscriptionsTransport = createDefaultRpcSubscriptionsTransport;
 exports.createDefaultRpcTransport = createDefaultRpcTransport;
+exports.createDefaultTransactionConfirmer = createDefaultTransactionConfirmer;
+exports.createNonceInvalidationPromiseFactory = createNonceInvalidationPromiseFactory;
+exports.createSignatureConfirmationPromiseFactory = createSignatureConfirmationPromiseFactory;
 exports.createSolanaRpc = createSolanaRpc;
+exports.createSolanaRpcSubscriptions = createSolanaRpcSubscriptions;
+exports.createSolanaRpcSubscriptions_UNSTABLE = createSolanaRpcSubscriptions_UNSTABLE;
+exports.waitForDurableNonceTransactionConfirmation = waitForDurableNonceTransactionConfirmation;
+exports.waitForTransactionConfirmation = waitForTransactionConfirmation;
 Object.keys(addresses).forEach(function (k) {
   if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
     enumerable: true,