@tonappchain/sdk 0.5.1 → 0.5.3

package/README.md

@@ -688,22 +688,22 @@ Fetches the current status information for multiple operations based on their op
 
 Track the execution of crosschain operation with `startTracking` method
 
-#### Method: `async function startTracking(transactionLinker: TransactionLinker, network: Network, customLiteSequencerEndpoints?: string[], delay: number = 10, maxIterationCount = MAX_ITERATION_COUNT, returnValue: boolean = false): Promise<void | { profilingData: ExecutionStages; tableData: ExecutionStagesTableData[]; }>`
+#### Method: `async function startTracking(transactionLinker: TransactionLinker, network: Network, options?: { customLiteSequencerEndpoints?: string[]; delay?: number; maxIterationCount?: number; returnValue?: boolean; tableView?: boolean; }): Promise<void | ExecutionStages>`
 
 #### **Parameters**:
   - `transactionLinker`: A `TransactionLinker` object returned from `sendCrossChainTransaction` function.
   - `network`: TON network (`Network` type).
-  - `customLiteSequencerEndpoints` *(optional)*: specify custom lite sequencer API URL for sending requests there.
-  - `delay` *(optional)*: specify custom delay after requests there.
-  - `maxIterationCount` *(optional)*: specify custom max iteration count there.
-  - `returnValue` *(optional)*: specify whether to return the data to you after tracking. When `false` will write to the console. Default is `false`
+  - `options` *(optional)*:
+    - `customLiteSequencerEndpoints` *(optional)*: specify custom lite sequencer API URL for sending requests there. Default is `undefined`
+    - `delay` *(optional)*: specify custom delay after requests there. Default is `10`
+    - `maxIterationCount` *(optional)*: specify custom max iteration count there. Default is `120`
+    - `returnValue` *(optional)*: specify whether to return the data to you after tracking. When `false` will write to the console. Default is `false`
+    - `tableView` *(optional)*: specify data display in the table. Default is `true`
 
 #### **Returns**:
 - Will stop requesting status once the final status of crosschain operation has been reached.
 - if returnValue is `false` return `Promise<void>`
-- if `true` return `Promise<TrackingOperationResult>` with value:
-  - **`profilingData`**: `ExecutionStages` - execution stages profiling data;
-  - **`tableData`**: `ExecutionStagesTableData[]` - execution stages profiling data in table format;
+- if `true` return `Promise<ExecutionStages>` - execution stages profiling data.
 
 #### **Possible exceptions**
 
@@ -1028,6 +1028,7 @@ Combines `StageData` with an additional stage identifier.
 - **`stage`**: Current stage in `StageName` enum.
 - **Other Properties from `StageData`**
 
