> ## Documentation Index
> Fetch the complete documentation index at: https://ton.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# TonWeb JavaScript SDK

> JavaScript SDK for The Open Network

<Note> The source code can be found [here](https://github.com/toncenter/tonweb).</Note>

[![NPM](https://img.shields.io/npm/v/tonweb.svg)](https://www.npmjs.org/package/tonweb)

## Install Web

```bash theme={null}
npm install tonweb
# or
yarn add tonweb
```

```js theme={null}
import TonWeb from "tonweb";

const tonweb = new TonWeb();
```

or

```html theme={null}
<script src="tonweb.js"></script>
<script>
  const tonweb = new window.TonWeb();
</script>
```

## Install NodeJS

```bash theme={null}
npm install tonweb
# or
yarn add tonweb
```

```js theme={null}
const TonWeb = require('tonweb');

const tonweb = new TonWeb();
```

## Overview example

```js theme={null}
const tonweb = new TonWeb();

const wallet = tonweb.wallet.create({publicKey});

const address = await wallet.getAddress();

const nonBounceableAddress = address.toString(true, true, false);

const seqno = await wallet.methods.seqno().call();

await wallet.deploy(secretKey).send(); // deploy wallet to blockchain

const fee = await wallet.methods.transfer({
    secretKey,
    toAddress: 'EQDjVXa_oltdBP64Nc__p397xLCvGm2IcZ1ba7anSW0NAkeP',
    amount: TonWeb.utils.toNano(0.01), // 0.01 TON
    seqno: seqno,
    payload: 'Hello',
    sendMode: 3,
}).estimateFee();

const Cell = TonWeb.boc.Cell;
const cell = new Cell();
cell.bits.writeUint(0, 32);
cell.bits.writeAddress(address);
cell.bits.writeGrams(1);
console.log(cell.print()); // print cell data like Fift
const bocBytes = cell.toBoc();

const history = await tonweb.getTransactions(address);

const balance = await tonweb.getBalance(address);

tonweb.sendBoc(bocBytes);
```

## API

By default, mainnet [toncenter.com](https://toncenter.com) API is used.\
Note: without the API key, request rate limits apply.

You can start your own TON HTTP API instance (it's [open source](https://github.com/toncenter/ton-http-api)).

### Use mainnet TonCenter API with high ratelimit API key:

```js theme={null}
const tonweb = new TonWeb(new TonWeb.HttpProvider('https://toncenter.com/api/v2/jsonRPC', {
  apiKey: 'YOUR_MAINNET_TONCENTER_API_KEY'
}));
```

### Use testnet TonCenter API with high ratelimit API key:

```js theme={null}
const tonweb = new TonWeb(new TonWeb.HttpProvider('https://testnet.toncenter.com/api/v2/jsonRPC', {
  apiKey: 'YOUR_TESTNET_TONCENTER_API_KEY'
}));
```

## Documentation

Each part is documented separately:

* [tonweb](https://github.com/toncenter/tonweb/blob/master/src/README.md)
* [tonweb-contract-wallet](https://github.com/toncenter/tonweb/blob/master/src/contract/wallet/README.md)
* [tonweb-contract](https://github.com/toncenter/tonweb/blob/master/src/contract/README.md)
* [tonweb-boc](https://github.com/toncenter/tonweb/blob/master/src/boc/README.md)
* [tonweb-utils](https://github.com/toncenter/tonweb/blob/master/src/utils/README.md)

> ℹ️ JSDoc is used throughout the codebase.

## Roadmap

1. Unit-tests
2. TypeScript support

## Build

```bash theme={null}
npm install
npm run build
```

## Use as alternative to Fift for building binary messages to smart-contracts

```bash theme={null}
npm install -g tonweb
export NODE_PATH=$(npm root --quiet -g)
```

Then create your `your_script.js`:

```js theme={null}
const TonWeb = require('tonweb');
const tonweb = new TonWeb();

// Your code here...
```

Run the script:

```bash theme={null}
node your_script.js
```