Merge pull request #146 from tonlabs/1.5.0-rc

Version 1.5.0

.github/workflows/npmpublish.yml

@@ -53,3 +53,12 @@ jobs:
           npm publish
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+  send-discord-msg:
+    needs: [publish-npm]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Discord notification
+        env:
+          DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
+        uses: Ilshidur/action-discord@master

.gitignore

@@ -116,3 +116,5 @@ dist
 .yarn/build-state.yml
 .yarn/install-state.gz
 .pnp.*
+.idea
+/package-lock.json

CHANGELOG.md

@@ -2,14 +2,21 @@
 
 All notable changes to this project will be documented in this file.
 
+## [1.5.0] - 2022-11-16
+
+### New
+
+- Support for `*.tsol` extension in Solidity compiler.
+- Ability to specify contract arguments from json files in form of `@file` or `@file@field`.
+
 ## [1.4.1] - 2022-11-16
 
 ### Fixed
 
--   Versions of dependency packages have been increased: @eversdk/core and @eversdk/appkit.\
-    The old ones caused unclear error messages.
+- Versions of dependency packages have been increased: @eversdk/core and @eversdk/appkit.\
+  The old ones caused unclear error messages.
 
--   Added an error message if the `network/registry.json` configuration file is corrupted.
+- Added an error message if the `network/registry.json` configuration file is corrupted.
 
 ## [1.4.0] - 2022-10-19
 

package.json

