@dsnp/sdk NPM | npm.io

DSNP TypeScript SDK

Easy to use SDK for the DSNP

Quick Start

Install the package

First, install the SDK package with the following command:

npm install @dsnp/sdk

Configure the SDK

Configuration File

Next, add a dsnp.config.js file to your project's root directory. For ethers, the following contents will work:

var ethers = require("ethers");

var provider = new ethers.providers.JsonRpcProvider("<ETH NODE HTTP ADDRESS>");
var signer = new ethers.Wallet("<ETH PRIVATE KEY>", provider);

module.exports = {
  signer: signer,
  provider: provider
};

Runtime Configuration

Alternatively, the configuration can be set at runtime with the following:

var config = require("@dsnp/sdk/Config");

config
  .setConfig({
    signer: signer,
    provider: provider
  })
  .then(function () {
    // Do something with the SDK
  });

Usage

Once the SDK is installed and configured, the following code can be used to post a batch on the chain:

var announcement = require("@dsnp/sdk/Announcement");

announcement.batch([{ hash, uri, dsnpType }]);

Documentation

See Documentation or generate documentation locally via npm run doc.

How to Install

Run npm install @dsnp/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

Check out the contracts repo and follow the instructions to start a hardhat test node and deploy the contracts.

In the SDK create a .env file with the following content.

RPC_URL=http://localhost:8545
TESTING_PRIVATE_KEY=ac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80

Replace the value of TESTING_PRIVATE_KEY with the value of LOCAL_NETWORK_ACCOUNT_PRIVATE_KEY in the .env from the contracts repo, or use what is in .github/workflows/main.yml. It may be same as above.
Ensure that the contracts version you would like to use is the correct version. The version of the @dsnp/contracts package is specified in the package.json
Run npm run test