@ton/sandbox 0.21.0-debugger.3 → 0.22.0

package/CHANGELOG.md

@@ -5,6 +5,22 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.22.0] - 2024-09-17
+
+### Added
+
+- Added `blockchain.recordStorage` flag. If set to `true`, `BlockchainTransaction` will have `oldStorage` and `newStorage` fields. Note that enabling this flag will disable a certain optimization, which will slow down contract emulation
+
+## [0.21.0] - 2024-09-16
+
+### Added
+
+- `SandboxContract` now wraps methods starting with `is` (having the same semantics as `get`) as well as `send` and `get`
+
+### Changed
+
+- Updated dependencies
+
 ## [0.20.0] - 2024-05-31
 
 ### Added

package/dist/blockchain/Blockchain.d.ts

@@ -26,6 +26,8 @@ export type BlockchainTransaction = Transaction & {
     parent?: BlockchainTransaction;
     children: BlockchainTransaction[];
     externals: ExternalOut[];
+    oldStorage?: Cell;
+    newStorage?: Cell;
 };
 /**
  * @type SendMessageResult Represents the result of sending a message.
@@ -45,7 +47,7 @@ export declare const SANDBOX_CONTRACT_SYMBOL: unique symbol;
  * @template F Type parameter representing the original contract object.
  */
 export type SandboxContract<F> = {
-    [P in keyof F]: P extends `get${string}` ? (F[P] extends (x: infer CP, ...args: infer P) => infer R ? (ExtendsContractProvider<CP> extends true ? (...args: P) => R : never) : never) : (P extends `send${string}` ? (F[P] extends (x: infer CP, ...args: infer P) => infer R ? (ExtendsContractProvider<CP> extends true ? (...args: P) => Promise<SendMessageResult & {
+    [P in keyof F]: P extends `${'get' | 'is'}${string}` ? (F[P] extends (x: infer CP, ...args: infer P) => infer R ? (ExtendsContractProvider<CP> extends true ? (...args: P) => R : never) : never) : (P extends `send${string}` ? (F[P] extends (x: infer CP, ...args: infer P) => infer R ? (ExtendsContractProvider<CP> extends true ? (...args: P) => Promise<SendMessageResult & {
         result: R extends Promise<infer PR> ? PR : R;
     }> : never) : never) : F[P]);
 };
@@ -98,7 +100,7 @@ export declare class Blockchain {
     protected lock: AsyncLock;
     protected contractFetches: Map<string, Promise<SmartContract>>;
     protected nextCreateWalletIndex: number;
-    protected shouldDebug: boolean;
+    protected shouldRecordStorage: boolean;
     readonly executor: IExecutor;
     /**
      * Saves snapshot of current blockchain.
@@ -116,8 +118,8 @@ export declare class Blockchain {
      * @param snapshot Snapshot of blockchain
      */
     loadFrom(snapshot: BlockchainSnapshot): Promise<void>;
-    get debug(): boolean;
-    set debug(value: boolean);
+    get recordStorage(): boolean;
+    set recordStorage(v: boolean);
     /**
      * @returns Current time in blockchain
      */

package/dist/blockchain/Blockchain.js

@@ -81,11 +81,11 @@ class Blockchain {
         this.globalLibs = snapshot.libs;
         this.nextCreateWalletIndex = snapshot.nextCreateWalletIndex;
     }
-    get debug() {
-        return this.shouldDebug;
+    get recordStorage() {
+        return this.shouldRecordStorage;
     }
-    set debug(value) {
-        this.shouldDebug = value;
+    set recordStorage(v) {
+        this.shouldRecordStorage = v;
     }
     /**
      * @returns Current time in blockchain
@@ -118,7 +118,7 @@ class Blockchain {
         this.lock = new AsyncLock_1.AsyncLock();
         this.contractFetches = new Map();
         this.nextCreateWalletIndex = 0;
-        this.shouldDebug = false;
+        this.shouldRecordStorage = false;
         this.networkConfig = blockchainConfigToBase64(opts.config);
         this.executor = opts.executor;
         this.storage = opts.storage;

package/dist/blockchain/SmartContract.d.ts

@@ -21,6 +21,8 @@ export type SmartContractTransaction = Transaction & {
     blockchainLogs: string;
     vmLogs: string;
     debugLogs: string;
+    oldStorage?: Cell;
+    newStorage?: Cell;
 };
 export type MessageParams = Partial<{
     now: number;
@@ -98,6 +100,4 @@ export declare class SmartContract {
     get verbosity(): LogsVerbosity;
     set verbosity(value: LogsVerbosity);
     setVerbosity(verbosity: Partial<LogsVerbosity> | Verbosity | undefined): void;
-    get debug(): boolean;
-    setDebug(debug: boolean | undefined): void;
 }

package/dist/blockchain/SmartContract.js

@@ -10,13 +10,11 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
-var _SmartContract_account, _SmartContract_parsedAccount, _SmartContract_lastTxTime, _SmartContract_verbosity, _SmartContract_debug;
+var _SmartContract_account, _SmartContract_parsedAccount, _SmartContract_lastTxTime, _SmartContract_verbosity;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SmartContract = exports.EmulationError = exports.TimeError = exports.GetMethodError = exports.createEmptyShardAccount = exports.createShardAccount = void 0;
 const core_1 = require("@ton/core");
 const selector_1 = require("../utils/selector");
-const debug_1 = require("../debugger/debug");
-const DebugInfoCache_1 = require("../debugger/DebugInfoCache");
 function createShardAccount(args) {
     let wc = args.workchain ?? 0;
     let address = args.address ?? (0, core_1.contractAddress)(wc, { code: args.code, data: args.data });
@@ -130,7 +128,6 @@ class SmartContract {
         _SmartContract_parsedAccount.set(this, void 0);
         _SmartContract_lastTxTime.set(this, void 0);
         _SmartContract_verbosity.set(this, void 0);
-        _SmartContract_debug.set(this, void 0);
         this.address = shardAccount.account.addr;
         __classPrivateFieldSet(this, _SmartContract_account, (0, core_1.beginCell)().store((0, core_1.storeShardAccount)(shardAccount)).endCell().toBoc().toString('base64'), "f");
         __classPrivateFieldSet(this, _SmartContract_parsedAccount, shardAccount, "f");
@@ -213,34 +210,10 @@ class SmartContract {
             now: this.blockchain.now,
             ...params,
         };
-        const args = {
+        return await this.runCommon(() => this.blockchain.executor.runTransaction({
             ...this.createCommonArgs(params),
             message: (0, core_1.beginCell)().store((0, core_1.storeMessage)(message)).endCell(),
-        };
-        if (this.debug) {
-            const acc = this.account;
-            if (acc.account === undefined || acc.account === null) {
-                console.log('Debugging uninitialized accounts is unsupported in debugger beta');
-                return await this.runCommon(() => this.blockchain.executor.runTransaction(args));
-            }
-            if (acc.account.storage.state.type !== 'active') {
-                console.log('Debugging uninitialized accounts is unsupported in debugger beta');
-                return await this.runCommon(() => this.blockchain.executor.runTransaction(args));
-            }
-            const code = acc.account.storage.state.state.code;
-            if (code === undefined || code === null) {
-                console.log('Debugging uninitialized accounts is unsupported in debugger beta');
-                return await this.runCommon(() => this.blockchain.executor.runTransaction(args));
-            }
-            const sm = DebugInfoCache_1.defaultDebugInfoCache.get(code.hash().toString('base64'));
-            if (sm === undefined) {
-                return await this.runCommon(() => this.blockchain.executor.runTransaction(args));
-            }
-            return await this.runCommon(() => (0, debug_1.debugTransaction)(this.blockchain.executor, args, code, sm));
-        }
-        else {
-            return await this.runCommon(() => this.blockchain.executor.runTransaction(args));
-        }
+        }));
     }
     async runTickTock(which, params) {
         return await this.runCommon(() => this.blockchain.executor.runTickTock({
@@ -249,6 +222,10 @@ class SmartContract {
         }));
     }
     async runCommon(run) {
+        let oldStorage = undefined;
+        if (this.blockchain.recordStorage && this.account.account?.storage.state.type === 'active') {
+            oldStorage = this.account.account?.storage.state.state.data ?? undefined;
+        }
         const res = await run();
         if (this.verbosity.print && this.verbosity.blockchainLogs && res.logs.length > 0) {
             console.log(res.logs);
@@ -266,18 +243,24 @@ class SmartContract {
         __classPrivateFieldSet(this, _SmartContract_account, res.result.shardAccount, "f");
         __classPrivateFieldSet(this, _SmartContract_parsedAccount, undefined, "f");
         __classPrivateFieldSet(this, _SmartContract_lastTxTime, tx.now, "f");
+        let newStorage = undefined;
+        if (this.blockchain.recordStorage && this.account.account?.storage.state.type === 'active') {
+            newStorage = this.account.account?.storage.state.state.data ?? undefined;
+        }
         return {
             ...tx,
             blockchainLogs: res.logs,
             vmLogs: res.result.vmLog,
             debugLogs: res.debugLogs,
+            oldStorage,
+            newStorage,
         };
     }
     async get(method, stack = [], params) {
         if (this.account.account?.storage.state.type !== 'active') {
             throw new Error('Trying to run get method on non-active contract');
         }
-        const args = {
+        const res = await this.blockchain.executor.runGetMethod({
             code: this.account.account?.storage.state.state.code,
             data: this.account.account?.storage.state.state.data,
             methodId: typeof method === 'string' ? (0, selector_1.getSelectorForMethod)(method) : method,
@@ -291,20 +274,7 @@ class SmartContract {
             randomSeed: params?.randomSeed ?? Buffer.alloc(32),
             gasLimit: params?.gasLimit ?? 10000000n,
             debugEnabled: this.verbosity.debugLogs,
-        };
-        let res;
-        if (this.debug) {
-            const di = DebugInfoCache_1.defaultDebugInfoCache.get(args.code.hash().toString('base64'));
-            if (di === undefined) {
-                res = await this.blockchain.executor.runGetMethod(args);
-            }
-            else {
-                res = await (0, debug_1.debugGetMethod)(this.blockchain.executor, args, di);
-            }
-        }
-        else {
-            res = await this.blockchain.executor.runGetMethod(args);
-        }
+        });
         if (this.verbosity.print && this.verbosity.blockchainLogs && res.logs.length > 0) {
             console.log(res.logs);
         }
@@ -352,12 +322,6 @@ class SmartContract {
             __classPrivateFieldSet(this, _SmartContract_verbosity, verbosity, "f");
         }
     }
-    get debug() {
-        return __classPrivateFieldGet(this, _SmartContract_debug, "f") ?? this.blockchain.debug;
-    }
-    setDebug(debug) {
-        __classPrivateFieldSet(this, _SmartContract_debug, debug, "f");
-    }
 }
 exports.SmartContract = SmartContract;
-_SmartContract_account = new WeakMap(), _SmartContract_parsedAccount = new WeakMap(), _SmartContract_lastTxTime = new WeakMap(), _SmartContract_verbosity = new WeakMap(), _SmartContract_debug = new WeakMap();
+_SmartContract_account = new WeakMap(), _SmartContract_parsedAccount = new WeakMap(), _SmartContract_lastTxTime = new WeakMap(), _SmartContract_verbosity = new WeakMap();

package/dist/executor/Executor.d.ts

@@ -82,9 +82,7 @@ export declare class Executor implements IExecutor {
     private heap;
     private emulator?;
     private debugLogs;
-    debugLogFunc: (s: string) => void;
     private constructor();
-    private handleLog;
     static create(): Promise<Executor>;
     runGetMethod(args: GetMethodArgs): Promise<GetMethodResult>;
     private runCommon;
@@ -94,31 +92,4 @@ export declare class Executor implements IExecutor {
     private getEmulatorPointer;
     invoke(method: string, args: (number | string)[]): number;
     private extractString;
-    sbsGetMethodSetup(args: GetMethodArgs): number;
-    destroyTvmEmulator(ptr: number): void;
-    sbsGetMethodStep(ptr: number): boolean;
-    sbsGetMethodStack(ptr: number): TupleItem[];
-    sbsGetMethodC7(ptr: number): TupleItem;
-    sbsGetMethodGetContParam(ptr: number): number;
-    sbsGetMethodSetContParam(ptr: number, param: number): number;
-    sbsGetMethodCodePos(ptr: number): {
-        hash: string;
-        offset: number;
-    };
-    sbsGetMethodResult(ptr: number): GetMethodResult;
-    sbsTransactionSetup(args: RunTransactionArgs): {
-        res: number;
-        emptr: number;
-    };
-    destroyEmulator(ptr: number): void;
-    sbsTransactionStep(ptr: number): boolean;
-    sbsTransactionCodePos(ptr: number): {
-        hash: string;
-        offset: number;
-    };
-    sbsTransactionStack(ptr: number): TupleItem[];
-    sbsTransactionC7(ptr: number): TupleItem;
-    sbsTransactionGetContParam(ptr: number): number;
-    sbsTransactionSetContParam(ptr: number, param: number): number;
-    sbsTransactionResult(ptr: number): EmulationResult;
 }

package/dist/executor/Executor.js

@@ -69,18 +69,13 @@ class Heap {
 class Executor {
     constructor(module) {
         this.debugLogs = [];
-        this.debugLogFunc = () => { };
         this.module = module;
         this.heap = new Heap(module);
     }
-    handleLog(text) {
-        this.debugLogs.push(text);
-        this.debugLogFunc(text);
-    }
     static async create() {
         const ex = new Executor(await EmulatorModule({
             wasmBinary: (0, base64_1.base64Decode)(require('./emulator-emscripten.wasm.js').EmulatorEmscriptenWasm),
-            printErr: (text) => ex.handleLog(text),
+            printErr: (text) => ex.debugLogs.push(text),
         }));
         return ex;
     }
@@ -209,159 +204,5 @@ class Executor {
         this.module._free(ptr);
         return str;
     }
-    sbsGetMethodSetup(args) {
-        const params = {
-            code: args.code.toBoc().toString('base64'),
-            data: args.data.toBoc().toString('base64'),
-            verbosity: verbosityToNum[args.verbosity],
-            libs: args.libs?.toBoc().toString('base64') ?? '',
-            address: args.address.toString(),
-            unixtime: args.unixTime,
-            balance: args.balance.toString(),
-            rand_seed: args.randomSeed.toString('hex'),
-            gas_limit: args.gasLimit.toString(),
-            method_id: args.methodId,
-            debug_enabled: args.debugEnabled,
-        };
-        let stack = (0, core_1.serializeTuple)(args.stack);
-        this.debugLogs = [];
-        const res = this.invoke('_setup_sbs_get_method', [
-            JSON.stringify(params),
-            stack.toBoc().toString('base64'),
-            args.config,
-        ]);
-        return res;
-    }
-    destroyTvmEmulator(ptr) {
-        this.invoke('_destroy_tvm_emulator', [ptr]);
-    }
-    sbsGetMethodStep(ptr) {
-        const res = this.invoke('_sbs_step', [
-            ptr,
-        ]);
-        return res !== 0;
-    }
-    sbsGetMethodStack(ptr) {
-        const resp = this.extractString(this.invoke('_sbs_get_stack', [
-            ptr
-        ]));
-        return (0, core_1.parseTuple)(core_1.Cell.fromBase64(resp));
-    }
-    sbsGetMethodC7(ptr) {
-        const resp = this.extractString(this.invoke('_sbs_get_c7', [
-            ptr
-        ]));
-        return (0, core_1.parseTuple)((0, core_1.beginCell)().storeUint(1, 24).storeRef(core_1.Cell.EMPTY).storeSlice(core_1.Cell.fromBase64(resp).beginParse()).endCell())[0];
-    }
-    sbsGetMethodGetContParam(ptr) {
-        return this.invoke('_sbs_get_cont_param', [
-            ptr
-        ]);
-    }
-    sbsGetMethodSetContParam(ptr, param) {
-        return this.invoke('_sbs_set_cont_param', [
-            ptr,
-            param
-        ]);
-    }
-    sbsGetMethodCodePos(ptr) {
-        const resp = this.extractString(this.invoke('_sbs_get_code_pos', [
-            ptr
-        ]));
-        const parts = resp.split(':');
-        return {
-            hash: parts[0],
-            offset: parseInt(parts[1]),
-        };
-    }
-    sbsGetMethodResult(ptr) {
-        const resp = JSON.parse(this.extractString(this.invoke('_sbs_get_method_result', [
-            ptr
-        ])));
-        const debugLogs = this.debugLogs.join('\n');
-        return {
-            output: resp,
-            logs: 'BLOCKCHAIN LOGS ARE NOT AVAILABLE IN DEBUGGER BETA',
-            debugLogs,
-        };
-    }
-    sbsTransactionSetup(args) {
-        const emptr = this.invoke('_create_emulator', [
-            args.config,
-            verbosityToNum[args.verbosity],
-        ]);
-        const params = runCommonArgsToInternalParams(args);
-        this.debugLogs = [];
-        const res = this.invoke('_emulate_sbs', [
-            emptr,
-            args.libs?.toBoc().toString('base64') ?? 0,
-            args.shardAccount,
-            args.message.toBoc().toString('base64'),
-            JSON.stringify(params),
-        ]);
-        return { res, emptr };
-    }
-    destroyEmulator(ptr) {
-        this.invoke('_destroy_emulator', [ptr]);
-    }
-    sbsTransactionStep(ptr) {
-        const res = this.invoke('_em_sbs_step', [ptr]);
-        return res !== 0;
-    }
-    sbsTransactionCodePos(ptr) {
-        const resp = this.extractString(this.invoke('_em_sbs_code_pos', [ptr]));
-        const parts = resp.split(':');
-        return {
-            hash: parts[0],
-            offset: parseInt(parts[1]),
-        };
-    }
-    sbsTransactionStack(ptr) {
-        const resp = this.extractString(this.invoke('_em_sbs_stack', [
-            ptr
-        ]));
-        return (0, core_1.parseTuple)(core_1.Cell.fromBase64(resp));
-    }
-    sbsTransactionC7(ptr) {
-        const resp = this.extractString(this.invoke('_em_sbs_c7', [
-            ptr
-        ]));
-        return (0, core_1.parseTuple)((0, core_1.beginCell)().storeUint(1, 24).storeRef(core_1.Cell.EMPTY).storeSlice(core_1.Cell.fromBase64(resp).beginParse()).endCell())[0];
-    }
-    sbsTransactionGetContParam(ptr) {
-        return this.invoke('_em_sbs_get_cont_param', [
-            ptr
-        ]);
-    }
-    sbsTransactionSetContParam(ptr, param) {
-        return this.invoke('_em_sbs_set_cont_param', [
-            ptr,
-            param
-        ]);
-    }
-    sbsTransactionResult(ptr) {
-        const result = JSON.parse(this.extractString(this.invoke('_em_sbs_result', [
-            ptr
-        ])));
-        const debugLogs = this.debugLogs.join('\n');
-        return {
-            result: result.success ? {
-                success: true,
-                transaction: result.transaction,
-                shardAccount: result.shard_account,
-                vmLog: result.vm_log,
-                actions: result.actions,
-            } : {
-                success: false,
-                error: result.error,
-                vmResults: 'vm_log' in result ? {
-                    vmLog: result.vm_log,
-                    vmExitCode: result.vm_exit_code,
-                } : undefined,
-            },
-            logs: 'BLOCKCHAIN LOGS ARE NOT AVAILABLE IN DEBUGGER BETA',
-            debugLogs,
-        };
-    }
 }
 exports.Executor = Executor;