This repository has been archived by the owner on Jan 22, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 4.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix: remove deprecated bpf-sdk, localnet, and examples
BREAKING CHANGE: Removed binaries solana-localnet and solana-bpf-sdk-install. Please install the Solana CLI tools to download the BPF SDK and to install the solana-test-validator binary intead.
- Loading branch information
Showing
26 changed files
with
33 additions
and
472 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
{ | ||
"repositoryUrl": "[email protected]:solana-labs/solana-web3.js.git", | ||
"preset": "conventionalcommits", | ||
"presetConfig": { | ||
"issueUrlFormat": "{{host}}/{{owner}}/solana/issues/{{id}}" | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -47,11 +47,17 @@ $ npm install --save @solana/web3.js | |
<script src="https://unpkg.com/@solana/[email protected]/lib/index.iife.min.js"></script> | ||
``` | ||
|
||
## Development Environment Setup | ||
|
||
### Development Environment Setup | ||
To build and run tests: | ||
1. Install Rust from https://rustup.rs/ | ||
2. Install the latest Solana release from https://docs.solana.com/cli/install-solana-cli-tools | ||
Install the latest Solana release from https://docs.solana.com/cli/install-solana-cli-tools | ||
|
||
### Run test validator | ||
|
||
**Use `solana-test-validator` from the latest Solana release** | ||
|
||
### BPF program development | ||
|
||
**Use `cargo build-bpf` from the latest Solana release** | ||
|
||
## Usage | ||
|
||
|
@@ -84,61 +90,10 @@ activate it: | |
node_modules/@solana/web3.js/module.flow.js | ||
``` | ||
|
||
## Examples | ||
See the [examples/](https://github.com/solana-labs/solana-web3.js/tree/master/examples) directory for small snippets. | ||
|
||
Standalone examples: | ||
* Message feed (BPF Rust and C): https://github.com/solana-labs/example-messagefeed | ||
* Tic-tac-toe (BPF C): https://github.com/solana-labs/example-tictactoe | ||
* Web wallet: https://github.com/solana-labs/example-webwallet | ||
|
||
## Releases | ||
Releases are available on [Github](https://github.com/solana-labs/solana-web3.js/releases) | ||
and [npmjs.com](https://www.npmjs.com/package/@solana/web3.js) | ||
|
||
Each Github release features a tarball containing API documentation and a | ||
minified version of the module suitable for direct use in a browser environment | ||
(<script> tag) | ||
|
||
## Deprecated | ||
|
||
### Local Network | ||
|
||
**Please use `solana-test-validator` from the latest Solana release instead of the information in this section** | ||
|
||
The `solana-localnet` program is provided to easily start a test Solana cluster | ||
locally on your machine. Docker must be installed. The JSON RPC endpoint of | ||
the local cluster is `http://localhost:8899`. | ||
|
||
To start, first fetch the latest Docker image by running: | ||
```bash | ||
$ npx solana-localnet update | ||
``` | ||
|
||
Then run the following command to start the cluster | ||
```bash | ||
$ npx solana-localnet up | ||
``` | ||
|
||
While the cluster is running logs are available with: | ||
```bash | ||
$ npx solana-localnet logs -f | ||
``` | ||
|
||
Stop the cluster with: | ||
```bash | ||
$ npx solana-localnet down | ||
``` | ||
|
||
### BPF program development | ||
|
||
**Please use `cargo build-bpf` from the latest Solana release instead of the information in this section** | ||
|
||
The Solana BPF SDK is located in the `bpf-sdk/` subdirectory if you installed | ||
solana-web3.js from npmjs.com. | ||
|
||
From a git clone, run `npm run bpf-sdk:install` to fetch the latest BPF SDK. | ||
|
||
Additionally Rust must be installed to build Rust BPF programs such as | ||
`examples/bpf-rust-noop/`. See https://www.rust-lang.org/install.html for | ||
installation details. |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.