JS Templates

.gitignore

@@ -8,7 +8,11 @@
 
 flow.json
 
+# Javascript node_modules
+**/**/node_modules
+
 # IDE related files
 .idea
 .vscode
+.history
 git

lib/javascript/.babelrc

@@ -0,0 +1,20 @@
+{
+	"presets": [
+		[
+			"@babel/preset-env",
+			{
+				"targets": {
+					"node": "current"
+				}
+			}
+		]
+	],
+	"plugins": [
+		[
+			"module-resolver",
+			{
+				"root": ["./src"]
+			}
+		]
+	]
+}

lib/javascript/.gitignore

@@ -0,0 +1,2 @@
+**/generated
+**/templates/index.js

lib/javascript/README.md

@@ -0,0 +1,18 @@
+# Important Notice
+
+Please, do NOT edit or commit files in `generated` folder. All files in that folder will be deleted
+by generator on next run, meaning your work will be lost. If you want to introduce changes to those
+files - edit Handlebars templates or generator code.
+
+# Development
+
+## First steps
+
+- Run `yarn precompile-handlebars` to precompile Handlebars templates
+- Run `yarn generate-cadence-code` to generate Javascript files, which would export Cadence code
+  together with other template information
+
+## Publish
+
+Package will be automatically published via CD/CI tools, when new changes are merged into `master`
+branch, no need to do extra steps.

lib/javascript/jest.config.js

@@ -0,0 +1,5 @@
+module.exports = {
+  "testEnvironment": "node",
+  "verbose": true,
+  "coveragePathIgnorePatterns": ["/node_modules/"],
+};

lib/javascript/package.json

@@ -0,0 +1,24 @@
+{
+	"name": "js-asset-generator",
+	"version": "1.0.0",
+	"main": "index.js",
+	"license": "MIT",
+	"scripts": {
+		"test-usage": "node_modules/.bin/babel-node src/testUsage.js",
+		"generate-cadence-code": "node_modules/.bin/babel-node src/generator",
+		"precompile-handlebars": "node_modules/.bin/handlebars src/generator/templates -f ./src/generator/templates/index.js -e hbs -c handlebars"
+	},
+	"devDependencies": {
+		"handlebars": "^4.7.6",
+		"handlebars-loader": "^1.7.1",
+		"jest": "^26.6.3",
+		"prettier": "^2.2.1"
+	},
+	"dependencies": {
+		"@babel/core": "^7.12.13",
+		"@babel/node": "^7.12.13",
+		"@babel/preset-env": "^7.12.13",
+		"babel-plugin-module-resolver": "^4.1.0",
+		"flow-js-testing": "file:../../../flow-js-testing"
+	}
+}

lib/javascript/prettier.config.js

@@ -0,0 +1,7 @@
+module.exports = {
+	printWidth: 100,
+	endOfLine: "lf",
+	proseWrap: "always",
+	useTabs: true,
+	tabWidth: 2,
+};

lib/javascript/src/generator/index.js

@@ -0,0 +1,45 @@
+import Handlebars from "handlebars";
+import { resolve } from "path";
+import {getFilesList, getSplitCharacter, trimAndSplit, underscoreToCamelCase} from "../utils";
+import { clearPath, generateExports, readFile, writeFile } from '../utils/file'
+
+// Load compiled templates
+import "./templates";
+
+const processFolder = async (input, output) => {
+  const splitCharacter = getSplitCharacter(input);
+  const fullBasePath = `${resolve(input)}${splitCharacter}`;
+  const fileList = await getFilesList(input);
+
+  for (let i = 0; i < fileList.length; i++) {
+    const path = fileList[i]
+    const packages = trimAndSplit(path, fullBasePath);
+    const pathPackages = packages.slice(0, -1);
+    const file = packages.slice(-1)[0];
+
+    const code = readFile(path);
+    const name = underscoreToCamelCase(file.replace(".cdc", ""));
+
+    const data = Handlebars.templates.asset({ code, name, assetName: name });
+
+    const templateFolder = pathPackages.join(`/`);
+    const filePath = `${output}/${templateFolder}/${name}.js`;
+
+    writeFile(filePath, data);
+  }
+
+  // Generate index.js exports in each folder
+  await generateExports(output, Handlebars.templates.package);
+}
+
+const main = async () => {
+	const templatePath = "./src/generated";
+
+  clearPath(templatePath)
+  await processFolder("../../transactions", "./src/generated/transactions");
+  await processFolder("../../contracts", "./src/generated/contracts");
+
+  console.log("✅ Done. You can find newly generated code in src/generated folder")
+};
+
+main();

