@mcintyre94/web3.js-experimental

v2.0.0-experimental.f9b30bb

Published

a year ago

Solana Javascript API

Downloads

0High
0Medium
0Low

mcintyre94

blockchain solana web3

Solana JavaScript SDK Technology Preview

If you build JavaScript applications on Solana, it’s likely you’ve worked with @solana/web3.js or a library powered by it. With 400K+ weekly downloads on npm, it’s the most-used library in the ecosystem for building program clients, web applications, block explorers, and more.

Here’s an example of a common code snippet from @solana/web3.js:

const connection = new Connection('https://api.mainnet-beta.solana.com');
const instruction = SystemProgram.transfer({ fromPubkey, toPubkey, lamports });
const transaction = new Transaction().add(instruction);
await sendAndConfirmTransaction(connection, transaction, [payer]);

In response to your feedback, we began a process of modernizing the library to prepare for the next generation of Solana applications. A Technology Preview of the new web3.js is now available for you to evaluate.

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.

Installation

For use in Node.js or a web application

npm install --save @solana/web3.js@ts

For use in a browser, without a build system

<!-- Development (debug mode, unminified) -->
<script src="https://unpkg.com/@solana/web3.js@ts/dist/index.development.js"></script>

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

What follows is an overview of why the library was re-engineered, what changes have been introduced, and how the JavaScript landscape might look across Solana in the near future.

Community feedback in action

We’re grateful to all of you for communicating the pain points you’ve experienced when developing Solana applications with web3.js. We’ve heard you loud and clear.

Tree-shaking

The object-oriented design of the web3.js (1.x) API prevents optimizing compilers from being able to “tree-shake” unused code from your production builds. No matter how much of the web3.js API you use in your application, you have to package all of it.

Opinionated

Depending on your use case and your tolerance for certain application behaviours, you may be willing to configure your application to make a different set of tradeoffs than another developer. The default tradeoffs that we codify into the web3.js API on the other hand have to work for as large a population as possible, in the common case.

The inability to customize web3.js has been a source of frustration for some:

The Mango team wanted to customize the transaction confirmation strategy, but all of that functionality is hidden away behind confirmTransaction – a static method of Connection. Here’s the code for confirmTransaction on GitHub.
Solana developer ‘mPaella’ wanted us to add a feature in the RPC that would failover to a set of backup URLs in case the primary one failed.
Solana developer ‘epicfaace’ wanted first-class support for automatic time-windowed batching in the RPC transport. Here’s their pull request.
Multiple folks have expressed the need for custom retry logic for failed requests or transactions. Here’s a pull request from ‘dafyddd’ and another from ‘abrkn’ attempting to modify retry logic to suit their individual use cases.

Lagging Behind Modern JavaScript

The advance of modern JavaScript features presents an opportunity to developers of crypto applcations, such as the ability to use native Ed25519 keys and to express large values as native bigint.

The Web Incubator Community Group has advocated for the addition of Ed25519 support to the Web Crypto API, and support has already landed in most modern JavaScript runtimes.

Support for bigint values has also become commonplace. The older number primitive in JavaScript has a maximum value of 2^53 - 1, whereas Rust’s u64 can represent values up to 2^64.

Class-Based Architecture

The object oriented, class-based architecture of the legacy library causes unnecessary bundle bloat. Your application has no choice but to bundle all of the functionality and dependencies of a class no matter how many methods you actually use at runtime.

Class-based architecture also presents unique risks to developers who trigger the dual-package hazard. This describes a situation you can find yourself in if you build for both CommonJS and ES modules. The situation arises when two “copies” of the same class are present in the dependency tree, causing checks like instanceof to fail, which introduces aggravating and difficult to debug problems.

The New web3.js

Enter web3.js 2.0. The new API aims to deliver a re-imagined experience of building Solana applications, a high level of performance by default, and all with a minimum of code. From the ability to customize the behaviour of the library through composition, to the joy of being able to catch common errors during build time before they make it to production, we hope that you enjoy building with it as much as we’ve enjoyed creating it.

Features

The new (2.0) version of @solana/web3.js aims to address shortcomings in the legacy library first, then goes even further .

Tree-Shaking

The 2.0 library is tree-shakable, and that tree-shakeability is enforced in the CI. Anything you don’t use from web3.js 2.0 can now be discarded from your bundle by an optimizing compiler.

The new library itself is comprised of several smaller, modular packages under the @solana organization, including:

@solana/rpc-transport: For building and managing RPC transports
@solana/rpc-core: The type-spec of the Solana JSON RPC
@solana/transactions: For building and transforming Solana transaction objects
@solana/codecs-*: For building data (de)serializers

Developers can use the default configurations within the library itself (@solana/web3.js:2.0) or import any number of the modular packages for additional customization.

Minimally Opinionated

The individual modules that make up web3.js are assembled in a default configuration reminiscent of the legacy library as part of the npm package @solana/web3.js, but those who wish to assemble them in different configurations may do so.

Each package uses types and generics liberally, allowing you to inject new functionality, to make extensions to each API via composition and supertypes, and to encourage you to create higher-level opinionated abstractions of your own.

In fact, we expect you to do so, and to open source some of those for use by others with similar needs.

Modern JavaScript

The new API is built for compatibility with platform APIs to reduce our dependencies on userspace implementations that introduce supply chain risk and bundle bloat to your applications.

One such example is the integration of Ed25519 CryptoKeys – native platform primitives for managing cryptographic keys and signatures.

Read more about the Web Crypto API here:

web3.js 2.0 also further eliminates dependencies such as BN.js by implementing large integers with bigint.

Interface-Based Architecture

