solana-program-library/token/js
Michael Vines da98fc691f Port token js tests from solana-localnet to solana-test-validator 2020-12-17 21:24:30 -08:00
..
cli Clean up JS test getConnection function (#577) 2020-10-08 09:27:06 +00:00
client Fix u64.fromBuffer return type to u64 (#830) 2020-11-12 10:40:46 +01:00
flow-typed Clean up JS test getConnection function (#577) 2020-10-08 09:27:06 +00: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 Port token js tests from solana-localnet to solana-test-validator 2020-12-17 21:24:30 -08:00
.prettierrc.yaml Relocate js 2020-08-08 15:25:47 -07:00
README.md Port token js tests from solana-localnet to solana-test-validator 2020-12-17 21:24:30 -08: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 [js-token-library] add freeze and thaw ix builder functions to module declarations (#851) 2020-11-16 18:49:15 +01:00
module.flow.js [js-token-library] add freeze and thaw ix builder functions to module declarations (#851) 2020-11-16 18:49:15 +01:00
package-lock.json Port token js tests from solana-localnet to solana-test-validator 2020-12-17 21:24:30 -08:00
package.json Port token js tests from solana-localnet to solana-test-validator 2020-12-17 21:24:30 -08: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:

$ solana-test-validator

Solana cluster logs are available with:

$ solana --url http://127.0.0.1:8899/ logs

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