create-ton 0.0.3

package/dist/cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/cli.js

@@ -0,0 +1,80 @@
+#!/usr/bin/env node
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const path_1 = __importDefault(require("path"));
+const child_process_1 = require("child_process");
+const inquirer_1 = __importDefault(require("inquirer"));
+const PACKAGE_JSON = 'package.json';
+async function main() {
+    const { name, variant } = await inquirer_1.default.prompt([
+        {
+            name: 'name',
+            message: 'Project name',
+        },
+        {
+            name: 'variant',
+            message: 'Choose the project template',
+            type: 'list',
+            choices: [
+                {
+                    name: 'An empty contract',
+                    value: 'empty',
+                },
+                {
+                    name: 'A simple counter contract',
+                    value: 'counter',
+                },
+            ],
+        },
+    ]);
+    if (name.length === 0)
+        throw new Error('Cannot initialize a project with an empty name');
+    await fs_extra_1.default.mkdir(name);
+    const steps = 2;
+    console.log(`[1/${steps}] Copying files...`);
+    const basePath = path_1.default.join(__dirname, 'template');
+    for (const file of await fs_extra_1.default.readdir(basePath)) {
+        if (file === PACKAGE_JSON || file === 'variants')
+            continue;
+        await fs_extra_1.default.copy(path_1.default.join(basePath, file), path_1.default.join(name, file));
+    }
+    const variantPath = path_1.default.join(basePath, 'variants', variant);
+    for (const file of await fs_extra_1.default.readdir(variantPath)) {
+        await fs_extra_1.default.copy(path_1.default.join(variantPath, file), path_1.default.join(name, file));
+    }
+    await fs_extra_1.default.writeFile(path_1.default.join(name, '.gitignore'), `node_modules
+temp
+build`);
+    await fs_extra_1.default.writeFile(path_1.default.join(name, PACKAGE_JSON), (await fs_extra_1.default.readFile(path_1.default.join(basePath, PACKAGE_JSON))).toString().replace('{{name}}', name));
+    console.log(`[2/${steps}] Installing dependencies...`);
+    (0, child_process_1.execSync)('npm i', {
+        stdio: 'inherit',
+        cwd: name,
+    });
+    (0, child_process_1.execSync)('git init', {
+        stdio: 'inherit',
+        cwd: name,
+    });
+    console.log('\nInitialized git repository.\n');
+    console.log(`Success!
+Now you can run the following to run the default tests:
+cd ${name}
+npm run test
+
+You can also run the following commands in your project's directory:
+
+npx blueprint create MyContract
+creates all the necessary files for a new contract
+
+npx blueprint build
+asks you to choose a contract and builds it
+
+npx blueprint run
+asks you to choose a script and runs it
+`);
+}
+main().catch(console.error);

package/dist/template/.prettierrc

@@ -0,0 +1,7 @@
+{
+    "printWidth": 120,
+    "tabWidth": 4,
+    "singleQuote": true,
+    "bracketSpacing": true,
+    "semi": true
+}

package/dist/template/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Tontech
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/template/README.md

