# @unfinishedlabs/sdk

> SDK Library for the DSNP

Latest version **0.0.1** (published 2021-04-15) · CC-BY-SA-4.0 license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install @unfinishedlabs/sdk
pnpm add @unfinishedlabs/sdk
yarn add @unfinishedlabs/sdk
bun add @unfinishedlabs/sdk
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2021-04-15 |
| First published | 2021-04-12 |
| Weekly downloads | 0 |
| License | CC-BY-SA-4.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=14.15.5 |
| Dependencies | 3 |
| Unpacked size | 160.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 9 |
| Maintainers | unfinished-releases, claireolmstead, wilwade, scott_b_unf |

## Links

- npm: https://www.npmjs.com/package/@unfinishedlabs/sdk
- Repository: https://github.com/LibertyDSNP/sdk-ts
- Homepage: https://github.com/LibertyDSNP/sdk-ts#readme
- Issues: https://github.com/LibertyDSNP/sdk-ts/issues
- npm.io page: https://npm.io/package/@unfinishedlabs/sdk

## Dependencies (3)

- [web3](https://npm.io/package/web3.md) ^1.3.4
- [js-sha3](https://npm.io/package/js-sha3.md) ^0.8.0
- [node-fetch](https://npm.io/package/node-fetch.md) ^2.6.1

## Recent versions

- 0.0.1 (latest) — 2021-04-15
- 0.0.0-6ddc15 (next) — 2021-05-05
- 0.0.0-3341a9 — 2021-05-04
- 0.0.0-9cf245 — 2021-04-30
- 0.0.0-ab32a9 — 2021-04-26
- 0.0.0-fe618e — 2021-04-23
- 0.0.0-de1cda — 2021-04-15
- 0.0.0-797ba2 — 2021-04-12
- 0.0.0-4b9f6c — 2021-04-12

## README

# 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](https://libertydsnp.github.io/sdk-ts/) 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`

---
_Source: https://npm.io/package/@unfinishedlabs/sdk · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._