DSNP TypeScript SDK
Easy to use SDK for the DSNP
Quick Start
npm install @unfinishedlabs/sdk
- Import:
import * as dsnp from "@unfinishedlabs/sdk";
import { Announcement } from "@unfinishedlabs/sdk";
import { batch } from "@unfinishedlabs/sdk/Announcement";
- Require:
const dsnp = require("@unfinishedlabs/sdk");
const { Announcement } = require("@unfinishedlabs/sdk");
const { batch } = require("@unfinishedlabs/sdk/Announcement");
Documentation
See Documentation or generate documentation locally via npm run doc
.
How to Install
Run npm install @unfinishedlabs/sdk
How to Build
Run npm run build
How to Compile Documentation
Documentation is deployed on merge to main to GitHub Pages: https://libertydsnp.github.io/sdk-ts/
- Run
npm run doc
for HTML documentation - Run
npm run doc:json
for JSON documentation - Run
npm run doc:markdown
for markdown documentation (published with the npm package)
Environment Variables
Name | Description |
---|---|
RPC_URL | url of node to make calls to |
BATCH_CONTRACT_ADDRESS | Address of contract on chain you are calling to |
TESTING_PRIVATE_KEY | Only used in testing - private key of account you are sending transactions from |
How to Test
Run npm run test