The new library employs interfaces and types for just about everything, expressing most objects as data. The dual-package hazard is no longer a threat to your development; any objects compatible with an interface are usable with functions that specify that interface.

This interface-based approach also allows for easy customization; for extending the library’s functionality or building on top of it.

Statistics

Consider these statistical comparisons between web3.js 2.0 and the legacy 1.x.

| | 1.x (Legacy) | 2.0 | +/- % | | --- | --- | --- | --- | | Total minified size of library | 90 KB | 33 KB | -63% | | Total minified size of library (when runtime supports Ed25519) | 90 KB | 17 KB | -81% | | Bundled size of a web application that only executes a transfer of lamports | 67 KB | 4.5 KB | -93% | | Bundled size of a web application that only executes a transfer of lamports (when runtime supports Ed25519) | 67 KB | 4.5 KB | -93% | | Bundled size of a worker that signs and sends a transaction | 5.4 MB | 1.7 MB | -68% | | Performance of key generation, signing, and verifying signatures (Brave with Experimental API flag) | 700 ops/s | 7000 ops/s | +900% | | First-load size for Solana Explorer | 311 KB | 228 KB | -26% |

The re-engineered library achieves these speedups and reductions in bundle size in large part through use of modern JavaScript APIs.

To validate our work, we replaced the legacy 1.x library with the new 2.0 library on the homepage of the Solana Explorer. Total first-load bundle size dropped by 26% without removing a single feature. Here’s an X thread by Callum McIntyre if you would like to dig deeper.

A tour of the web3.js 2.0 API

Here’s an overview of how to use the new library to interact with the RPC, configure network transports, work with Ed25519 keys, and to serialize data.

RPC

web3.js 2.0 ships with an implementation of the JSON RPC specification and a type spec for the Solana JSON RPC.

Initializing a Default RPC API

Here’s an example of creating the default API for interacting with the Solana JSON RPC:

import { createSolanaRpc, createDefaultRpcTransport } from '@solana/web3.js';

// Create an HTTP transport
const transport = createDefaultRpcTransport({ url: 'http://127.0.0.1:8899' });

// Create an RPC client
const rpc = createSolanaRpc({ transport });
//     ^ RpcMethods<SolanaRpcMethods>

// Send a request
const slot = await rpc.getSlot().send();

The function createSolanaRpc(..) accepts a transport to some endpoint that implements JSON RPC and provides all of the capabilities specified by the Solana JSON RPC HTTP Methods.

Aborting Requests

RPC requests are now abortable with modern AbortControllers. The send(..) method on any PendingRpcRequest<..> allows an optional abortSignal?: AbortSignal argument.

Here’s an example of a custom AbortController used to abort a subscription:

import { createSolanaRpcSubscriptions, createDefaultRpcSubscriptionsTransport } from '@solana/web3.js';

const transport = createDefaultRpcSubscriptionsTransport({ url: 'ws://127.0.0.1:8900' });
const rpcSubscriptions = createSolanaRpcSubscriptions({ transport });

// Create a new AbortController
const abortController = new AbortController();

// Subscribe for slot notifications
const slotNotifications = await rpcSubscriptions
    .slotNotifications()
    .subscribe({ abortSignal: abortController.signal });

// Set a timer for 5 seconds, then abort the controller
setTimeout(() => { abortController.abort(); }, 5000);

// Log slot notifications
for await (const notif of slotNotifications) {
  console.log('Slot notification', notif);
}

console.log('Done.');

Read more about AbortController at the following links:

Scoping the RPC API

The new library is comprised of many smaller modular libraries. The packages responsible for managing communication with an RPC are @solana/rpc-transport and @solana/rpc-core.

The @solana/rpc-transport library is responsible for creating transports to an RPC using some specified API – such as the Solana JSON RPC HTTP API, while @solana/rpc-core provides the actual Solana JSON RPC API (a specification of each of its supported methods).

Here’s an example of using @solana/rpc-transport and @solana/rpc-core to create an RPC transport with the Solana API (note: this is the manual implementation of the code snippet above):

import { createSolanaRpcApi, SolanaRpcMethods } from '@solana/rpc-core';
import { createHttpTransport, createJsonRpc } from '@solana/rpc-transport';

const api = createSolanaRpcApi();

const transport = createHttpTransport({ url: 'http://127.0.0.1:8899' });

const rpc = createJsonRpc<SolanaRpcMethods>({ api, transport });
//     ^ RpcMethods<SolanaRpcMethods>

If you want to, you can also reduce the scope of the API’s type-spec so you are left only with the types you need. Keep in mind types don’t affect bundle size, but you may choose to scope the type-spec for a variety of reasons, including reducing TypeScript noise.

import { createSolanaRpcApi } from '@solana/rpc-core';
import type { GetAccountInfoApi } from '@solana/rpc-core/dist/types/rpc-methods/getAccountInfo';
import { createHttpTransport, createJsonRpc } from '@solana/rpc-transport';

const api = createSolanaRpcApi();

const transport = createHttpTransport({ url: 'http://127.0.0.1:8899' });

const getAccountInfoRpc = createJsonRpc<GetAccountInfoApi>({ api, transport });
//    ^ RpcMethods<GetAccountInfoApi>

Creating a Custom RPC API

The new library’s RPC specification supports an infinite number of JSON-RPC methods with zero increase in bundle size.

This means the library can support future additions to the official Solana JSON RPC, or custom RPC methods defined by some development team – for example QuickNode or Helius.

Here’s an example of how a developer at QuickNode might build a custom RPC type-spec for their in-house RPC methods:

// Define the method's response payload
type NftCollectionDetailsApiResponse = Readonly<{
    address: string;
    circulatingSupply: number;
    description: string;
    erc721: boolean;
    erc1155: boolean;
    genesisBlock: string;
    genesisTransaction: string;
    name: string;
    totalSupply: number;
}>;

// Set up an interface for the request method
interface NftCollectionDetailsApi {
    // Define the method's name, parameters and response type
    qn_fetchNFTCollectionDetails(args: {
        contracts: string[],
    }): NftCollectionDetailsApiResponse;
}

// Export the type spec for downstream users
export type QuickNodeRpcMethods = NftCollectionDetailsApi;

Here’s how a developer might use it:

import { createHttpTransport, createJsonRpc, createJsonRpcApi } from '@solana/rpc-transport';

// Create the custom API
const api = createJsonRpcApi<QuickNodeRpcMethods>();

// Set up an HTTP transport
const transport = createHttpTransport({ url: 'http://127.0.0.1:8899' });

// Create the RPC client
const quickNodeRpc = createJsonRpc<QuickNodeRpcMethods>({ api, transport });
//    ^ RpcMethods<QuickNodeRpcMethods>

As long as a particular JSON RPC method adheres to the official JSON RPC specification, it will be supported by web3.js 2.0.

Transports

Using the @solana/rpc-transport package, developers can create custom RPC transports. With this library, one can implement highly specialized functionality for leveraging multiple transports, attempting/handling retries, and more.

Round Robin

Here’s an example of how someone might implement a “round robin” approach to leveraging multiple RPC transports within their application:

import { createSolanaRpcApi } from '@solana/rpc-core';
import { createJsonRpc } from '@solana/rpc-transport';
import { IRpcTransport } from '@solana/rpc-transport/dist/types/transports/transport-types';
import { createDefaultRpcTransport } from '@solana/web3.js';

// Create a transport for each RPC server
const transports = [
    createDefaultRpcTransport({ url: 'https://mainnet-beta.my-server-1.com' }),
    createDefaultRpcTransport({ url: 'https://mainnet-beta.my-server-2.com' }),
    createDefaultRpcTransport({ url: 'https://mainnet-beta.my-server-3.com' }),
];

// Set up the round robin factory
let nextTransport = 0;
async function roundRobinTransport<TResponse>(...args: Parameters<IRpcTransport>): Promise<TResponse> {
    const transport = transports[nextTransport];
    nextTransport = (nextTransport + 1) % transports.length;
    return await transport(...args);
}

// Create the RPC client
const rpc = createJsonRpc({
    api: createSolanaRpcApi(),
    transport: roundRobinTransport,
});

Sharding

Another example of a possible customization for RPC transports is sharding. Here’s an example:

// TODO: Your turn; send us a pull request with an example.

Retry Logic

The transport library can also be used to implement custom retry logic on any request:

import { createDefaultRpcTransport } from "@solana/web3.js";
import { IRpcTransport } from "@solana/rpc-transport/dist/types/transports/transport-types";
import { createJsonRpc } from "@solana/rpc-transport";
import { createSolanaRpcApi } from "@solana/rpc-core";

// Set the maximum number of attempts to retry a request
const MAX_ATTEMPTS = 4;

// Create the default transport
const defaultTransport = createDefaultRpcTransport({ url: 'https://mainnet-beta.my-server-1.com' });

// Sleep function to wait for a given number of milliseconds
function sleep(ms: number): Promise<void> {
  return new Promise((resolve) => setTimeout(resolve, ms));
}

// Calculate the delay for a given attempt
function calculateRetryDelay(attempt: number): number {
  // Exponential backoff with a maximum of 1.5 seconds
  return Math.min(100 * Math.pow(2, attempt), 1500);
}

// A retrying transport that will retry up to MAX_ATTEMPTS times before failing
async function retryingTransport<TResponse>(...args: Parameters<IRpcTransport>): Promise<TResponse> {
  let requestError;
  for (let attempts = 0; attempts < MAX_ATTEMPTS; attempts++) {
    try {
      return await defaultTransport(...args);
    } catch (err) {
      requestError = err;
      // Only sleep if we have more attempts remaining
      if (attempts < MAX_ATTEMPTS - 1) {
        const retryDelay = calculateRetryDelay(attempts);
        await sleep(retryDelay);
      }
    }
  }
  throw requestError;
}

// Create the RPC client
const rpc = createJsonRpc({
  api: createSolanaRpcApi(),
  transport: retryingTransport,
});

Failover

Support for handling failover can be implemented as a first-class citizen in your application using the new transport library. Here’s an example of some failover logic integrated into a transport:

// TODO: Your turn; send us a pull request with an example.

Fanning Out

Perhaps your application needs to make a large number of requests, or needs to fan request for different methods out to different servers. Here’s an example of an implementation that does the latter:

import { createSolanaRpcApi } from '@solana/rpc-core';
import { createJsonRpc } from '@solana/rpc-transport';
import { IRpcTransport } from '@solana/rpc-transport/dist/types/transports/transport-types';
import { createDefaultRpcTransport } from '@solana/web3.js';

// Create multiple transports
const transportA = createDefaultRpcTransport({ url: 'https://mainnet-beta.my-server-1.com' }));
const transportB = createDefaultRpcTransport({ url: 'https://mainnet-beta.my-server-2.com' }));
const transportC = createDefaultRpcTransport({ url: 'https://mainnet-beta.my-server-3.com' }));
const transportD = createDefaultRpcTransport({ url: 'https://mainnet-beta.my-server-4.com' }));