@@ -1,6 +1,6 @@
 {
     "name": "everdev",
-    "version": "1.4.1",
+    "version": "1.5.0",
     "description": "Everscale Dev Environment",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
@@ -45,9 +45,9 @@
         "node": ">=6"
     },
     "dependencies": {
-        "@eversdk/appkit": "^0.3.3",
-        "@eversdk/core": "^1.38.1",
-        "@eversdk/lib-node": "^1.38.1",
+        "@eversdk/appkit": "^0.3.4",
+        "@eversdk/core": "^1.39.0",
+        "@eversdk/lib-node": "^1.39.0",
         "chalk": "^2.4.2",
         "dockerode": "^3.3.1",
         "fs-extra": "^9.1.0",

src/__tests__/addProjectId.ts

@@ -1,4 +1,4 @@
-import { transormEndpoint } from "../controllers/contract/accounts"
+import { transformEndpoint } from "../controllers/contract/accounts"
 import { doneTests, initTests } from "./init"
 
 beforeAll(initTests)
@@ -12,7 +12,7 @@ test("Transform different endpoints. Add projectId", async () => {
         "https://eri01.net.everos.dev/graphql/",
         "eri01.net.everos.dev/graphql",
     ]
-    const result = endpoints.map(transormEndpoint("myId"))
+    const result = endpoints.map(transformEndpoint("myId"))
     expect(result[0]).toEqual("eri01.net.everos.dev/myId")
     expect(result[1]).toEqual("https://eri01.net.everos.dev/myId")
     expect(result[2]).toEqual("eri01.net.everos.dev/myId")
@@ -27,7 +27,7 @@ test("Transform different endpoints. Add void projectId", async () => {
         "https://eri01.net.everos.dev/graphql/",
         "eri01.net.everos.dev/graphql",
     ]
-    const result = endpoints.map(transormEndpoint(undefined))
+    const result = endpoints.map(transformEndpoint(undefined))
     expect(result[0]).toEqual("eri01.net.everos.dev")
     expect(result[1]).toEqual("https://eri01.net.everos.dev")
     expect(result[2]).toEqual("eri01.net.everos.dev")

src/__tests__/contracts.ts

@@ -0,0 +1,28 @@
+import { doneTests, initTests } from "./init"
+import path from "path"
+import { ParamParser } from "../controllers/contract/param-parser"
+
+beforeAll(initTests)
+afterAll(doneTests)
+
+function dataPath(name: string): string {
+    return path.resolve(__dirname, "..", "..", "src", "__tests__", "data", name)
+}
+
+test("Contract alone args file", async () => {
+    const file = dataPath("contracts-input-alone.json")
+    const abi = { name: "a", type: "string[]" }
+    const args = ParamParser.components(abi, `@${file}`)
+    expect(args).toEqual([1, 2, 3])
+})
+
+test("Contract multi args file", async () => {
+    const file = dataPath("contracts-input.json")
+    const abi = { name: "a", type: "string[]" }
+    const args = ParamParser.components(abi, `@${file}@test1`)
+    expect(args).toEqual({ a: [1, 2, 3] })
+    const args2 = ParamParser.components(abi, `@${file}@test2`)
+    expect(args2).toEqual({ b: [1, 2, 3] })
+    const args3 = ParamParser.components(abi, `@${file}@test2.b`)
+    expect(args3).toEqual([1, 2, 3])
+})

src/__tests__/data/contracts-input-alone.json

@@ -0,0 +1,2 @@
+[1, 2, 3]
+

src/__tests__/data/contracts-input.json

@@ -0,0 +1,8 @@
+{
+	"test1": {
+		"a": [1, 2, 3]
+	},
+	"test2": {
+		"b": [1, 2, 3]
+	}
+}

src/__tests__/parser.ts

@@ -9,7 +9,7 @@ import {
 beforeAll(initTests)
 afterAll(doneTests)
 
-test("Shoud throw", async () => {
+test("Should throw", async () => {
     const parser = new CommandLine()
     try {
         await parser.parse(["nono"])

src/controllers/contract/accounts.ts

@@ -4,12 +4,12 @@ import { NetworkRegistry } from "../network/registry"
 import { TonClient } from "@eversdk/core"
 import { SignerRegistry } from "../signer/registry"
 import { ParamParser } from "./param-parser"
-import { resolveContract } from "../../core/utils"
+import { resolveContract } from "../../core/solFileResolvers"
 
-// Remove sufix graphql if exists and add projectId
+// Remove suffix graphql if exists and add projectId
 // Intentionally do not use URL object or any modules,
 // because url may lack `http://` prefix
-export const transormEndpoint = (project?: string) => (url: string) => {
+export const transformEndpoint = (project?: string) => (url: string) => {
     const result = url
         .trim()
         .replace(/\/graphql\/?$/i, "")
@@ -32,7 +32,7 @@ export async function getAccount(
     const { project, accessKey } = network.credentials || {}
     const client = new TonClient({
         network: {
-            endpoints: network.endpoints.map(transormEndpoint(project)),
+            endpoints: network.endpoints.map(transformEndpoint(project)),
 
             ...(accessKey ? { access_key: accessKey } : {}),
         },

src/controllers/contract/index.ts

@@ -1,5 +1,8 @@
 import { Command, CommandArg, Terminal, ToolController } from "../../core"
-import { resolveContract, resolveTvcAsBase64 } from "../../core/utils"
+import {
+    resolveContract,
+    resolveTvcAsBase64,
+} from "../../core/solFileResolvers"
 import { Account, AccountType } from "@eversdk/appkit"
 import { TonClient } from "@eversdk/core"
 import { getAccount } from "./accounts"
@@ -75,14 +78,35 @@ const functionArg: CommandArg = {
     defaultValue: "",
 }
 
+const JSON_ARG_DESCR = `
+Value is resolved to the JSON object. Can be provided in several variants:
+- \`name:value\` pairs.
+  Array values must be specified as [item,...].
+  Spaces are not allowed. If value contains spaces or special symbols "[],:" it must be enclosed in "" or ''.
+  Example: \`'foo:1,bar:"2",baz:[1,2,3]'\`.
+  Result:  \`{ foo: 1, bar: "2", baz: [1, 2, 3] }\`.
+- \`{ name: value, ... }\` – JSON object.
+  Example: \`'{foo:1,bar:"2",baz:[1,2,3]}\`.
+  Result:  \`{ foo: 1, bar: "2", baz: [1, 2, 3] }\`.
+- \`@file\` – JSON object loaded from the specified file.
+  Example: \`@./args.json\`.
+  File args.json: \`{ foo: 1, bar: "2", baz: [1, 2, 3] }\`.
+  Result:  \`{ foo: 1, bar: "2", baz: [1, 2, 3] }\`.
+- \`@file@field\` – specified field of the JSON object loaded from the specified file.
+  \`field\` is a path to nested field separated by \`.\` (e.g. \`foo.bar.baz\`).
+  Example: \`@./args.json@f1\`.
+  File args.json: \`{ f1: { foo: 1, bar: "2", baz: [1, 2, 3] } }\`. 
+  Result:  \`{ foo: 1, bar: "2", baz: [1, 2, 3] }\`.
+  Example: \`@./[email protected]\`.
+  File args.json: \`{ f1: { foo: 1, bar: "2", baz: [1, 2, 3] } }\`. 
+  Result:  \`[1, 2, 3]\`.
+`
+
 const inputOpt: CommandArg = {
     name: "input",
     alias: "i",
     title: "Function parameters as name:value,...",
-    description:
-        "Array values must be specified as [item,...]. " +
-        'Spaces are not allowed. If value contains spaces or special symbols "[],:" ' +
-        "it must be enclosed in \"\" or ''",
+    description: `Value for function parameters.${JSON_ARG_DESCR}`,
     type: "string",
     defaultValue: "",
 }
@@ -93,9 +117,7 @@ const dataOpt: CommandArg = {
     title: "Deploying initial data as name:value,...",
     description:
         "This data is required to calculate the account address and to deploy contract.\n" +
-        "Array values must be specified as [item,...]. " +
-        'Spaces are not allowed. If value contains spaces or special symbols "[],:" ' +
-        "it must be enclosed in \"\" or ''",
+        JSON_ARG_DESCR,
     type: "string",
     defaultValue: "",
 }

src/controllers/contract/param-parser.ts

@@ -1,4 +1,7 @@
 import { AbiParam } from "@eversdk/core"
+import path from "path"
+import process from "process"
+import { loadJSON } from "../../core/utils"
 
 export class ParamParser {
     pos = 0
@@ -108,6 +111,19 @@ export class ParamParser {
     }
 
     parseComponents(param: AbiParam): { [name: string]: any } {
+        const text = this.text.trim()
+        if (text.startsWith("@")) {
+            return loadJSON(path.resolve(process.cwd(), text.substring(1)))
+        }
+
+        if (text.startsWith("{") && text.endsWith("}")) {
+            try {
+                return JSON.parse(text)
+            } catch (err: any) {
+                throw new Error(`Malformed JSON object has been passed`)
+            }
+        }
+
         const isLetter = (x: string) => x.toLowerCase() !== x.toUpperCase()
         const isDigit = (x: string) => x >= "0" && x <= "9"
         const isIdent = (x: string) => isLetter(x) || isDigit(x) || x === "_"

src/controllers/contract/run.ts

@@ -10,6 +10,7 @@ import {
 import { Account } from "@eversdk/appkit"
 import { ParamParser } from "./param-parser"
 import { SignerRegistry } from "../signer/registry"
+import * as process from "process"
 
 export async function resolveFunction(
     terminal: Terminal,
@@ -117,18 +118,6 @@ export async function resolveParams(
     paramsString: string,
     preventUi: boolean,
 ): Promise<object> {
-    if (paramsString.match(/{.+}/)) {
-        let jsonArgs: any
-        try {
-            jsonArgs = JSON.parse(paramsString)
-        } catch (err: any) {
-            throw new Error(`Malformed JSON object has been passed`)
-        }
-        terminal.log(
-            `Skip ABI validation step because a JSON object has been passed as an argument.`,
-        )
-        return jsonArgs
-    }
     const values: { [name: string]: any } = ParamParser.components(
         {
             name: "params",

src/controllers/js/wrap.ts

@@ -2,7 +2,8 @@ import path from "path"
 import { TonClient } from "@eversdk/core"
 import { libNode } from "@eversdk/lib-node"
 
-import { resolveContract, writeTextFile } from "../../core/utils"
+import { writeTextFile } from "../../core/utils"
+import { resolveContract } from "../../core/solFileResolvers"
 import { Command, CommandArgVariant, Terminal } from "../../core"
 
 TonClient.useBinaryLibrary(libNode)

src/controllers/solidity/index.ts

@@ -1,11 +1,21 @@
 import { Command, Component, Terminal, ToolController } from "../../core"
 import path from "path"
-import { changeExt, uniqueFilePath, writeTextFile } from "../../core/utils"
+import {
+    changeExt,
+    defineFileType,
+    uniqueFilePath,
+    writeTextFile,
+} from "../../core/utils"
 import fs from "fs"
 import mv from "mv"
 import { BasicContract } from "./snippets"
 import { components } from "./components"
 
+export const SOLIDITY_FILE = defineFileType("Solidity", /\.t?sol$/i, [
+    ".sol",
+    ".tsol",
+])
+
 export const solidityVersionCommand: Command = {
     name: "version",
     title: "Show Solidity Version",
@@ -32,7 +42,10 @@ export const solidityCreateCommand: Command = {
         },
     ],
     async run(terminal: Terminal, args: { name: string; folder: string }) {
-        const filePath = uniqueFilePath(args.folder, `${args.name}{}.sol`)
+        const filePath = uniqueFilePath(
+            args.folder,
+            `${args.name}{}${SOLIDITY_FILE.defaultExt}`,
+        )
         const text = BasicContract.split("{name}").join(args.name)
         writeTextFile(filePath, text)
         terminal.log(`Solidity contract ${path.basename(filePath)} created.`)
@@ -48,7 +61,7 @@ export const solidityCompileCommand: Command = {
             name: "file",
             type: "file",
             title: "Source file",
-            nameRegExp: /\.sol$/i,
+            nameRegExp: SOLIDITY_FILE.nameRegEx,
             greedy: true,
         },
         {
@@ -178,7 +191,7 @@ export const solidityAstCommand: Command = {
             name: "file",
             type: "file",
             title: "Source file",
-            nameRegExp: /\.sol$/i,
+            nameRegExp: SOLIDITY_FILE.nameRegEx,
             greedy: true,
         },
         {
@@ -214,7 +227,7 @@ export const solidityAstCommand: Command = {
     ): Promise<void> {
         for (const file of args.file.split(" ")) {
             const ext = path.extname(file)
-            if (ext !== ".sol") {
+            if (SOLIDITY_FILE.extensions.includes(ext) === false) {
                 terminal.log(`Choose solidity source file.`)
                 return
             }