@perpx/js-sdk
v0.1.1
Published
General client library for the new PerpX system
Keywords
Readme
The Typescript client is used for placing transactions and querying the PerpX chain.
Installation
Install the package directly from the GitHub repository:
npm install @perpx/js-sdkOr using yarn:
yarn add @perpx/js-sdkDevelopment
1. Clone or fork the clients repo
git clone [email protected]:1119-Labs/perpx-sdk.git2. Go to one of the examples
- Go to
perpx-sdk/examples
cd perpx-sdk/examplesThese examples by default use a test account with PERPX_TEST_MNEMONIC from the TS client library under perpx-sdk/examples/constants, but you can use any test address that you own.
3. Run the scripts with node
npm install
npm run buildYou should now see a /build/examples dir generated with JS files. We will use node to run these scripts
- Open a terminal to run an example, e.g. account_endpoints.
node ../build/examples/composite_example.js
Everytime you change the TS code, you need to run npm run build again, before you execute using node.
Release
Using the npm version command will update the appropriate version tags within the package locks and also will add a git tag with the version number..
For example npm version minor will perform the necessary changes for a minor version release. After the change is merged, a GitHub action will
publish the new release.