// Function to determine which shard to use based on the request method
function selectShard(method: string): IRpcTransport {
    switch (method) {
        case 'getAccountInfo':
        case 'getBalance':
            return transportA;
        case 'getTransaction':
        case 'getRecentBlockhash':
            return transportB;
        case 'sendTransaction':
            return transportC;
        default:
            return transportD;
    }
}

const rpc = createJsonRpc({
    api: createSolanaRpcApi(),
    transport: async (...args: Parameters<IRpcTransport>): Promise<any> => {
        const payload = args[0].payload as { method: string };
        const selectedTransport = selectShard(payload.method);
        return await selectedTransport(...args);
    },
});

Subscriptions

Subscriptions in the legacy library do not allow custom retry logic, and do not give you the opportunity to recover from having potentially missed messages. The new version does away with silent retries, surfaces transport errors to your application, and gives you the opportunity to recover from gap events.

Async Iterator

The new subscriptions API vends subscription notifications as an AsyncIterator. The AsyncIterator conforms to the async iterator protocol, which allows developers to consume messages using a for await...of loop.

Here’s an example of working with a subscription in the new library:

import { address, createSolanaRpcSubscriptions, createDefaultRpcSubscriptionsTransport } from '@solana/web3.js';

// Create the subscriptions transport
const transport = createDefaultRpcSubscriptionsTransport({ url: 'ws://127.0.0.1:8900' });

// Create the RPC client
const rpc = createSolanaRpcSubscriptions({ transport });

// Set up an abort controller
const abortController = new AbortController();

// Subscribe to account notifications
const accountNotifications = await rpc
    .accountNotifications(address('AxZfZWeqztBCL37Mkjkd4b8Hf6J13WCcfozrBY6vZzv3'), { commitment: 'confirmed' })
    .subscribe({ abortSignal: abortController.signal });

// Consume messages
try {
    for await (const notification of accountNotifications) {
        console.log('New balance', notification.value.lamports);
    }
    // Reaching this line means the subscription was aborted (ie. unsubscribed).
} catch (e) {
    // The subscription went down.
    // Retry it and then recover from potentially having missed
    // a balance update, here (eg. by making a `getBalance()` call)
} finally {
    // Whether the subscription failed or was aborted, you can run cleanup code here.
}

The new subscriptions API also offers a separate rpc creator if you would like to use Solana’s unstable subscription methods.

import { createSolanaRpcSubscriptions_UNSTABLE, createDefaultRpcSubscriptionsTransport } from '@solana/web3.js';

const transport = createDefaultRpcSubscriptionsTransport({ url: 'ws://127.0.0.1:8900' });

// For unstable methods, explicitly request them in the type spec
const unstableRpc = createSolanaRpcSubscriptions_UNSTABLE({ transport });
// ^ RpcSubscriptionMethods<SolanaRpcSubscriptions & SolanaRpcSubscriptionsUnstable>

You can read more about AsyncIterator at the following links:

Cancelling Subscriptions

Similar to the AbortSignal logic in the HTTP methods provided by @solana/rpc-core, applications can terminate active subscriptions using an AbortController. In fact, this parameter is required for subscriptions to encourage you to cleanup subscriptions that your application no longer needs.

Consider this example of cancelling a subscription using an AbortController:

// Subscribe to account notifications
const accountNotifications = await rpc
    .accountNotifications(address('AxZfZWeqztBCL37Mkjkd4b8Hf6J13WCcfozrBY6vZzv3'), { commitment: 'confirmed' })
    .subscribe({ abortSignal });

// Consume messages
let previousOwner = null;
for await (const notification of accountNotifications) {
    const { value: { owner } } = notification;
    // Check the owner to see if it has changed
    if (previousOwner && owner !== previousOwner) {
        // If so, abort the subscription
        abortController.abort();
    } else {
        console.log(notification);
    }
    previousOwner = owner;
}

Message Gap Recovery

One of the most crucial aspects of any subscription API is managing potential missed messages. Missing messages, such as account state updates, could be catastrophic for an application. That’s why the new library provides native support for recovering missed messages using the AsyncIterator.

When a connection fails unexpectedly, any messages you miss while disconnected can result in your UI falling behind or becoming corrupt. Because subscription failure is now made explicit in the new API, you can implement ‘catch up’ logic after re-estabilshing the subscription.

Here’s an example of such logic:

try {
    for await (const notif of accountNotifications) {
        updateAccountBalance(notif.lamports);
    }
} catch(e) {
    // The subscription failed.
    // First, reestablish the subscription.
    await setupAccountBalanceSubscription(address);
    // Then make a one-shot request to 'catch up' on any missed balance changes.
    const { value: lamports } = await rpc.getBalance(address).send();
    updateAccountBalance(lamports);
}

Keys

The new library takes a brand-new approach to Solana key pairs and addresses, which will feel quite different from the classes PublicKey and Keypair from version 1.x.

Web Crypto API

All key operations now use the native Ed25519 implementation in JavaScript’s Web Crypto API.

The API itself is designed to be a more reliably secure way to manage highly sensitive secret key information, but developers should still use extreme caution when dealing with secret key bytes in their applications.

One thing to note is that many operations from Web Crypto – such as importing, generating, signing, and verifying are now asynchronous.

Here’s an example of generating a CryptoKeyPair using the Web Crypto API and signing a message:

import { generateKeyPair, signBytes, verifySignature } from '@solana/web3.js';

const keyPair: CryptoKeyPair = await generateKeyPair();

const message = new Uint8Array(8).fill(0);

const signedMessage = await signBytes(keyPair.privateKey, message);
//    ^ Signature

const verified = await verifySignature(keyPair.publicKey, signedMessage, message);

