extend init functionality

Author: juliancwirko

CHANGELOG.md

@@ -1,3 +1,7 @@
+### [0.15.0](https://github.com/xdevguild/buildo-begins/releases/tag/v0.15.0) (2023-12-29)
+- add buildo.dev and Piggy Bank example dapps to the init functionality
+- update dependencies
+
 ### [0.14.3](https://github.com/xdevguild/buildo-begins/releases/tag/v0.14.3) (2023-08-03)
 - update dependencies and fix missing ora dependency
 

README.md

@@ -30,7 +30,7 @@ Meet Buildo. He is here to help you start creating in the MultiversX blockchain
 
 ### How to work with Buildo:
 
-1. Install globally `npm install buildo-begins -g` or you can also run commands with npx, for example `npx buildo-begins issue-esdt`
+1. Install globally `npm install buildo-begins -g` or you can also run commands with npx, for example `npx buildo-begins@latest issue-esdt`
 2. Derive the pem from seed phrase: `buildo-begins derive-pem`
 3. The walletKey.pem file will be created (**Be careful with this file when working with the mainnet. Please don't share it with anyone!**). (Other ways of signing, for example with hardware wallet are in plans)
 4. Check the commands with `buildo-begins --help`
@@ -46,7 +46,7 @@ Each command will display a set of self-explanatory prompts. If there is somethi
 #### General operations
 
 - `buildo-begins derive-pem` - derive PEM file from seed phrase
-- `buildo-begins init` - initialize the NextJS dapp template or simple smart contract for learning purposes
+- `buildo-begins init` - initialize the NextJS dapp template, Piggy Bank smart contract and dapp for learning purposes or Buildo.dev dapp
 - `buildo-begins herotag` - create a herotag and assign it to address and check addresses of existing ones
 - `buildo-begins converters` - a set of converters based on excellent [MultiversX (Elrond) Converters](http://207.244.241.38/elrond-converters/) but in the CLI, always at hand!
 - `buildo-begins claim-developer-rewards` - Claim dev rewards from your smart contract. You have to use the owner's wallet address (PEM) when calling it

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "buildo-begins",
   "engines": {
-    "node": "^14.13.1 || >=16.0.0"
+    "node": ">=18.0.0"
   },
-  "version": "0.14.3",
+  "version": "0.15.0",
   "description": "MultiversX blockchain CLI helper tools (protocol, API and smart contracts interaction, also helper tools)",
   "bin": {
-    "buildo-begins": "./build/index.js"
+    "buildo-begins": "build/index.js"
   },
   "type": "module",
   "main": "build/index.js",
@@ -25,7 +25,7 @@
   "homepage": "https://github.com/xdevguild/buildo-begins",
   "repository": {
     "type": "git",
-    "url": "https://github.com/xdevguild/buildo-begins"
+    "url": "git+https://github.com/xdevguild/buildo-begins.git"
   },
   "keywords": [
     "cli",
@@ -38,35 +38,35 @@
     "api"
   ],
   "dependencies": {
-    "@multiversx/sdk-core": "12.6.0",
-    "@multiversx/sdk-network-providers": "1.5.0",
+    "@multiversx/sdk-core": "12.17.0",
+    "@multiversx/sdk-network-providers": "2.2.0",
     "@multiversx/sdk-transaction-decoder": "1.0.2",
     "@multiversx/sdk-wallet": "4.2.0",
     "adm-zip": "0.5.10",
-    "axios": "1.4.0",
-    "bignumber.js": "9.1.1",
+    "axios": "1.6.3",
+    "bignumber.js": "9.1.2",
     "chalk": "5.3.0",
-    "cosmiconfig": "8.2.0",
+    "cosmiconfig": "9.0.0",
     "cross-spawn": "7.0.3",
-    "keccak": "3.0.3",
-    "ora": "7.0.1",
+    "keccak": "3.0.4",
+    "ora": "8.0.1",
     "p-event": "6.0.0",
     "prompts": "2.4.2"
   },
   "devDependencies": {
-    "@types/adm-zip": "0.5.0",
-    "@types/cross-spawn": "6.0.2",
-    "@types/keccak": "3.0.1",
-    "@types/node": "20.4.6",
-    "@types/prompts": "2.4.4",
-    "@typescript-eslint/eslint-plugin": "6.2.1",
-    "@typescript-eslint/parser": "6.2.1",
-    "esbuild": "0.18.17",
-    "eslint": "8.46.0",
-    "eslint-config-prettier": "8.10.0",
-    "eslint-plugin-prettier": "5.0.0",
-    "prettier": "3.0.1",
-    "rimraf": "5.0.1",
-    "typescript": "5.1.6"
+    "@types/adm-zip": "0.5.5",
+    "@types/cross-spawn": "6.0.6",
+    "@types/keccak": "3.0.4",
+    "@types/node": "20.10.5",
+    "@types/prompts": "2.4.9",
+    "@typescript-eslint/eslint-plugin": "6.16.0",
+    "@typescript-eslint/parser": "6.16.0",
+    "esbuild": "0.19.10",
+    "eslint": "8.56.0",
+    "eslint-config-prettier": "9.1.0",
+    "eslint-plugin-prettier": "5.1.2",
+    "prettier": "3.1.1",
+    "rimraf": "5.0.5",
+    "typescript": "5.3.3"
   }
 }

package.json

@@ -34,9 +34,8 @@ export const changeOwnerAddress = async () => {
   ];
 
   try {
-    const { smartContractAddress, newOwnerAddress } = await prompts(
-      promptQuestion
-    );
+    const { smartContractAddress, newOwnerAddress } =
+      await prompts(promptQuestion);
 
     if (!smartContractAddress || !newOwnerAddress) {
       console.log(

src/change-owner-address.ts

@@ -147,8 +147,12 @@ export const specialOpertationsGasLimit = 300_000;
 
 // Resources to download (URLs)
 export const downloadUrls: Record<string, string> = {
-  nextJsDapp:
+  nextJsDappTemplate:
     'https://github.com/xdevguild/nextjs-dapp-template/archive/refs/heads/main.zip',
+  buildoDev:
+    'https://github.com/xdevguild/buildo.dev/archive/refs/heads/main.zip',
   piggyBankExampleSc:
-    'https://github.com/xdevguild/multiversx-simple-sc/archive/refs/heads/master.zip',
+    'https://github.com/xdevguild/piggy-bank-sc/archive/refs/heads/master.zip',
+  piggyBankExampleDapp:
+    'https://github.com/xdevguild/piggy-bank-dapp/archive/refs/heads/main.zip',
 };

src/config.ts

@@ -36,9 +36,8 @@ const promptQuestions: PromptObject[] = [
 
 export const decodeTransaction = async () => {
   try {
-    const { senderAddress, receiverAddress, dataString, value } = await prompts(
-      promptQuestions
-    );
+    const { senderAddress, receiverAddress, dataString, value } =
+      await prompts(promptQuestions);
 
     if (!senderAddress || !receiverAddress || !dataString) {
       console.log(

src/decode-transaction.ts

@@ -7,6 +7,20 @@ import axios from 'axios';
 import AdmZip from 'adm-zip';
 import { downloadUrls } from './config';
 
+const mainDirInZipNameMap = {
+  nextJsDappTemplate: 'nextjs-dapp-template-main',
+  piggyBankExampleSc: 'piggy-bank-sc-master',
+  piggyBankExampleDapp: 'piggy-bank-dapp-main',
+  buildoDev: 'buildo.dev-main',
+};
+
+const successMsgMap = (dappDirectoryName: string) => ({
+  nextJsDappTemplate: `The NextJS Dapp template is initialized in the ${dappDirectoryName} directory. Npm dependencies installed. .env.example copied into .env.local - change the settings there.`,
+  piggyBankExampleSc: `The PiggyBank Smart Contract is initialized in ${dappDirectoryName}. You can now use VS Code and MultiversX IDE extension to configure your workspace and work with it. Check MultiversX IDE for VS Code on how to start!`,
+  piggyBankExampleDapp: `The Piggy Bank Dapp is initialized in the ${dappDirectoryName} directory. Npm dependencies installed. .env.example copied into .env.local - change the settings there.`,
+  buildoDev: `The Buildo.dev Dapp is initialized in the ${dappDirectoryName} directory. Npm dependencies installed. .env.example copied into .env.local - change the settings there.`,
+});
+
 const directoryNameRegex =
   // eslint-disable-next-line no-control-regex
   /^[^\s^\x00-\x1f\\?*:"";<>|/.][^\x00-\x1f\\?*:"";<>|/]*[^\s^\x00-\x1f\\?*:"";<>|/.]+$/g;
@@ -15,7 +29,8 @@ const directoryNameRegex =
 const triggerDownloadAndExtract = async (
   dappDirectoryName: string,
   resourceUrl: string,
-  isNextJSDapp: boolean
+  resourceType: keyof typeof mainDirInZipNameMap,
+  isNextJSDappTemplate: boolean
 ) => {
   try {
     const response = await axios.get(resourceUrl, {
@@ -27,9 +42,7 @@ const triggerDownloadAndExtract = async (
     const zip = new AdmZip(response.data);
     const zipEntries = zip.getEntries();
 
-    const mainDirInZipName = isNextJSDapp
-      ? 'nextjs-dapp-template-main'
-      : 'multiversx-simple-sc-master';
+    const mainDirInZipName = mainDirInZipNameMap[resourceType];
 
     zipEntries.forEach((entry) => {
       const entryName = entry.entryName;
@@ -48,18 +61,17 @@ const triggerDownloadAndExtract = async (
       }
     });
 
-    if (isNextJSDapp) {
+    if (isNextJSDappTemplate) {
       process.chdir(dappDirectoryName);
       spawn.sync('npm', ['install'], { stdio: 'inherit' });
       spawn.sync('cp', ['.env.example', '.env.local'], { stdio: 'inherit' });
       process.chdir('..');
     }
     console.log('\n');
-    console.log(
-      isNextJSDapp
-        ? `The NextJS Dapp template is initialized in the ${dappDirectoryName} directory. Npm dependencies installed. .env.example copied into .env.local - change the settings there.`
-        : `The PiggyBank Smart Contract is initialized in ${dappDirectoryName}. You can now use VS Code and MultiversX IDE extension to configure your workspace and work with it. Check https://youtu.be/y0beoihLppA on how to start!`
-    );
+    console.log(successMsgMap(dappDirectoryName)[resourceType]);
+
+    console.log(isNextJSDappTemplate ? `` : ``);
+
     console.log('\n');
   } catch (err) {
     if (axios.isAxiosError(err)) {
@@ -84,11 +96,23 @@ export const init = async () => {
             'The simple MultiversX smart contract for learning purposes.',
           value: 'piggyBankExampleSc',
         },
+        {
+          title: 'Piggy Bank Dapp example',
+          description:
+            'The simple MultiversX dapp for learning purposes. It integrates with Piggy Bank smart contract.',
+          value: 'piggyBankExampleDapp',
+        },
         {
           title: 'NextJS Dapp template',
           description:
-            'The MultiversX Dapp template built with NextJS, Chakra UI and MultiversX JS SDK',
-          value: 'nextJsDapp',
+            'The MultiversX Dapp template built with Next.js, Shadcn UI (Tailwind, Radix) and MultiversX JS SDK',
+          value: 'nextJsDappTemplate',
+        },
+        {
+          title: 'Buildo.dev dapp',
+          description:
+            'Buildo.dev app for you to test locally. Besides that, you can use it at www.buildo.dev.',
+          value: 'buildoDev',
         },
       ],
     },
@@ -115,12 +139,13 @@ export const init = async () => {
       exit(9);
     }
 
-    const isDappTemplate = resourceType === 'nextJsDapp';
+    const isNextJSDappTemplate = resourceType !== 'piggyBankExampleSc';
 
     await triggerDownloadAndExtract(
       dappDirectoryName,
       downloadUrls[resourceType],
-      isDappTemplate
+      resourceType,
+      isNextJSDappTemplate
     );
   } catch (e) {
     console.log((e as Error)?.message);

src/init.ts

@@ -44,9 +44,8 @@ const promptQuestions: PromptObject[] = [
 
 export const createMetaEsdt = async () => {
   try {
-    const { ticker, initialQuantity, name, attributes } = await prompts(
-      promptQuestions
-    );
+    const { ticker, initialQuantity, name, attributes } =
+      await prompts(promptQuestions);
 
     if (!initialQuantity || !ticker || !name) {
       console.log(

src/meta-esdt/create-meta-esdt.ts

@@ -75,9 +75,8 @@ const promptQuestions: PromptObject[] = [
 
 export const issueMetaEsdt = async () => {
   try {
-    const { name, ticker, tokenProperties, numberOfDecimals } = await prompts(
-      promptQuestions
-    );
+    const { name, ticker, tokenProperties, numberOfDecimals } =
+      await prompts(promptQuestions);
 
     if (!name || !ticker || !numberOfDecimals) {
       console.log(