# polycode-sdk

> Polycode SDK

Latest version **1.0.3** (published 2023-11-08) · ISC license · 0 weekly downloads

## Install

```sh
npm install polycode-sdk
pnpm add polycode-sdk
yarn add polycode-sdk
bun add polycode-sdk
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2023-11-08 |
| First published | 2023-11-06 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 7.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | polycodesh |

## Links

- npm: https://www.npmjs.com/package/polycode-sdk
- Repository: https://github.com/0xPolycode/polycode-sdk
- Homepage: https://github.com/0xPolycode/polycode-sdk#readme
- Issues: https://github.com/0xPolycode/polycode-sdk/issues
- npm.io page: https://npm.io/package/polycode-sdk

## Dependencies (1)

- [dev3-sdk](https://npm.io/package/dev3-sdk.md) ^0.0.31

## Recent versions

- 1.0.3 (latest) — 2023-11-08
- 1.0.2 — 2023-11-06
- 1.0.1 — 2023-11-06
- 1.0.0 — 2023-11-06

## README

# Polycode SDK (TypeScript)

This SDK provides the support the Polycode platform via various functions exposed through the SDK package;
you can easily integrate the SDK to existing web projects regardless of the technology stack being used.

Polycode SDK speeds up blockchain application development by abstracting away complexities such as wallet management,
transaction building, processing, and smart contract interactions.

The simplest way to start using the SDK is to run the following command in your project's root directory:

```shell
$ npm install polycode-sdk
```

Then intialize the singleton object inside your application (be it nodejs, browser based, or other) like this:

```javascript
import { PolycodeSDK } from "polycode-sdk";
// or 
const { PolycodeSDK } = require("polycode-sdk")
...
const sdk = new PolycodeSDK("your-api-key", "your-project-id"); 
```

`"your-api-key"` and `"your-project-id"` values can be found on your project details page
on the [polycode platform](https://app.polycode.sh/).

## Build

Update your environment to NodeJS v16 before running the steps below.

To clone and build the project, run the following command in your terminal:

```code
$ git clone https://github.com/0xpolycode/polycode-sdk

$ npm install
 
$ npm run build
```

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