Web Crypto Polyfill

Wherever Ed25519 is not supported, we offer a polyfill for Web Crypto’s Ed25519 API.

This polyfill can be found at @solana/webcrypto-ed25519-polyfill and mimics the functionality of the Web Crypto API for Ed25519 key pairs using the same userspace implementation we used in web3.js 1.x. It does not polyfill other algorithms.

Determine if your target runtime supports Ed25519, and install the polyfill if it does not:

import '@solana/webcrypto-ed25519-polyfill';
import { generateKeyPair, signBytes, verifySignature } from '@solana/web3.js';

const keyPair: CryptoKeyPair = await generateKeyPair();

/* Remaining logic */

You can see where Ed25519 is currently supported in this GitHub issue on the Web Crypto repository. Consider sniffing the user-agent when deciding whether or not to deliver the polyfill to browsers.

Operations on CryptoKey objects using the Web Crypto API or the polyfill are mostly handled by the @solana/keys package.

String Addresses

All addresses are now JavaScript strings. They are represented by the opaque type Address, which describes exactly what a Solana address actually is.

Consequently, that means no more PublicKey.

Here’s what they look like in development:

import { Address, address, getAddressFromPublicKey, generateKeyPair } from '@solana/web3.js';

// Coerce a string to an `Address`
const myOtherAddress = address('AxZfZWeqztBCL37Mkjkd4b8Hf6J13WCcfozrBY6vZzv3');

// Typecast it instead
const myAddress =
    'AxZfZWeqztBCL37Mkjkd4b8Hf6J13WCcfozrBY6vZzv3' as Address<'AxZfZWeqztBCL37Mkjkd4b8Hf6J13WCcfozrBY6vZzv3'>;

// From CryptoKey
const keyPair = await generateKeyPair();
const myPublicKeyAsAddress = await getAddressFromPublicKey(keyPair.publicKey);

Some tooling for working with base58-encoded addresses can be found in the @solana/addresses package.

Transactions

Just like many other familiar aspects of the 1.0 library, transactions have received a makeover as well.

For starters, all transactions are now version-aware, so there’s no longer a need to juggle two different types of transactions (Transaction vs. VersionedTransaction).

Address lookups are now completely described inside transaction instructions, so you don’t have to materialize addressTableLookups from the transaction object anymore.

Here’s a simple example of creating a transaction – notice how the type of the transaction is refined at each step of the process:

import {
    address,
    createTransaction,
    setTransactionFeePayer,
    setTransactionLifetimeUsingBlockhash,
    Blockhash,
} from '@solana/web3.js';

const recentBlockhash = {
    blockhash: '4uhcVJyU9pJkvQyS88uRDiswHXSCkY3zQawwpjk2NsNY' as Blockhash,
    lastValidBlockHeight: 196055492n,
};
const feePayer = address('AxZfZWeqztBCL37Mkjkd4b8Hf6J13WCcfozrBY6vZzv3');

// Create a new transaction (legacy)
const transactionLegacy = createTransaction({ version: 'legacy' });
			// ^ LegacyTransaction

const transactionWithFeePayerLegacy = setTransactionFeePayer(feePayer, transactionLegacy);
			// ^ LegacyTransaction & ITransactionWithFeePayer

const transactionWithFeePayerAndLifetimeLegacy = setTransactionLifetimeUsingBlockhash(
    recentBlockhash,
    transactionWithFeePayerLegacy
);
			// ^ LegacyTransaction & ITransactionWithFeePayer & ITransactionWithBlockhash

// Create a new transaction (v0)
const transactionV0 = createTransaction({ version: 0 });
			// ^ V0Transaction

// Set the fee payer
const transactionWithFeePayerV0 = setTransactionFeePayer(feePayer, transactionV0);
			// ^ V0Transaction & ITransactionWithFeePayer

const transactionWithFeePayerAndLifetimeV0 = setTransactionLifetimeUsingBlockhash(
    recentBlockhash,
    transactionWithFeePayerV0
);
			// ^ V0Transaction & ITransactionWithFeePayer & ITransactionWithBlockhash

As you can see, each time a transaction is modified, the type reflects the current state. If you add a fee payer, you’ll get a type representing a transaction with a fee payer, and so on.

Additionally, transaction-modifying methods such as setTransactionFeePayer(..) and setTransactionLifetimeUsingBlockhash(..) will strip a transaction of its signatures, since those signatures would no longer match the modified transaction message.

import {
    address,
    createTransaction,
    generateKeyPair,
    setTransactionFeePayer,
    setTransactionLifetimeUsingBlockhash,
    signTransaction,
    Blockhash,
} from '@solana/web3.js';

const recentBlockhash = {
    blockhash: '4uhcVJyU9pJkvQyS88uRDiswHXSCkY3zQawwpjk2NsNY' as Blockhash,
    lastValidBlockHeight: 196055492n,
};
const feePayer = address('AxZfZWeqztBCL37Mkjkd4b8Hf6J13WCcfozrBY6vZzv3');
const signer = await generateKeyPair();

const transaction = createTransaction({ version: 'legacy' });
const transactionWithFeePayer = setTransactionFeePayer(feePayer, transaction);
const transactionWithFeePayerAndLifetime = setTransactionLifetimeUsingBlockhash(
    recentBlockhash,
    transactionWithFeePayer
);
const transactionSignedWithFeePayerAndLifetime = await signTransaction(
    [signer],
    transactionWithFeePayerAndLifetime
);
			// ^ LegacyTransaction & ITransactionWithFeePayer & ITransactionWithBlockhash & ITransactionWithSignatures

