# API Reference

### API Reference

#### Table of Contents

| Class                                                 | Description                                  | Methods                                              |
| ----------------------------------------------------- | -------------------------------------------- | ---------------------------------------------------- |
| [WalletManagerTon](#walletmanagerton)                 | Main class for managing TON wallets          | [Constructor](#constructor), [Methods](#methods)     |
| [WalletAccountTon](#walletaccountton)                 | Individual TON wallet account implementation | [Constructor](#constructor-1), [Methods](#methods-1) |
| [WalletAccountReadOnlyTon](#walletaccountreadonlyton) | Read-only TON wallet account                 | [Constructor](#constructor-2), [Methods](#methods-2) |

#### WalletManagerTon

The main class for managing TON wallets.\
Extends `WalletManager` from `@tetherto/wdk-wallet`.

**Constructor**

```javascript
new WalletManagerTon(seed, config)
```

**Parameters:**

* `seed` (string | Uint8Array): BIP-39 mnemonic seed phrase or seed bytes
* `config` (object, optional): Configuration object
  * `tonClient` (object | TonClient, optional): TON client configuration or instance
    * `url` (string): TON Center API URL (e.g., '<https://toncenter.com/api/v3>')
    * `secretKey` (string, optional): API key for TON Center
  * `transferMaxFee` (number | bigint, optional): Maximum fee amount for transfer operations (in nanotons)

**Example:**

```javascript
const wallet = new WalletManagerTon(seedPhrase, {
  tonClient: {
    url: 'https://toncenter.com/api/v3',
    secretKey: 'your-api-key'
  },
  transferMaxFee: 1000000000 // Maximum fee in nanotons (1 TON)
})
```

**Methods**

| Method                   | Description                                                      | Returns                                   |
| ------------------------ | ---------------------------------------------------------------- | ----------------------------------------- |
| `getAccount(index)`      | Returns a wallet account at the specified index                  | `Promise<WalletAccountTon>`               |
| `getAccountByPath(path)` | Returns a wallet account at the specified BIP-44 derivation path | `Promise<WalletAccountTon>`               |
| `getFeeRates()`          | Returns current fee rates for transactions                       | `Promise<{normal: bigint, fast: bigint}>` |
| `dispose()`              | Disposes all wallet accounts, clearing private keys from memory  | `void`                                    |

**`getAccount(index)`**

Returns a wallet account at the specified index.

**Parameters:**

* `index` (number, optional): The index of the account to get (default: 0)

**Returns:** `Promise<WalletAccountTon>` - The wallet account

**Example:**

```javascript
const account = await wallet.getAccount(0)
```

**`getAccountByPath(path)`**

Returns a wallet account at the specified BIP-44 derivation path.

**Parameters:**

* `path` (string): The derivation path (e.g., "0'/0/0")

**Returns:** `Promise<WalletAccountTon>` - The wallet account

**Example:**

```javascript
const account = await wallet.getAccountByPath("0'/0/1")
```

**`getFeeRates()`**

Returns current fee rates for normal and fast transactions.

**Returns:** `Promise<FeeRates>` - Object containing normal and fast fee rates (as `bigint` values)

**Example:**

```javascript
const feeRates = await wallet.getFeeRates()
console.log('Normal fee rate:', feeRates.normal, 'nanotons')
console.log('Fast fee rate:', feeRates.fast, 'nanotons')
```

**`dispose()`**

Disposes all wallet accounts, clearing private keys from memory.

**Example:**

```javascript
wallet.dispose()
```

**Properties**

**`seed`**

The wallet's seed bytes.

**Type:** `Uint8Array`

**Example:**

```javascript
console.log('Seed:', wallet.seed)
```

#### WalletAccountTon

Individual TON wallet account implementation. Extends `WalletAccountReadOnlyTon` and implements `IWalletAccount`.

**Constructor**

```javascript
new WalletAccountTon(seed, path, config)
```

**Parameters:**

* `seed` (string | Uint8Array): BIP-39 mnemonic seed phrase or seed bytes
* `path` (string): BIP-44 derivation path (e.g., "0'/0/0")
* `config` (object, optional): Configuration object
  * `tonClient` (object | TonClient, optional): TON client configuration or instance
    * `url` (string): TON Center API URL
    * `secretKey` (string, optional): API key for TON Center
  * `transferMaxFee` (number | bigint, optional): Maximum fee amount for transfer operations

**Example:**

```javascript
const account = new WalletAccountTon(seedPhrase, "0'/0/0", {
  tonClient: {
    url: 'https://toncenter.com/api/v3',
    secretKey: 'your-api-key'
  },
  transferMaxFee: 10000000 // Maximum fee in nanotons (e.g., 0.01 TON)
})
```

**Methods**

| Method                          | Description                                                    | Returns                                |
| ------------------------------- | -------------------------------------------------------------- | -------------------------------------- |
| `getAddress()`                  | Returns the account's TON address                              | `Promise<string>`                      |
| `sign(message)`                 | Signs a message using the account's private key                | `Promise<string>`                      |
| `verify(message, signature)`    | Verifies a message signature                                   | `Promise<boolean>`                     |
| `sendTransaction(tx)`           | Sends a TON transaction                                        | `Promise<{hash: string, fee: bigint}>` |
| `quoteSendTransaction(tx)`      | Estimates the fee for a TON transaction                        | `Promise<{fee: bigint}>`               |
| `transfer(options)`             | Transfers Jetton tokens to another address                     | `Promise<{hash: string, fee: bigint}>` |
| `quoteTransfer(options)`        | Estimates the fee for a Jetton transfer                        | `Promise<{fee: bigint}>`               |
| `getBalance()`                  | Returns the native TON balance (in nanotons)                   | `Promise<bigint>`                      |
| `getTokenBalance(tokenAddress)` | Returns the balance of a specific Jetton token                 | `Promise<bigint>`                      |
| `getTransactionReceipt(hash)`   | Returns a transaction's receipt                                | \`Promise\<TonTransactionReceipt       |
| `toReadOnlyAccount()`           | Returns a read-only copy of the account                        | `Promise<WalletAccountReadOnlyTon>`    |
| `dispose()`                     | Disposes the wallet account, clearing private keys from memory | `void`                                 |

**`getAddress()`**

Returns the account's address.

**Returns:** `Promise<string>` - The account's TON address

**Example:**

```javascript
const address = await account.getAddress()
console.log('Account address:', address)
```

**`sign(message)`**

Signs a message using the account's private key.

**Parameters:**

* `message` (string): The message to sign

**Returns:** `Promise<string>` - The message signature

**Example:**

```javascript
const signature = await account.sign('Hello, World!')
console.log('Signature:', signature)
```

**`verify(message, signature)`**

Verifies a message signature.

**Parameters:**

* `message` (string): The original message
* `signature` (string): The signature to verify

**Returns:** `Promise<boolean>` - True if the signature is valid

**Example:**

```javascript
const isValid = await account.verify('Hello, World!', signature)
console.log('Signature valid:', isValid)
```

**`sendTransaction(tx)`**

Sends a TON transaction and returns the result with hash and fee.

**Parameters:**

* `tx` (object): The transaction object
  * `to` (string): Recipient TON address (e.g., 'EQ...')
  * `value` (number | bigint): Amount in nanotons (1 TON = 1,000,000,000 nanotons)
  * `bounceable` (boolean, optional): Whether the address is bounceable (TON-specific, optional)
  * `body` (string | Cell, optional): Optional message body

**Returns:** `Promise<{hash: string, fee: bigint}>` - Object containing hash and fee (in nanotons)

**Example:**

```javascript
const result = await account.sendTransaction({
  to: 'EQ...', // TON address
  value: 1000000000 // 1 TON in nanotons
});
console.log('Transaction hash:', result.hash);
console.log('Transaction fee:', result.fee, 'nanotons');
```

**`quoteSendTransaction(tx)`**

Estimates the fee for a transaction.

**Parameters:**

* `tx` (object): The transaction object (same as sendTransaction)
  * `to` (string): Recipient TON address (e.g., 'EQ...')
  * `value` (number | bigint): Amount in nanotons (1 TON = 1,000,000,000 nanotons)
  * `bounceable` (boolean, optional): Whether the address is bounceable (TON-specific, optional)
  * `body` (string | Cell, optional): Optional message body

**Returns:** `Promise<{fee: bigint}>` - Object containing fee estimate (in nanotons)

**Example:**

```javascript
const quote = await account.quoteSendTransaction({
  to: 'EQ...', // TON address
  value: 1000000000 // 1 TON in nanotons
});
console.log('Estimated fee:', quote.fee, 'nanotons');
```

**`transfer(options)`**

Transfers Jettons (TON tokens) to another address.

**Parameters:**

* `options` (object): Transfer options
  * `token` (string): Jetton master contract address (TON format, e.g., 'EQ...')
  * `recipient` (string): Recipient TON address (e.g., 'EQ...')
  * `amount` (number | bigint): Amount in Jetton's base units

**Returns:** `Promise<{hash: string, fee: bigint}>` - Object containing hash and fee (in nanotons)

**Example:**

```javascript
const result = await account.transfer({
  token: 'EQ...',      // Jetton master contract address
  recipient: 'EQ...',  // Recipient's TON address
  amount: 1000000000    // Amount in Jetton's base units
});
console.log('Transfer hash:', result.hash);
console.log('Transfer fee:', result.fee, 'nanotons');
```

**`quoteTransfer(options)`**

Estimates the fee for a Jetton (TON token) transfer.

**Parameters:**

* `options` (object): Transfer options (same as transfer)
  * `token` (string): Jetton master contract address (TON format, e.g., 'EQ...')
  * `recipient` (string): Recipient TON address (e.g., 'EQ...')
  * `amount` (number | bigint): Amount in Jetton's base units

**Returns:** `Promise<{fee: bigint}>` - Object containing fee estimate (in nanotons)

**Example:**

```javascript
const quote = await account.quoteTransfer({
  token: 'EQ...',      // Jetton master contract address
  recipient: 'EQ...',  // Recipient's TON address
  amount: 1000000000    // Amount in Jetton's base units
});
console.log('Transfer fee estimate:', quote.fee, 'nanotons');
```

**`getBalance()`**

Returns the native TON balance (in nanotons).

**Returns:** `Promise<bigint>` - Balance in nanotons

**Example:**

```javascript
const balance = await account.getBalance();
console.log('Balance:', balance, 'nanotons');
```

**`getTokenBalance(tokenAddress)`**

Returns the balance of a specific Jetton (TON token).

**Parameters:**

* `tokenAddress` (string): The Jetton master contract address (TON format, e.g., 'EQ...')

**Returns:** `Promise<bigint>` - Token balance in base units

**Example:**

```javascript
const tokenBalance = await account.getTokenBalance('EQ...');
console.log('Token balance:', tokenBalance, 'nanotons');
```

**`getTransactionReceipt(hash)`**

Returns a transaction's receipt if it has been mined.

**Parameters:**

* `hash` (string): The transaction hash

**Returns:** `Promise<TonTransactionReceipt | null>` - Transaction receipt or null if not yet mined

**Example:**

```javascript
const receipt = await account.getTransactionReceipt('EQ...')
console.log('Transaction confirmed:', receipt.success)
```

**`toReadOnlyAccount()`**

Returns a read-only copy of the account.

**Returns:** `Promise<WalletAccountReadOnlyTon>` - The read-only account

**Example:**

```javascript
const readOnlyAccount = await account.toReadOnlyAccount()
const address = await readOnlyAccount.getAddress()
console.log('Read-only account address:', address)
```

**`dispose()`**

Disposes the wallet account, clearing private keys from memory.

**Example:**

```javascript
account.dispose()
```

**Properties**

| Property  | Type                                                      | Description                                 |
| --------- | --------------------------------------------------------- | ------------------------------------------- |
| `index`   | `number`                                                  | The derivation path's index of this account |
| `path`    | `string`                                                  | The full derivation path of this account    |
| `keyPair` | `{publicKey: Uint8Array, privateKey: Uint8Array \| null}` | The account's public and private key pair   |

**Example:**

```javascript
const { publicKey, privateKey } = account.keyPair
console.log('Public key length:', publicKey.length)
console.log('Private key length:', privateKey.length)
```

#### WalletAccountReadOnlyTon

Read-only TON wallet account. Extends `WalletAccountReadOnly` from `@tetherto/wdk-wallet`.

**Constructor**

```javascript
new WalletAccountReadOnlyTon(publicKey, config)
```

**Parameters:**

* `publicKey` (string | Uint8Array): The account's public key
* `config` (object, optional): Configuration object (`Omit<TonWalletConfig, 'transferMaxFee'>`)
  * `tonClient` (object | TonClient, optional): TON client configuration or instance
    * `url` (string): TON Center API URL
    * `secretKey` (string, optional): API key for TON Center

**Example:**

```javascript
const readOnlyAccount = new WalletAccountReadOnlyTon(publicKey, {
  tonClient: {
    url: 'https://toncenter.com/api/v3',
    secretKey: 'your-api-key'
  }
})
```

**Methods**

| Method                          | Description                                    | Returns                                  |
| ------------------------------- | ---------------------------------------------- | ---------------------------------------- |
| `getAddress()`                  | Returns the account's TON address              | `Promise<string>`                        |
| `verify(message, signature)`    | Verifies a message signature                   | `Promise<boolean>`                       |
| `getBalance()`                  | Returns the native TON balance (in nanotons)   | `Promise<bigint>`                        |
| `getTokenBalance(tokenAddress)` | Returns the balance of a specific Jetton token | `Promise<bigint>`                        |
| `quoteSendTransaction(tx)`      | Estimates the fee for a TON transaction        | `Promise<{fee: bigint}>`                 |
| `quoteTransfer(options)`        | Estimates the fee for a Jetton transfer        | `Promise<{fee: bigint}>`                 |
| `getTransactionReceipt(hash)`   | Returns a transaction's receipt                | `Promise<TonTransactionReceipt \| null>` |

**`getAddress()`**

Returns the account's address.

**Returns:** `Promise<string>` - The account's TON address

**Example:**

```javascript
const address = await readOnlyAccount.getAddress()
console.log('Account address:', address)
```

**`verify(message, signature)`**

Verifies a message signature.

**Parameters:**

* `message` (string): The original message
* `signature` (string): The signature to verify

**Returns:** `Promise<boolean>` - True if the signature is valid

**Example:**

```javascript
const isValid = await readOnlyAccount.verify('Hello, World!', signature)
console.log('Signature valid:', isValid)
```

**`getBalance()`**

Returns the native TON balance (in nanotons).

**Returns:** `Promise<bigint>` - Balance in nanotons

**Example:**

```javascript
const balance = await readOnlyAccount.getBalance()
console.log('Balance:', balance, 'nanotons')
```

**`getTokenBalance(tokenAddress)`**

Returns the balance of a specific Jetton (TON token).

**Parameters:**

* `tokenAddress` (string): The Jetton master contract address (TON format, e.g., 'EQ...')

**Returns:** `Promise<bigint>` - Token balance in base units

**Example:**

```javascript
const tokenBalance = await readOnlyAccount.getTokenBalance('EQ...')
console.log('Token balance:', tokenBalance)
```

**`quoteSendTransaction(tx)`**

Estimates the fee for a transaction.

**Parameters:**

* `tx` (object): The transaction object
  * `to` (string): Recipient TON address
  * `value` (number | bigint): Amount in nanotons
  * `bounceable` (boolean, optional): Whether the address is bounceable
  * `body` (string | Cell, optional): Optional message body

**Returns:** `Promise<{fee: bigint}>` - Object containing fee estimate (in nanotons)

**Example:**

```javascript
const quote = await readOnlyAccount.quoteSendTransaction({
  to: 'EQ...',
  value: 1000000000
})
console.log('Estimated fee:', quote.fee, 'nanotons')
```

**`quoteTransfer(options)`**

Estimates the fee for a Jetton (TON token) transfer.

**Parameters:**

* `options` (object): Transfer options
  * `token` (string): Jetton master contract address
  * `recipient` (string): Recipient TON address
  * `amount` (number | bigint): Amount in Jetton's base units

**Returns:** `Promise<{fee: bigint}>` - Object containing fee estimate (in nanotons)

**Example:**

```javascript
const quote = await readOnlyAccount.quoteTransfer({
  token: 'EQ...',
  recipient: 'EQ...',
  amount: 1000000000
})
console.log('Transfer fee estimate:', quote.fee, 'nanotons')
```

**`getTransactionReceipt(hash)`**

Returns a transaction's receipt if it has been mined.

**Parameters:**

* `hash` (string): The transaction hash

**Returns:** `Promise<TonTransactionReceipt | null>` - Transaction receipt or null if not yet mined

**Example:**

```javascript
const receipt = await readOnlyAccount.getTransactionReceipt('EQ...')
console.log('Transaction confirmed:', receipt !== null)
```

### Types

#### TonTransaction

```typescript
interface TonTransaction {
  /**
   * Recipient's TON address in base64 format
   * @example 'EQD4FPq...'
   */
  to: string;

  /**
   * Amount to send in nanotons (1 TON = 1,000,000,000 nanotons)
   * @example 1000000000 // 1 TON
   */
  value: number | bigint;

  /**
   * Whether the destination address is bounceable
   */
  bounceable?: boolean;

  /**
   * Optional message body
   */
  body?: string | Cell;
}
```

#### TransferOptions

```typescript
interface TransferOptions {
  /**
   * Jetton master contract address
   * @example 'EQD4FPq...'
   */
  token: string;

  /**
   * Recipient's TON address
   * @example 'EQD4FPq...'
   */
  recipient: string;

  /**
   * Amount in Jetton's base units
   * @example 1000000000 // Amount depends on token decimals
   */
  amount: number | bigint;
}
```

#### TransactionResult

```typescript
interface TransactionResult {
  /**
   * Transaction hash in base64 format
   * @example 'EQD4FPq...'
   */
  hash: string;

  /**
   * Transaction fee in nanotons
   * @example 100000n // 0.0001 TON
   */
  fee: bigint;
}
```

#### TransferResult

```typescript
interface TransferResult {
  /**
   * Transfer operation hash
   */
  hash: string;

  /**
   * Transfer fee in nanotons
   */
  fee: bigint;
}
```

#### FeeRates

```typescript
interface FeeRates {
  /**
   * Fee rate for normal priority transactions (in nanotons)
   * @example 100000000n // 0.1 TON
   */
  normal: bigint;

  /**
   * Fee rate for high priority transactions (in nanotons)
   * @example 200000000n // 0.2 TON
   */
  fast: bigint;
}
```

#### KeyPair

```typescript
interface KeyPair {
  /**
   * Ed25519 public key
   */
  publicKey: Uint8Array;

  /**
   * Ed25519 private key (null if the account has been disposed)
   * @security Never expose or log this value
   */
  privateKey: Uint8Array | null;
}
```

#### TonWalletConfig

```typescript
interface TonWalletConfig {
  /**
   * TON Center client configuration or an instance of TonClient
   */
  tonClient?: TonClientConfig | TonClient;

  /**
   * Maximum allowed fee for transfers (in nanotons)
   * @example 1000000000n // 1 TON
   */
  transferMaxFee?: number | bigint;
}
```

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><i class="fa-code">:code:</i></td><td><strong>Node.js Quickstart</strong></td><td>Get started with WDK in a Node.js environment</td><td><a href="../../../start-building/nodejs-bare-quickstart">nodejs-bare-quickstart</a></td></tr><tr><td><i class="fa-mobile-alt">:mobile-alt:</i></td><td><strong>React Native Quickstart</strong></td><td>Build mobile wallets with React Native Expo</td><td><a href="../../../start-building/react-native-quickstart">react-native-quickstart</a></td></tr><tr><td><i class="fa-code">:code:</i></td><td><strong>WDK TON Wallet Usage</strong></td><td>Get started with WDK's TON Wallet Usage</td><td><a href="usage">usage</a></td></tr><tr><td><i class="fa-code">:code:</i></td><td><strong>WDK TON Wallet Configuration</strong></td><td>Get started with WDK's TON Wallet Configuration</td><td><a href="configuration">configuration</a></td></tr></tbody></table>

***

#### Need Help?

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><i class="fa-discord">:discord:</i></td><td><strong>Discord Community</strong></td><td>Connect with developers, ask questions, share your projects</td><td><a href="https://discord.gg/arYXDhHB2w" class="button primary">Join Community</a></td><td><a href="https://discord.gg/arYXDhHB2w">https://discord.gg/arYXDhHB2w</a></td></tr><tr><td><i class="fa-github">:github:</i></td><td><strong>GitHub Issues</strong></td><td>Report bugs, request features, and get technical help</td><td><a href="https://github.com/tetherto/wdk-core" class="button secondary">Open an Issue</a></td><td><a href="https://github.com/tetherto/wdk-core">https://github.com/tetherto/wdk-core</a></td></tr><tr><td><i class="fa-envelope">:envelope:</i></td><td><strong>Email Contact</strong></td><td>For sensitive or private matters, contact our team directly</td><td><a href="mailto:wallet-info.tether.io" class="button secondary">Send an email</a></td><td><a href="mailto:wallet-info.tether.io">mailto:wallet-info.tether.io</a></td></tr></tbody></table>