lib/javascript/src/generator/templates/asset.hbs

@@ -0,0 +1,26 @@
+import { replaceImportAddresses } from "flow-js-testing/dist/utils/imports";
+import { getEnvironment } from "utils/env";
+import { reportMissingImports } from 'utils'
+
+export const CODE = `
+{{ code }}
+`;
+
+/**
+* Method to generate cadence code for TestAsset
+* @param {Object.<string, string>} addressMap - contract name as a key and address where it's deployed as value
+* @param {( "emulator" | "testnet" | "mainnet" )} [env] - current working environment, defines default deployed contracts
+*/
+export const {{ assetName }} = (addressMap = {}, env = "testnet") => {
+    const envMap = getEnvironment(env);
+    const fullMap = {
+    ...envMap,
+    ...addressMap,
+    };
+
+    // If there are any missing imports in fullMap it will be reported via console
+    reportMissingImports(CODE, fullMap, `{{ name }} =>`)
+
+    return replaceImportAddresses(CODE, fullMap);
+};
+

lib/javascript/src/generator/templates/package.hbs

@@ -0,0 +1,16 @@
+{{#each folders ~}}
+    import {{this}} from './{{this}}'
+{{/each}}
+
+{{#each files ~}}
+    import { {{this}} } from './{{this}}'
+{{/each}}
+
+export default {
+    {{#each folders}}
+        {{ this }},
+    {{/each}}
+    {{#each files}}
+        {{ this }},
+    {{/each}}
+}

lib/javascript/src/generator/templates/version.hbs

@@ -0,0 +1 @@
+export const VERSION = {{version}}

lib/javascript/src/testUsage.js

@@ -0,0 +1,8 @@
+import flowToken  from "./generated/transactions/flowToken";
+
+const main = async () => {
+  const code = flowToken.burnTokens()
+	console.log({ code });
+};
+
+main();

lib/javascript/src/utils/env/index.js

@@ -0,0 +1,22 @@
+const ENVIRONMENTS = {
+	emulator: {
+		FlowToken: "0xee82856bf20e2aa6",
+		FungibleToken: "0x0ae53cb6e3f42a79",
+	},
+	testnet: {
+		FlowToken: "0x7e60df042a9c0868",
+		FungibleToken: "0x9a0766d93b6608b7",
+		LockedTokens: "0x95e019a17d0e23d7",
+		StakingProxy: "0x7aad92e5a0715d21",
+	},
+	mainnet: {
+		FlowToken: "0x1654653399040a61",
+		FungibleToken: "0xf233dcee88fe0abe",
+		LockedTokens: "0x8d0e87b65159ae63",
+		StakingProxy: "0x62430cf28c26d095",
+	},
+};
+
+export const getEnvironment = (env) => {
+	return ENVIRONMENTS[env] || ENVIRONMENTS.emulator;
+};

lib/javascript/src/utils/file/index.js

@@ -0,0 +1,87 @@
+import fs from "fs";
+import { resolve, dirname } from "path";
+import prettier from 'prettier';
+import parserBabel from 'prettier/parser-babel';
+import { underscoreToCamelCase } from "utils/strings";
+
+/**
+ * Syntax sugar for file reading
+ * @param {string} path - path to file to be read
+ */
+export const readFile = (path) => {
+	return fs.readFileSync(path, "utf8");
+};
+
+/**
+ * Syntax sugar for file writing
+ * @param {string} path - path to file to be read
+ * @param {string} data - data to write into file
+ */
+export const writeFile = (path, data) => {
+	const targetDir = dirname(path);
+	fs.mkdirSync(targetDir, { recursive: true });
+	return fs.writeFileSync(path, data, { encoding: "utf8" });
+};
+
+/**
+ * Syntax sugar for removing directory and all it's contents
+ * @param {string} path - path to directory to delete
+ */
+export const clearPath = (path) => {
+	fs.rmdirSync(path, { recursive: true });
+};
+
+export const getFilesList = async (dir) => {
+	const dirents = await fs.promises.readdir(dir, { withFileTypes: true });
+	const files = await Promise.all(
+		dirents.map((dirent) => {
+			const res = resolve(dir, dirent.name);
+			return dirent.isDirectory() ? getFilesList(res) : res;
+		})
+	);
+	return files.flat();
+};
+
+export const sansExtension = (fileName) => {
+	return fileName.replace(/\..*/, "");
+};
+
+export const prettify = (code) => {
+  return prettier.format(code, { parser: 'babel', plugins: [parserBabel] });
+};
+
+export const generateExports = async (dir, template) => {
+	const entities = await fs.promises.readdir(dir, { withFileTypes: true });
+
+	const currentFolder = entities.reduce(
+		(acc, entity) => {
+			if (entity.isDirectory()) {
+				acc.folders.push(entity);
+				acc.folderNames.push(entity.name);
+			} else {
+			  const camelCased = underscoreToCamelCase(entity.name)
+			  const fileName = sansExtension(camelCased)
+				acc.files.push(fileName);
+			}
+			return acc;
+		},
+		{ folderNames: [], folders: [], files: [] }
+	);
+
+	currentFolder.name = dir;
+
+	const packageData = template({
+		folders: currentFolder.folderNames,
+		files: currentFolder.files,
+	});
+	writeFile(`${dir}/index.js`, prettify(packageData))
+
+	await Promise.all(
+		currentFolder.folders.map((dirent) => {
+			const res = resolve(dir, dirent.name);
+			return dirent.isDirectory() ? generateExports(res, template) : res;
+		})
+	);
+
+	return currentFolder;
+};

lib/javascript/src/utils/generator/index.js

@@ -0,0 +1,43 @@
+import { extractImports } from "flow-js-testing/dist/utils/imports";
+
+/**
+ * Get list of missing
+ * @param {string} code - template cadence code
+ * @param {Object.<string, string>} addressMap - contract name as a key and address where it's deployed as value
+ */
+export const missingImports = (code, addressMap) => {
+	const importsList = extractImports(code);
+	const missing = [];
+
+	for (const key in importsList) {
+		if (!addressMap[key] && importsList.hasOwnProperty(key)) {
+			missing.push(key);
+		}
+	}
+
+	return missing;
+};
+
+/**
+ * Get list of missing
+ * @param {string} prefix - template cadence code
+ * @param {Array.<string>} list - list of missing addresses
+ */
+export const report = (list = [], prefix = "") => {
+	const errorMessage = `Missing imports for contracts:`;
+	const message = prefix ? `${prefix} ${errorMessage}` : errorMessage;
+	console.error(message, list);
+};
+
+/**
+ * Get list of missing
+ * @param {string} code - template cadence code
+ * @param {Object.<string, string>} addressMap - contract name as a key and address where it's deployed as value
+ * @param {string} [prefix] - prefix to add to error message
+ */
+export const reportMissingImports = (code, addressMap, prefix = "") => {
+	const list = missingImports(code, addressMap);
+	if (list.length > 0) {
+		report(list, prefix);
+	}
+};

lib/javascript/src/utils/hash/index.js

@@ -0,0 +1,8 @@
+import crypto from "crypto";
+
+export const hashInput = (input) => {
+	const algorithm = "sha256";
+	const inputEncoding = "utf8";
+	const encoding = "hex";
+	return crypto.createHash(algorithm).update(input, inputEncoding).digest(encoding);
+};

lib/javascript/src/utils/hash/index.test.js

@@ -0,0 +1,11 @@
+import { hashInput } from "./index";
+
+describe("test hashing", () => {
+	test("basic hash", () => {
+		const input = "test";
+		const result = hashInput(input);
+		const expected = "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08";
+
+		expect(result).toBe(expected);
+	});
+});

lib/javascript/src/utils/index.js

@@ -0,0 +1,4 @@
+export { hashInput } from "./hash";
+export { getFilesList, readFile, writeFile } from "./file";
+export { underscoreToCamelCase, trimAndSplit, getSplitCharacter } from "./strings";
+export { reportMissingImports, report } from "./generator";