@@ -0,0 +1,82 @@
+# TON project template (RFC)
+
+Starter template for a new TON project - FunC contracts, unit tests, compilation and deployment scripts.
+
+> This repo is a work in progress and is subject to change
+
+## Layout
+
+-   `contracts` - contains the source code of all the smart contracts of the project and their dependencies.
+-   `wrappers` - contains the wrapper classes (implementing `Contract` from ton-core) for the contracts, including any [de]serialization primitives and compilation functions.
+-   `tests` - tests for the contracts. Would typically use the wrappers.
+-   `scripts` - contains scripts used by the project, mainly the deployment scripts.   
+
+We ask the community to provide any comments on this layout, the wanted/required changes, or even suggestions for entirely different project structures and/or tool concepts.
+
+PRs are welcome!
+
+## Repo contents / tech stack
+1. Compiling FunC - [https://github.com/ton-community/func-js](https://github.com/ton-community/func-js)
+2. Testing TON smart contracts - [https://github.com/ton-community/sandbox/](https://github.com/ton-community/sandbox/)
+3. Deployment of contracts is supported with [TON Connect 2](https://github.com/ton-connect/), [Tonhub wallet](https://tonhub.com/) or via a direct `ton://` deeplink
+
+## How to use
+* Clone this repo
+* Run `yarn install`
+
+### Building a contract
+1. Interactively
+   1. Run `yarn blueprint build`
+   2. Choose the contract you'd like to build
+1. Non-interactively
+   1. Run `yarn blueprint build <CONTRACT>`
+   2. example: `yarn blueprint build pingpong`
+
+### Deploying a contract
+1. Interactively
+   1. Run `yarn blueprint run`
+   2. Choose the contract you'd like to deploy
+   3. Choose whether you're deploying on mainnet or testnet
+   4. Choose how to deploy:
+      1. With a TON Connect compatible wallet
+      2. A `ton://` deep link / QR code
+      3. Tonhub wallet
+   5. Deploy the contract
+2. Non-interactively
+   1. Run `yarn blueprint run <CONTRACT> --<NETWORK> --<DEPLOY_METHOD>`
+   2. example: `yarn blueprint run pingpong --mainnet --tonconnect`
+
+### Testing
+1. Run `yarn test`
+
+## Adding your own contract
+1. Run `yarn blueprint create <CONTRACT>`
+2. example: `yarn blueprint create MyContract`
+
+* Write code
+  * FunC contracts are located in `contracts/*.fc`
+    * Standalone root contracts are located in `contracts/*.fc`
+    * Shared imports (when breaking code to multiple files) are in `contracts/imports/*.fc`
+  * Tests in TypeScript are located in `test/*.spec.ts`
+  * Wrapper classes for interacting with the contract are located in `wrappers/*.ts`
+  * Any scripts (including deployers) are located in `scripts/*.ts`
+
+* Build
+  * Builder configs are located in `wrappers/*.compile.ts`
+  * In the root repo dir, run in terminal `yarn blueprint build`
+  * Compilation errors will appear on screen, if applicable
+  * Resulting build artifacts include:
+    * `build/*.compiled.json` - the binary code cell of the compiled contract (for deployment). Saved in a hex format within a json file to support webapp imports
+
+* Test
+  * In the root repo dir, run in terminal `yarn test`
+  * Don't forget to build (or rebuild) before running tests
+  * Tests are running inside Node.js by running TVM in web-assembly using [sandbox](https://github.com/ton-community/sandbox)
+
+* Deploy
+  * Run `yarn blueprint run <deployscript>`
+  * Contracts will be rebuilt on each execution
+  * Follow the on-screen instructions of the deploy script
+  
+# License
+MIT

package/dist/template/jest.config.js

@@ -0,0 +1,4 @@
+module.exports = {
+    preset: 'ts-jest',
+    testEnvironment: 'node',
+};

package/dist/template/package.json

@@ -0,0 +1,23 @@
+{
+    "name": "{{name}}",
+    "version": "0.0.1",
+    "license": "MIT",
+    "scripts": {
+        "test": "jest"
+    },
+    "devDependencies": {
+        "@ton-community/blueprint": "^0.0.2",
+        "@ton-community/sandbox": "^0.2.0",
+        "@ton-community/test-utils": "^0.0.2",
+        "@types/jest": "^29.2.6",
+        "@types/node": "^18.11.18",
+        "jest": "^29.3.1",
+        "prettier": "^2.8.3",
+        "ton": "^13.3.0",
+        "ton-core": "^0.46.0",
+        "ton-crypto": "^3.2.0",
+        "ts-jest": "^29.0.5",
+        "ts-node": "^10.9.1",
+        "typescript": "^4.9.4"
+    }
+}

package/dist/template/tsconfig.json

@@ -0,0 +1,12 @@
+{
+    "compilerOptions": {
+        "target": "ES2020",
+        "outDir": "dist",
+        "module": "commonjs",
+        "declaration": true,
+        "esModuleInterop": true,
+        "forceConsistentCasingInFileNames": true,
+        "strict": true,
+        "skipLibCheck": true
+    }
+}

package/dist/template/variants/counter/contracts/counter.fc

@@ -0,0 +1,71 @@
+#include "imports/stdlib.fc";
+
+const op::increase = "op::increase"c; ;; create an opcode from string using the "c" prefix, this results in 0x7e8764ef opcode in this case
+
+;; storage variables
+
+;; id is required to be able to create different instances of counters
+;; since addresses in TON depend on the initial state of the contract
+global int ctx_id;
+global int ctx_counter;
+
+;; load_data populates storage variables using stored data
+() load_data() impure {
+    var ds = get_data().begin_parse();
+
+    ctx_id = ds~load_uint(32);
+    ctx_counter = ds~load_uint(32);
+
+    ds.end_parse();
+}
+
+;; save_data stores storage variables as a cell into persistent storage
+() save_data() impure {
+    set_data(
+        begin_cell()
+            .store_uint(ctx_id, 32)
+            .store_uint(ctx_counter, 32)
+            .end_cell()
+    );
+}
+
+;; recv_internal is the main function of the contract and is called when it receives a message from other contract's
+() recv_internal(int my_balance, int msg_value, cell in_msg_full, slice in_msg_body) impure {
+    if (in_msg_body.slice_empty?()) { ;; ignore all empty messages
+        return ();
+    }
+
+    slice cs = in_msg_full.begin_parse();
+    int flags = cs~load_uint(4);
+    if (flags & 1) { ;; ignore all bounced messages
+        return ();
+    }
+
+    load_data(); ;; here we populate the storage variables
+
+    int op = in_msg_body~load_uint(32); ;; by convention, the first 32 bits of incoming message is the op
+    int query_id = in_msg_body~load_uint(64); ;; also by convention, the next 64 bits contain the "query id", although this is not always the case
+
+    if (op == op::increase) {
+        int increase_by = in_msg_body~load_uint(32);
+        ctx_counter += increase_by;
+        save_data();
+        return ();
+    }
+
+    throw(0xffff); ;; if the message contains an op that is not known to this contract, we throw
+}
+
+;; get methods are a means to conveniently read contract data using, for example, HTTP APIs
+;; they are marked with method_id
+;; note that unlike in many other smart contract VMs, get methods cannot be called by other contracts
+
+int get_counter() method_id {
+    load_data();
+    return ctx_counter;
+}
+
+int get_id() method_id {
+    load_data();
+    return ctx_id;
+}