@ton/ton 16.1.0 → 16.2.1

package/README.md

@@ -30,7 +30,7 @@ To use this library you need HTTP API endpoint, you can use one of the public en
 - Mainnet: https://toncenter.com/api/v2/jsonRPC
 - Testnet: https://testnet.toncenter.com/api/v2/jsonRPC
 
-```js
+```ts
 import { TonClient, WalletContractV4, internal } from "@ton/ton";
 import { mnemonicNew, mnemonicToPrivateKey } from "@ton/crypto";
 
@@ -40,20 +40,22 @@ const client = new TonClient({
 });
 
 // Generate new key
-let mnemonics = await mnemonicNew();
-let keyPair = await mnemonicToPrivateKey(mnemonics);
+const mnemonic = await mnemonicNew();
+const keyPair = await mnemonicToPrivateKey(mnemonic);
 
 // Create wallet contract
-let workchain = 0; // Usually you need a workchain 0
-let wallet = WalletContractV4.create({ workchain, publicKey: keyPair.publicKey });
-let contract = client.open(wallet);
+const wallet = WalletContractV4.create({
+  workchain: 0, // basechain
+  publicKey: keyPair.publicKey,
+});
+const contract = client.open(wallet);
 
 // Get balance
-let balance: bigint = await contract.getBalance();
+const balance = await contract.getBalance();
 
 // Create a transfer
