1.5.1 • Published 7 months ago

@jpyc/sdk-core v1.5.1

Weekly downloads
-
License
MIT
Repository
github
Last release
7 months ago

JPYC Core SDK

License: MIT build npm version

JPYC core SDK implements NodeJS interfaces to interact with JPYCv2 contracts on different chains. Currently, we're supporting Ethereum, Polygon, Gnosis, Avalanche, Astar and Shiden.

💡 Usage

Please follow the following steps to configure SDK.

1. Installation

Install NPM package.

# yarn
$ yarn add @jpyc/sdk-core
# npm
$ npm i @jpyc/sdk-core

2. Environment Variables

Some data, such as configuration variables (e.g., chain name) or sensitive data (e.g., private key), are embedded as environment variables. You need to set the following environment variables.

VariableDescription & Instructions
SDK_ENVSDK environment. Set to local for local environment or any other sensible name for production environment.
CHAIN_NAMEChain name. Set to one of the following\: local, ethereum, polygon, gnosis, avalanche, astar or shiden.
NETWORK_NAMENetwork name within the specified chain. Set to one of the following\: mainnet, goerli, sepolia, amoy, chiado or fuji
RPC_ENDPOINTRPC endpoint to send transactions.
PRIVATE_KEYPrivate key of an account.
LOCAL_PROXY_ADDRESSProxy contract address in local environment.

3. SDK Instantiation

Initialize an SDK instance.

import {
  ChainName,
  Endpoint,
  IJPYC,
  ISdkClient,
  JPYC,
  NetworkName,
  SdkClient,
} from '@jpyc/sdk-core';

// 1. Initialize an SdkClient instance
const sdkClient: ISdkClient = new SdkClient({
  chainName: process.env.CHAIN_NAME as ChainName,
  networkName: process.env.NETWORK_NAME as NetworkName,
  rpcEndpoint: process.env.RPC_ENDPOINT as Endpoint,
});

// 2. Generate an account from a private key
export const account = sdkClient.createPrivateKeyAccount({});

// 3. Generate a client with the account
export const client = sdkClient.createLocalClient({
  account: account,
});

// 4. Initialize an SDK instance
export const jpyc: IJPYC = new JPYC({
  client: client,
});

4. SDK Usage

Use the initialized SDK wherever you would like.

import { jpyc } from './YOUR/PATH/TO/INITIALIZATION/FILE';

// Fetch `totalSupply` from `JPYCv2` contract
const totalSupply = await jpyc.totalSupply();
console.log(`totalSupply: ${totalSupply.toString()}`);

✨ Code Examples

For your reference, we provide code examples in the separate sdk-examples repository. Please follow the instructions specified in README files.

🤖 Available Commands

The following commands are available as yarn scripts for local development & testing.

CommandDescription
compileCompile (transpile) SDK
testRun unit tests (using jest)
lintRun Eslint
lint:dry-runRun Eslint without fixing
formatRun Prettier
format:dry-runRun Prettier without fixing
docsGenerate developer documents in both Markdown and HTML
docs:mdGenerate developer documents in Markdown
docs:htmlGenerate developer documents in HTML

📚 Documentation

You can find the auto-generated developer documents here.

1.5.1

7 months ago

1.5.0

7 months ago

1.4.2

1 year ago

1.4.1

1 year ago

1.4.0

1 year ago

1.3.0

1 year ago

1.2.0

1 year ago

1.1.0

1 year ago

1.0.0

1 year ago