solana/web3.js
Michael Vines 36df1b1e5e Add local browser example 2020-06-14 21:57:04 -07:00
..
examples Add local browser example 2020-06-14 21:57:04 -07:00
src Add Account class 2020-06-14 21:57:04 -07:00
test Add Account class 2020-06-14 21:57:04 -07:00
.babelrc Project boilerplate from eunikitin/modern-package-boilerplate 2020-06-14 21:57:04 -07:00
.esdoc.json Add esdoc boilerplate 2020-06-14 21:57:04 -07:00
.eslintignore Project boilerplate from eunikitin/modern-package-boilerplate 2020-06-14 21:57:04 -07:00
.eslintrc.js Adjust eslint configuration 2020-06-14 21:57:04 -07:00
.flowconfig Project boilerplate from eunikitin/modern-package-boilerplate 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 Run lint/flow/doc/examples in CI 2020-06-14 21:57:04 -07:00
CONTRIBUTING.md Add more documentation 2020-06-14 21:57:04 -07:00
LICENSE Project boilerplate from eunikitin/modern-package-boilerplate 2020-06-14 21:57:04 -07:00
README.md Add local browser example 2020-06-14 21:57:04 -07:00
commitlint.config.js
jest.json Project boilerplate from eunikitin/modern-package-boilerplate 2020-06-14 21:57:04 -07:00
package-lock.json 0.0.3 2020-06-14 21:57:04 -07:00
package.json 0.0.3 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 Support cjs, esm and iife modules 2020-06-14 21:57:04 -07:00

README.md

Build status Coverage Status npm

Solana JavaScript API

This is the Solana Javascript API built on the Solana JSON RPC API (TODO: add link).

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.3/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

Releases

Releases are available on Github and npmjs.com.

Each Github release features a tarball containing the API documentation release and a minified version of the module suitable for direct use in a browser environment (<script> tag)