@ton/sandbox 0.18.0 → 0.20.0

package/dist/treasury/Treasury.d.ts

@@ -2,6 +2,9 @@ import { Address, Cell, Contract, ContractProvider, MessageRelaxed, Sender, Send
 export type Treasury = Sender & {
     address: Address;
 };
+/**
+ * @class TreasuryContract is Wallet v4 alternative. For additional information see {@link Blockchain.treasury}
+ */
 export declare class TreasuryContract implements Contract {
     static readonly code: Cell;
     static create(workchain: number, subwalletId: bigint): TreasuryContract;
@@ -9,10 +12,27 @@ export declare class TreasuryContract implements Contract {
     readonly init: StateInit;
     readonly subwalletId: bigint;
     constructor(workchain: number, subwalletId: bigint);
+    /**
+     * Send bulk messages using one external message.
+     * @param messages Messages to send
+     * @param sendMode Send mode of every message
+     */
     sendMessages(provider: ContractProvider, messages: MessageRelaxed[], sendMode?: SendMode): Promise<void>;
+    /**
+     * Sends message by arguments specified.
+     */
     send(provider: ContractProvider, args: SenderArguments): Promise<void>;
+    /**
+     * @returns Sender
+     */
     getSender(provider: ContractProvider): Treasury;
+    /**
+     * @returns wallet balance in nanoTONs
+     */
     getBalance(provider: ContractProvider): Promise<bigint>;
+    /**
+     * Creates transfer cell for {@link sendMessages}.
+     */
     createTransfer(args: {
         messages: MessageRelaxed[];
         sendMode?: SendMode;

package/dist/treasury/Treasury.js

@@ -22,6 +22,9 @@ function senderArgsToMessageRelaxed(args) {
         bounce: args.bounce
     });
 }
+/**
+ * @class TreasuryContract is Wallet v4 alternative. For additional information see {@link Blockchain.treasury}
+ */
 class TreasuryContract {
     static create(workchain, subwalletId) {
         return new TreasuryContract(workchain, subwalletId);
@@ -34,6 +37,11 @@ class TreasuryContract {
         this.address = (0, core_1.contractAddress)(workchain, this.init);
         this.subwalletId = subwalletId;
     }
+    /**
+     * Send bulk messages using one external message.
+     * @param messages Messages to send
+     * @param sendMode Send mode of every message
+     */
     async sendMessages(provider, messages, sendMode) {
         let transfer = this.createTransfer({
             sendMode: sendMode,
@@ -41,9 +49,15 @@ class TreasuryContract {
         });
         await provider.external(transfer);
     }
+    /**
+     * Sends message by arguments specified.
+     */
     async send(provider, args) {
         await this.sendMessages(provider, [senderArgsToMessageRelaxed(args)], args.sendMode ?? undefined);
     }
+    /**
+     * @returns Sender
+     */
     getSender(provider) {
         return {
             address: this.address,
@@ -56,9 +70,15 @@ class TreasuryContract {
             }
         };
     }
+    /**
+     * @returns wallet balance in nanoTONs
+     */
     async getBalance(provider) {
         return (await provider.getState()).balance;
     }
+    /**
+     * Creates transfer cell for {@link sendMessages}.
+     */
     createTransfer(args) {
         let sendMode = core_1.SendMode.PAY_GAS_SEPARATELY;
         if (args.sendMode !== null && args.sendMode !== undefined) {

package/dist/utils/message.d.ts

@@ -1,4 +1,7 @@
 import { Address, Cell, Message, StateInit } from "@ton/core";
+/**
+ * Creates {@link Message} from params.
+ */
 export declare function internal(params: {
     from: Address;
     to: Address;

package/dist/utils/message.js

@@ -2,6 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.internal = void 0;
 const core_1 = require("@ton/core");
+/**
+ * Creates {@link Message} from params.
+ */
 function internal(params) {
     return {
         info: {

package/dist/utils/prettyLogTransaction.d.ts

@@ -1,3 +1,16 @@
 import { Transaction } from "@ton/core";
+/**
+ * @param tx Transaction to create log string
+ * @returns Transaction log string
+ */
 export declare function prettyLogTransaction(tx: Transaction): string;
+/**
+ * Log transaction using `console.log`. Logs base on result of {@link prettyLogTransaction}.
+ * Example output:
+ * ```
+ * null  ➡️  EQBGhqLAZseEqRXz4ByFPTGV7SVMlI4hrbs-Sps_Xzx01x8G
+ *       ➡️  0.05 💎 EQC2VluVfpj2FoHNMAiDMpcMzwvjLZxxTG8ecq477RE3NvVt
+ * ```
+ * @param txs Transactions to log
+ */
 export declare function prettyLogTransactions(txs: Transaction[]): void;

package/dist/utils/prettyLogTransaction.js

@@ -2,6 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.prettyLogTransactions = exports.prettyLogTransaction = void 0;
 const core_1 = require("@ton/core");
+/**
+ * @param tx Transaction to create log string
+ * @returns Transaction log string
+ */
 function prettyLogTransaction(tx) {
     let res = `${tx.inMessage?.info.src}  ➡️  ${tx.inMessage?.info.dest}\n`;
     for (let message of tx.outMessages.values()) {
@@ -15,6 +19,15 @@ function prettyLogTransaction(tx) {
     return res;
 }
 exports.prettyLogTransaction = prettyLogTransaction;
+/**
+ * Log transaction using `console.log`. Logs base on result of {@link prettyLogTransaction}.
+ * Example output:
+ * ```
+ * null  ➡️  EQBGhqLAZseEqRXz4ByFPTGV7SVMlI4hrbs-Sps_Xzx01x8G
+ *       ➡️  0.05 💎 EQC2VluVfpj2FoHNMAiDMpcMzwvjLZxxTG8ecq477RE3NvVt
+ * ```
+ * @param txs Transactions to log
+ */
 function prettyLogTransactions(txs) {
     let out = '';
     for (let tx of txs) {

package/dist/utils/printTransactionFees.d.ts

@@ -1,3 +1,16 @@
 import { Transaction } from "@ton/core";
 export declare function formatCoinsPure(value: bigint, precision?: number): string;
+/**
+ * Prints transaction fees.
+ * Example output:
+ * ```
+ * ┌─────────┬─────────────┬────────────────┬────────────────┬────────────────┬────────────────┬───────────────┬────────────┬────────────────┬──────────┬────────────┐
+ * │ (index) │ op          │ valueIn        │ valueOut       │ totalFees      │ inForwardFee   │ outForwardFee │ outActions │ computeFee     │ exitCode │ actionCode │
+ * ├─────────┼─────────────┼────────────────┼────────────────┼────────────────┼────────────────┼───────────────┼────────────┼────────────────┼──────────┼────────────┤
+ * │ 0       │ 'N/A'       │ 'N/A'          │ '1000 TON'     │ '0.004007 TON' │ 'N/A'          │ '0.001 TON'   │ 1          │ '0.001937 TON' │ 0        │ 0          │
+ * │ 1       │ '0x45ab564' │ '1000 TON'     │ '998.8485 TON' │ '1.051473 TON' │ '0.000667 TON' │ '0.255 TON'   │ 255        │ '0.966474 TON' │ 0        │ 0          │
+ * │ 2       │ '0x0'       │ '3.917053 TON' │ '0 TON'        │ '0.00031 TON'  │ '0.000667 TON' │ 'N/A'         │ 0          │ '0.000309 TON' │ 0        │ 0          │
+ * ```
+ * @param transactions List of transaction to print fees
+ */
 export declare function printTransactionFees(transactions: Transaction[]): void;

package/dist/utils/printTransactionFees.js

@@ -30,6 +30,19 @@ function formatCoins(value, precision = 6) {
         return 'N/A';
     return formatCoinsPure(value, precision) + ' TON';
 }
+/**
+ * Prints transaction fees.
+ * Example output:
+ * ```
+ * ┌─────────┬─────────────┬────────────────┬────────────────┬────────────────┬────────────────┬───────────────┬────────────┬────────────────┬──────────┬────────────┐
+ * │ (index) │ op          │ valueIn        │ valueOut       │ totalFees      │ inForwardFee   │ outForwardFee │ outActions │ computeFee     │ exitCode │ actionCode │
+ * ├─────────┼─────────────┼────────────────┼────────────────┼────────────────┼────────────────┼───────────────┼────────────┼────────────────┼──────────┼────────────┤
+ * │ 0       │ 'N/A'       │ 'N/A'          │ '1000 TON'     │ '0.004007 TON' │ 'N/A'          │ '0.001 TON'   │ 1          │ '0.001937 TON' │ 0        │ 0          │
+ * │ 1       │ '0x45ab564' │ '1000 TON'     │ '998.8485 TON' │ '1.051473 TON' │ '0.000667 TON' │ '0.255 TON'   │ 255        │ '0.966474 TON' │ 0        │ 0          │
+ * │ 2       │ '0x0'       │ '3.917053 TON' │ '0 TON'        │ '0.00031 TON'  │ '0.000667 TON' │ 'N/A'         │ 0          │ '0.000309 TON' │ 0        │ 0          │
+ * ```
+ * @param transactions List of transaction to print fees
+ */
 function printTransactionFees(transactions) {
     console.table(transactions
         .map((tx) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ton/sandbox",
-  "version": "0.18.0",
+  "version": "0.20.0",
   "description": "TON transaction emulator",
   "main": "dist/index.js",
   "license": "MIT",