@solana/web3.js 1.78.0 → 2.0.0-development

package/README.md

@@ -6,150 +6,94 @@
 
 [code-style-prettier-image]: https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square
 [code-style-prettier-url]: https://github.com/prettier/prettier
-[npm-downloads-image]: https://img.shields.io/npm/dm/@solana/web3.js.svg?style=flat
-[npm-image]: https://img.shields.io/npm/v/@solana/web3.js.svg?style=flat
-[npm-url]: https://www.npmjs.com/package/@solana/web3.js
+[npm-downloads-image]: https://img.shields.io/npm/dm/@solana/web3.js/experimental.svg?style=flat
+[npm-image]: https://img.shields.io/npm/v/@solana/web3.js/experimental.svg?style=flat
+[npm-url]: https://www.npmjs.com/package/@solana/web3.js/v/experimental
 [semantic-release-image]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
 [semantic-release-url]: https://github.com/semantic-release/semantic-release
 
-# Solana JavaScript SDK
+# Experimental Solana JavaScript SDK
 
-Use this to interact with accounts and programs on the Solana network through the Solana [JSON RPC API](https://docs.solana.com/apps/jsonrpc-api).
+Use this to interact with accounts and programs on the Solana network through the Solana [JSON-RPC API](https://docs.solana.com/apps/jsonrpc-api).
+
+**This library is experimental**. It is unsuitable for production use, because the API is unstable and may change without warning. If you want to build a production Solana application, use the [1.x branch](https://www.npmjs.com/package/@solana/web3.js).
 
 ## Installation
 
-### For use in Node.js or a web application
+### For use in Node.js, React Native, or a web application
 
-```
-$ npm install --save @solana/web3.js
+```shell
+npm install --save @solana/web3.js@experimental
 ```
 
 ### For use in a browser, without a build system
 
 ```html
-<!-- Development (un-minified) -->
-<script src="https://unpkg.com/@solana/web3.js@latest/lib/index.iife.js"></script>
+<!-- Development (debug mode, unminified) -->
+<script src="https://unpkg.com/@solana/web3.js@experimental/dist/index.development.js"></script>
 
 <!-- Production (minified) -->
-<script src="https://unpkg.com/@solana/web3.js@latest/lib/index.iife.min.js"></script>
+<script src="https://unpkg.com/@solana/web3.js@experimental/dist/index.production.min.js"></script>
 ```
 
-## Documentation and examples
-
-- [The Solana Cookbook](https://solanacookbook.com/) has extensive task-based documentation using this library.
-- For more detail on individual functions, see the [latest API Documentation](https://solana-labs.github.io/solana-web3.js)
+## Usage
 
-## Getting help
+There are 3 main applications of this library.
 
-Have a question or a problem? Check the [Solana Stack Exchange](https://solana.stackexchange.com) to see if anyone else is having the same one. If not, [post a new question](https://solana.stackexchange.com/questions/ask).
+1. **RPC**. Solana apps interact with the network by calling methods on the Solana JSON-RPC.
+2. **Transactions**. Solana apps interact with Solana program by building and sending transactions.
+3. **Keys**. People use cryptographic keys to verify the provenance of messages and to attest to the ownership of their accounts.
 
-Include:
+### RPC
 
-- A detailed description of what you're trying to achieve
-- Source code, if possible
-- The text of any errors you encountered, with stacktraces if available
+First, configure your connection to an RPC server. This might be a server that you host, one that you lease, or one of the limited-use [public RPC servers](https://docs.solana.com/cluster/rpc-endpoints).
 
-## Compatibility
-
-This library requires a JavaScript runtime that supports [`BigInt`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt) and the [exponentiation operator](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Exponentiation). Both are supported in the following runtimes:
+```ts
+import { createDefaultRpcTransport } from '@solana/web3.js';
+const devnetTransport = createDefaultRpcTransport({ url: 'https://api.devnet.solana.com' });
+```
 
-- Browsers, by [release date](https://caniuse.com/bigint):
-  - Chrome: May 2018
-  - Firefox: July 2019
-  - Safari: September 2020
-  - Mobile Safari: September 2020
-  - Edge: January 2020
-  - Opera: June 2018
-  - Samsung Internet: April 2019
-- Runtimes, [by version](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt):
-  - Deno: >=1.0
-  - Node: >=10.4.0
-- React Native:
-  - \>=0.7.0 using the [Hermes](https://reactnative.dev/blog/2022/07/08/hermes-as-the-default) engine ([integration guide](https://solanacookbook.com/integrations/react-native.html#how-to-use-solana-web3-js-in-a-react-native-app)):
+Second, construct an RPC instance that uses that transport.
 
-## Development environment setup
+```ts
+const devnetRpc = createSolanaRpc({ transport: devnetTransport });
+```
 
-### Testing
+Now, you can use it to call methods on your RPC server. For instance, here is how you would fetch an account's balance.
 
-#### Unit tests
+```ts
+const systemProgramAddress = '11111111111111111111111111111111' as Base58EncodedAddress;
+const balanceInLamports = await devnetRpc.getBalance(systemProgramAddress).send();
+console.log('Balance of System Program account in Lamports', balanceInLamports);
+```
 
-To run the full suite of unit tests, excute the following in the root:
+### Transactions
 
-```shell
-$ npm test
-```
+Unimplemented.
 
-#### Integration tests
+### Keys
 
-Integration tests require a validator client running on your machine.
+#### Addresses and public keys
 
-To install a test validator:
+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.
 
-```shell
-$ npm run test:live-with-test-validator:setup
-```
+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.
 
-To start the test validator and run all of the integration tests in live mode:
+```ts
+import { assertIsBase58EncodedAddress } from '@solana/web3.js`;
 
-```shell
-$ cd packages/library-legacy
-$ npm run test:live-with-test-validator
+// Imagine a function that fetches an account's balance when a user submits a form.
+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);
+        // At this point, `address` is a `Base58EncodedAddress` that can be used with the RPC.
+        const balanceInLamports = await rpc.getBalance(address).send();
+    } catch (e) {
+        // `address` turned out not to be a base58-encoded address
+    }
+}
 ```
-
-### Speed up build times with remote caching
-
-Cache build artifacts remotely so that you, others, and the CI server can take advantage of each others' build efforts.
-
-1. Log the Turborepo CLI into the Solana Vercel account
-   ```shell
-   pnpm turbo login
-   ```
-2. Link the repository to the remote cache
-   ```shell
-   pnpm turbo link
-   ```
-
-## Contributing
-
-If you found a bug or would like to request a feature, please [file an issue](https://github.com/solana-labs/solana-web3.js/issues/new). If, based on the discussion on an issue you would like to offer a code change, please make a [pull request](https://github.com/solana-labs/solana-web3.js/compare). If neither of these describes what you would like to contribute, read the [getting help](#getting-help) section above.
-
-## Disclaimer
-
-All claims, content, designs, algorithms, estimates, roadmaps,
-specifications, and performance measurements described in this project
-are done with the Solana Foundation's ("SF") best efforts. It is up to
-the reader to check and validate their accuracy and truthfulness.
-Furthermore nothing in this project constitutes a solicitation for
-investment.
-
-Any content produced by SF or developer resources that SF provides, are
-for educational and inspiration purposes only. SF does not encourage,
-induce or sanction the deployment, integration or use of any such
-applications (including the code comprising the Solana blockchain
-protocol) in violation of applicable laws or regulations and hereby
-prohibits any such deployment, integration or use. This includes use of
-any such applications by the reader (a) in violation of export control
-or sanctions laws of the United States or any other applicable
-jurisdiction, (b) if the reader is located in or ordinarily resident in
-a country or territory subject to comprehensive sanctions administered
-by the U.S. Office of Foreign Assets Control (OFAC), or (c) if the
-reader is or is working on behalf of a Specially Designated National
-(SDN) or a person subject to similar blocking or denied party
-prohibitions.
-
-The reader should be aware that U.S. export control and sanctions laws
-prohibit U.S. persons (and other persons that are subject to such laws)
-from transacting with persons in certain countries and territories or
-that are on the SDN list. As a project based primarily on open-source
-software, it is possible that such sanctioned persons may nevertheless
-bypass prohibitions, obtain the code comprising the Solana blockchain
-protocol (or other project code or applications) and deploy, integrate,
-or otherwise use it. Accordingly, there is a risk to individuals that
-other persons using the Solana blockchain protocol may be sanctioned
-persons and that transactions with such persons would be a violation of
-U.S. export controls and sanctions law. This risk applies to
-individuals, organizations, and other ecosystem participants that
-deploy, integrate, or use the Solana blockchain protocol code directly
-(e.g., as a node operator), and individuals that transact on the Solana
-blockchain through light clients, third party interfaces, and/or wallet
-software.

package/dist/index.browser.cjs

@@ -0,0 +1,158 @@
+'use strict';
+
+var instructions = require('@solana/instructions');
+var keys = require('@solana/keys');
+var rpcCore = require('@solana/rpc-core');
+var rpcTransport = require('@solana/rpc-transport');
+var fastStableStringify = require('fast-stable-stringify');
+
+function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
+
+var fastStableStringify__default = /*#__PURE__*/_interopDefault(fastStableStringify);
+
+// src/index.ts
+
+// src/rpc-integer-overflow-error.ts
+var SolanaJsonRpcIntegerOverflowError = class extends Error {
+  constructor(methodName, keyPath, value) {
+    const argPosition = (typeof keyPath[0] === "number" ? keyPath[0] : parseInt(keyPath[0], 10)) + 1;
+    let ordinal = "";
+    const lastDigit = argPosition % 10;
+    const lastTwoDigits = argPosition % 100;
+    if (lastDigit == 1 && lastTwoDigits != 11) {
+      ordinal = argPosition + "st";
+    } else if (lastDigit == 2 && lastTwoDigits != 12) {
+      ordinal = argPosition + "nd";
+    } else if (lastDigit == 3 && lastTwoDigits != 13) {
+      ordinal = argPosition + "rd";
+    } else {
+      ordinal = argPosition + "th";
+    }
+    const path = keyPath.length > 1 ? keyPath.slice(1).map((pathPart) => typeof pathPart === "number" ? `[${pathPart}]` : pathPart).join(".") : null;
+    super(
+      `The ${ordinal} argument to the \`${methodName}\` RPC method${path ? ` at path \`${path}\`` : ""} was \`${value}\`. This number is unsafe for use with the Solana JSON-RPC because it exceeds \`Number.MAX_SAFE_INTEGER\`.`
+    );
+    this.keyPath = keyPath;
+    this.methodName = methodName;
+    this.value = value;
+  }
+  get name() {
+    return "SolanaJsonRpcIntegerOverflowError";
+  }
+};
+
+// src/rpc-default-config.ts
+var DEFAULT_RPC_CONFIG = {
+  onIntegerOverflow(methodName, keyPath, value) {
+    throw new SolanaJsonRpcIntegerOverflowError(methodName, keyPath, value);
+  }
+};
+
+// src/rpc.ts
+function createSolanaRpc(config) {
+  return rpcTransport.createJsonRpc({
+    ...config,
+    api: rpcCore.createSolanaRpcApi(DEFAULT_RPC_CONFIG)
+  });
+}
+
+// src/rpc-request-coalescer.ts
+function getRpcTransportWithRequestCoalescing(transport, getDeduplicationKey) {
+  let coalescedRequestsByDeduplicationKey;
+  return async function makeCoalescedHttpRequest(config) {
+    const { payload, signal } = config;
+    const deduplicationKey = getDeduplicationKey(payload);
+    if (deduplicationKey === void 0) {
+      return await transport(config);
+    }
+    if (!coalescedRequestsByDeduplicationKey) {
+      Promise.resolve().then(() => {
+        coalescedRequestsByDeduplicationKey = void 0;
+      });
+      coalescedRequestsByDeduplicationKey = {};
+    }
+    if (coalescedRequestsByDeduplicationKey[deduplicationKey] == null) {
+      const abortController = new AbortController();
+      coalescedRequestsByDeduplicationKey[deduplicationKey] = {
+        abortController,
+        numConsumers: 0,
+        responsePromise: transport({
+          ...config,
+          signal: abortController.signal
+        })
+      };
+    }
+    const coalescedRequest = coalescedRequestsByDeduplicationKey[deduplicationKey];
+    coalescedRequest.numConsumers++;
+    if (signal) {
+      const responsePromise = coalescedRequest.responsePromise;
+      return await new Promise((resolve, reject) => {
+        const handleAbort = (e) => {
+          signal.removeEventListener("abort", handleAbort);
+          coalescedRequest.numConsumers -= 1;
+          if (coalescedRequest.numConsumers === 0) {
+            const abortController = coalescedRequest.abortController;
+            abortController.abort();
+          }
+          const abortError = new DOMException(e.target.reason, "AbortError");
+          reject(abortError);
+        };
+        signal.addEventListener("abort", handleAbort);
+        responsePromise.then(resolve).finally(() => {
+          signal.removeEventListener("abort", handleAbort);
+        });
+      });
+    } else {
+      return await coalescedRequest.responsePromise;
+    }
+  };
+}
+function getSolanaRpcPayloadDeduplicationKey(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]);
+  }
+}
+
+// src/rpc-transport.ts
+function normalizeHeaders(headers) {
+  const out = {};
+  for (const headerName in headers) {
+    out[headerName.toLowerCase()] = headers[headerName];
+  }
+  return out;
+}
+function createDefaultRpcTransport(config) {
+  return getRpcTransportWithRequestCoalescing(
+    rpcTransport.createHttpTransport({
+      ...config,
+      headers: {
+        ...config.headers ? normalizeHeaders(config.headers) : void 0,
+        ...{
+          // Keep these headers lowercase so they will override any user-supplied headers above.
+          "solana-client": `js/${"2.0.0-development"}` ?? "UNKNOWN"
+        }
+      }
+    }),
+    getSolanaRpcPayloadDeduplicationKey
+  );
+}
+
+exports.createDefaultRpcTransport = createDefaultRpcTransport;
+exports.createSolanaRpc = createSolanaRpc;
+Object.keys(instructions).forEach(function (k) {
+  if (k !== 'default' && !exports.hasOwnProperty(k)) Object.defineProperty(exports, k, {
+    enumerable: true,
+    get: function () { return instructions[k]; }
+  });
+});
+Object.keys(keys).forEach(function (k) {
+  if (k !== 'default' && !exports.hasOwnProperty(k)) Object.defineProperty(exports, k, {
+    enumerable: true,
+    get: function () { return keys[k]; }
+  });
+});
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=index.browser.cjs.map

