@com.put/ppl-token
v1.0.1
Published
PPL Token JavaScript API
Downloads
6
Readme
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 @com.put/web3.js
, by running:
$ npm install
Select a Network
The client connects to a local Put cluster by default.
To enable on-chain program logs, set the RUST_LOG
environment variable:
$ export RUST_LOG=put_runtime::native_loader=trace,put_runtime::system_instruction_processor=trace,put_runtime::bank=debug,put_bpf_loader=debug,put_rbpf=debug
To start a local Put cluster run:
$ put-test-validator
Put cluster logs are available with:
$ put --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 Put cluster
Put maintains three public clusters:
devnet
- Development cluster with airdrops enabledtestnet
- Tour De Put test cluster without airdrops enabledmainnet-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
- (first-time only) Create your account on npmjs.com (with 2FA enabled!) and ask @mvines about granting the publish right and run
npm login
- Bump version in
package.json
andnpm install
(to updatepackage-lock.json
) - Create a PR for the version bump
- Merge the PR and push new git tag on master branch
- Create release on github.com from the pushed tag
- Run
npm run build
andnpm publish