+
 ### `OperationType`
 
 ```typescript
@@ -1088,24 +1089,6 @@ Represents the profiling data for all execution stages within an operation.
 - **`INCLUDED_IN_TON_CONSENSUS`**.
 - **`EXECUTED_IN_TON`**.
 
-### `ExecutionStagesTableData`
-
-```typescript
-export type ExecutionStagesTableData = {
-    stage: string;
-    exists: string;
-    success: string;
-    timestamp: string;
-    transactions: string;
-    noteContent: string;
-    errorName: string;
-    internalMsg: string;
-    bytesError: string;
-};
-```
-
-Represents the profiling data for all execution stages in table format.
-
 
 ### `ExecutionStagesByOperationId`
 

package/dist/sdk/StartTracking.d.ts

@@ -1,2 +1,8 @@
-import { Network, TrackingOperationResult, TransactionLinker } from '../structs/Struct';
-export declare function startTracking(transactionLinker: TransactionLinker, network: Network, customLiteSequencerEndpoints?: string[], delay?: number, maxIterationCount?: number, returnValue?: boolean): Promise<void | TrackingOperationResult>;
+import { ExecutionStages, Network, TransactionLinker } from '../structs/Struct';
+export declare function startTracking(transactionLinker: TransactionLinker, network: Network, options?: {
+    customLiteSequencerEndpoints?: string[];
+    delay?: number;
+    maxIterationCount?: number;
+    returnValue?: boolean;
+    tableView?: boolean;
+}): Promise<void | ExecutionStages>;

package/dist/sdk/StartTracking.js

@@ -1,11 +1,16 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.startTracking = startTracking;
 const Struct_1 = require("../structs/Struct");
 const Consts_1 = require("./Consts");
 const OperationTracker_1 = require("./OperationTracker");
 const Utils_1 = require("./Utils");
-async function startTracking(transactionLinker, network, customLiteSequencerEndpoints, delay = 10, maxIterationCount = Consts_1.MAX_ITERATION_COUNT, returnValue = false) {
+const cli_table3_1 = __importDefault(require("cli-table3"));
+async function startTracking(transactionLinker, network, options) {
+    const { customLiteSequencerEndpoints, delay = 10, maxIterationCount = Consts_1.MAX_ITERATION_COUNT, returnValue = false, tableView = true, } = options || {};
     const tracker = new OperationTracker_1.OperationTracker(network, customLiteSequencerEndpoints);
     console.log('Start tracking operation');
     console.log('caller: ', transactionLinker.caller);
@@ -16,7 +21,7 @@ async function startTracking(transactionLinker, network, customLiteSequencerEndp
     let iteration = 0; // number of iterations
     let operationType = '';
     let ok = true; // finished successfully
-    let errorMessage;
+    let errorMessage = '';
     while (true) {
         ++iteration;
         if (iteration >= maxIterationCount) {
@@ -53,15 +58,22 @@ async function startTracking(transactionLinker, network, customLiteSequencerEndp
     }
     console.log('Tracking finished');
     if (!ok) {
+        if (returnValue) {
+            throw Error(errorMessage);
+        }
         console.log(errorMessage);
     }
     const profilingData = await tracker.getStageProfiling(operationId);
-    const tableData = formatExecutionStages(profilingData);
     if (returnValue) {
-        return { profilingData, tableData };
+        return profilingData;
     }
     console.log(profilingData.operationType);
-    console.table(tableData);
+    if (tableView) {
+        printExecutionStagesTable(profilingData);
+    }
+    else {
+        console.log(formatExecutionStages(profilingData));
+    }
 }
 function formatExecutionStages(stages) {
     const { operationType, ...stagesData } = stages;
@@ -74,7 +86,7 @@ function formatExecutionStages(stages) {
             data.stageData &&
             data.stageData.transactions != null &&
             data.stageData.transactions.length > 0
-            ? data.stageData.transactions.map((t) => t.hash).join(', ')
+            ? data.stageData.transactions.map((t) => t.hash).join(' \n')
             : '-',
         noteContent: data.exists && data.stageData && data.stageData.note != null ? data.stageData.note.content : '-',
         errorName: data.exists && data.stageData && data.stageData.note != null ? data.stageData.note.errorName : '-',
@@ -82,3 +94,35 @@ function formatExecutionStages(stages) {
         bytesError: data.exists && data.stageData && data.stageData.note != null ? data.stageData.note.internalBytesError : '-',
     }));
 }
+function printExecutionStagesTable(stages) {
+    const table = new cli_table3_1.default({
+        head: [
+            'Stage',
+            'Exists',
+            'Success',
+            'Timestamp',
+            'Transactions',
+            'NoteContent',
+            'ErrorName',
+            'InternalMsg',
+            'BytesError',
+        ],
+        colWidths: [30, 8, 9, 13, 70, 13, 13, 13, 13],
+        wordWrap: true,
+    });
+    const tableData = formatExecutionStages(stages);
+    tableData.forEach((row) => {
+        table.push([
+            row.stage,
+            row.exists,
+            row.success,
+            row.timestamp,
+            row.transactions,
+            row.noteContent,
+            row.errorName,
+            row.internalMsg,
+            row.bytesError,
+        ]);
+    });
+    console.log(table.toString());
+}

package/dist/sender/SenderFactory.js

@@ -38,7 +38,7 @@ class SenderFactory {
             config.walletId = {
                 networkGlobalId: params.network === Struct_1.Network.TESTNET ? -3 : -239,
                 context: {
-                    walletVersion: 'V5R1',
+                    walletVersion: 'v5r1',
                     workchain: 0,
                     subwalletNumber: params.options?.v5r1?.subwalletNumber ?? 0,
                 },

package/dist/structs/Struct.d.ts

@@ -152,12 +152,12 @@ export type TACSimulationRequest = {
     tonCaller: string;
 };
 export declare enum StageName {
-    COLLECTED_IN_TAC = "COLLECTED_IN_TAC",
-    INCLUDED_IN_TAC_CONSENSUS = "INCLUDED_IN_TAC_CONSENSUS",
-    EXECUTED_IN_TAC = "EXECUTED_IN_TAC",
-    COLLECTED_IN_TON = "COLLECTED_IN_TON",
-    INCLUDED_IN_TON_CONSENSUS = "INCLUDED_IN_TON_CONSENSUS",
-    EXECUTED_IN_TON = "EXECUTED_IN_TON"
+    COLLECTED_IN_TAC = "collectedInTAC",
+    INCLUDED_IN_TAC_CONSENSUS = "includedInTACConsensus",
+    EXECUTED_IN_TAC = "executedInTAC",
+    COLLECTED_IN_TON = "collectedInTON",
+    INCLUDED_IN_TON_CONSENSUS = "includedInTONConsensus",
+    EXECUTED_IN_TON = "executedInTON"
 }
 export type TransactionData = {
     hash: string;
@@ -185,21 +185,6 @@ export type ProfilingStageData = {
 export type ExecutionStages = {
     operationType: OperationType;
 } & Record<StageName, ProfilingStageData>;
-export type ExecutionStagesTableData = {
-    stage: string;
-    exists: string;
-    success: string;
-    timestamp: string;
-    transactions: string;
-    noteContent: string;
-    errorName: string;
-    internalMsg: string;
-    bytesError: string;
-};
-export type TrackingOperationResult = {
-    profilingData: ExecutionStages;
-    tableData: ExecutionStagesTableData[];
-};
 export type ExecutionStagesByOperationId = Record<string, ExecutionStages>;
 export type StatusInfosByOperationId = Record<string, StatusInfo>;
 export type OperationIds = {

package/dist/structs/Struct.js

@@ -29,10 +29,10 @@ var OperationType;
 })(OperationType || (exports.OperationType = OperationType = {}));
 var StageName;
 (function (StageName) {
-    StageName["COLLECTED_IN_TAC"] = "COLLECTED_IN_TAC";
-    StageName["INCLUDED_IN_TAC_CONSENSUS"] = "INCLUDED_IN_TAC_CONSENSUS";
-    StageName["EXECUTED_IN_TAC"] = "EXECUTED_IN_TAC";
-    StageName["COLLECTED_IN_TON"] = "COLLECTED_IN_TON";
-    StageName["INCLUDED_IN_TON_CONSENSUS"] = "INCLUDED_IN_TON_CONSENSUS";
-    StageName["EXECUTED_IN_TON"] = "EXECUTED_IN_TON";
+    StageName["COLLECTED_IN_TAC"] = "collectedInTAC";
+    StageName["INCLUDED_IN_TAC_CONSENSUS"] = "includedInTACConsensus";
+    StageName["EXECUTED_IN_TAC"] = "executedInTAC";
+    StageName["COLLECTED_IN_TON"] = "collectedInTON";
+    StageName["INCLUDED_IN_TON_CONSENSUS"] = "includedInTONConsensus";
+    StageName["EXECUTED_IN_TON"] = "executedInTON";
 })(StageName || (exports.StageName = StageName = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tonappchain/sdk",
-  "version": "0.5.1",
+  "version": "0.5.3",
   "repository": "https://github.com/TacBuild/tac-sdk.git",
   "author": "TAC. <developers@tac>",
   "license": "MIT",
@@ -24,6 +24,7 @@
     "@tonappchain/ton-lite-client": "3.0.6",
     "@tonconnect/ui": "^2.0.11",
     "bn.js": "^5.2.1",
+    "cli-table3": "^0.6.5",
     "dotenv": "^16.4.7",
     "ethers": "^6.13.5",
     "ton-crypto": "^3.2.0"