// Setting the lifetime again will remove the signatures from the object
const transactionSignaturesStripped = setTransactionLifetimeUsingBlockhash(
    recentBlockhash,
    transactionSignedWithFeePayerAndLifetime,
);
			// ^ LegacyTransaction & ITransactionWithFeePayer & ITransactionWithBlockhash

The signTransaction(..) function will raise a type error if your unsigned transaction is not already equipped with a fee payer and a lifetime.

const feePayer = address('AxZfZWeqztBCL37Mkjkd4b8Hf6J13WCcfozrBY6vZzv3');
const signer = await generateKeyPair();

const transaction = createTransaction({ version: 'legacy' });
const transactionWithFeePayer = setTransactionFeePayer(feePayer, transaction);

// Attempting to sign the transaction without a lifetime will throw a type error
const transactionSignedWithFeePayer = await signTransaction([signer], transactionWithFeePayer);
				// => "Property 'lifetimeConstraint' is missing in type"

Transaction objects are also frozen by these functions to prevent transactions from being mutated in place by functions you pass them to.

Building transactions in this manner might feel different to what you’re used to. Also, we certainly wouldn’t want you to have to bind transformed transactions to a new variable at each step, so we have released a functional programming library dubbed @solana/functional that lets you build transactions in pipelines. Here’s how it can be used:

import { pipe } from '@solana/functional';
import {
    address,
    Blockhash,
    createTransaction,
    setTransactionFeePayer,
    setTransactionLifetimeUsingBlockhash,
} from '@solana/web3.js';

// Use `pipe(..)` to create a pipeline of transaction transform operations
const transaction = pipe(
    createTransaction({ version: 0 }),
    tx => setTransactionFeePayer(feePayer, tx),
    tx => setTransactionLifetimeUsingBlockhash(recentBlockhash, tx)
);

Note that pipe(..) is completely decoupled from transactions, so it can be used to pipeline any compatible transforms.

Codecs

We have taken steps to make it easier to write data (de)serializers, especially as they pertain to Rust datatypes and byte buffers.

Solana’s codecs libraries are broken up into modular components so you only need to import the ones you need. They are:

@solana/codecs-core: The core codecs library for working with codecs serializers and creating custom ones
@solana/codecs-numbers: Used for serialization of numbers (little-endian and big-endian bytes, etc.)
@solana/codecs-strings: Used for serialization of strings
@solana/codecs-data-structures: Codecs and serializers for structs
@solana/options: Designed to build codecs and serializers for types that mimic Rust’s enums, which can include embedded data within their variants such as values, tuples, and structs

Here’s an example of encoding and decoding a custom struct with some strings and numbers:

import { getStructCodec } from "@solana/codecs-data-structures";
import { getU64Codec, getU8Codec } from "@solana/codecs-numbers";
import { getStringCodec } from "@solana/codecs-strings";

// Equivalent in Rust:
// struct {
//     amount: u64,
//     decimals: u8,
//     name: String,
// }
const structCodec = getStructCodec([
  ["amount", getU64Codec()],
  ["decimals", getU8Codec()],
  ["name", getStringCodec()],
]);

const myToken = {
  amount: 1000000000000000n, // `bigint` or `number` is supported
  decimals: 2,
  name: "My Token",
};

const myEncodedToken: Uint8Array = structCodec.encode(myToken);
const myDecodedToken = structCodec.decode(myEncodedToken)[0];

myDecodedToken satisfies {
  amount: bigint;
  decimals: number;
  name: string;
}

You may only need to encode or decode data, but not both. Importing one or the other allows your optimizing compiler to tree-shake the other implementation away:

import { Codec, combineCodec, Decoder, Encoder } from "@solana/codecs-core";
import { getStructDecoder, getStructEncoder } from "@solana/codecs-data-structures";
import { getU8Decoder, getU8Encoder, getU64Decoder, getU64Encoder } from "@solana/codecs-numbers";
import { getStringDecoder, getStringEncoder } from "@solana/codecs-strings";

export type MyToken = {
  amount: bigint,
  decimals: number,
  name: string,
}

export type MyTokenArgs = {
  amount: number | bigint,
  decimals: number,
  name: string,
}

export const getMyTokenEncoder = (): Encoder<MyTokenArgs> => getStructEncoder([
  ["amount", getU64Encoder()],
  ["decimals", getU8Encoder()],
  ["name", getStringEncoder()],
]);

export const getMyTokenDecoder = (): Decoder<MyToken> => getStructDecoder([
  ["amount", getU64Decoder()],
  ["decimals", getU8Decoder()],
  ["name", getStringDecoder()],
]);

export const getMyTokenCodec = (): Codec<MyTokenArgs, MyToken> => combineCodec(
  getMyTokenEncoder(),
  getMyTokenDecoder()
);

See more in the different packages’ README files on GitHub.

Type-Safety

The new library makes use of some advanced TypeScript features, including generic types, conditional types, Parameters<..>, ReturnType<..> and more.

We’ve described the RPC API in detail so that TypeScript can determine the exact type of the result you will receive from the server given a particular input. Change the type of the input, and you will see the return type reflect that change.

RPC Types

The RPC methods – both HTTP and subscriptions – are built with multiple overloads and conditional types. The expected HTTP response payload or subscription message format will be reflected in the return type of the function you’re working with when you provide the inputs in your code.

Here’s an example of this in action:

// Provide one set of parameters, get a certain type
// These parameters resolve to return type:
// {
//     blockhash: Blockhash;
//     blockHeight: bigint;
//     blockTime: UnixTimestamp;
//     parentSlot: bigint;
//     previousBlockhash: Blockhash;
// }
const blockResponse = await rpc.getBlock(0n, {
    rewards: false,
    transactionDetails: 'none'
}).send();