-let seqno: number = await contract.getSeqno();
-let transfer = await contract.createTransfer({
+const seqno = await contract.getSeqno();
+const transfer = await contract.createTransfer({
   seqno,
   secretKey: keyPair.secretKey,
   messages: [internal({
@@ -62,12 +64,46 @@ let transfer = await contract.createTransfer({
     body: 'Hello world',
   })]
 });
+```
+
+## Formatting
+
+We use `biome` as our formatter. It's prettier compatible and fast
+
+IDE Setup: [VSCode](https://marketplace.visualstudio.com/items?itemName=biomejs.biome), [Zed](https://biomejs.dev/reference/zed/)
+
+```sh
+yarn run format
+```
+
+## Testing
+
+### Debugging in tests
+
+By default tests are running using multiple worker threads. It's faster, but
+undesirable during debugging. `SINGLETHREADED` env variable covers this case
+
+```sh
+SINGLETHREADED=1 yarn run test
+```
+
+### Coverage report
+
+We use test coverage to eliminate blind spots in our tests.
+
+#### How to?
+
+The goal is to make all functions runned at least once
+
+1. Build a coverage report
 
+```sh
+yarn run coverage
 ```
 
-## Docs
+2. Coverage report is build to the `/coverage` directory
 
-[Documentation](https://ton-community.github.io/ton/)
+3. Open `/coverage/index.html` to check the report
 
 ## Acknowledgements
 

package/dist/client/TonClient.d.ts

@@ -6,8 +6,8 @@
  * LICENSE file in the root directory of this source tree.
  */
 import { HttpApi } from "./api/HttpApi";
-import { AxiosAdapter } from 'axios';
-import { Address, Cell, Contract, ContractProvider, Message, Transaction, TupleItem, TupleReader, StateInit, OpenedContract } from '@ton/core';
+import { AxiosAdapter } from "axios";
+import { Address, Cell, Contract, ContractProvider, Message, Transaction, TupleItem, TupleReader, StateInit, OpenedContract } from "@ton/core";
 export type TonClientParameters = {
     /**
      * API Endpoint
@@ -65,7 +65,7 @@ export declare class TonClient {
      * @param name name of method
      * @param params optional parameters
      * @returns stack and gas_used field
-    */
+     */
     runMethodWithError(address: Address, name: string, params?: any[]): Promise<{
         gas_used: number;
         stack: TupleReader;
@@ -170,9 +170,9 @@ export declare class TonClient {
         initData: Cell | null;
         ignoreSignature: boolean;
     }): Promise<{
-        '@type': "query.fees";
+        "@type": "query.fees";
         source_fees: {
-            '@type': "fees";
+            "@type": "fees";
             in_fwd_fee: number;
             storage_fee: number;
             gas_fee: number;
@@ -198,7 +198,7 @@ export declare class TonClient {
     getContractState(address: Address): Promise<{
         balance: bigint;
         extra_currencies: {
-            '@type': "extraCurrency";
+            "@type": "extraCurrency";
             id: number;
             amount: string;
         }[] | undefined;

package/dist/client/TonClient.js

@@ -13,12 +13,12 @@ const core_1 = require("@ton/core");
 class TonClient {
     constructor(parameters) {
         this.parameters = {
-            endpoint: parameters.endpoint
+            endpoint: parameters.endpoint,
         };
         this.api = new HttpApi_1.HttpApi(this.parameters.endpoint, {
             timeout: parameters.timeout,
             apiKey: parameters.apiKey,
-            adapter: parameters.httpAdapter
+            adapter: parameters.httpAdapter,
         });
     }
     /**
@@ -39,7 +39,7 @@ class TonClient {
     async runMethod(address, name, stack = []) {
         let res = await this.api.callGetMethod(address, name, stack);
         if (res.exit_code !== 0) {
-            throw Error('Unable to execute get method. Got exit_code: ' + res.exit_code);
+            throw Error("Unable to execute get method. Got exit_code: " + res.exit_code);
         }
         return { gas_used: res.gas_used, stack: parseStack(res.stack) };
     }
@@ -60,10 +60,14 @@ class TonClient {
      * @param name name of method
      * @param params optional parameters
      * @returns stack and gas_used field
-    */
+     */
     async runMethodWithError(address, name, params = []) {
         let res = await this.api.callGetMethod(address, name, params);
-        return { gas_used: res.gas_used, stack: parseStack(res.stack), exit_code: res.exit_code };
+        return {
+            gas_used: res.gas_used,
+            stack: parseStack(res.stack),
+            exit_code: res.exit_code,
+        };
     }
     /**
      * Invoke get method that returns error code instead of throwing error
@@ -85,7 +89,7 @@ class TonClient {
         let tx = await this.api.getTransactions(address, opts);
         let res = [];
         for (let r of tx) {
-            res.push((0, core_1.loadTransaction)(core_1.Cell.fromBoc(Buffer.from(r.data, 'base64'))[0].beginParse()));
+            res.push((0, core_1.loadTransaction)(core_1.Cell.fromBoc(Buffer.from(r.data, "base64"))[0].beginParse()));
         }
         return res;
     }
@@ -99,7 +103,7 @@ class TonClient {
     async getTransaction(address, lt, hash) {
         let res = await this.api.getTransaction(address, lt, hash);
         if (res) {
-            return (0, core_1.loadTransaction)(core_1.Cell.fromBoc(Buffer.from(res.data, 'base64'))[0].beginParse());
+            return (0, core_1.loadTransaction)(core_1.Cell.fromBoc(Buffer.from(res.data, "base64"))[0].beginParse());
         }
         else {
             return null;
@@ -137,7 +141,7 @@ class TonClient {
             workchain: r.init.workchain,
             shard: r.last.shard,
             initSeqno: r.init.seqno,
-            latestSeqno: r.last.seqno
+            latestSeqno: r.last.seqno,
         };
     }
     /**
@@ -149,7 +153,7 @@ class TonClient {
         return r.map((m) => ({
             workchain: m.workchain,
             shard: m.shard,
-            seqno: m.seqno
+            seqno: m.seqno,
         }));
     }
     /**
@@ -161,12 +165,12 @@ class TonClient {
     async getShardTransactions(workchain, seqno, shard) {
         let tx = await this.api.getBlockTransactions(workchain, seqno, shard);
         if (tx.incomplete) {
-            throw Error('Unsupported');
+            throw Error("Unsupported");
         }
         return tx.transactions.map((v) => ({
             account: core_1.Address.parseRaw(v.account),
             lt: v.lt,
-            hash: v.hash
+            hash: v.hash,
         }));
     }
     /**
@@ -174,10 +178,7 @@ class TonClient {
      * @param src source message
      */
     async sendMessage(src) {
-        const boc = (0, core_1.beginCell)()
-            .store((0, core_1.storeMessage)(src))
-            .endCell()
-            .toBoc();
+        const boc = (0, core_1.beginCell)().store((0, core_1.storeMessage)(src)).endCell().toBoc();
         await this.api.sendBoc(boc);
     }
     /**
@@ -193,7 +194,12 @@ class TonClient {
      * @returns
      */
     async estimateExternalMessageFee(address, args) {
-        return await this.api.estimateFee(address, { body: args.body, initCode: args.initCode, initData: args.initData, ignoreSignature: args.ignoreSignature });
+        return await this.api.estimateFee(address, {
+            body: args.body,
+            initCode: args.initCode,
+            initData: args.initData,
+            ignoreSignature: args.ignoreSignature,
+        });
     }
     /**
      * Send external message to contract
@@ -201,10 +207,11 @@ class TonClient {
      * @param src message body
      */
     async sendExternalMessage(contract, src) {
-        if (await this.isContractDeployed(contract.address) || !contract.init) {
+        if ((await this.isContractDeployed(contract.address)) ||
+            !contract.init) {
             const message = (0, core_1.external)({
                 to: contract.address,
-                body: src
+                body: src,
             });
             await this.sendMessage(message);
         }
@@ -212,7 +219,7 @@ class TonClient {
             const message = (0, core_1.external)({
                 to: contract.address,
                 init: contract.init,
-                body: src
+                body: src,
             });
             await this.sendMessage(message);
         }
@@ -223,7 +230,7 @@ class TonClient {
      * @returns true if contract is in active state
      */
     async isContractDeployed(address) {
-        return (await this.getContractState(address)).state === 'active';
+        return (await this.getContractState(address)).state === "active";
     }
     /**
      * Resolves contract state
@@ -237,18 +244,20 @@ class TonClient {
             balance,
             extra_currencies: info.extra_currencies,
             state,
-            code: info.code !== '' ? Buffer.from(info.code, 'base64') : null,
-            data: info.data !== '' ? Buffer.from(info.data, 'base64') : null,
-            lastTransaction: info.last_transaction_id.lt !== '0' ? {
-                lt: info.last_transaction_id.lt,
-                hash: info.last_transaction_id.hash,
-            } : null,
+            code: info.code !== "" ? Buffer.from(info.code, "base64") : null,
+            data: info.data !== "" ? Buffer.from(info.data, "base64") : null,
+            lastTransaction: info.last_transaction_id.lt !== "0"
+                ? {
+                    lt: info.last_transaction_id.lt,
+                    hash: info.last_transaction_id.hash,
+                }
+                : null,
             blockId: {
                 workchain: info.block_id.workchain,
                 shard: info.block_id.shard,
-                seqno: info.block_id.seqno
+                seqno: info.block_id.seqno,
             },
-            timestampt: info.sync_utime
+            timestampt: info.sync_utime,
         };
     }
     /**
@@ -271,61 +280,70 @@ class TonClient {
 }
 exports.TonClient = TonClient;
 function parseStackEntry(x) {
-    const typeName = x['@type'];
+    const typeName = x["@type"];
     switch (typeName) {
-        case 'tvm.list':
-        case 'tvm.tuple':
+        case "tvm.list":
+        case "tvm.tuple":
             return x.elements.map(parseStackEntry);
-        case 'tvm.cell':
-            return core_1.Cell.fromBoc(Buffer.from(x.bytes, 'base64'))[0];
-        case 'tvm.slice':
-            return core_1.Cell.fromBoc(Buffer.from(x.bytes, 'base64'))[0];
-        case 'tvm.stackEntryCell':
+        case "tvm.cell":
+            return core_1.Cell.fromBoc(Buffer.from(x.bytes, "base64"))[0];
+        case "tvm.slice":
+            return core_1.Cell.fromBoc(Buffer.from(x.bytes, "base64"))[0];
+        case "tvm.stackEntryCell":
             return parseStackEntry(x.cell);
-        case 'tvm.stackEntrySlice':
+        case "tvm.stackEntrySlice":
             return parseStackEntry(x.slice);
-        case 'tvm.stackEntryTuple':
+        case "tvm.stackEntryTuple":
             return parseStackEntry(x.tuple);
-        case 'tvm.stackEntryList':
+        case "tvm.stackEntryList":
             return parseStackEntry(x.list);
-        case 'tvm.stackEntryNumber':
+        case "tvm.stackEntryNumber":
             return parseStackEntry(x.number);
-        case 'tvm.numberDecimal':
+        case "tvm.numberDecimal":
             return BigInt(x.number);
         default:
-            throw Error('Unsupported item type: ' + typeName);
+            throw Error("Unsupported item type: " + typeName);
     }
 }
 function parseStackItem(s) {
-    if (s[0] === 'num') {
+    if (s[0] === "num") {
         let val = s[1];
-        if (val.startsWith('-')) {
-            return { type: 'int', value: -BigInt(val.slice(1)) };
+        if (val.startsWith("-")) {
+            return { type: "int", value: -BigInt(val.slice(1)) };
         }
         else {
-            return { type: 'int', value: BigInt(val) };
+            return { type: "int", value: BigInt(val) };
         }
     }
-    else if (s[0] === 'null') {
-        return { type: 'null' };
+    else if (s[0] === "null") {
+        return { type: "null" };
     }
-    else if (s[0] === 'cell') {
-        return { type: 'cell', cell: core_1.Cell.fromBoc(Buffer.from(s[1].bytes, 'base64'))[0] };
+    else if (s[0] === "cell") {
+        return {
+            type: "cell",
+            cell: core_1.Cell.fromBoc(Buffer.from(s[1].bytes, "base64"))[0],
+        };
     }
-    else if (s[0] === 'slice') {
-        return { type: 'slice', cell: core_1.Cell.fromBoc(Buffer.from(s[1].bytes, 'base64'))[0] };
+    else if (s[0] === "slice") {
+        return {
+            type: "slice",
+            cell: core_1.Cell.fromBoc(Buffer.from(s[1].bytes, "base64"))[0],
+        };
     }
-    else if (s[0] === 'builder') {
-        return { type: 'builder', cell: core_1.Cell.fromBoc(Buffer.from(s[1].bytes, 'base64'))[0] };
+    else if (s[0] === "builder") {
+        return {
+            type: "builder",
+            cell: core_1.Cell.fromBoc(Buffer.from(s[1].bytes, "base64"))[0],
+        };
     }
-    else if (s[0] === 'tuple' || s[0] === 'list') {
+    else if (s[0] === "tuple" || s[0] === "list") {
         if (s[1].elements.length === 0) {
-            return { type: 'null' };
+            return { type: "null" };
         }
-        return { type: 'tuple', items: s[1].elements.map(parseStackEntry) };
+        return { type: "tuple", items: s[1].elements.map(parseStackEntry) };
     }
     else {
-        throw Error('Unsupported stack item type: ' + s[0]);
+        throw Error("Unsupported stack item type: " + s[0]);
     }
 }
 function parseStack(src) {
@@ -340,29 +358,34 @@ function createProvider(client, address, init) {
         async getState() {
             let state = await client.getContractState(address);
             let balance = state.balance;
-            let last = state.lastTransaction ? { lt: BigInt(state.lastTransaction.lt), hash: Buffer.from(state.lastTransaction.hash, 'base64') } : null;
+            let last = state.lastTransaction
+                ? {
+                    lt: BigInt(state.lastTransaction.lt),
+                    hash: Buffer.from(state.lastTransaction.hash, "base64"),
+                }
+                : null;
             let ecMap = null;
             let storage;
-            if (state.state === 'active') {
+            if (state.state === "active") {
                 storage = {
-                    type: 'active',
+                    type: "active",
                     code: state.code ? state.code : null,
                     data: state.data ? state.data : null,
                 };
             }
-            else if (state.state === 'uninitialized') {
+            else if (state.state === "uninitialized") {
                 storage = {
-                    type: 'uninit',
+                    type: "uninit",
                 };
             }
-            else if (state.state === 'frozen') {
+            else if (state.state === "frozen") {
                 storage = {
-                    type: 'frozen',
+                    type: "frozen",
                     stateHash: Buffer.alloc(0),
                 };
             }
             else {
-                throw Error('Unsupported state');
+                throw Error("Unsupported state");
             }
             if (state.extra_currencies && state.extra_currencies.length > 0) {
                 ecMap = {};
@@ -378,8 +401,8 @@ function createProvider(client, address, init) {
             };
         },
         async get(name, args) {
-            if (typeof name !== 'string') {
-                throw new Error('Method name must be a string for TonClient provider');
+            if (typeof name !== "string") {
+                throw new Error("Method name must be a string for TonClient provider");
             }
             let method = await client.runMethod(address, name, args);
             return { stack: method.stack };
@@ -389,7 +412,7 @@ function createProvider(client, address, init) {
             // Resolve init
             //
             let neededInit = null;
-            if (init && !await client.isContractDeployed(address)) {
+            if (init && !(await client.isContractDeployed(address))) {
                 neededInit = init;
             }
             //
@@ -398,18 +421,15 @@ function createProvider(client, address, init) {
             const ext = (0, core_1.external)({
                 to: address,
                 init: neededInit,
-                body: message
+                body: message,
             });
-            let boc = (0, core_1.beginCell)()
-                .store((0, core_1.storeMessage)(ext))
-                .endCell()
-                .toBoc();
+            let boc = (0, core_1.beginCell)().store((0, core_1.storeMessage)(ext)).endCell().toBoc();
             await client.sendFile(boc);
         },
         async internal(via, message) {
             // Resolve init
             let neededInit = null;
-            if (init && (!await client.isContractDeployed(address))) {
+            if (init && !(await client.isContractDeployed(address))) {
                 neededInit = init;
             }
             // Resolve bounce
@@ -419,7 +439,7 @@ function createProvider(client, address, init) {
             }
             // Resolve value
             let value;
-            if (typeof message.value === 'string') {
+            if (typeof message.value === "string") {
                 value = (0, core_1.toNano)(message.value);
             }
             else {
@@ -427,7 +447,7 @@ function createProvider(client, address, init) {
             }
             // Resolve body
             let body = null;
-            if (typeof message.body === 'string') {
+            if (typeof message.body === "string") {
                 body = (0, core_1.comment)(message.body);
             }
             else if (message.body) {
@@ -441,14 +461,19 @@ function createProvider(client, address, init) {
                 sendMode: message.sendMode,
                 extracurrency: message.extracurrency,
                 init: neededInit,
-                body
+                body,
             });
         },
         open(contract) {
             return (0, core_1.openContract)(contract, (args) => createProvider(client, args.address, args.init ?? null));
         },
         getTransactions(address, lt, hash, limit) {
-            return client.getTransactions(address, { limit: limit ?? 100, lt: lt.toString(), hash: hash.toString('base64'), inclusive: true });
-        }
+            return client.getTransactions(address, {
+                limit: limit ?? 100,
+                lt: lt.toString(),
+                hash: hash.toString("base64"),
+                inclusive: true,
+            });
+        },
     };
 }

package/dist/client/TonClient4.d.ts

@@ -7,7 +7,7 @@
  */
 import { AxiosAdapter, InternalAxiosRequestConfig } from "axios";
 import { Address, Contract, ContractProvider, OpenedContract, StateInit, Transaction, TupleItem, TupleReader } from "@ton/core";
-import { z } from 'zod';
+import { z } from "zod";
 export type TonClient4Parameters = {
     /**
      * API endpoint