# bttcjs

> Javascript developer library for interacting with Bttc Network

Latest version **1.0.2** (published 2021-11-09) · MIT license · 0 weekly downloads

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

## Install

```sh
npm install bttcjs
pnpm add bttcjs
yarn add bttcjs
bun add bttcjs
```

## Health

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

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2021-11-09 |
| First published | 2021-11-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=8.0.0 |
| Dependencies | 13 |
| Unpacked size | 51.7 MB |
| Known vulnerabilities | 0 (+24 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Ray Wu |
| Maintainers | bttcprotocol |
| Keywords | ethereum, web3, ethers, bttc |

## Links

- npm: https://www.npmjs.com/package/bttcjs
- Repository: https://github.com/bttcprotocol/js-sdk
- Homepage: https://github.com/bttcprotocol/js-sdk#readme
- Issues: https://github.com/bttcprotocol/js-sdk/issues
- npm.io page: https://npm.io/package/bttcjs

## Dependencies (13)

- [web3](https://npm.io/package/web3.md) ^1.3.0
- [axios](https://npm.io/package/axios.md) ^0.21.1
- [bn.js](https://npm.io/package/bn.js.md) 5.0.0
- [debug](https://npm.io/package/debug.md) ^4.1.1
- [console](https://npm.io/package/console.md) ^0.7.2
- [tronweb](https://npm.io/package/tronweb.md) ^4.0.0
- [eth-sig-util](https://npm.io/package/eth-sig-util.md) ^2.5.3
- [query-string](https://npm.io/package/query-string.md) 6.8.1
- [ethereumjs-tx](https://npm.io/package/ethereumjs-tx.md) 1.3.7
- [ethereumjs-util](https://npm.io/package/ethereumjs-util.md) ^5.2.0
- [ethereumjs-block](https://npm.io/package/ethereumjs-block.md) 2.2.0
- [@maticnetwork/meta](https://npm.io/package/@maticnetwork/meta.md) ^2.4.16
- [merkle-patricia-tree](https://npm.io/package/merkle-patricia-tree.md) 2.3.2

## Recent versions

- 1.0.2 (latest) — 2021-11-09
- 1.0.1 — 2021-11-02

## README

# Bttc SDK

This repository contains the `bttcjs` client library. `bttcjs` makes it easy for developers, who may not be deeply familiar with smart contract development, to interact with the various components of Bttc Network.

This library will help developers to move assets from Ethereum chain / TRON chain / BSC chian to Bttc chain, and withdraw from Bttc to them using fraud proofs.

We will be improving this library to make all features available like Plasma Faster Exit, challenge exit, finalize exit and more.

## Development

**Setup**

```bash
npm ci
```

**How to debug**

Write your code inside file `test/debug.js` and run below code

```bash
npm run debug
```

Above command will build the source code & install the builded version into test folder, which will be used by `debug.js`.

**Lint**

```bash
# To check lint errors
npm run lint

# To fix most common lint errors
# Note that it might not fix all errors, some need manual intervention
npm run lint:fix
```

**Build code**

```bash
npm run build
```

**Run test**

```bash
npm run test
```

**Generate distribution files**

```bash
npm run deploy
```

**NPM publish**

Before running publish script, make sure you have updated version properly.

Note that `prepublishOnly` script will be automatically called while publishing. It will check lint, clean dist/lib folders and build fresh distribution files before it executes `npm publish`.

```bash
npm publish
```

### License

MIT

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