@ton/blueprint 0.13.0 → 0.14.1

package/CHANGELOG.md

@@ -5,6 +5,18 @@ 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.14.1] - 2023-12-01
+
+### Fixed
+
+- Fixed test templates (added missing imports)
+
+## [0.14.0] - 2023-11-23
+
+### Added
+
+- Added `verify` command to quickly verify contracts on [verifier.ton.org](https://verifier.ton.org)
+
 ## [0.13.0] - 2023-11-05
 
 ### Added

package/README.md

@@ -103,7 +103,25 @@ Run in terminal:   `npx blueprint help`   or   `yarn blueprint he
 2. Implement a deployment script in `scripts/deploy<CONTRACT>.ts`
 3. Rely on the wrapper TypeScript class from `wrappers/<CONTRACT>.ts` to initialize the contract
 
-&nbsp;
+## Plugins
+
+Blueprint has a plugin system to allow the community to develop their own additions for the ecosystem without the need to change blueprint's code.
+
+In order to use plugins, create a `blueprint.config.ts` file in the root of your project with something like this:
+```typescript
+import { Config } from '@ton/blueprint';
+import { ScaffoldPlugin } from 'blueprint-scaffold';
+
+export const config: Config = {
+   plugins: [new ScaffoldPlugin()],
+};
+```
+(This example shows how to add the [scaffold](https://github.com/1IxI1/blueprint-scaffold) plugin)
+
+It is important that the config is exported, is named `config`, and is not `default` exported.
+
+Here are some of the plugins developed by the community:
+- [scaffold](https://github.com/1IxI1/blueprint-scaffold) - allows developers to quickly create a simple dapp automatically using the wrappers' code
 
 ## Contributors
 

package/dist/cli/build.d.ts

@@ -1,2 +1,8 @@
-import { Runner } from './Runner';
+import { Args, Runner } from './Runner';
+import { UIProvider } from '../ui/UIProvider';
+export declare function selectCompile(ui: UIProvider, args: Args): Promise<{
+    module: any;
+    name: string;
+    path: string;
+}>;
 export declare const build: Runner;

package/dist/cli/build.js

@@ -3,12 +3,19 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.build = void 0;
+exports.build = exports.selectCompile = void 0;
 const utils_1 = require("../utils");
 const arg_1 = __importDefault(require("arg"));
 const build_1 = require("../build");
+async function selectCompile(ui, args) {
+    return await (0, utils_1.selectFile)(await (0, utils_1.findCompiles)(), {
+        ui,
+        hint: args._.length > 1 && args._[1].length > 0 ? args._[1] : undefined,
+        import: false,
+    });
+}
+exports.selectCompile = selectCompile;
 const build = async (args, ui) => {
-    require('ts-node/register');
     const localArgs = (0, arg_1.default)({
         '--all': Boolean,
     });
@@ -16,11 +23,7 @@ const build = async (args, ui) => {
         await (0, build_1.buildAll)();
     }
     else {
-        const sel = await (0, utils_1.selectFile)(await (0, utils_1.findCompiles)(), {
-            ui,
-            hint: args._.length > 1 && args._[1].length > 0 ? args._[1] : undefined,
-            import: false,
-        });
+        const sel = await selectCompile(ui, args);
         await (0, build_1.buildOne)(sel.name, ui);
     }
 };

package/dist/cli/cli.js

@@ -35,6 +35,7 @@ const create_1 = require("./create");
 const run_1 = require("./run");
 const build_1 = require("./build");
 const test_1 = require("./test");
+const verify_1 = require("./verify");
 const help_1 = require("./help");
 const InquirerUIProvider_1 = require("../ui/InquirerUIProvider");
 const Runner_1 = require("./Runner");
@@ -45,6 +46,7 @@ const runners = {
     build: build_1.build,
     test: test_1.test,
     help: help_1.help,
+    verify: verify_1.verify,
 };
 async function main() {
     var _a;

package/dist/cli/help.js

@@ -14,7 +14,8 @@ List of available commands:
 - run
 - build
 - help
-- test`,
+- test
+- verify`,
     create: `Usage: blueprint create [contract name] [flags]
 
 Creates a new contract together with supporting files according to a template.
@@ -47,6 +48,12 @@ Flags:
     test: `Usage: blueprint test
 
 Just runs \`npm test\`, which by default runs \`jest\`.`,
+    verify: `Usage: blueprint verify [contract name] [flags]
+
+Builds a contract (similar to build command) and verifies it on https://verifier.ton.org. The contract must be already deployed on the network. If the contract's name is not specified on the command line, it will be asked interactively.
+
+Flags:
+--mainnet, --testnet - specifies the network on which to verify the contract. If not specified on the command line, it will be asked interactively.`
 };
 exports.additionalHelpMessages = {};
 const help = async (args, ui) => {

package/dist/cli/run.js

@@ -4,7 +4,6 @@ exports.run = void 0;
 const createNetworkProvider_1 = require("../network/createNetworkProvider");
 const utils_1 = require("../utils");
 const run = async (args, ui) => {
-    require('ts-node/register');
     const { module: mod } = await (0, utils_1.selectFile)(await (0, utils_1.findScripts)(), {
         ui,
         hint: args._.length > 1 && args._[1].length > 0 ? args._[1] : undefined,

package/dist/cli/test.js

@@ -3,7 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.test = void 0;
 const child_process_1 = require("child_process");
 const test = async () => {
-    require('ts-node/register');
     (0, child_process_1.execSync)('npm test', { stdio: 'inherit' });
 };
 exports.test = test;

package/dist/cli/verify.d.ts

@@ -0,0 +1,2 @@
+import { Runner } from './Runner';
+export declare const verify: Runner;

package/dist/cli/verify.js

@@ -0,0 +1,179 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.verify = void 0;
+const core_1 = require("@ton/core");
+const compile_1 = require("../compile/compile");
+const path_1 = __importDefault(require("path"));
+const createNetworkProvider_1 = require("../network/createNetworkProvider");
+const build_1 = require("./build");
+const backends = {
+    mainnet: {
+        verifierRegistry: core_1.Address.parse('EQDS0AW7NV1w3nFwx-mmryfpH4OGQ3PXnoFGOJA_8PTHuLrw'),
+        backends: [
+            'https://ton-source-prod-1.herokuapp.com',
+            'https://ton-source-prod-2.herokuapp.com',
+            'https://ton-source-prod-3.herokuapp.com',
+        ],
+        id: 'orbs.com',
+    },
+    testnet: {
+        verifierRegistry: core_1.Address.parse('EQB--CRXUbqYbqJKScEWeOrnk0TKJxB071M-WwvMpMEvq6Ed'),
+        backends: ['https://ton-source-prod-testnet-1.herokuapp.com'],
+        id: 'orbs-testnet',
+    },
+};
+function removeRandom(els) {
+    return els.splice(Math.floor(Math.random() * els.length), 1)[0];
+}
+class VerifierRegistry {
+    constructor(address) {
+        this.address = address;
+    }
+    async getVerifiers(provider) {
+        const res = await provider.get('get_verifiers', []);
+        const item = res.stack.readCell();
+        const c = item.beginParse();
+        const d = c.loadDict(core_1.Dictionary.Keys.BigUint(256), {
+            serialize: () => {
+                throw undefined;
+            },
+            parse: (s) => s,
+        });
+        return Array.from(d.values()).map((v) => {
+            const admin = v.loadAddress();
+            const quorom = v.loadUint(8);
+            const pubKeyEndpoints = v.loadDict(core_1.Dictionary.Keys.BigUint(256), core_1.Dictionary.Values.Uint(32));
+            return {
+                admin: admin,
+                quorum: quorom,
+                pubKeyEndpoints: new Map(Array.from(pubKeyEndpoints).map(([k, v]) => [k, v])),
+                name: v.loadRef().beginParse().loadStringTail(),
+                url: v.loadRef().beginParse().loadStringTail(),
+            };
+        });
+    }
+}
+const verify = async (args, ui) => {
+    const sel = await (0, build_1.selectCompile)(ui, args);
+    const networkProvider = await (0, createNetworkProvider_1.createNetworkProvider)(ui, false);
+    const sender = networkProvider.sender();
+    const senderAddress = sender.address;
+    if (senderAddress === undefined) {
+        throw new Error('Sender address needs to be known');
+    }
+    const network = networkProvider.network();
+    if (network === 'custom') {
+        throw new Error('Cannot use custom network');
+    }
+    const addr = await ui.input('Deployed contract address');
+    const result = await (0, compile_1.doCompile)(sel.name);
+    let src;
+    const fd = new FormData();
+    if (result.lang === 'func') {
+        for (const f of result.snapshot) {
+            fd.append(f.filename, new Blob([f.content]), path_1.default.basename(f.filename));
+        }
+        src = {
+            compiler: 'func',
+            compilerSettings: {
+                funcVersion: result.version,
+                commandLine: '-SPA ' + result.targets.join(' '),
+            },
+            knownContractAddress: addr,
+            knownContractHash: result.code.hash().toString('base64'),
+            sources: result.snapshot.map((s) => ({
+                includeInCommand: result.targets.includes(s.filename),
+                isEntrypoint: result.targets.includes(s.filename),
+                isStdLib: false,
+                hasIncludeDirectives: true,
+                folder: path_1.default.dirname(s.filename),
+            })),
+            senderAddress: senderAddress.toString(),
+        };
+    }
+    else if (result.lang === 'tact') {
+        let pkg = undefined;
+        for (const [k, v] of result.fs) {
+            if (k.endsWith('.pkg')) {
+                pkg = {
+                    name: k,
+                    content: v,
+                };
+                break;
+            }
+        }
+        if (pkg === undefined) {
+            throw new Error('Could not find .pkg in compilation results');
+        }
+        fd.append(path_1.default.basename(pkg.name), new Blob([pkg.content]), path_1.default.basename(pkg.name));
+        src = {
+            compiler: 'tact',
+            compilerSettings: {
+                tactVersion: '',
+            },
+            knownContractAddress: addr,
+            knownContractHash: result.code.hash().toString('base64'),
+            sources: [
+                {
+                    includeInCommand: true,
+                    isEntrypoint: false,
+                    isStdLib: false,
+                    hasIncludeDirectives: false,
+                    folder: '',
+                },
+            ],
+            senderAddress: senderAddress.toString(),
+        };
+    }
+    else {
+        // future proofing
+        throw new Error('Unsupported language ' + result.lang);
+    }
+    fd.append('json', new Blob([JSON.stringify(src)], {
+        type: 'application/json',
+    }), 'blob');
+    const backend = backends[network];
+    const verifierRegistry = networkProvider.open(new VerifierRegistry(backend.verifierRegistry));
+    const verifier = (await verifierRegistry.getVerifiers()).find((v) => v.name === backend.id);
+    if (verifier === undefined) {
+        throw new Error('Could not find verifier');
+    }
+    const remainingBackends = [...backend.backends];
+    const sourceResponse = await fetch(removeRandom(remainingBackends) + '/source', {
+        method: 'POST',
+        body: fd,
+    });
+    if (sourceResponse.status !== 200) {
+        throw new Error('Could not compile on backend:\n' + (await sourceResponse.text()));
+    }
+    const sourceResult = await sourceResponse.json();
+    if (sourceResult.compileResult.result !== 'similar') {
+        throw new Error('The code is not similar');
+    }
+    let msgCell = sourceResult.msgCell;
+    let acquiredSigs = 1;
+    while (acquiredSigs < verifier.quorum) {
+        const signResponse = await fetch(removeRandom(remainingBackends) + '/sign', {
+            method: 'POST',
+            body: JSON.stringify({
+                messageCell: msgCell,
+            }),
+        });
+        if (signResponse.status !== 200) {
+            throw new Error('Could not compile on backend:\n' + (await signResponse.text()));
+        }
+        const signResult = await signResponse.json();
+        msgCell = signResult.msgCell;
+        acquiredSigs++;
+    }
+    const c = core_1.Cell.fromBoc(Buffer.from(msgCell.data))[0];
+    await networkProvider.sender().send({
+        to: backend.verifierRegistry,
+        value: (0, core_1.toNano)('0.5'),
+        body: c,
+    });
+};
+exports.verify = verify;

package/dist/compile/compile.d.ts

@@ -1,8 +1,12 @@
 /// <reference types="node" />
+import { SourcesArray } from '@ton-community/func-js';
 import { Cell } from '@ton/core';
 export type FuncCompileResult = {
     lang: 'func';
     code: Cell;
+    targets: string[];
+    snapshot: SourcesArray;
+    version: string;
 };
 export type TactCompileResult = {
     lang: 'tact';

package/dist/compile/compile.js

@@ -36,7 +36,6 @@ const compiler_1 = require("@tact-lang/compiler");
 const OverwritableVirtualFileSystem_1 = require("./OverwritableVirtualFileSystem");
 async function getCompilerConfigForContract(name) {
     var _a;
-    require('ts-node/register');
     const mod = await (_a = path_1.default.join(paths_1.WRAPPERS_DIR, name + '.compile.ts'), Promise.resolve().then(() => __importStar(require(_a))));
     if (typeof mod.compile !== 'object') {
         throw new Error(`Object 'compile' is missing`);
@@ -47,9 +46,19 @@ async function doCompileFunc(config) {
     const cr = await (0, func_js_1.compileFunc)(config);
     if (cr.status === 'error')
         throw new Error(cr.message);
+    let targets = [];
+    if (config.targets) {
+        targets = config.targets;
+    }
+    else if (Array.isArray(config.sources)) {
+        targets = config.sources.map((s) => s.filename);
+    }
     return {
         lang: 'func',
         code: core_1.Cell.fromBase64(cr.codeBoc),
+        targets,
+        snapshot: cr.snapshot,
+        version: (await (0, func_js_1.compilerVersion)()).funcVersion,
     };
 }
 function findTactBoc(fs) {

package/dist/network/createNetworkProvider.d.ts

@@ -1,3 +1,3 @@
 import { UIProvider } from '../ui/UIProvider';
 import { NetworkProvider } from './NetworkProvider';
-export declare function createNetworkProvider(ui: UIProvider): Promise<NetworkProvider>;
+export declare function createNetworkProvider(ui: UIProvider, allowCustom?: boolean): Promise<NetworkProvider>;

package/dist/network/createNetworkProvider.js

@@ -196,9 +196,10 @@ async function createMnemonicProvider(client, ui) {
     });
 }
 class NetworkProviderBuilder {
-    constructor(args, ui) {
+    constructor(args, ui, allowCustom = true) {
         this.args = args;
         this.ui = ui;
+        this.allowCustom = allowCustom;
     }
     async chooseNetwork() {
         let network = (0, utils_1.oneOrZeroOf)({
@@ -207,7 +208,11 @@ class NetworkProviderBuilder {
             custom: this.args['--custom'] !== undefined,
         });
         if (!network) {
-            network = await this.ui.choose('Which network do you want to use?', ['mainnet', 'testnet', 'custom'], (c) => c);
+            let nets = ['mainnet', 'testnet'];
+            if (this.allowCustom) {
+                nets = ['mainnet', 'testnet', 'custom'];
+            }
+            network = await this.ui.choose('Which network do you want to use?', nets, (c) => c);
             if (network === 'custom') {
                 const defaultCustomEndpoint = 'http://localhost:8081/';
                 this.args['--custom'] = (await this.ui.input(`Provide a custom API v2 endpoint (default is ${defaultCustomEndpoint})`)).trim();
@@ -216,6 +221,9 @@ class NetworkProviderBuilder {
                 this.args['--custom'] += 'jsonRPC';
             }
         }
+        if (network === 'custom' && !this.allowCustom) {
+            throw new Error('Custom network is not allowed');
+        }
         return network;
     }
     chooseExplorer() {
@@ -304,8 +312,8 @@ class NetworkProviderBuilder {
         return new NetworkProviderImpl(tc, sender, network, explorer, this.ui);
     }
 }
-async function createNetworkProvider(ui) {
+async function createNetworkProvider(ui, allowCustom = true) {
     const args = (0, arg_1.default)(argSpec);
-    return await new NetworkProviderBuilder(args, ui).build();
+    return await new NetworkProviderBuilder(args, ui, allowCustom).build();
 }
 exports.createNetworkProvider = createNetworkProvider;

package/dist/templates/func/counter/tests/spec.ts.template

@@ -1,5 +1,5 @@
 {{name}}.spec.ts
-import { Blockchain, SandboxContract } from '@ton/sandbox';
+import { Blockchain, SandboxContract, TreasuryContract } from '@ton/sandbox';
 import { Cell, toNano } from '@ton/core';
 import { {{name}} } from '../wrappers/{{name}}';
 import '@ton/test-utils';

package/dist/templates/func/empty/tests/spec.ts.template

@@ -1,5 +1,5 @@
 {{name}}.spec.ts
-import { Blockchain, SandboxContract } from '@ton/sandbox';
+import { Blockchain, SandboxContract, TreasuryContract } from '@ton/sandbox';
 import { Cell, toNano } from '@ton/core';
 import { {{name}} } from '../wrappers/{{name}}';
 import '@ton/test-utils';

package/dist/templates/tact/counter/tests/spec.ts.template

@@ -1,5 +1,5 @@
 {{name}}.spec.ts
-import { Blockchain, SandboxContract } from '@ton/sandbox';
+import { Blockchain, SandboxContract, TreasuryContract } from '@ton/sandbox';
 import { toNano } from '@ton/core';
 import { {{name}} } from '../wrappers/{{name}}';
 import '@ton/test-utils';

package/dist/templates/tact/empty/tests/spec.ts.template

@@ -1,5 +1,5 @@
 {{name}}.spec.ts
-import { Blockchain, SandboxContract } from '@ton/sandbox';
+import { Blockchain, SandboxContract, TreasuryContract } from '@ton/sandbox';
 import { toNano } from '@ton/core';
 import { {{name}} } from '../wrappers/{{name}}';
 import '@ton/test-utils';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ton/blueprint",
-  "version": "0.13.0",
+  "version": "0.14.1",
   "description": "Framework for development of TON smart contracts",
   "main": "dist/index.js",
   "bin": "./dist/cli/cli.js",