solana-program-library/token-swap/js
Jon Cinque ba76d520eb
token-swap js: Prepare package for npm (#475)
* Run `pretty` properly
* Add `build:program` like for spl-token
* Add TypeScript to CI
* snake_case -> camelCase variables
* Combine transactions on swap initialization
* Make instruction functions static
2020-09-18 19:10:21 +02:00
..
cli token-swap js: Prepare package for npm (#475) 2020-09-18 19:10:21 +02:00
client token-swap js: Prepare package for npm (#475) 2020-09-18 19:10:21 +02:00
flow-typed Relocate js 2020-08-08 15:25:47 -07:00
.eslintignore token-swap js: Prepare package for npm (#475) 2020-09-18 19:10:21 +02:00
.eslintrc.js Relocate js 2020-08-08 15:25:47 -07:00
.flowconfig Relocate js 2020-08-08 15:25:47 -07:00
.prettierrc.yaml Relocate js 2020-08-08 15:25:47 -07:00
README.md token-swap js: Prepare package for npm (#475) 2020-09-18 19:10:21 +02:00
babel.config.json Relocate js 2020-08-08 15:25:47 -07:00
babel.rollup.config.json Token-swap ts, flow bindings and build using rollup. (#463) 2020-09-18 09:31:16 +02: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 token-swap js: Prepare package for npm (#475) 2020-09-18 19:10:21 +02:00
module.flow.js token-swap js: Prepare package for npm (#475) 2020-09-18 19:10:21 +02:00
package-lock.json token-swap js: Prepare package for npm (#475) 2020-09-18 19:10:21 +02:00
package.json token-swap js: Prepare package for npm (#475) 2020-09-18 19:10:21 +02:00
rollup.config.js Token-swap ts, flow bindings and build using rollup. (#463) 2020-09-18 09:31:16 +02:00
url.js Relocate js 2020-08-08 15:25:47 -07:00

README.md

Token-swap JavaScript API

The Token-swap 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