solana-program-library/token/js
dependabot[bot] 1a6df09e89
build(deps-dev): bump @babel/preset-env in /token/js (#1716)
Bumps [@babel/preset-env](https://github.com/babel/babel/tree/HEAD/packages/babel-preset-env) from 7.13.10 to 7.14.2.
- [Release notes](https://github.com/babel/babel/releases)
- [Changelog](https://github.com/babel/babel/blob/main/CHANGELOG.md)
- [Commits](https://github.com/babel/babel/commits/v7.14.2/packages/babel-preset-env)

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-05-13 08:44:36 +00:00
..
cli Fix potential vulnerabilities in programs using spl-token CPIs by adding program id checks (#1714) 2021-05-12 22:36:41 +00:00
client fix: reject off-curve owners during ATA creation 2021-05-05 15:48:59 -06:00
flow-typed/npm chore: add negative test for ATA creation with off-curve owner 2021-05-05 15:48:59 -06:00
test chore: add negative test for ATA creation with off-curve owner 2021-05-05 15:48:59 -06:00
.eslintignore fix: add support for browser modules to @solana/spl-token (#1337) 2021-02-25 14:56:09 +08:00
.eslintrc.js fix: add support for browser modules to @solana/spl-token (#1337) 2021-02-25 14:56:09 +08: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
.mocharc.js fix: add support for browser modules to @solana/spl-token (#1337) 2021-02-25 14:56:09 +08:00
.prettierrc.yaml Relocate js 2020-08-08 15:25:47 -07:00
README.md Add basic release docs (#1542) 2021-03-31 17:18:20 +09:00
babel.config.json fix: add support for browser modules to @solana/spl-token (#1337) 2021-02-25 14:56:09 +08: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
mocha.html fix: add support for browser modules to @solana/spl-token (#1337) 2021-02-25 14:56:09 +08:00
module.d.ts Support associated token for JS (Also, make the program testable) (#1364) 2021-03-03 20:56:22 +09:00
module.flow.js Support associated token for JS (Also, make the program testable) (#1364) 2021-03-03 20:56:22 +09:00
package-lock.json build(deps-dev): bump @babel/preset-env in /token/js (#1716) 2021-05-13 08:44:36 +00:00
package.json token/js: Bump version to v0.1.4 2021-05-07 06:39:04 +00:00
rollup.config.js fix: add support for browser modules to @solana/spl-token (#1337) 2021-02-25 14:56:09 +08: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

Releasing

  1. (first-time only) Create your account on npmjs.com (with 2FA enabled!) and ask @mvines about granting the publish right and run npm login
  2. Bump version in package.json and npm install (to update package-lock.json)
  3. Create a PR for the version bump
  4. Merge the PR and push new git tag on master branch
  5. Create release on github.com from the pushed tag
  6. Run npm run build and npm publish