Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update READMEs to point to the next tag #3633

Merged
merged 1 commit into from
Nov 26, 2024
Merged

Update READMEs to point to the next tag #3633

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@

[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/rc.svg?style=flat
[npm-image]: https://img.shields.io/npm/v/@solana/web3.js/rc.svg?style=flat
[npm-url]: https://www.npmjs.com/package/@solana/web3.js/v/rc
[npm-downloads-image]: https://img.shields.io/npm/dm/@solana/web3.js/next.svg?style=flat
[npm-image]: https://img.shields.io/npm/v/@solana/web3.js/next.svg?style=flat
[npm-url]: https://www.npmjs.com/package/@solana/web3.js/v/next

# Solana JavaScript SDK

Expand All @@ -21,17 +21,17 @@ This is the JavaScript SDK for building Solana apps for Node, web, and React Nat
For use in a Node.js or web application:

```shell
npm install --save @solana/web3.js@rc
npm install --save @solana/web3.js@next
```

For use in a browser, without a build system:

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

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

# Quick Start
Expand Down Expand Up @@ -73,7 +73,7 @@ The new library itself is comprised of several smaller, modular packages under t

Some of these packages are themselves composed of smaller packages. For instance, `@solana/rpc` is composed of `@solana/rpc-spec` (for core JSON RPC specification types), `@solana/rpc-api` (for the Solana-specific RPC methods), `@solana/rpc-transport-http` (for the default HTTP transport) and so on.

Developers can use the default configurations within the main library (`@solana/web3.js@rc`) or import any of its subpackages where customization-through-composition is desired.
Developers can use the default configurations within the main library (`@solana/web3.js@next`) or import any of its subpackages where customization-through-composition is desired.

## Composable Internals

Expand All @@ -88,7 +88,7 @@ The inability to customize web3.js up until now has been a source of frustration

Version 2.0 exposes far more of its internals, particularly where communication with an RPC is concerned, and allows willing developers the ability to compose new implementations from the default ones that manifest a nearly limitless array of customizations.

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@rc`, but those who wish to assemble them in different configurations may do so.
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@next`, but those who wish to assemble them in different configurations may do so.

Generic types are offered in numerous places, allowing you to specify 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.

Expand Down
8 changes: 4 additions & 4 deletions packages/accounts/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@

[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/accounts/rc.svg?style=flat
[npm-image]: https://img.shields.io/npm/v/@solana/accounts/rc.svg?style=flat
[npm-url]: https://www.npmjs.com/package/@solana/accounts/v/rc
[npm-downloads-image]: https://img.shields.io/npm/dm/@solana/accounts/next.svg?style=flat
[npm-image]: https://img.shields.io/npm/v/@solana/accounts/next.svg?style=flat
[npm-url]: https://www.npmjs.com/package/@solana/accounts/v/next

# @solana/accounts

This package contains types and helper methods for representing, fetching and decoding Solana accounts. It can be used standalone, but it is also exported as part of the Solana JavaScript SDK [`@solana/web3.js@rc`](https://github.com/solana-labs/solana-web3.js/tree/master/packages/library).
This package contains types and helper methods for representing, fetching and decoding Solana accounts. It can be used standalone, but it is also exported as part of the Solana JavaScript SDK [`@solana/web3.js@next`](https://github.com/solana-labs/solana-web3.js/tree/master/packages/library).

It provides a unified definition of a Solana account regardless of how it was retrieved and can represent both encoded and decoded accounts. It also introduces the concept of a `MaybeAccount` which represents a fetched account that may or may not exist on-chain whilst keeping track of its address in both cases.

Expand Down
6 changes: 3 additions & 3 deletions packages/addresses/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@

[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/addresses/rc.svg?style=flat
[npm-image]: https://img.shields.io/npm/v/@solana/addresses/rc.svg?style=flat
[npm-url]: https://www.npmjs.com/package/@solana/addresses/v/rc
[npm-downloads-image]: https://img.shields.io/npm/dm/@solana/addresses/next.svg?style=flat
[npm-image]: https://img.shields.io/npm/v/@solana/addresses/next.svg?style=flat
[npm-url]: https://www.npmjs.com/package/@solana/addresses/v/next

# @solana/addresses

Expand Down
6 changes: 3 additions & 3 deletions packages/assertions/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@

[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/assertions/rc.svg?style=flat
[npm-image]: https://img.shields.io/npm/v/@solana/assertions/rc.svg?style=flat
[npm-url]: https://www.npmjs.com/package/@solana/assertions/v/rc
[npm-downloads-image]: https://img.shields.io/npm/dm/@solana/assertions/next.svg?style=flat
[npm-image]: https://img.shields.io/npm/v/@solana/assertions/next.svg?style=flat
[npm-url]: https://www.npmjs.com/package/@solana/assertions/v/next

# @solana/assertions

Expand Down
8 changes: 4 additions & 4 deletions packages/codecs-core/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@

[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/codecs-core/rc.svg?style=flat
[npm-image]: https://img.shields.io/npm/v/@solana/codecs-core/rc.svg?style=flat
[npm-url]: https://www.npmjs.com/package/@solana/codecs-core/v/rc
[npm-downloads-image]: https://img.shields.io/npm/dm/@solana/codecs-core/next.svg?style=flat
[npm-image]: https://img.shields.io/npm/v/@solana/codecs-core/next.svg?style=flat
[npm-url]: https://www.npmjs.com/package/@solana/codecs-core/v/next

# @solana/codecs-core

This package contains the core types and functions for encoding and decoding data structures on Solana. It can be used standalone, but it is also exported as part of the Solana JavaScript SDK [`@solana/web3.js@rc`](https://github.com/solana-labs/solana-web3.js/tree/master/packages/library).
This package contains the core types and functions for encoding and decoding data structures on Solana. It can be used standalone, but it is also exported as part of the Solana JavaScript SDK [`@solana/web3.js@next`](https://github.com/solana-labs/solana-web3.js/tree/master/packages/library).

This package is also part of the [`@solana/codecs` package](https://github.com/solana-labs/solana-web3.js/tree/master/packages/codecs) which acts as an entry point for all codec packages as well as for their documentation.

Expand Down
8 changes: 4 additions & 4 deletions packages/codecs-data-structures/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@

[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/codecs-data-structures/rc.svg?style=flat
[npm-image]: https://img.shields.io/npm/v/@solana/codecs-data-structures/rc.svg?style=flat
[npm-url]: https://www.npmjs.com/package/@solana/codecs-data-structures/v/rc
[npm-downloads-image]: https://img.shields.io/npm/dm/@solana/codecs-data-structures/next.svg?style=flat
[npm-image]: https://img.shields.io/npm/v/@solana/codecs-data-structures/next.svg?style=flat
[npm-url]: https://www.npmjs.com/package/@solana/codecs-data-structures/v/next

# @solana/codecs-data-structures

This package contains codecs for various data structures such as arrays, maps, structs, tuples, enums, etc. It can be used standalone, but it is also exported as part of the Solana JavaScript SDK [`@solana/web3.js@rc`](https://github.com/solana-labs/solana-web3.js/tree/master/packages/library).
This package contains codecs for various data structures such as arrays, maps, structs, tuples, enums, etc. It can be used standalone, but it is also exported as part of the Solana JavaScript SDK [`@solana/web3.js@next`](https://github.com/solana-labs/solana-web3.js/tree/master/packages/library).

This package is also part of the [`@solana/codecs` package](https://github.com/solana-labs/solana-web3.js/tree/master/packages/codecs) which acts as an entry point for all codec packages as well as for their documentation.

Expand Down
8 changes: 4 additions & 4 deletions packages/codecs-numbers/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@

[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/codecs-numbers/rc.svg?style=flat
[npm-image]: https://img.shields.io/npm/v/@solana/codecs-numbers/rc.svg?style=flat
[npm-url]: https://www.npmjs.com/package/@solana/codecs-numbers/v/rc
[npm-downloads-image]: https://img.shields.io/npm/dm/@solana/codecs-numbers/next.svg?style=flat
[npm-image]: https://img.shields.io/npm/v/@solana/codecs-numbers/next.svg?style=flat
[npm-url]: https://www.npmjs.com/package/@solana/codecs-numbers/v/next

# @solana/codecs-numbers

This package contains codecs for numbers of different sizes and endianness. It can be used standalone, but it is also exported as part of the Solana JavaScript SDK [`@solana/web3.js@rc`](https://github.com/solana-labs/solana-web3.js/tree/master/packages/library).
This package contains codecs for numbers of different sizes and endianness. It can be used standalone, but it is also exported as part of the Solana JavaScript SDK [`@solana/web3.js@next`](https://github.com/solana-labs/solana-web3.js/tree/master/packages/library).

This package is also part of the [`@solana/codecs` package](https://github.com/solana-labs/solana-web3.js/tree/master/packages/codecs) which acts as an entry point for all codec packages as well as for their documentation.

Expand Down
8 changes: 4 additions & 4 deletions packages/codecs-strings/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@

[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/codecs-strings/rc.svg?style=flat
[npm-image]: https://img.shields.io/npm/v/@solana/codecs-strings/rc.svg?style=flat
[npm-url]: https://www.npmjs.com/package/@solana/codecs-strings/v/rc
[npm-downloads-image]: https://img.shields.io/npm/dm/@solana/codecs-strings/next.svg?style=flat
[npm-image]: https://img.shields.io/npm/v/@solana/codecs-strings/next.svg?style=flat
[npm-url]: https://www.npmjs.com/package/@solana/codecs-strings/v/next

# @solana/codecs-strings

This package contains codecs for strings of different sizes and encodings. It can be used standalone, but it is also exported as part of the Solana JavaScript SDK [`@solana/web3.js@rc`](https://github.com/solana-labs/solana-web3.js/tree/master/packages/library).
This package contains codecs for strings of different sizes and encodings. It can be used standalone, but it is also exported as part of the Solana JavaScript SDK [`@solana/web3.js@next`](https://github.com/solana-labs/solana-web3.js/tree/master/packages/library).

This package is also part of the [`@solana/codecs` package](https://github.com/solana-labs/solana-web3.js/tree/master/packages/codecs) which acts as an entry point for all codec packages as well as for their documentation.

Expand Down
8 changes: 4 additions & 4 deletions packages/codecs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@

[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/codecs/rc.svg?style=flat
[npm-image]: https://img.shields.io/npm/v/@solana/codecs/rc.svg?style=flat
[npm-url]: https://www.npmjs.com/package/@solana/codecs/v/rc
[npm-downloads-image]: https://img.shields.io/npm/dm/@solana/codecs/next.svg?style=flat
[npm-image]: https://img.shields.io/npm/v/@solana/codecs/next.svg?style=flat
[npm-url]: https://www.npmjs.com/package/@solana/codecs/v/next

# @solana/codecs

This package contains all types and helpers for encoding and decoding anything to and from a `Uint8Array`. It can be used standalone, but it is also exported as part of the Solana JavaScript SDK [`@solana/web3.js@rc`](https://github.com/solana-labs/solana-web3.js/tree/master/packages/library).
This package contains all types and helpers for encoding and decoding anything to and from a `Uint8Array`. It can be used standalone, but it is also exported as part of the Solana JavaScript SDK [`@solana/web3.js@next`](https://github.com/solana-labs/solana-web3.js/tree/master/packages/library).

No matter which serialization strategy we use, Codecs abstract away its implementation and offers a simple `encode` and `decode` interface. Codecs are also highly composable, allowing us to build complex data structures from simple building blocks.

Expand Down
8 changes: 4 additions & 4 deletions packages/compat/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@

[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/compat/rc.svg?style=flat
[npm-image]: https://img.shields.io/npm/v/@solana/compat/rc.svg?style=flat
[npm-url]: https://www.npmjs.com/package/@solana/compat/v/rc
[npm-downloads-image]: https://img.shields.io/npm/dm/@solana/compat/next.svg?style=flat
[npm-image]: https://img.shields.io/npm/v/@solana/compat/next.svg?style=flat
[npm-url]: https://www.npmjs.com/package/@solana/compat/v/next

# @solana/compat

This package contains utilities for converting from legacy web3js classes to the new data structures. It can be used standalone, but it is also exported as part of the Solana JavaScript SDK [`@solana/web3.js@rc`](https://github.com/solana-labs/solana-web3.js/tree/master/packages/library).
This package contains utilities for converting from legacy web3js classes to the new data structures. It can be used standalone, but it is also exported as part of the Solana JavaScript SDK [`@solana/web3.js@next`](https://github.com/solana-labs/solana-web3.js/tree/master/packages/library).

## Functions

Expand Down
6 changes: 3 additions & 3 deletions packages/errors/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@

[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/errors/rc.svg?style=flat
[npm-image]: https://img.shields.io/npm/v/@solana/errors/rc.svg?style=flat
[npm-url]: https://www.npmjs.com/package/@solana/errors/v/rc
[npm-downloads-image]: https://img.shields.io/npm/dm/@solana/errors/next.svg?style=flat
[npm-image]: https://img.shields.io/npm/v/@solana/errors/next.svg?style=flat
[npm-url]: https://www.npmjs.com/package/@solana/errors/v/next

# @solana/errors

Expand Down
8 changes: 4 additions & 4 deletions packages/functional/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,16 @@

[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/functional/rc.svg?style=flat
[npm-image]: https://img.shields.io/npm/v/@solana/functional/rc.svg?style=flat
[npm-url]: https://www.npmjs.com/package/@solana/functional/v/rc
[npm-downloads-image]: https://img.shields.io/npm/dm/@solana/functional/next.svg?style=flat
[npm-image]: https://img.shields.io/npm/v/@solana/functional/next.svg?style=flat
[npm-url]: https://www.npmjs.com/package/@solana/functional/v/next

# @solana/functional

This package contains generalized functional helpers and functional helpers
specific to Solana application components. It can be used standalone, but it
is also exported as part of the Solana JavaScript SDK
[`@solana/web3.js@rc`](https://github.com/solana-labs/solana-web3.js/tree/master/packages/library).
[`@solana/web3.js@next`](https://github.com/solana-labs/solana-web3.js/tree/master/packages/library).

## Functions

Expand Down
8 changes: 4 additions & 4 deletions packages/instructions/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@

[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/instructions/rc.svg?style=flat
[npm-image]: https://img.shields.io/npm/v/@solana/instructions/rc.svg?style=flat
[npm-url]: https://www.npmjs.com/package/@solana/instructions/v/rc
[npm-downloads-image]: https://img.shields.io/npm/dm/@solana/instructions/next.svg?style=flat
[npm-image]: https://img.shields.io/npm/v/@solana/instructions/next.svg?style=flat
[npm-url]: https://www.npmjs.com/package/@solana/instructions/v/next

# @solana/instructions

This package contains types for creating transaction instructions. It can be used standalone, but it is also exported as part of the Solana JavaScript SDK [`@solana/web3.js@rc`](https://github.com/solana-labs/solana-web3.js/tree/master/packages/library).
This package contains types for creating transaction instructions. It can be used standalone, but it is also exported as part of the Solana JavaScript SDK [`@solana/web3.js@next`](https://github.com/solana-labs/solana-web3.js/tree/master/packages/library).

## Types

Expand Down
8 changes: 4 additions & 4 deletions packages/keys/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@

[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/keys/rc.svg?style=flat
[npm-image]: https://img.shields.io/npm/v/@solana/keys/rc.svg?style=flat
[npm-url]: https://www.npmjs.com/package/@solana/keys/v/rc
[npm-downloads-image]: https://img.shields.io/npm/dm/@solana/keys/next.svg?style=flat
[npm-image]: https://img.shields.io/npm/v/@solana/keys/next.svg?style=flat
[npm-url]: https://www.npmjs.com/package/@solana/keys/v/next

# @solana/keys

This package contains utilities for validating, generating, and manipulating addresses and key material. It can be used standalone, but it is also exported as part of the Solana JavaScript SDK [`@solana/web3.js@rc`](https://github.com/solana-labs/solana-web3.js/tree/master/packages/library).
This package contains utilities for validating, generating, and manipulating addresses and key material. It can be used standalone, but it is also exported as part of the Solana JavaScript SDK [`@solana/web3.js@next`](https://github.com/solana-labs/solana-web3.js/tree/master/packages/library).

## Types

Expand Down
6 changes: 3 additions & 3 deletions packages/library/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@

[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/rc.svg?style=flat
[npm-image]: https://img.shields.io/npm/v/@solana/web3.js/rc.svg?style=flat
[npm-url]: https://www.npmjs.com/package/@solana/web3.js/v/rc
[npm-downloads-image]: https://img.shields.io/npm/dm/@solana/web3.js/next.svg?style=flat
[npm-image]: https://img.shields.io/npm/v/@solana/web3.js/next.svg?style=flat
[npm-url]: https://www.npmjs.com/package/@solana/web3.js/v/next

# @solana/web3.js

Expand Down
Loading