solana/web3.js
dependabot[bot] e3d722bb42
chore: bump @commitlint/travis-cli from 12.1.1 to 12.1.3 in /web3.js (#17184)
Bumps [@commitlint/travis-cli](https://github.com/conventional-changelog/commitlint) from 12.1.1 to 12.1.3.
- [Release notes](https://github.com/conventional-changelog/commitlint/releases)
- [Changelog](https://github.com/conventional-changelog/commitlint/blob/master/CHANGELOG.md)
- [Commits](https://github.com/conventional-changelog/commitlint/compare/v12.1.1...v12.1.3)

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

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-05-12 08:18:18 +00:00
..
.github Add warning to PR template for mirrored repos (#13344) 2020-11-02 14:34:14 +08:00
.travis chore: stop building on npm prepare (#16126) 2021-03-25 19:06:29 +08:00
scripts fix: add explicit module declaration to type definitions (#16219) 2021-03-30 20:16:31 +08:00
src fix: improve findProgramAddress error when MAX_SEED_LENGTH is exceeded (#17151) 2021-05-10 15:55:51 -07:00
test feat: add Keypair class and deprecate Account (#17098) 2021-05-07 08:59:51 +00:00
.eslintignore fix: add explicit module declaration to type definitions (#16219) 2021-03-30 20:16:31 +08:00
.eslintrc.js chore: project config changes for typescript migration 2021-03-17 10:26:00 +08:00
.flowconfig fix: fix flow type declaration (#17049) 2021-05-05 17:50:55 +08:00
.gitignore fix: add explicit module declaration to type definitions (#16219) 2021-03-30 20:16:31 +08:00
.mergify.yml
.mocharc.js chore: replace jest with mocha 2021-02-08 07:57:05 +08:00
.prettierignore fix: add explicit module declaration to type definitions (#16219) 2021-03-30 20:16:31 +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 Update web3.js import sample 2021-05-03 23:32:45 -07: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 @commitlint/travis-cli from 12.1.1 to 12.1.3 in /web3.js (#17184) 2021-05-12 08:18:18 +00:00
package.json chore: bump @rollup/plugin-commonjs from 18.1.0 to 19.0.0 in /web3.js (#17141) 2021-05-10 12:22:05 +00:00
rollup.config.js fix: fix flow type declaration (#17049) 2021-05-05 17:50:55 +08:00
rollup.config.types.js fix: add explicit module declaration to type definitions (#16219) 2021-03-30 20:16:31 +08:00
tsconfig.d.json fix: add explicit module declaration to type definitions (#16219) 2021-03-30 20:16:31 +08:00
tsconfig.json fix: add explicit module declaration to type definitions (#16219) 2021-03-30 20:16:31 +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 * 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)