History

Michael Vines 2824779699 Fix lint fix		2020-06-14 21:57:04 -07:00
..
examples	Add getSignatureStatus()	2020-06-14 21:57:04 -07:00
flow-typed	Add decode()	2020-06-14 21:57:04 -07:00
src	Improve rpc result validation	2020-06-14 21:57:04 -07:00
test	Improve rpc result validation	2020-06-14 21:57:04 -07:00
.babelrc	Activate flow	2020-06-14 21:57:04 -07:00
.esdoc.json	Add esdoc boilerplate	2020-06-14 21:57:04 -07:00
.eslintignore	Ignore deploy/	2020-06-14 21:57:04 -07:00
.eslintrc.js	Adjust eslint configuration	2020-06-14 21:57:04 -07:00
.flowconfig	Activate flow	2020-06-14 21:57:04 -07:00
.gitignore	Add esdoc boilerplate	2020-06-14 21:57:04 -07:00
.npmignore	Trim npm package contents	2020-06-14 21:57:04 -07:00
.travis.yml	Remove coveralls remnants	2020-06-14 21:57:04 -07:00
CONTRIBUTING.md	Add more documentation	2020-06-14 21:57:04 -07:00
LICENSE	…
README.md	Add link to tic-tac-toe	2020-06-14 21:57:04 -07:00
commitlint.config.js	…
jest.json	…
package-lock.json	Update babel-core and jest	2020-06-14 21:57:04 -07:00
package.json	Fix lint fix	2020-06-14 21:57:04 -07:00
release-process.md	Add npm/github deployment	2020-06-14 21:57:04 -07:00
rollup.config.js	Reduce rollup warnings	2020-06-14 21:57:04 -07:00

README.md

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

<script src="https://github.com/solana-labs/solana-web3.js/releases/download/v0.0.6/solanaWeb3.min.js"></script>

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);

Examples

See the examples/ directory for small snippets.

Standalone examples:

Web wallet: https://github.com/solana-labs/example-webwallet
Tic-tac-toe: https://github.com/solana-labs/example-tictactoe

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)