solana-program-library/token/js
Jack May a07935371f
Prep token/js for publishing (#165)
2020-07-30 02:07:55 -07:00
..
cli Prep token/js for publishing (#165) 2020-07-30 02:07:55 -07:00
client Prep token/js for publishing (#165) 2020-07-30 02:07:55 -07:00
flow-typed Remove unused dependencies (#133) 2020-07-21 18:27:02 -06:00
.babelrc Remove unused dependencies (#133) 2020-07-21 18:27:02 -06:00
.eslintrc.js Remove unused dependencies (#133) 2020-07-21 18:27:02 -06:00
.flowconfig Remove builtin flowconfig suppress_comments (#140) 2020-07-21 10:28:03 -07:00
.prettierrc.yaml Reorganize repository in preparation for more programs (#20) 2020-06-05 12:34:17 -06:00
README.md Add token docs (#158) 2020-07-28 11:00:37 -07:00
cluster-devnet.env Reorganize repository in preparation for more programs (#20) 2020-06-05 12:34:17 -06:00
cluster-mainnet-beta.env Reorganize repository in preparation for more programs (#20) 2020-06-05 12:34:17 -06:00
cluster-testnet.env Reorganize repository in preparation for more programs (#20) 2020-06-05 12:34:17 -06:00
module.d.ts Prep token/js for publishing (#165) 2020-07-30 02:07:55 -07:00
module.flow.js Prep token/js for publishing (#165) 2020-07-30 02:07:55 -07:00
package-lock.json Prep token/js for publishing (#165) 2020-07-30 02:07:55 -07:00
package.json Prep token/js for publishing (#165) 2020-07-30 02:07:55 -07:00
url.js Reorganize repository in preparation for more programs (#20) 2020-06-05 12:34:17 -06: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