# dev3-sdk

> SDK for interacting with the 0xDev3 platform.

Latest version **1.0.1** (published 2023-12-21) · ISC license · 0 weekly downloads

## Install

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

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2023-12-21 |
| First published | 2022-09-20 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 4 |
| Unpacked size | 1.8 MB |
| Known vulnerabilities | 0 (+23 in 1 direct dependencies) |
| Install scripts | no |
| Author | Dev3 |
| Maintainers | duimane |
| Keywords | dev3, typescript, dapp builder, api, sdk |

## Links

- npm: https://www.npmjs.com/package/dev3-sdk
- npm.io page: https://npm.io/package/dev3-sdk

## Dependencies (4)

- [axios](https://npm.io/package/axios.md) ^0.27.2
- [dkg.js](https://npm.io/package/dkg.js.md) ^6.0.16
- [@ethersproject/bignumber](https://npm.io/package/@ethersproject/bignumber.md) ^5.7.0
- [polycode-chainlink-feeds](https://npm.io/package/polycode-chainlink-feeds.md) ^1.0.9

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 1.0.1 (latest) — 2023-12-21
- 1.0.0 — 2023-12-21
- 0.0.33 — 2023-12-21
- 0.0.32 — 2023-12-01
- 0.0.31 — 2023-11-08
- 0.0.30 — 2023-11-06
- 0.0.29 — 2023-11-06
- 0.0.28 — 2023-10-12
- 0.0.27 — 2023-10-02
- 0.0.26 — 2023-09-30
- 0.0.25 — 2023-09-29
- 0.0.24 — 2023-09-27
- 0.0.23 — 2023-09-27
- 0.0.22 — 2023-09-27
- 0.0.21 — 2023-09-27
- … 20 more at https://npm.io/package/dev3-sdk/versions

## README

# Dev3 SDK (TypeScript)

SDK built for interacting with the Dev3 platform.
The demo version of the platform is available [here](https://app.dev3.sh/).

The Dev3 platform provides a nice UI to interact with the blockchain, deploy new or import existing smart contracts, and call various smart contract functions with a single click.

This SDK provides the support the Dev3 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. 

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

```shell
$ npm install dev3-sdk
``` 

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

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

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

## Chainlink SDK

### Price Feeds

Using Dev3 SDK automatically provides youaccess to Chainlink Data Feeds. Follow the instructions in the
[Chainlink docs](./docs/chainlink.md).

Take a look at [Example React App](https://github.com/0xDev3/chainlink-sdk-example-react-app) too see how to use Chainlink Dev3 SDK inside your project!

### VRF Subscriptions Management

📕 [Docs](https://docs.dev3.sh/welcome-to-dev3/sdk/chainlink-subscriptions/vrf-subscriptions)

👨🏻‍💻 [Example app (live)](https://chainlink-vrf-subscriptions-example-react-app.vercel.app/)

📑 [Example app (github)](https://github.com/0xDev3/chainlink-vrf-subscriptions-example-react-app)

The example app is running on the Sepolia testnet. You can use the [Chainlink Faucet](https://faucets.chain.link/) to get some test LINK tokens, and the [Ethereum Faucet](https://sepoliafaucet.com/) to get some test ETH.

### Functions Subscriptions Management

📕 [Docs](https://docs.dev3.sh/welcome-to-dev3/sdk/chainlink-subscriptions/functions-subscriptions)

👨🏻‍💻 [Example app (live)](https://chainlink-functions-example-react-app-sigma.vercel.app/)

📑 [Example app (github)](https://github.com/0xDev3/chainlink-functions-example-react-app)

The example app is running on the Sepolia testnet. You can use the [Chainlink Faucet](https://faucets.chain.link/) to get some test LINK tokens, and the [Ethereum Faucet](https://sepoliafaucet.com/) to get some test ETH.

## 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/0xdev3/dev3-sdk

$ npm install
 
$ npm run build
```

## Test

```code
$ npm run test
```

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