solana/web3.js
dependabot[bot] 17dca6da6a
chore: bump rollup-plugin-flat-dts from 1.1.0 to 1.2.0 in /web3.js (#16087)
Bumps [rollup-plugin-flat-dts](https://github.com/run-z/rollup-plugin-flat-dts) from 1.1.0 to 1.2.0.
- [Release notes](https://github.com/run-z/rollup-plugin-flat-dts/releases)
- [Commits](https://github.com/run-z/rollup-plugin-flat-dts/compare/v1.1.0...v1.2.0)

Signed-off-by: dependabot[bot] <[email protected]>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-03-24 05:13:09 +00:00
..
.github Add warning to PR template for mirrored repos (#13344) 2020-11-02 14:34:14 +08:00
.travis fix: remove deprecated bpf-sdk, localnet, and examples 2021-03-19 17:45:08 +08:00
src feat: add logs subscription (#16045) 2021-03-24 11:05:17 +08:00
test feat: add logs subscription (#16045) 2021-03-24 11:05:17 +08:00
.eslintignore chore: linter fixes 2021-03-17 10:26:00 +08:00
.eslintrc.js chore: project config changes for typescript migration 2021-03-17 10:26:00 +08:00
.gitignore fix: remove deprecated bpf-sdk, localnet, and examples 2021-03-19 17:45:08 +08:00
.mergify.yml ci: remove automerge label on CI failure 2020-06-14 21:57:04 -07:00
.mocharc.js chore: replace jest with mocha 2021-02-08 07:57:05 +08:00
.prettierignore chore: migrate tests to typescript 2021-03-17 10:26:00 +08:00
.prettierrc.yaml
.releaserc.json fix: remove deprecated bpf-sdk, localnet, and examples 2021-03-19 17:45:08 +08:00
.sgcrc
.travis.yml chore: port web3.js to solana-test-validator 2020-12-17 20:53:10 +00:00
CONTRIBUTING.md chore: project config changes for typescript migration 2021-03-17 10:26:00 +08:00
LICENSE
README.md fix: remove deprecated bpf-sdk, localnet, and examples 2021-03-19 17:45:08 +08:00
babel.config.json chore: project config changes for typescript migration 2021-03-17 10:26:00 +08:00
commitlint.config.js
mocha.html chore: replace jest with mocha 2021-02-08 07:57:05 +08:00
package-lock.json chore: bump rollup-plugin-flat-dts from 1.1.0 to 1.2.0 in /web3.js (#16087) 2021-03-24 05:13:09 +00:00
package.json chore: bump rollup from 2.42.0 to 2.42.3 in /web3.js (#16085) 2021-03-24 04:43:16 +00:00
rollup.config.js chore: migrate tests to typescript 2021-03-17 10:26:00 +08:00
tsconfig.json chore: migrate tests to typescript 2021-03-17 10:26:00 +08:00
typedoc.json chore: project config changes for typescript migration 2021-03-17 10:26:00 +08:00

README.md

Build status codecov
npm npm-downloads
semantic-release code-style-prettier

Solana JavaScript API

This is the Solana Javascript API built on the Solana JSON RPC API

Latest API Documentation

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/[email protected]/lib/index.iife.js"></script>

<!-- Production (un-minified) -->
<script src="https://unpkg.com/@solana/[email protected]/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 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)