// Switch `rewards` to `true`, get `rewards` in the return type
// {
//     /* ... Previous response */
//     rewards: Reward[];
// }
const blockWithRewardsResponse = await rpc.getBlock(0n, {
    rewards: true,
    transactionDetails: 'none'
}).send();

// Switch `transactionDetails` to `full`, get `transactions` in the return type
// {
//     /* ... Previous response */
//     transactions: TransactionResponse[];
// }
const blockWithRewardsAndTransactionsResponse = await rpc.getBlock(0n, {
    rewards: true,
    transactionDetails: 'full'
}).send();

Catching Compile-Time Bugs with TypeScript

As previously mentioned, the type coverage in web3.js 2.0 allow developers to catch common bugs at compile time, rather than runtime.

In the example below, a transaction is created and then attempted to be compiled without setting the fee payer. This would result in a runtime error from the RPC, but instead you will see a type error from TypeScript as you type:

const encodedTx = pipe(
    createTransaction({ version: 0 }),
    tx => setTransactionLifetimeUsingBlockhash(recentBlockhash, tx),
    tx => getBase64EncodedWireTransaction(tx), // Property 'feePayer' is missing in type
);

Consider another example where a developer is attempting to send a transaction that has not been fully signed. Again, the TypeScript compiler will throw a type error:

const unsignedTransaction = pipe(
    createTransaction({ version: 0 }),
    tx => setTransactionFeePayer(feePayerAddress, tx),
    tx => setTransactionLifetimeUsingBlockhash(recentBlockhash, tx),
);

const signature = sendAndConfirmTransaction({
    confirmRecentTransaction: createDefaultRecentTransactionConfirmer({ rpc, rpcSubscriptions }),
    rpc,
    transaction: unsignedTransaction, // Transaction has not been signed: Type error
});

const transaction = await signTransaction([], unsignedTransaction);

// Asserts the transaction as a `IFullySignedTransaction`
// Throws an error if any signatures are missing!
assertTransactionIsFullySigned(transaction);

Are you working with a nonce transaction and forgot to make AdvanceNonce the first instruction? That’s a type error:

const feePayer = await generateKeyPair();
const feePayerAddress = await getAddressFromPublicKey(feePayer.publicKey);

const notNonceTransaction = pipe(
    createTransaction({ version: 0 }),
    tx => setTransactionFeePayer(feePayerAddress, tx),
);

notNonceTransaction satisfies IDurableNonceTransaction;
                    // => Property 'lifetimeConstraint' is missing in type

const nonceConfig = {
    nonce: 'nonce' as Nonce,
    nonceAccountAddress: address('5tLU66bxQ35so2bReGcyf3GfMMAAauZdNA1N4uRnKQu4'),
    nonceAuthorityAddress: address('GDhj8paPg8woUzp9n8fj7eAMocN5P7Ej3A7T9F5gotTX'),
};

const stillNotNonceTransaction = {
    lifetimeConstraint: nonceConfig,
    ...notNonceTransaction,
};

stillNotNonceTransaction satisfies IDurableNonceTransaction;
                        // => 'readonly IInstruction<string>[]' is not assignable to type 'readonly [AdvanceNonceAccountInstruction<string, string>, ...IInstruction<string>[]]'

const validNonceTransaction = pipe(
    createTransaction({ version: 0 }),
    tx => setTransactionFeePayer(feePayerAddress, tx),
    tx => setTransactionLifetimeUsingDurableNonce(nonceConfig, tx), // Adds the instruction!
);

validNonceTransaction satisfies IDurableNonceTransaction; // OK

The library’s type-checking can even catch you using lamports instead of SOL for a value:

const airdropAmount = 1n; // SOL
const signature = rpc.requestAirdrop(myAddress, airdropAmount).send();

It will force you to cast the numerical value for your airdrop (or transfer, etc.) amount using lamports(), which should be a good reminder!

const airdropAmount = lamports(1000000000n);
const signature = rpc.requestAirdrop(myAddress, airdropAmount).send();With the new library, it’s possible to specify the nature of a transaction instruction completely, just using TypeScrip

Compatibility Layer

You will have noticed by now that web3.js is a complete and total breaking change from the 1.x line. We want to provide you with a strategy for interacting with 1.x APIs while building your application using 2.0. You need a tool for commuting between 1.x and 2.0 data types.

The @solana/compat library allows for interoperability between functions and class objects from the legacy library - such as VersionedTransaction, PublicKey, and Keypair - and functions and types of the new library - such as Address, Transaction, and CryptoKeyPair.

Here’s how you can use @solana/compat to convert from a legacy PublicKey to an Address:

import { fromLegacyPublicKey } from '@solana/compat';

const publicKey = new PublicKey('B3piXWBQLLRuk56XG5VihxR4oe2PSsDM8nTF6s1DeVF5');
const address: Address = fromLegacyPublicKey(publicKey);

Here’s how to convert from a legacy Keypair to a CryptoKeyPair:

import { fromLegacyKeypair } from '@solana/compat';

const keypairLegacy = Keypair.generate();
const cryptoKeyPair: CryptoKeyPair = fromLegacyKeypair(keypair);

Here’s how to convert legacy transaction objects to the new library’s transaction types:

// For a transaction using a blockhash lifetime
const tx = fromVersionedTransactionWithBlockhash(legacyTransactionV0);
// You can also optionally provide a `lastValidBlockheight` parameter to manage retries
const tx = fromVersionedTransactionWithBlockhash(legacyTransactionV0, lastValidBlockheight);

