# sandbox.lib.js

> A simple shim to override the standard AttachToTangle behaviour of the iota.lib.js library to use a sandbox.

Latest version **0.0.1** (published 2018-02-13) · 0 weekly downloads

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

## Install

```sh
npm install sandbox.lib.js
pnpm add sandbox.lib.js
yarn add sandbox.lib.js
bun add sandbox.lib.js
```

## Health

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

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2018-02-13 |
| First published | 2018-02-13 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 40.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Lewis Freiberg |
| Maintainers | lewi |
| Keywords | iota, sandbox, library-shim, javascript |

## Links

- npm: https://www.npmjs.com/package/sandbox.lib.js
- npm.io page: https://npm.io/package/sandbox.lib.js

## Dependencies (1)

- [node-fetch](https://npm.io/package/node-fetch.md) ^2.0.0

## Recent versions

- 0.0.1 (latest) — 2018-02-13

## README

# Sandbox - IOTA.js Library Shim

This library is used to shim the [iota.lib.js](https://github.com/iotaledger/iota.lib.js) library to allow for it to be used with the Sandbox. This enables for users to offload PoW from web user or small devices without capabilities. 

This library has been constructed for [this sandbox application](#). 

## Basic Usage

The library exposes one function, which your require or import. This function is used to overlay sandbox functionality to your current `iota.lib.js` instance.

```javascript
// Import the Sanbox Monkey Patch for the IOTA lib
const sandboxPatch = require('sandbox.lib.js')

// Patch the current IOTA instance
sandboxPatch(iota, `https://sandbox.testnet.iota.org`, 500, `sdkd...sdaa`)
```

1. **iota**: `Object` The `iota.lib.js` instance in your application
2. **url**: `String` URL of the sandbox you wish to use
3. **delay**: `Integer` Milliseconds to wait before checking for PoW update. *Null value defaults to 1000*
4. **key**: `String` API key used to raise the un-authenticated API limits. *Optional*

## API Key

In order to receive an API you should go to the following URL to receive an API for the IOTA Testnet: 

```bash
https://sandbox.testnet.iota.org
```



If you are running your own sandbox, please generate a token from the appropriate sources

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