solana-program-library/token/js
Michael Vines aa9984e0d0 Replace mkdirp-promise with mkdirp 2020-10-06 18:01:48 -07:00
..
cli Reduce airdrop to fit in current testnet/devnet limits (#541) 2020-09-25 18:44:16 -06:00
client Replace mkdirp-promise with mkdirp 2020-10-06 18:01:48 -07:00
flow-typed Replace mkdirp-promise with mkdirp 2020-10-06 18:01:48 -07:00
.eslintignore Relocate js 2020-08-08 15:25:47 -07:00
.eslintrc.js Relocate js 2020-08-08 15:25:47 -07:00
.flowconfig Relocate js 2020-08-08 15:25:47 -07:00
.gitignore Relocate js 2020-08-08 15:25:47 -07:00
.prettierrc.yaml Relocate js 2020-08-08 15:25:47 -07:00
README.md Javascript -> JavaScript (#409) 2020-09-09 17:57:30 -06:00
babel.config.json Relocate js 2020-08-08 15:25:47 -07:00
babel.rollup.config.json Relocate js 2020-08-08 15:25:47 -07:00
cluster-devnet.env Relocate js 2020-08-08 15:25:47 -07:00
cluster-mainnet-beta.env Relocate js 2020-08-08 15:25:47 -07:00
cluster-testnet.env Relocate js 2020-08-08 15:25:47 -07:00
module.d.ts Fix lint check in CI (#519) 2020-09-23 18:20:37 +02:00
module.flow.js Expose Layouts and instruction creation functions to allow more flexible use of the Token and TokenSwap clients. (#517) 2020-09-23 14:22:56 +02:00
package-lock.json Replace mkdirp-promise with mkdirp 2020-10-06 18:01:48 -07:00
package.json Replace mkdirp-promise with mkdirp 2020-10-06 18:01:48 -07:00
rollup.config.js Relocate js 2020-08-08 15:25:47 -07:00
url.js Relocate js 2020-08-08 15:25:47 -07:00

README.md

Token JavaScript API

The Token JavaScript library comprises:

  • A library to interact with the on-chain program
  • A test client that exercises the program
  • Scripts to facilitate building the program

Getting Started

First fetch the npm dependencies, including @solana/web3.js, by running:

$ npm install

Select a Network

The client connects to a local Solana cluster by default.

To enable on-chain program logs, set the RUST_LOG environment variable:

$ export RUST_LOG=solana_runtime::native_loader=trace,solana_runtime::system_instruction_processor=trace,solana_runtime::bank=debug,solana_bpf_loader=debug,solana_rbpf=debug

To start a local Solana cluster run:

$ npm run localnet:update
$ npm run localnet:up

Solana cluster logs are available with:

$ npm run localnet:logs

For more details on working with a local cluster, see the full instructions.

Build the on-chain program

$ npm run build:program

Run the test client

$ npm run start

Pointing to a public Solana cluster

Solana maintains three public clusters:

  • devnet - Development cluster with airdrops enabled
  • testnet - Tour De Sol test cluster without airdrops enabled
  • mainnet-beta - Main cluster

Use npm scripts to configure which cluster.

To point to devnet:

$ npm run cluster:devnet

To point back to the local cluster:

$ npm run cluster:localnet