// For a transaction using a durable nonce lifetime
const tx = fromVersionedTransactionWithDurableNonce(transaction);
// Again you can also optionally provide a `lastValidBlockheight`
const tx = fromVersionedTransactionWithDurableNonce(transaction, lastValidBlockheight);

To see more conversions supported by @solana/compat, you can check out the package’s README on GitHub.

Going Forward

This Technology Preview is just that, and development on the new web3.js is ongoing. We are working on tooling to accompany the new library to make building web applications on Solana easier, safer, and more scalable.

Although this new approach to JavaScript tooling is drastically different than the tooling you are used to, we are confident that the customizability, performance, bundle size, and safety characteristics of the new library will make it worth the migration. We’re here to help you every step of the way, via Github issues when you find problems with the library, and on the Solana Stack Exchange when you have questions on how something is supposed to work.

Program Clients

Writing JavaScript clients for on-chain programs has been done manually up until now. Without an IDL for some of the native programs, this process has been necessarily manual and has resulted in clients that lag behind the actual capabilities of the programs themselves.

We think that program clients should be generated rather than written. Developers should be able to write Rust programs, compile the program code, and generate all of the JavaScript client-side code to interact with the program.

Developers familiar with Shank and Solita may recognize this idea. We want to take it even further.

Here’s what the code could look like for a program client that includes Solana’s core programs like the System program or the Compute Budget program.

import { createTransaction, pipe } from '@solana/web3.js';
import { addMemo, setComputeUnitLimit, transferSol } from '@solana/spl-core';

const instructions = await Promise.all([
  setComputeUnitLimit({ units: 600_000 }),
  transferSol({ source, destination, amount: 1_000_000_000 }),
  addMemo({ memo: "I'm transferring some SOL!" })
]);

// Creates a V0 transaction with 3 instructions inside.
const transaction = pipe(
  createTransaction({ version: 0 }),
  tx => appendTransactionInstructions(instructions, tx),
);

GraphQL

Though not directly related to web3.js, we wanted to hijack your attention to show you something else that we’re working on, of particular interest to frontend developers. It’s a new API for interacting with the RPC: a GraphQL API.

The @solana/rpc-graphql package can be used to make GraphQL queries to Solana RPC endpoints, using the same transports described above (including any customizations).

Here’s an example of retrieving account data with GraphQL:

const source = `
    query myQuery($address: String!) {
        account(address: $address) {
            lamports
        }
    }
`;

const variableValues = {
    address: 'AyGCwnwxQMCqaU4ixReHt8h5W4dwmxU7eM3BEQBdWVca',
};

const result = await rpcGraphQL.query(source, variableValues);

expect(result).toMatchObject({
    data: {
        account: {
            lamports: 10290815n,
        },
    },
});

Using GraphQL allows developers to only specify which fields they actually need, and do away with the rest of the response.

However, GraphQL is also extremely powerful for nesting queries, which can be particularly useful if you want to, say, get the sum of every lamports balance of every owner of the owner of each token account, while discarding any mint accounts.

const source = `
    query getLamportsOfOwnersOfOwnersOfTokenAccounts {
        programAccounts(programAddress: "TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA") {
            ... on TokenAccount {
                data {
                    parsed {
                        info {
                            owner {
                                owner {
                                    lamports
                                }
                            }
                        }
                    }
                }
            }
        }
    }
`;

const result = await rpcGraphQL.query(source);

const sumOfAllLamportsOfOwnersOfOwnersOfTokenAccounts = result
    .map(o => o.account.data.parsed.info.owner.owner.lamports)
    .reduce((acc, lamports) => acc + lamports, 0);

The new GraphQL package supports this same style of nested querying on transactions and blocks.

const source = `
    query myQuery($signature: String!, $commitment: Commitment) {
        transaction(signature: $signature, commitment: $commitment) {
            ... on TransactionJsonParsed {
                transaction {
                    message {
                        ... on TransactionMessageParsed {
                            instructions {
                                ... on CreateAccountInstruction {
                                    parsed {
                                        info {
                                            lamports
                                            space
                                        }
                                        program
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
`;

const variableValues = {
    signature: '63zkpxATgAwXRGFQZPDESTw2m4uZQ99sX338ibgKtTcgG6v34E3MSS3zckCwJHrimS71cvei6h1Bn1K1De53BNWC',
    commitment: 'confirmed',
};
                                        
const result = await rpcGraphQL.query(source, variableValues);

expect(result).toMatchObject({
    data: {
        transaction: {
            transaction: {
                message: {
                    instructions: expect.arrayContaining([{
                        parsed: {
                            info: {
                                lamports: expect.any(BigInt),
                                space: expect.any(BigInt),
                            },
                            program: 'system',
                        },
                    }])
                },
            },
        },
    },
});

See more in the package’s README on GitHub.

Development

You can see all development of the new library and any associated tooling – such as program clients and GraphQL support – in the web3.js repository on GitHub.

https://github.com/solana-labs/solana-web3.js

Solana Labs develops these tools in public, with open source. We encourage any and all developers who would like to work on these tools to contribute to the codebase.

In fact, we welcome anyone who experiments with the new library to submit feedback via GitHub issues (or pull requests). A steady stream of feedback on the library from you will give us the confidence to propose a release candidate sooner.

You can find issues to tackle in the repository’s “issues” section, just make sure to follow the contributor guidelines!

Thank you

We’re grateful that you have read this far. If you are interested in migrating an existing application to the new web3.js to take advantage of some of the benefits we’ve demonstrated, we want to give you some direct support. Reach out to @steveluscher on Twitter to start a conversation.