Skip to content

Latest commit

 

History

History
133 lines (97 loc) · 3.74 KB

README.md

File metadata and controls

133 lines (97 loc) · 3.74 KB
Raw

license

pendulum.js

This library provides additional typing information for user to access Pendulum's modules by using polkadot.js

Getting Started

  • Install dependencies

📝NOTE: @polkadot/api version is pinned

yarn add @polkadot/api @pendulum-chain/api
  • Create API instance
import {ApiPromise} from '@polkadot/api';
import {WsProvider} from '@polkadot/rpc-provider';
import {options} from '@pendulum-chain/api';

async function main() {
  const provider = new WsProvider('ws://localhost:9944');
  // OR
  // const provider = new WsProvider('wss://shiden.api.onfinality.io/public-ws');
  const api = new ApiPromise(options({provider}));
  await api.isReady;

  // Use the api
  // For example:
  console.log((await api.rpc.system.properties()).toHuman());

  process.exit(0);
}

main()
  • Use api to interact with node.
// query and display account data
const data = await api.query.system.account('5F98oWfz2r5rcRVnP9VCndg33DAAsky3iuoBSpaPUbgN9AJn');
console.log(data.toHuman())

Packages

  • api
    • Contains necessary options to create a polkadot.js API instance
  • api-derive
    • Contains utility classes and derived methods.
  • types-definitions
    • Polkadot.js type definitions for Pendulum Network.
  • types
    • Polkadot.js type definitions for Pendulum Network.
  • sdk-core
    • core api libraries
  • precomplies
    • precomplied contracts abi

How-to

Update polkadot libraries

yarn up @polkadot/api @polkadot/api-augment @polkadot/api-derive @polkadot/rpc-core @polkadot/types @polkadot/types-codec

or manually replace all @polkadot dependencies in the package.json files with the latest version.

Afterward, run the following command to get rid of any duplicate dependencies:

yarn dedupe

Update the type definitions of this package

To update the type definitions of this package, you need to first fetch the metadata from your target chain:

# To use the metadata from a live-chain use
yarn update-metadata
# To use the metadata from a local node use
yarn update-metadata-local

and then run the following command to build the type definitions based on that metadata:

yarn build

Note: When you encounter compilation issues while building, you sometimes have to re-add the custom type definitions in packages/type-definitions/src/vaultRegistry.ts. To do so, just find the latest type definitions in packages/types/src/lookup/pendulum.ts (after building, since some files will already be re-built) and copy-paste them into the types key in packages/type-definitions/src/vaultRegistry.ts.

Publishing package updates to npm

This project uses yarn for package management. To publish a new version of the package, you can follow these steps.

After you have made the changes you want to publish, you need to bump the version of the package. You can do this by running:

# For a major version bump
yarn update-version-major
# For a minor version bump
yarn update-version-minor
# For a patch version bump
yarn update-version-patch

Next, you need to build the package and publish it to npm. To be able to publish the package, you need to be a member of the @pendulum-chain organization on npm. You also need to generate and add an access token on npmjs.com. Then, provide the token you generated to yarn and publish the packages by running:

NPM_TOKEN=YOUR_NPM_TOKEN yarn publish

Finally, you should push the changes to the remote repository. You can do this by running:

git push