package/dist/index.browser.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts","../src/rpc.ts","../src/rpc-integer-overflow-error.ts","../src/rpc-default-config.ts","../src/rpc-transport.ts","../src/rpc-request-coalescer.ts","../src/rpc-request-deduplication.ts"],"names":[],"mappings":";AAAA,cAAc;AACd,cAAc;;;ACDd,SAAS,0BAA4C;AACrD,SAAS,qBAAqB;;;ACDvB,IAAM,oCAAN,cAAgD,MAAM;AAAA,EAIzD,YAAY,YAAoB,SAA8B,OAAe;AACzE,UAAM,eAAe,OAAO,QAAQ,CAAC,MAAM,WAAW,QAAQ,CAAC,IAAI,SAAS,QAAQ,CAAC,GAAG,EAAE,KAAK;AAC/F,QAAI,UAAU;AACd,UAAM,YAAY,cAAc;AAChC,UAAM,gBAAgB,cAAc;AACpC,QAAI,aAAa,KAAK,iBAAiB,IAAI;AACvC,gBAAU,cAAc;AAAA,IAC5B,WAAW,aAAa,KAAK,iBAAiB,IAAI;AAC9C,gBAAU,cAAc;AAAA,IAC5B,WAAW,aAAa,KAAK,iBAAiB,IAAI;AAC9C,gBAAU,cAAc;AAAA,IAC5B,OAAO;AACH,gBAAU,cAAc;AAAA,IAC5B;AACA,UAAM,OACF,QAAQ,SAAS,IACX,QACK,MAAM,CAAC,EACP,IAAI,cAAa,OAAO,aAAa,WAAW,IAAI,cAAc,QAAS,EAC3E,KAAK,GAAG,IACb;AACV;AAAA,MACI,OAAO,6BAA6B,0BAC7B,OAAO,cAAc,WAAW,YAAY;AAAA,IAGvD;AACA,SAAK,UAAU;AACf,SAAK,aAAa;AAClB,SAAK,QAAQ;AAAA,EACjB;AAAA,EACA,IAAI,OAAO;AACP,WAAO;AAAA,EACX;AACJ;;;AClCO,IAAM,qBAAwE;AAAA,EACjF,kBAAkB,YAAY,SAAS,OAAO;AAC1C,UAAM,IAAI,kCAAkC,YAAY,SAAS,KAAK;AAAA,EAC1E;AACJ;;;AFFO,SAAS,gBAAgB,QAAiF;AAC7G,SAAO,cAAgC;AAAA,IACnC,GAAG;AAAA,IACH,KAAK,mBAAmB,kBAAkB;AAAA,EAC9C,CAAC;AACL;;;AGXA,SAAS,2BAA2B;;;ACU7B,SAAS,qCACZ,WACA,qBACa;AACb,MAAI;AACJ,SAAO,eAAe,yBAClB,QACkB;AAClB,UAAM,EAAE,SAAS,OAAO,IAAI;AAC5B,UAAM,mBAAmB,oBAAoB,OAAO;AACpD,QAAI,qBAAqB,QAAW;AAChC,aAAO,MAAM,UAAU,MAAM;AAAA,IACjC;AACA,QAAI,CAAC,qCAAqC;AACtC,cAAQ,QAAQ,EAAE,KAAK,MAAM;AACzB,8CAAsC;AAAA,MAC1C,CAAC;AACD,4CAAsC,CAAC;AAAA,IAC3C;AACA,QAAI,oCAAoC,gBAAgB,KAAK,MAAM;AAC/D,YAAM,kBAAkB,IAAI,gBAAgB;AAC5C,0CAAoC,gBAAgB,IAAI;AAAA,QACpD;AAAA,QACA,cAAc;AAAA,QACd,iBAAiB,UAAqB;AAAA,UAClC,GAAG;AAAA,UACH,QAAQ,gBAAgB;AAAA,QAC5B,CAAC;AAAA,MACL;AAAA,IACJ;AACA,UAAM,mBAAmB,oCAAoC,gBAAgB;AAC7E,qBAAiB;AACjB,QAAI,QAAQ;AACR,YAAM,kBAAkB,iBAAiB;AACzC,aAAO,MAAM,IAAI,QAAmB,CAAC,SAAS,WAAW;AACrD,cAAM,cAAc,CAAC,MAAoC;AACrD,iBAAO,oBAAoB,SAAS,WAAW;AAC/C,2BAAiB,gBAAgB;AACjC,cAAI,iBAAiB,iBAAiB,GAAG;AACrC,kBAAM,kBAAkB,iBAAiB;AACzC,4BAAgB,MAAM;AAAA,UAC1B;AACA,gBAAM,aAAa,IAAI,aAAc,EAAE,OAAuB,QAAQ,YAAY;AAClF,iBAAO,UAAU;AAAA,QACrB;AACA,eAAO,iBAAiB,SAAS,WAAW;AAC5C,wBAAgB,KAAK,OAAO,EAAE,QAAQ,MAAM;AACxC,iBAAO,oBAAoB,SAAS,WAAW;AAAA,QACnD,CAAC;AAAA,MACL,CAAC;AAAA,IACL,OAAO;AACH,aAAQ,MAAM,iBAAiB;AAAA,IACnC;AAAA,EACJ;AACJ;;;AC9DA,OAAO,yBAAyB;AAEzB,SAAS,oCAAoC,SAAsC;AACtF,MAAI,WAAW,QAAQ,OAAO,YAAY,YAAY,MAAM,QAAQ,OAAO,GAAG;AAC1E;AAAA,EACJ;AACA,MAAI,aAAa,WAAW,QAAQ,YAAY,SAAS,YAAY,WAAW,YAAY,SAAS;AACjG,WAAO,oBAAoB,CAAC,QAAQ,QAAQ,QAAQ,MAAM,CAAC;AAAA,EAC/D;AACJ;;;AFFA,SAAS,iBACL,SACiD;AACjD,QAAM,MAA8B,CAAC;AACrC,aAAW,cAAc,SAAS;AAC9B,QAAI,WAAW,YAAY,CAAC,IAAI,QAAQ,UAAU;AAAA,EACtD;AACA,SAAO;AACX;AAEO,SAAS,0BAA0B,QAAkE;AACxG,SAAO;AAAA,IACH,oBAAoB;AAAA,MAChB,GAAG;AAAA,MACH,SAAS;AAAA,QACL,GAAI,OAAO,UAAU,iBAAiB,OAAO,OAAO,IAAI;AAAA,QACxD,GAAI;AAAA;AAAA,UAEA,iBAAiB,MAAM,yBAAiB;AAAA,QAC5C;AAAA,MACJ;AAAA,IACJ,CAAC;AAAA,IACD;AAAA,EACJ;AACJ","sourcesContent":["export * from '@solana/instructions';\nexport * from '@solana/keys';\nexport * from './rpc';\nexport * from './rpc-transport';\n","import { createSolanaRpcApi, SolanaRpcMethods } from '@solana/rpc-core';\nimport { createJsonRpc } from '@solana/rpc-transport';\nimport type { Rpc } from '@solana/rpc-transport/dist/types/json-rpc-types';\n\nimport { DEFAULT_RPC_CONFIG } from './rpc-default-config';\n\nexport function createSolanaRpc(config: Omit<Parameters<typeof createJsonRpc>[0], 'api'>): Rpc<SolanaRpcMethods> {\n    return createJsonRpc<SolanaRpcMethods>({\n        ...config,\n        api: createSolanaRpcApi(DEFAULT_RPC_CONFIG),\n    });\n}\n","export class SolanaJsonRpcIntegerOverflowError extends Error {\n    readonly methodName: string;\n    readonly keyPath: (number | string)[];\n    readonly value: bigint;\n    constructor(methodName: string, keyPath: (number | string)[], value: bigint) {\n        const argPosition = (typeof keyPath[0] === 'number' ? keyPath[0] : parseInt(keyPath[0], 10)) + 1;\n        let ordinal = '';\n        const lastDigit = argPosition % 10;\n        const lastTwoDigits = argPosition % 100;\n        if (lastDigit == 1 && lastTwoDigits != 11) {\n            ordinal = argPosition + 'st';\n        } else if (lastDigit == 2 && lastTwoDigits != 12) {\n            ordinal = argPosition + 'nd';\n        } else if (lastDigit == 3 && lastTwoDigits != 13) {\n            ordinal = argPosition + 'rd';\n        } else {\n            ordinal = argPosition + 'th';\n        }\n        const path =\n            keyPath.length > 1\n                ? keyPath\n                      .slice(1)\n                      .map(pathPart => (typeof pathPart === 'number' ? `[${pathPart}]` : pathPart))\n                      .join('.')\n                : null;\n        super(\n            `The ${ordinal} argument to the \\`${methodName}\\` RPC method` +\n                `${path ? ` at path \\`${path}\\`` : ''} was \\`${value}\\`. This number is ` +\n                'unsafe for use with the Solana JSON-RPC because it exceeds ' +\n                '`Number.MAX_SAFE_INTEGER`.'\n        );\n        this.keyPath = keyPath;\n        this.methodName = methodName;\n        this.value = value;\n    }\n    get name() {\n        return 'SolanaJsonRpcIntegerOverflowError';\n    }\n}\n","import { createSolanaRpcApi } from '@solana/rpc-core';\n\nimport { SolanaJsonRpcIntegerOverflowError } from './rpc-integer-overflow-error';\n\nexport const DEFAULT_RPC_CONFIG: Partial<Parameters<typeof createSolanaRpcApi>[0]> = {\n    onIntegerOverflow(methodName, keyPath, value) {\n        throw new SolanaJsonRpcIntegerOverflowError(methodName, keyPath, value);\n    },\n};\n","import { createHttpTransport } from '@solana/rpc-transport';\nimport { IRpcTransport } from '@solana/rpc-transport/dist/types/transports/transport-types';\n\nimport { getRpcTransportWithRequestCoalescing } from './rpc-request-coalescer';\nimport { getSolanaRpcPayloadDeduplicationKey } from './rpc-request-deduplication';\n\n/**\n * Lowercasing header names makes it easier to override user-supplied headers.\n */\nfunction normalizeHeaders<T extends Record<string, string>>(\n    headers: T\n): { [K in keyof T & string as Lowercase<K>]: T[K] } {\n    const out: Record<string, string> = {};\n    for (const headerName in headers) {\n        out[headerName.toLowerCase()] = headers[headerName];\n    }\n    return out as { [K in keyof T & string as Lowercase<K>]: T[K] };\n}\n\nexport function createDefaultRpcTransport(config: Parameters<typeof createHttpTransport>[0]): IRpcTransport {\n    return getRpcTransportWithRequestCoalescing(\n        createHttpTransport({\n            ...config,\n            headers: {\n                ...(config.headers ? normalizeHeaders(config.headers) : undefined),\n                ...({\n                    // Keep these headers lowercase so they will override any user-supplied headers above.\n                    'solana-client': `js/${__VERSION__}` ?? 'UNKNOWN',\n                } as { [overrideHeader: string]: string }),\n            },\n        }),\n        getSolanaRpcPayloadDeduplicationKey\n    );\n}\n","import { IRpcTransport } from '@solana/rpc-transport/dist/types/transports/transport-types';\n\ntype CoalescedRequest = {\n    readonly abortController: AbortController;\n    numConsumers: number;\n    readonly responsePromise: Promise<unknown>;\n};\n\ntype GetDeduplicationKeyFn = (payload: unknown) => string | undefined;\n\nexport function getRpcTransportWithRequestCoalescing(\n    transport: IRpcTransport,\n    getDeduplicationKey: GetDeduplicationKeyFn\n): IRpcTransport {\n    let coalescedRequestsByDeduplicationKey: Record<string, CoalescedRequest> | undefined;\n    return async function makeCoalescedHttpRequest<TResponse>(\n        config: Parameters<IRpcTransport>[0]\n    ): Promise<TResponse> {\n        const { payload, signal } = config;\n        const deduplicationKey = getDeduplicationKey(payload);\n        if (deduplicationKey === undefined) {\n            return await transport(config);\n        }\n        if (!coalescedRequestsByDeduplicationKey) {\n            Promise.resolve().then(() => {\n                coalescedRequestsByDeduplicationKey = undefined;\n            });\n            coalescedRequestsByDeduplicationKey = {};\n        }\n        if (coalescedRequestsByDeduplicationKey[deduplicationKey] == null) {\n            const abortController = new AbortController();\n            coalescedRequestsByDeduplicationKey[deduplicationKey] = {\n                abortController,\n                numConsumers: 0,\n                responsePromise: transport<TResponse>({\n                    ...config,\n                    signal: abortController.signal,\n                }),\n            };\n        }\n        const coalescedRequest = coalescedRequestsByDeduplicationKey[deduplicationKey];\n        coalescedRequest.numConsumers++;\n        if (signal) {\n            const responsePromise = coalescedRequest.responsePromise as Promise<TResponse>;\n            return await new Promise<TResponse>((resolve, reject) => {\n                const handleAbort = (e: AbortSignalEventMap['abort']) => {\n                    signal.removeEventListener('abort', handleAbort);\n                    coalescedRequest.numConsumers -= 1;\n                    if (coalescedRequest.numConsumers === 0) {\n                        const abortController = coalescedRequest.abortController;\n                        abortController.abort();\n                    }\n                    const abortError = new DOMException((e.target as AbortSignal).reason, 'AbortError');\n                    reject(abortError);\n                };\n                signal.addEventListener('abort', handleAbort);\n                responsePromise.then(resolve).finally(() => {\n                    signal.removeEventListener('abort', handleAbort);\n                });\n            });\n        } else {\n            return (await coalescedRequest.responsePromise) as TResponse;\n        }\n    };\n}\n","// eslint-disable-next-line @typescript-eslint/ban-ts-comment\n// @ts-ignore\nimport fastStableStringify from 'fast-stable-stringify';\n\nexport function getSolanaRpcPayloadDeduplicationKey(payload: unknown): string | undefined {\n    if (payload == null || typeof payload !== 'object' || Array.isArray(payload)) {\n        return;\n    }\n    if ('jsonrpc' in payload && payload.jsonrpc === '2.0' && 'method' in payload && 'params' in payload) {\n        return fastStableStringify([payload.method, payload.params]);\n    }\n}\n"]}

package/dist/index.browser.js

@@ -0,0 +1,137 @@
+export * from '@solana/instructions';
+export * from '@solana/keys';
+import { createSolanaRpcApi } from '@solana/rpc-core';
+import { createJsonRpc, createHttpTransport } from '@solana/rpc-transport';
+import fastStableStringify from 'fast-stable-stringify';
+
+// src/index.ts
+
+// src/rpc-integer-overflow-error.ts
+var SolanaJsonRpcIntegerOverflowError = class extends Error {
+  constructor(methodName, keyPath, value) {
+    const argPosition = (typeof keyPath[0] === "number" ? keyPath[0] : parseInt(keyPath[0], 10)) + 1;
+    let ordinal = "";
+    const lastDigit = argPosition % 10;
+    const lastTwoDigits = argPosition % 100;
+    if (lastDigit == 1 && lastTwoDigits != 11) {
+      ordinal = argPosition + "st";
+    } else if (lastDigit == 2 && lastTwoDigits != 12) {
+      ordinal = argPosition + "nd";
+    } else if (lastDigit == 3 && lastTwoDigits != 13) {
+      ordinal = argPosition + "rd";
+    } else {
+      ordinal = argPosition + "th";
+    }
+    const path = keyPath.length > 1 ? keyPath.slice(1).map((pathPart) => typeof pathPart === "number" ? `[${pathPart}]` : pathPart).join(".") : null;
+    super(
+      `The ${ordinal} argument to the \`${methodName}\` RPC method${path ? ` at path \`${path}\`` : ""} was \`${value}\`. This number is unsafe for use with the Solana JSON-RPC because it exceeds \`Number.MAX_SAFE_INTEGER\`.`
+    );
+    this.keyPath = keyPath;
+    this.methodName = methodName;
+    this.value = value;
+  }
+  get name() {
+    return "SolanaJsonRpcIntegerOverflowError";
+  }
+};
+
+// src/rpc-default-config.ts
+var DEFAULT_RPC_CONFIG = {
+  onIntegerOverflow(methodName, keyPath, value) {
+    throw new SolanaJsonRpcIntegerOverflowError(methodName, keyPath, value);
+  }
+};
+
+// src/rpc.ts
+function createSolanaRpc(config) {
+  return createJsonRpc({
+    ...config,
+    api: createSolanaRpcApi(DEFAULT_RPC_CONFIG)
+  });
+}
+
+// src/rpc-request-coalescer.ts
+function getRpcTransportWithRequestCoalescing(transport, getDeduplicationKey) {
+  let coalescedRequestsByDeduplicationKey;
+  return async function makeCoalescedHttpRequest(config) {
+    const { payload, signal } = config;
+    const deduplicationKey = getDeduplicationKey(payload);
+    if (deduplicationKey === void 0) {
+      return await transport(config);
+    }
+    if (!coalescedRequestsByDeduplicationKey) {
+      Promise.resolve().then(() => {
+        coalescedRequestsByDeduplicationKey = void 0;
+      });
+      coalescedRequestsByDeduplicationKey = {};
+    }
+    if (coalescedRequestsByDeduplicationKey[deduplicationKey] == null) {
+      const abortController = new AbortController();
+      coalescedRequestsByDeduplicationKey[deduplicationKey] = {
+        abortController,
+        numConsumers: 0,
+        responsePromise: transport({
+          ...config,
+          signal: abortController.signal
+        })
+      };
+    }
+    const coalescedRequest = coalescedRequestsByDeduplicationKey[deduplicationKey];
+    coalescedRequest.numConsumers++;
+    if (signal) {
+      const responsePromise = coalescedRequest.responsePromise;
+      return await new Promise((resolve, reject) => {
+        const handleAbort = (e) => {
+          signal.removeEventListener("abort", handleAbort);
+          coalescedRequest.numConsumers -= 1;
+          if (coalescedRequest.numConsumers === 0) {
+            const abortController = coalescedRequest.abortController;
+            abortController.abort();
+          }
+          const abortError = new DOMException(e.target.reason, "AbortError");
+          reject(abortError);
+        };
+        signal.addEventListener("abort", handleAbort);
+        responsePromise.then(resolve).finally(() => {
+          signal.removeEventListener("abort", handleAbort);
+        });
+      });
+    } else {
+      return await coalescedRequest.responsePromise;
+    }
+  };
+}
+function getSolanaRpcPayloadDeduplicationKey(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([payload.method, payload.params]);
+  }
+}
+
+// src/rpc-transport.ts
+function normalizeHeaders(headers) {
+  const out = {};
+  for (const headerName in headers) {
+    out[headerName.toLowerCase()] = headers[headerName];
+  }
+  return out;
+}
+function createDefaultRpcTransport(config) {
+  return getRpcTransportWithRequestCoalescing(
+    createHttpTransport({
+      ...config,
+      headers: {
+        ...config.headers ? normalizeHeaders(config.headers) : void 0,
+        ...{
+          // Keep these headers lowercase so they will override any user-supplied headers above.
+          "solana-client": `js/${"2.0.0-development"}` ?? "UNKNOWN"
+        }
+      }
+    }),
+    getSolanaRpcPayloadDeduplicationKey
+  );
+}
+
+export { createDefaultRpcTransport, createSolanaRpc };

package/dist/index.browser.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts","../src/rpc.ts","../src/rpc-integer-overflow-error.ts","../src/rpc-default-config.ts","../src/rpc-transport.ts","../src/rpc-request-coalescer.ts","../src/rpc-request-deduplication.ts"],"names":[],"mappings":";AAAA,cAAc;AACd,cAAc;;;ACDd,SAAS,0BAA4C;AACrD,SAAS,qBAAqB;;;ACDvB,IAAM,oCAAN,cAAgD,MAAM;AAAA,EAIzD,YAAY,YAAoB,SAA8B,OAAe;AACzE,UAAM,eAAe,OAAO,QAAQ,CAAC,MAAM,WAAW,QAAQ,CAAC,IAAI,SAAS,QAAQ,CAAC,GAAG,EAAE,KAAK;AAC/F,QAAI,UAAU;AACd,UAAM,YAAY,cAAc;AAChC,UAAM,gBAAgB,cAAc;AACpC,QAAI,aAAa,KAAK,iBAAiB,IAAI;AACvC,gBAAU,cAAc;AAAA,IAC5B,WAAW,aAAa,KAAK,iBAAiB,IAAI;AAC9C,gBAAU,cAAc;AAAA,IAC5B,WAAW,aAAa,KAAK,iBAAiB,IAAI;AAC9C,gBAAU,cAAc;AAAA,IAC5B,OAAO;AACH,gBAAU,cAAc;AAAA,IAC5B;AACA,UAAM,OACF,QAAQ,SAAS,IACX,QACK,MAAM,CAAC,EACP,IAAI,cAAa,OAAO,aAAa,WAAW,IAAI,cAAc,QAAS,EAC3E,KAAK,GAAG,IACb;AACV;AAAA,MACI,OAAO,6BAA6B,0BAC7B,OAAO,cAAc,WAAW,YAAY;AAAA,IAGvD;AACA,SAAK,UAAU;AACf,SAAK,aAAa;AAClB,SAAK,QAAQ;AAAA,EACjB;AAAA,EACA,IAAI,OAAO;AACP,WAAO;AAAA,EACX;AACJ;;;AClCO,IAAM,qBAAwE;AAAA,EACjF,kBAAkB,YAAY,SAAS,OAAO;AAC1C,UAAM,IAAI,kCAAkC,YAAY,SAAS,KAAK;AAAA,EAC1E;AACJ;;;AFFO,SAAS,gBAAgB,QAAiF;AAC7G,SAAO,cAAgC;AAAA,IACnC,GAAG;AAAA,IACH,KAAK,mBAAmB,kBAAkB;AAAA,EAC9C,CAAC;AACL;;;AGXA,SAAS,2BAA2B;;;ACU7B,SAAS,qCACZ,WACA,qBACa;AACb,MAAI;AACJ,SAAO,eAAe,yBAClB,QACkB;AAClB,UAAM,EAAE,SAAS,OAAO,IAAI;AAC5B,UAAM,mBAAmB,oBAAoB,OAAO;AACpD,QAAI,qBAAqB,QAAW;AAChC,aAAO,MAAM,UAAU,MAAM;AAAA,IACjC;AACA,QAAI,CAAC,qCAAqC;AACtC,cAAQ,QAAQ,EAAE,KAAK,MAAM;AACzB,8CAAsC;AAAA,MAC1C,CAAC;AACD,4CAAsC,CAAC;AAAA,IAC3C;AACA,QAAI,oCAAoC,gBAAgB,KAAK,MAAM;AAC/D,YAAM,kBAAkB,IAAI,gBAAgB;AAC5C,0CAAoC,gBAAgB,IAAI;AAAA,QACpD;AAAA,QACA,cAAc;AAAA,QACd,iBAAiB,UAAqB;AAAA,UAClC,GAAG;AAAA,UACH,QAAQ,gBAAgB;AAAA,QAC5B,CAAC;AAAA,MACL;AAAA,IACJ;AACA,UAAM,mBAAmB,oCAAoC,gBAAgB;AAC7E,qBAAiB;AACjB,QAAI,QAAQ;AACR,YAAM,kBAAkB,iBAAiB;AACzC,aAAO,MAAM,IAAI,QAAmB,CAAC,SAAS,WAAW;AACrD,cAAM,cAAc,CAAC,MAAoC;AACrD,iBAAO,oBAAoB,SAAS,WAAW;AAC/C,2BAAiB,gBAAgB;AACjC,cAAI,iBAAiB,iBAAiB,GAAG;AACrC,kBAAM,kBAAkB,iBAAiB;AACzC,4BAAgB,MAAM;AAAA,UAC1B;AACA,gBAAM,aAAa,IAAI,aAAc,EAAE,OAAuB,QAAQ,YAAY;AAClF,iBAAO,UAAU;AAAA,QACrB;AACA,eAAO,iBAAiB,SAAS,WAAW;AAC5C,wBAAgB,KAAK,OAAO,EAAE,QAAQ,MAAM;AACxC,iBAAO,oBAAoB,SAAS,WAAW;AAAA,QACnD,CAAC;AAAA,MACL,CAAC;AAAA,IACL,OAAO;AACH,aAAQ,MAAM,iBAAiB;AAAA,IACnC;AAAA,EACJ;AACJ;;;AC9DA,OAAO,yBAAyB;AAEzB,SAAS,oCAAoC,SAAsC;AACtF,MAAI,WAAW,QAAQ,OAAO,YAAY,YAAY,MAAM,QAAQ,OAAO,GAAG;AAC1E;AAAA,EACJ;AACA,MAAI,aAAa,WAAW,QAAQ,YAAY,SAAS,YAAY,WAAW,YAAY,SAAS;AACjG,WAAO,oBAAoB,CAAC,QAAQ,QAAQ,QAAQ,MAAM,CAAC;AAAA,EAC/D;AACJ;;;AFFA,SAAS,iBACL,SACiD;AACjD,QAAM,MAA8B,CAAC;AACrC,aAAW,cAAc,SAAS;AAC9B,QAAI,WAAW,YAAY,CAAC,IAAI,QAAQ,UAAU;AAAA,EACtD;AACA,SAAO;AACX;AAEO,SAAS,0BAA0B,QAAkE;AACxG,SAAO;AAAA,IACH,oBAAoB;AAAA,MAChB,GAAG;AAAA,MACH,SAAS;AAAA,QACL,GAAI,OAAO,UAAU,iBAAiB,OAAO,OAAO,IAAI;AAAA,QACxD,GAAI;AAAA;AAAA,UAEA,iBAAiB,MAAM,yBAAiB;AAAA,QAC5C;AAAA,MACJ;AAAA,IACJ,CAAC;AAAA,IACD;AAAA,EACJ;AACJ","sourcesContent":["export * from '@solana/instructions';\nexport * from '@solana/keys';\nexport * from './rpc';\nexport * from './rpc-transport';\n","import { createSolanaRpcApi, SolanaRpcMethods } from '@solana/rpc-core';\nimport { createJsonRpc } from '@solana/rpc-transport';\nimport type { Rpc } from '@solana/rpc-transport/dist/types/json-rpc-types';\n\nimport { DEFAULT_RPC_CONFIG } from './rpc-default-config';\n\nexport function createSolanaRpc(config: Omit<Parameters<typeof createJsonRpc>[0], 'api'>): Rpc<SolanaRpcMethods> {\n    return createJsonRpc<SolanaRpcMethods>({\n        ...config,\n        api: createSolanaRpcApi(DEFAULT_RPC_CONFIG),\n    });\n}\n","export class SolanaJsonRpcIntegerOverflowError extends Error {\n    readonly methodName: string;\n    readonly keyPath: (number | string)[];\n    readonly value: bigint;\n    constructor(methodName: string, keyPath: (number | string)[], value: bigint) {\n        const argPosition = (typeof keyPath[0] === 'number' ? keyPath[0] : parseInt(keyPath[0], 10)) + 1;\n        let ordinal = '';\n        const lastDigit = argPosition % 10;\n        const lastTwoDigits = argPosition % 100;\n        if (lastDigit == 1 && lastTwoDigits != 11) {\n            ordinal = argPosition + 'st';\n        } else if (lastDigit == 2 && lastTwoDigits != 12) {\n            ordinal = argPosition + 'nd';\n        } else if (lastDigit == 3 && lastTwoDigits != 13) {\n            ordinal = argPosition + 'rd';\n        } else {\n            ordinal = argPosition + 'th';\n        }\n        const path =\n            keyPath.length > 1\n                ? keyPath\n                      .slice(1)\n                      .map(pathPart => (typeof pathPart === 'number' ? `[${pathPart}]` : pathPart))\n                      .join('.')\n                : null;\n        super(\n            `The ${ordinal} argument to the \\`${methodName}\\` RPC method` +\n                `${path ? ` at path \\`${path}\\`` : ''} was \\`${value}\\`. This number is ` +\n                'unsafe for use with the Solana JSON-RPC because it exceeds ' +\n                '`Number.MAX_SAFE_INTEGER`.'\n        );\n        this.keyPath = keyPath;\n        this.methodName = methodName;\n        this.value = value;\n    }\n    get name() {\n        return 'SolanaJsonRpcIntegerOverflowError';\n    }\n}\n","import { createSolanaRpcApi } from '@solana/rpc-core';\n\nimport { SolanaJsonRpcIntegerOverflowError } from './rpc-integer-overflow-error';\n\nexport const DEFAULT_RPC_CONFIG: Partial<Parameters<typeof createSolanaRpcApi>[0]> = {\n    onIntegerOverflow(methodName, keyPath, value) {\n        throw new SolanaJsonRpcIntegerOverflowError(methodName, keyPath, value);\n    },\n};\n","import { createHttpTransport } from '@solana/rpc-transport';\nimport { IRpcTransport } from '@solana/rpc-transport/dist/types/transports/transport-types';\n\nimport { getRpcTransportWithRequestCoalescing } from './rpc-request-coalescer';\nimport { getSolanaRpcPayloadDeduplicationKey } from './rpc-request-deduplication';\n\n/**\n * Lowercasing header names makes it easier to override user-supplied headers.\n */\nfunction normalizeHeaders<T extends Record<string, string>>(\n    headers: T\n): { [K in keyof T & string as Lowercase<K>]: T[K] } {\n    const out: Record<string, string> = {};\n    for (const headerName in headers) {\n        out[headerName.toLowerCase()] = headers[headerName];\n    }\n    return out as { [K in keyof T & string as Lowercase<K>]: T[K] };\n}\n\nexport function createDefaultRpcTransport(config: Parameters<typeof createHttpTransport>[0]): IRpcTransport {\n    return getRpcTransportWithRequestCoalescing(\n        createHttpTransport({\n            ...config,\n            headers: {\n                ...(config.headers ? normalizeHeaders(config.headers) : undefined),\n                ...({\n                    // Keep these headers lowercase so they will override any user-supplied headers above.\n                    'solana-client': `js/${__VERSION__}` ?? 'UNKNOWN',\n                } as { [overrideHeader: string]: string }),\n            },\n        }),\n        getSolanaRpcPayloadDeduplicationKey\n    );\n}\n","import { IRpcTransport } from '@solana/rpc-transport/dist/types/transports/transport-types';\n\ntype CoalescedRequest = {\n    readonly abortController: AbortController;\n    numConsumers: number;\n    readonly responsePromise: Promise<unknown>;\n};\n\ntype GetDeduplicationKeyFn = (payload: unknown) => string | undefined;\n\nexport function getRpcTransportWithRequestCoalescing(\n    transport: IRpcTransport,\n    getDeduplicationKey: GetDeduplicationKeyFn\n): IRpcTransport {\n    let coalescedRequestsByDeduplicationKey: Record<string, CoalescedRequest> | undefined;\n    return async function makeCoalescedHttpRequest<TResponse>(\n        config: Parameters<IRpcTransport>[0]\n    ): Promise<TResponse> {\n        const { payload, signal } = config;\n        const deduplicationKey = getDeduplicationKey(payload);\n        if (deduplicationKey === undefined) {\n            return await transport(config);\n        }\n        if (!coalescedRequestsByDeduplicationKey) {\n            Promise.resolve().then(() => {\n                coalescedRequestsByDeduplicationKey = undefined;\n            });\n            coalescedRequestsByDeduplicationKey = {};\n        }\n        if (coalescedRequestsByDeduplicationKey[deduplicationKey] == null) {\n            const abortController = new AbortController();\n            coalescedRequestsByDeduplicationKey[deduplicationKey] = {\n                abortController,\n                numConsumers: 0,\n                responsePromise: transport<TResponse>({\n                    ...config,\n                    signal: abortController.signal,\n                }),\n            };\n        }\n        const coalescedRequest = coalescedRequestsByDeduplicationKey[deduplicationKey];\n        coalescedRequest.numConsumers++;\n        if (signal) {\n            const responsePromise = coalescedRequest.responsePromise as Promise<TResponse>;\n            return await new Promise<TResponse>((resolve, reject) => {\n                const handleAbort = (e: AbortSignalEventMap['abort']) => {\n                    signal.removeEventListener('abort', handleAbort);\n                    coalescedRequest.numConsumers -= 1;\n                    if (coalescedRequest.numConsumers === 0) {\n                        const abortController = coalescedRequest.abortController;\n                        abortController.abort();\n                    }\n                    const abortError = new DOMException((e.target as AbortSignal).reason, 'AbortError');\n                    reject(abortError);\n                };\n                signal.addEventListener('abort', handleAbort);\n                responsePromise.then(resolve).finally(() => {\n                    signal.removeEventListener('abort', handleAbort);\n                });\n            });\n        } else {\n            return (await coalescedRequest.responsePromise) as TResponse;\n        }\n    };\n}\n","// eslint-disable-next-line @typescript-eslint/ban-ts-comment\n// @ts-ignore\nimport fastStableStringify from 'fast-stable-stringify';\n\nexport function getSolanaRpcPayloadDeduplicationKey(payload: unknown): string | undefined {\n    if (payload == null || typeof payload !== 'object' || Array.isArray(payload)) {\n        return;\n    }\n    if ('jsonrpc' in payload && payload.jsonrpc === '2.0' && 'method' in payload && 'params' in payload) {\n        return fastStableStringify([payload.method, payload.params]);\n    }\n}\n"]}