@solana/web3.js

[!NOTE] This branch tracks the v3 line of @solana/web3.js. It keeps the familiar class-based API, updates it for the latest RPC methods, and rebuilds the internals on Solana Kit.

Solana JavaScript SDK (v3)

Use this to interact with accounts and programs on the Solana network through the Solana JSON RPC API.

Installation

For use in Node.js or a web application

$ npm install @solana/web3.js@rc

$ pnpm add @solana/web3.js@rc

$ bun add @solana/web3.js@rc

$ yarn add @solana/web3.js@rc

For use in a browser, without a build system

<!-- Development (un-minified) -->
<script src="https://unpkg.com/@solana/web3.js@rc/lib/index.iife.js"></script>

<!-- Production (minified) -->
<script src="https://unpkg.com/@solana/web3.js@rc/lib/index.iife.min.js"></script>

The @rc tag always resolves to the latest release candidate. For production, pin browser bundles to an exact published version instead, and update the version when a newer v3 release is published.

Documentation and examples

• The Solana Cookbook has extensive task-based documentation using this library.
• For more detail on individual functions, see the latest API Documentation
• For applications upgrading to v3, see the web3.js v1 → v3 migration guide.

v3 Migration Assistance

This repository includes a reusable agent skill for upgrading applications from @solana/web3.js v1 to v3:

• Human-facing guide: docs/web3js-v1-to-v3-migration.md
• skills/web3js-v1-to-v3-migration/SKILL.md

You can install it locally from a checkout:

$ npx skills add ./skills/web3js-v1-to-v3-migration

Or install it directly from the repository:

$ npx skills add https://github.com/solana-foundation/solana-web3.js/tree/v3.x/skills/web3js-v1-to-v3-migration

Getting help

Have a question or a problem? Check the Solana Stack Exchange to see if anyone else is having the same one. If not, post a new question.

Include:

• 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

Compatibility

@solana/web3.js v3 publishes separate builds for Node.js, browsers, and React Native.

• Node.js: supported on Node 20.18.0 or newer. This matches the package engines field and is the runtime floor the project tests against.
• Browsers: supported in modern evergreen browsers with BigInt support. The distributed browser bundles target modern JavaScript engines; older browsers are not a compatibility target unless your application transpiles and polyfills this package itself.
• React Native: supported on runtimes with BigInt support, such as Hermes.
• Other runtimes: may work if they provide the required language features and web APIs, but they are not part of the supported compatibility contract.

If you are loading the IIFE bundle directly in a page, treat it as a modern-browser build rather than a legacy compatibility bundle.

Development environment setup

This repository is developed against Node.js 20.18.0 or newer and uses pnpm for local development.

To install dependencies:

$ pnpm install

Testing

Unit tests

To run the full suite of unit tests, execute the following in the root:

$ pnpm test:unit

Integration tests

Integration tests require a validator client running on your machine.

To install a test validator:

$ pnpm test:live-with-test-validator:setup

To start the test validator and run all of the integration tests in live mode:

$ pnpm test:live-with-test-validator

Other useful development commands:

• pnpm test:typecheck runs the TypeScript typechecker without emitting files.
• pnpm test:lint runs ESLint over src/ and test/.
• pnpm test:lint:fix applies autofixable ESLint changes.
• pnpm test:prettier checks formatting across the repository.
• pnpm test:prettier:fix rewrites files to match the configured Prettier style.
• pnpm dev rebuilds in watch mode while you are working locally.
• pnpm compile:js produces the distributable JavaScript bundles.
• pnpm compile:docs regenerates the API documentation.

Contributing

If you found a bug or would like to request a feature, please file an issue. If, based on the discussion on an issue you would like to offer a code change, please make a pull request. If neither of these describes what you would like to contribute, read the 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.

Similar packages

Other packages similar to @solana/web3.js

web3

web3.js is a collection of libraries that allow you to interact with a local or remote Ethereum node using HTTP, IPC, or WebSocket. It provides similar functionalities to @solana/web3.js but is designed for the Ethereum blockchain.

ethers

ethers.js is a library for interacting with the Ethereum blockchain and its ecosystem. It provides a more lightweight and modular approach compared to web3.js and includes functionalities for managing accounts, sending transactions, and interacting with smart contracts.

near-api-js

near-api-js is a JavaScript library for interacting with the NEAR blockchain. It provides similar functionalities to @solana/web3.js, including account management, transaction handling, and smart contract interaction, but is designed specifically for the NEAR blockchain.