63e37b2b20
* Remove @brief annotations from Rust API docs (#20769)
(cherry picked from commit d9b0fc0e3e)
# Conflicts:
# programs/bpf/rust/invoke/src/instructions.rs
# programs/bpf/rust/invoke/src/processor.rs
# programs/bpf/rust/realloc/src/instructions.rs
# programs/bpf/rust/realloc/src/lib.rs
# programs/bpf/rust/realloc/src/processor.rs
# programs/bpf/rust/realloc_invoke/src/instructions.rs
# programs/bpf/rust/realloc_invoke/src/lib.rs
# programs/bpf/rust/realloc_invoke/src/processor.rs
# sdk/cargo-build-bpf/tests/crates/fail/src/lib.rs
# sdk/src/precompiles.rs
* Fix conflicts
Co-authored-by: Brian Anderson <andersrb@gmail.com>
Co-authored-by: Tyera Eulberg <tyera@solana.com>
Solana JavaScript API
This is the Solana Javascript API built on the Solana JSON RPC API
Installation
Yarn
$ yarn add @solana/web3.js
npm
$ npm install --save @solana/web3.js
Browser bundle
<!-- Development (un-minified) -->
<script src="https://unpkg.com/@solana/web3.js@0.92.0/lib/index.iife.js"></script>
<!-- Production (un-minified) -->
<script src="https://unpkg.com/@solana/web3.js@0.92.0/lib/index.iife.min.js"></script>
Development Environment Setup
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
Javascript
const solanaWeb3 = require('@solana/web3.js');
console.log(solanaWeb3);
ES6
import * as solanaWeb3 from '@solana/web3.js';
console.log(solanaWeb3);
Browser bundle
// `solanaWeb3` is provided in the global namespace by the `solanaWeb3.min.js` script bundle.
console.log(solanaWeb3);
Flow
A Flow library definition is provided at module.flow.js. Add the following line under the [libs] section of your project's .flowconfig to activate it:
[libs]
node_modules/@solana/web3.js/module.flow.js
Releases
Releases are available on Github and npmjs.com
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)