@ton/blueprint 0.24.0 → 0.25.0

package/CHANGELOG.md

@@ -5,6 +5,12 @@ 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.25.0] - 2024-11-02
+
+### Added
+
+- Support for Tolk, "next-generation FunC", a new language for writing smart contracts in TON. [Tolk overview](https://docs.ton.org/develop/tolk/overview)
+
 ## [0.24.0] - 2024-09-16
 
 ### Added

package/README.md

@@ -39,7 +39,7 @@ npm create ton@latest
 
 ## Overview
 
-Blueprint is an all-in-one development environment designed to enhance the process of creating, testing, and deploying smart contracts on TON blockchain using [FunC](https://docs.ton.org/develop/func/overview) and [Tact](https://docs.tact-lang.org/) languages
+Blueprint is an all-in-one development environment designed to enhance the process of creating, testing, and deploying smart contracts on TON blockchain using [FunC](https://docs.ton.org/develop/func/overview), [Tolk](https://docs.ton.org/develop/tolk/overview), and [Tact](https://docs.tact-lang.org/) languages.
 
 ### Core features
 
@@ -51,15 +51,16 @@ Blueprint is an all-in-one development environment designed to enhance the proce
 ### Tech stack
 
 1. Compiling FunC with https://github.com/ton-community/func-js
-2. Compiling Tact with https://github.com/tact-lang/tact
-3. Testing smart contracts with https://github.com/ton-org/sandbox
-4. Deploying smart contracts with [TON Connect 2](https://github.com/ton-connect) or a `ton://` deeplink
+2. Compiling Tolk with https://github.com/ton-blockchain/tolk-js
+3. Compiling Tact with https://github.com/tact-lang/tact
+4. Testing smart contracts with https://github.com/ton-org/sandbox
+5. Deploying smart contracts with [TON Connect 2](https://github.com/ton-connect) or a `ton://` deeplink
 
 ### Requirements
 
 * [Node.js](https://nodejs.org) with a recent version like v18. Version can be verified with `node -v`
 * IDE with TON support:
-  * [Visual Studio Code](https://code.visualstudio.com/) with the [FunC plugin](https://marketplace.visualstudio.com/items?itemName=tonwhales.func-vscode)
+  * [Visual Studio Code](https://code.visualstudio.com/) with the [FunC plugin](https://marketplace.visualstudio.com/items?itemName=tonwhales.func-vscode) or [Tolk plugin](https://marketplace.visualstudio.com/items?itemName=ton-core.tolk-vscode)
   * [IntelliJ IDEA](https://www.jetbrains.com/idea/) with the [TON Development plugin](https://plugins.jetbrains.com/plugin/23382-ton)
 
 ## Features overview
@@ -71,7 +72,7 @@ Blueprint is an all-in-one development environment designed to enhance the proce
 
 ### Directory structure
 
-* `contracts/` - Source code in [FunC](https://docs.ton.org/develop/func/overview) or [Tact](https://tact-lang.org/) for all smart contracts and their imports
+* `contracts/` - Source code for all smart contracts and their imports
 * `wrappers/` - TypeScript interface classes for all contracts (implementing `Contract` from [@ton/core](https://www.npmjs.com/package/@ton/core))
   * include message [de]serialization primitives, getter wrappers and compilation functions
   * used by the test suite and client code to interact with the contracts from TypeScript
@@ -131,7 +132,7 @@ Before developing, make sure that your current working directory is located in t
 ### Creating contracts
 
 1. Run interactive:    `npx blueprint create`   or   `yarn blueprint create`
-2. Non-interactive: &nbsp; `npx/yarn blueprint create <CONTRACT> --type <TYPE>` (type can be `func-empty`, `func-counter`, `tact-empty`, `tact-counter`)
+2. Non-interactive: &nbsp; `npx/yarn blueprint create <CONTRACT> --type <TYPE>` (type can be `func-empty`, `tolk-empty`, `tact-empty`, `func-counter`, `tolk-counter`, `tact-counter`)
    * Example: `yarn blueprint create MyNewContract --type func-empty`
 
 ### Writing contract code
@@ -141,8 +142,12 @@ Before developing, make sure that your current working directory is located in t
 2. Implement shared FunC imports (if breaking code to multiple files) in `contracts/imports/*.fc`
 3. Implement wrapper TypeScript class in `wrappers/<CONTRACT>.ts` to encode messages and decode getters
 
+#### Tolk
+1. Implement the contract in `contracts/<CONTRACT>.tolk`; if you wish, split into multiple files
+2. Implement wrapper TypeScript class in `wrappers/<CONTRACT>.ts` to encode messages and decode getters
+
 #### Tact
-1. Implement tact contract in `contracts/<CONTRACT>.tact`
+1. Implement the contract in `contracts/<CONTRACT>.tact`
 2. Wrappers will be automatically generated in `build/<CONTRACT>/tact_<CONTRACT>.ts`
 
 ### Testing contracts

package/dist/cli/constants.js

@@ -7,13 +7,21 @@ exports.templateTypes = [
         value: 'func-empty',
     },
     {
-        name: 'A simple counter contract (FunC)',
-        value: 'func-counter',
+        name: 'An empty contract (Tolk)',
+        value: 'tolk-empty',
     },
     {
         name: 'An empty contract (TACT)',
         value: 'tact-empty',
     },
+    {
+        name: 'A simple counter contract (FunC)',
+        value: 'func-counter',
+    },
+    {
+        name: 'A simple counter contract (Tolk)',
+        value: 'tolk-counter',
+    },
     {
         name: 'A simple counter contract (TACT)',
         value: 'tact-counter',

package/dist/cli/create.d.ts

@@ -1,6 +1,2 @@
 import { Runner } from './Runner';
-export declare const templateTypes: {
-    name: string;
-    value: string;
-}[];
 export declare const create: Runner;

package/dist/cli/create.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.create = exports.templateTypes = void 0;
+exports.create = void 0;
 const promises_1 = require("fs/promises");
 const path_1 = __importDefault(require("path"));
 const template_1 = require("../template");
@@ -47,24 +47,6 @@ async function createFiles(templatePath, realPath, replaces) {
         }
     }
 }
-exports.templateTypes = [
-    {
-        name: 'An empty contract (FunC)',
-        value: 'func-empty',
-    },
-    {
-        name: 'A simple counter contract (FunC)',
-        value: 'func-counter',
-    },
-    {
-        name: 'An empty contract (TACT)',
-        value: 'tact-empty',
-    },
-    {
-        name: 'A simple counter contract (TACT)',
-        value: 'tact-counter',
-    },
-];
 const create = async (args, ui) => {
     const localArgs = (0, arg_1.default)({
         '--type': String,
@@ -81,7 +63,7 @@ const create = async (args, ui) => {
         throw new Error(`Cannot create a contract with an empty name`);
     if (name.toLowerCase() === 'contract' || !/^[A-Z][a-zA-Z0-9]*$/.test(name))
         throw new Error(`Cannot create a contract with the name '${name}'`);
-    const which = (await (0, utils_1.selectOption)(exports.templateTypes, {
+    const which = (await (0, utils_1.selectOption)(constants_1.templateTypes, {
         ui,
         msg: 'What type of contract do you want to create?',
         hint: localArgs['--type'],
@@ -92,7 +74,7 @@ const create = async (args, ui) => {
         name,
         loweredName: name.substring(0, 1).toLowerCase() + name.substring(1),
         snakeName,
-        contractPath: 'contracts/' + snakeName + '.' + (lang === 'func' ? 'fc' : 'tact'),
+        contractPath: 'contracts/' + snakeName + '.' + (lang === 'func' ? 'fc' : (lang === 'tolk' ? 'tolk' : 'tact')),
     };
     const config = await (0, utils_2.getConfig)();
     const commonPath = config?.separateCompilables ? 'common' : 'not-separated-common';

package/dist/compile/CompilerConfig.d.ts

@@ -23,4 +23,11 @@ export type FuncCompilerConfig = {
     targets?: string[];
     sources: SourcesArray;
 });
-export type CompilerConfig = (TactCompilerConfig | FuncCompilerConfig) & CommonCompilerConfig;
+export type TolkCompilerConfig = {
+    lang: 'tolk';
+    entrypoint: string;
+    optimizationLevel?: number;
+    withStackComments?: boolean;
+    experimentalOptions?: string;
+};
+export type CompilerConfig = (TactCompilerConfig | FuncCompilerConfig | TolkCompilerConfig) & CommonCompilerConfig;

package/dist/compile/compile.d.ts

@@ -1,14 +1,24 @@
 /// <reference types="node" />
-import { SourcesArray } from '@ton-community/func-js';
 import { Cell } from '@ton/core';
 import { TactCompilerConfig } from './CompilerConfig';
 export declare function getCompilablesDirectory(): Promise<string>;
 export declare const COMPILE_END = ".compile.ts";
+export type SourceSnapshot = {
+    filename: string;
+    content: string;
+};
+export type TolkCompileResult = {
+    lang: 'tolk';
+    stderr: string;
+    code: Cell;
+    snapshot: SourceSnapshot[];
+    version: string;
+};
 export type FuncCompileResult = {
     lang: 'func';
     code: Cell;
     targets: string[];
-    snapshot: SourcesArray;
+    snapshot: SourceSnapshot[];
     version: string;
 };
 export type TactCompileResult = {
@@ -17,7 +27,7 @@ export type TactCompileResult = {
     code: Cell;
     options?: TactCompilerConfig['options'];
 };
-export type CompileResult = TactCompileResult | FuncCompileResult;
+export type CompileResult = TactCompileResult | FuncCompileResult | TolkCompileResult;
 export declare function doCompile(name: string, opts?: CompileOpts): Promise<CompileResult>;
 export type CompileOpts = {
     hookUserData?: any;

package/dist/compile/compile.js

@@ -35,6 +35,7 @@ const paths_1 = require("../paths");
 const Tact = __importStar(require("@tact-lang/compiler"));
 const OverwritableVirtualFileSystem_1 = require("./OverwritableVirtualFileSystem");
 const utils_1 = require("../config/utils");
+const tolk_js_1 = require("@ton/tolk-js");
 async function getCompilablesDirectory() {
     const config = await (0, utils_1.getConfig)();
     if (config?.separateCompilables) {
@@ -53,6 +54,22 @@ async function getCompilerConfigForContract(name) {
     }
     return mod.compile;
 }
+async function doCompileTolk(config) {
+    const res = await (0, tolk_js_1.runTolkCompiler)(config);
+    if (res.status === 'error') {
+        throw new Error(res.message);
+    }
+    return {
+        lang: 'tolk',
+        stderr: res.stderr,
+        code: core_1.Cell.fromBase64(res.codeBoc64),
+        snapshot: res.sourcesSnapshot.map((e) => ({
+            filename: e.filename,
+            content: e.contents,
+        })),
+        version: await (0, tolk_js_1.getTolkCompilerVersion)(),
+    };
+}
 async function doCompileFunc(config) {
     const cr = await (0, func_js_1.compileFunc)(config);
     if (cr.status === 'error')
@@ -126,6 +143,15 @@ async function doCompileInner(name, config) {
     if (config.lang === 'tact') {
         return await doCompileTact(config, name);
     }
+    if (config.lang === 'tolk') {
+        return await doCompileTolk({
+            entrypointFileName: config.entrypoint,
+            fsReadCallback: (path) => (0, fs_1.readFileSync)(path).toString(),
+            optimizationLevel: config.optimizationLevel,
+            withStackComments: config.withStackComments,
+            experimentalOptions: config.experimentalOptions,
+        });
+    }
     return await doCompileFunc({
         targets: config.targets,
         sources: config.sources ?? ((path) => (0, fs_1.readFileSync)(path).toString()),

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 export { tonDeepLink, sleep } from './utils';
 export { NetworkProvider } from './network/NetworkProvider';
 export { createNetworkProvider } from './network/createNetworkProvider';
-export { compile, CompileOpts } from './compile/compile';
+export { compile, CompileOpts, SourceSnapshot, TolkCompileResult, FuncCompileResult, TactCompileResult, CompileResult } from './compile/compile';
 export { CompilerConfig, HookParams } from './compile/CompilerConfig';
 export { UIProvider } from './ui/UIProvider';
 export { Config } from './config/Config';