@ton/blueprint 0.14.2 → 0.15.0

package/CHANGELOG.md

@@ -5,6 +5,20 @@ 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.15.0] - 2023-12-15
+
+### Added
+
+- Added flags `--custom-version`, `--custom-key`, `--custom-type` to `run` and `verify` commands to allow better control over custom API behavior
+
+### Changed
+
+- `--custom` now always adds `jsonRPC` to API URL for v2 APIs
+
+### Fixed
+
+- Fixed argument handling
+
 ## [0.14.2] - 2023-12-01
 
 ### Changed

package/dist/cli/build.js

@@ -23,7 +23,7 @@ const build = async (args, ui) => {
         await (0, build_1.buildAll)();
     }
     else {
-        const sel = await selectCompile(ui, args);
+        const sel = await selectCompile(ui, localArgs);
         await (0, build_1.buildOne)(sel.name, ui);
     }
 };

package/dist/cli/cli.js

@@ -91,22 +91,7 @@ async function main() {
         process.exit(1);
     }
     const ui = new InquirerUIProvider_1.InquirerUIProvider();
-    const waitingForCustomLink = args._.includes('--custom');
-    await runner({
-        ...args,
-        _: args._.filter((a, inx) => {
-            // filter out the flags
-            if (a.length > 1 && a[0] === '-')
-                return false;
-            // and endpoint urls
-            if (waitingForCustomLink) {
-                if (args._[inx - 1] === '--custom' && // url goes after --custom
-                    a.startsWith('http'))
-                    return false;
-            }
-            return true;
-        }),
-    }, ui);
+    await runner(args, ui);
     ui.close();
 }
 process.on('SIGINT', () => {

package/dist/cli/create.js

@@ -67,8 +67,8 @@ const create = async (args, ui) => {
     const localArgs = (0, arg_1.default)({
         '--type': String,
     });
-    const name = args._.length > 1 && args._[1].trim().length > 0
-        ? args._[1].trim()
+    const name = localArgs._.length > 1 && localArgs._[1].trim().length > 0
+        ? localArgs._[1].trim()
         : await ui.input('Contract name (PascalCase)');
     if (name.length === 0)
         throw new Error(`Cannot create a contract with an empty name`);

package/dist/cli/help.js

@@ -34,7 +34,10 @@ Script name is matched (ignoring case) to a file in the scripts directory. If no
 
 Flags:
 --mainnet, --testnet - specifies the network to use when running the script. If not specified on the command line, it will be asked interactively.
---custom [api-v2-endpoint] - indicates that a custom API should be used when running the script, and the API URL optionally.
+--custom [api-endpoint] - indicates that a custom API should be used when running the script, and the API URL optionally. (example: https://testnet.toncenter.com/api/v2/)
+--custom-version - specifies the API version to use with the custom API. Options: v2 (defualt), v4.
+--custom-key - specifies the API key to use with the custom API, can only be used with API v2.
+--custom-type - specifies the network type to be indicated to scripts. Options: custom (default), mainnet, testnet.
 --tonconnect, --tonhub, --deeplink, --mnemonic - specifies the deployer to use when running the script. If not specified on the command line, it will be asked interactively.
 --tonscan, --tonviewer, --toncx, --dton - specifies the network explorer to use when displaying links to the deployed contracts. Default: tonscan.`,
     build: `Usage: blueprint build [contract name] [flags]
@@ -53,7 +56,11 @@ Just runs \`npm test\`, which by default runs \`jest\`.`,
 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.`
+--mainnet, --testnet - specifies the network to use when running the script. If not specified on the command line, it will be asked interactively.
+--custom [api-endpoint] - indicates that a custom API should be used when running the script, and the API URL optionally. (example: https://testnet.toncenter.com/api/v2/) Requires --custom-type to be specified.
+--custom-version - specifies the API version to use with the custom API. Options: v2 (defualt), v4.
+--custom-key - specifies the API key to use with the custom API, can only be used with API v2.
+--custom-type - specifies the network type to be indicated to scripts. Options: mainnet, testnet.`,
 };
 exports.additionalHelpMessages = {};
 const help = async (args, ui) => {

package/dist/cli/run.js

@@ -1,17 +1,22 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.run = void 0;
 const createNetworkProvider_1 = require("../network/createNetworkProvider");
 const utils_1 = require("../utils");
+const arg_1 = __importDefault(require("arg"));
 const run = async (args, ui) => {
+    const localArgs = (0, arg_1.default)(createNetworkProvider_1.argSpec);
     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,
+        hint: localArgs._.length > 1 && localArgs._[1].length > 0 ? localArgs._[1] : undefined,
     });
     if (typeof mod.run !== 'function') {
         throw new Error('Function `run` is missing!');
     }
-    const networkProvider = await (0, createNetworkProvider_1.createNetworkProvider)(ui);
-    await mod.run(networkProvider, args._.slice(2));
+    const networkProvider = await (0, createNetworkProvider_1.createNetworkProvider)(ui, localArgs);
+    await mod.run(networkProvider, localArgs._.slice(2));
 };
 exports.run = run;

package/dist/cli/verify.js

@@ -9,6 +9,7 @@ const compile_1 = require("../compile/compile");
 const path_1 = __importDefault(require("path"));
 const createNetworkProvider_1 = require("../network/createNetworkProvider");
 const build_1 = require("./build");
+const arg_1 = __importDefault(require("arg"));
 const backends = {
     mainnet: {
         verifierRegistry: core_1.Address.parse('EQDS0AW7NV1w3nFwx-mmryfpH4OGQ3PXnoFGOJA_8PTHuLrw'),
@@ -57,8 +58,9 @@ class VerifierRegistry {
     }
 }
 const verify = async (args, ui) => {
-    const sel = await (0, build_1.selectCompile)(ui, args);
-    const networkProvider = await (0, createNetworkProvider_1.createNetworkProvider)(ui, false);
+    const localArgs = (0, arg_1.default)(createNetworkProvider_1.argSpec);
+    const sel = await (0, build_1.selectCompile)(ui, localArgs);
+    const networkProvider = await (0, createNetworkProvider_1.createNetworkProvider)(ui, localArgs, false);
     const sender = networkProvider.sender();
     const senderAddress = sender.address;
     if (senderAddress === undefined) {

package/dist/network/createNetworkProvider.d.ts

@@ -1,3 +1,21 @@
+import arg from 'arg';
 import { UIProvider } from '../ui/UIProvider';
 import { NetworkProvider } from './NetworkProvider';
-export declare function createNetworkProvider(ui: UIProvider, allowCustom?: boolean): Promise<NetworkProvider>;
+export declare const argSpec: {
+    '--mainnet': BooleanConstructor;
+    '--testnet': BooleanConstructor;
+    '--custom': StringConstructor;
+    '--custom-type': StringConstructor;
+    '--custom-version': StringConstructor;
+    '--custom-key': StringConstructor;
+    '--tonconnect': BooleanConstructor;
+    '--deeplink': BooleanConstructor;
+    '--tonhub': BooleanConstructor;
+    '--mnemonic': BooleanConstructor;
+    '--tonscan': BooleanConstructor;
+    '--tonviewer': BooleanConstructor;
+    '--toncx': BooleanConstructor;
+    '--dton': BooleanConstructor;
+};
+export type Args = arg.Result<typeof argSpec>;
+export declare function createNetworkProvider(ui: UIProvider, args: Args, allowCustom?: boolean): Promise<NetworkProvider>;

package/dist/network/createNetworkProvider.js

@@ -15,9 +15,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 var _SendProviderSender_provider, _WrappedContractProvider_address, _WrappedContractProvider_provider, _WrappedContractProvider_init, _NetworkProviderImpl_tc, _NetworkProviderImpl_sender, _NetworkProviderImpl_network, _NetworkProviderImpl_explorer, _NetworkProviderImpl_ui;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createNetworkProvider = void 0;
+exports.createNetworkProvider = exports.argSpec = void 0;
 const utils_1 = require("../utils");
-const arg_1 = __importDefault(require("arg"));
 const DeeplinkProvider_1 = require("./send/DeeplinkProvider");
 const TonConnectProvider_1 = require("./send/TonConnectProvider");
 const TonHubProvider_1 = require("./send/TonHubProvider");
@@ -29,10 +28,13 @@ const path_1 = __importDefault(require("path"));
 const paths_1 = require("../paths");
 const crypto_1 = require("@ton/crypto");
 const MnemonicProvider_1 = require("./send/MnemonicProvider");
-const argSpec = {
+exports.argSpec = {
     '--mainnet': Boolean,
     '--testnet': Boolean,
     '--custom': String,
+    '--custom-type': String,
+    '--custom-version': String,
+    '--custom-key': String,
     '--tonconnect': Boolean,
     '--deeplink': Boolean,
     '--tonhub': Boolean,
@@ -208,22 +210,14 @@ class NetworkProviderBuilder {
             custom: this.args['--custom'] !== undefined,
         });
         if (!network) {
-            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);
+            network = await this.ui.choose('Which network do you want to use?', ['mainnet', 'testnet', 'custom'], (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();
                 if (this.args['--custom'] === '')
                     this.args['--custom'] = defaultCustomEndpoint;
-                this.args['--custom'] += 'jsonRPC';
             }
         }
-        if (network === 'custom' && !this.allowCustom) {
-            throw new Error('Custom network is not allowed');
-        }
         return network;
     }
     chooseExplorer() {
@@ -286,11 +280,44 @@ class NetworkProviderBuilder {
         return provider;
     }
     async build() {
-        const network = await this.chooseNetwork();
+        let network = await this.chooseNetwork();
         const explorer = this.chooseExplorer();
+        if (network !== 'custom' &&
+            (this.args['--custom-key'] !== undefined ||
+                this.args['--custom-type'] !== undefined ||
+                this.args['--custom-version'] !== undefined)) {
+            throw new Error('Cannot use custom parameters with a non-custom network');
+        }
         let tc;
         if (network === 'custom') {
-            tc = new ton_1.TonClient({ endpoint: this.args['--custom'] });
+            const endpoint = this.args['--custom'];
+            if (this.args['--custom-version'] === undefined || this.args['--custom-version'].toLowerCase() === 'v2') {
+                tc = new ton_1.TonClient({
+                    endpoint: endpoint + 'jsonRPC',
+                    apiKey: this.args['--custom-key'],
+                });
+            }
+            else if (this.args['--custom-version'].toLowerCase() === 'v4') {
+                if (this.args['--custom-key'] !== undefined) {
+                    throw new Error('Cannot use a custom API key with a v4 API');
+                }
+                tc = new ton_1.TonClient4({
+                    endpoint,
+                });
+            }
+            else {
+                throw new Error('Unknown API version: ' + this.args['--custom-version']);
+            }
+            if (this.args['--custom-type'] !== undefined) {
+                const ct = this.args['--custom-type'].toLowerCase();
+                if (!['mainnet', 'testnet', 'custom'].includes(ct)) {
+                    throw new Error('Unknown network type: ' + ct);
+                }
+                network = ct;
+            }
+            else if (!this.allowCustom) {
+                throw new Error('The usage of this network provider requires either mainnet or testnet');
+            }
         }
         else {
             tc = new ton_1.TonClient4({
@@ -312,8 +339,7 @@ class NetworkProviderBuilder {
         return new NetworkProviderImpl(tc, sender, network, explorer, this.ui);
     }
 }
-async function createNetworkProvider(ui, allowCustom = true) {
-    const args = (0, arg_1.default)(argSpec);
+async function createNetworkProvider(ui, args, allowCustom = true) {
     return await new NetworkProviderBuilder(args, ui, allowCustom).build();
 }
 exports.createNetworkProvider = createNetworkProvider;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ton/blueprint",
-  "version": "0.14.2",
+  "version": "0.15.0",
   "description": "Framework for development of TON smart contracts",
   "main": "dist/index.js",
   "bin": "./dist/cli/cli.js",
@@ -36,7 +36,7 @@
   "dependencies": {
     "@orbs-network/ton-access": "^2.3.3",
     "@tact-lang/compiler": "^1.1.5",
-    "@ton-community/func-js": "^0.6.2",
+    "@ton-community/func-js": "^0.6.3",
     "@tonconnect/sdk": "^2.1.3",
     "arg": "^5.0.2",
     "chalk": "^4.1.0",