@solana-mobile/dapp-store-cli 0.1.6 → 0.1.8

package/src/index.ts

@@ -7,7 +7,9 @@ import {
   publishSupportCommand,
   publishUpdateCommand
 } from "./commands/publish/index.js";
-import { getConfigFile, parseKeypair, showUserErrorMessage } from "./utils.js";
+import { checkForSelfUpdate, generateNetworkSuffix, getConfigFile, parseKeypair, showMessage } from "./utils.js";
+import terminalLink from "terminal-link";
+import boxen from "boxen";
 
 import * as dotenv from "dotenv";
 
@@ -34,10 +36,20 @@ function resolveBuildToolsPath(buildToolsPath: string | undefined) {
   return;
 }
 
+async function tryWithErrorMessage(block: () => Promise<any>) {
+  try {
+    await block()
+  } catch (e) {
+    const errorMsg = (e as Error | null)?.message ?? "";
+
+    showMessage("Error", errorMsg, true);
+  }
+}
+
 async function main() {
   program
     .name("dapp-store")
-    .version("0.1.6")
+    .version("0.1.8")
     .description("CLI to assist with publishing to the Saga Dapp Store");
 
   const createCommand = program
@@ -54,11 +66,19 @@ async function main() {
     .option("-u, --url <url>", "RPC URL", "https://devnet.genesysgo.net")
     .option("-d, --dry-run", "Flag for dry run. Doesn't mint an NFT")
     .action(async ({ keypair, url, dryRun }) => {
-      const signer = parseKeypair(keypair);
+      tryWithErrorMessage(async () => {
+        await checkForSelfUpdate();
 
-      if (signer) {
-        const result = await createPublisherCommand({ signer, url, dryRun });
-      }
+        const signer = parseKeypair(keypair);
+        if (signer) {
+          const result: { publisherAddress: string } = await createPublisherCommand({ signer, url, dryRun });
+
+          const displayUrl = `https://solscan.io/token/${result.publisherAddress}${generateNetworkSuffix(url)}`;
+          const resultText = `Publisher NFT successfully minted:\n${displayUrl}`;
+
+          showMessage("Success", resultText);
+        }
+      });
     });
 
   createCommand
@@ -75,29 +95,30 @@ async function main() {
     .option("-u, --url <url>", "RPC URL", "https://devnet.genesysgo.net")
     .option("-d, --dry-run", "Flag for dry run. Doesn't mint an NFT")
     .action(async ({ publisherMintAddress, keypair, url, dryRun }) => {
-      try {
+      tryWithErrorMessage(async () => {
+        await checkForSelfUpdate();
+
         const config = await getConfigFile();
 
         if (!hasAddressInConfig(config.publisher) && !publisherMintAddress) {
-          showUserErrorMessage(
-            "Either specify an publisher mint address in the config file, or specify as a CLI argument to this command."
-          );
-          createCommand.showHelpAfterError();
-          return;
+          throw new Error("Either specify a publisher mint address in the config file or specify as a CLI argument to this command.")
         }
 
         const signer = parseKeypair(keypair);
         if (signer) {
-          await createAppCommand({
+          const result = await createAppCommand({
             publisherMintAddress: publisherMintAddress,
             signer,
             url,
             dryRun,
           });
+
+          const displayUrl = `https://solscan.io/token/${result.appAddress}${generateNetworkSuffix(url)}`;
+          const resultText = `App NFT successfully minted:\n${displayUrl}`;
+
+          showMessage("Success", resultText);
         }
-      } catch (e) {
-        showUserErrorMessage((e as Error | null)?.message ?? "");
-      }
+      });
     });
 
   createCommand
@@ -118,28 +139,20 @@ async function main() {
       "Path to Android build tools which contains AAPT2"
     )
     .action(async ({ appMintAddress, keypair, url, dryRun, buildToolsPath }) => {
-        try {
+        tryWithErrorMessage(async () => {
+          await checkForSelfUpdate();
+
           const resolvedBuildToolsPath = resolveBuildToolsPath(buildToolsPath);
           if (resolvedBuildToolsPath === undefined) {
-            showUserErrorMessage(
-              "Please specify an Android build tools directory in the .env file or via the command line argument."
-            );
-            createCommand.showHelpAfterError();
-            return;
+            throw new Error("Please specify an Android build tools directory in the .env file or via the command line argument.")
           }
 
           const config = await getConfigFile();
-
           if (!hasAddressInConfig(config.app) && !appMintAddress) {
-            showUserErrorMessage(
-              "\n\n::: Either specify an app mint address in the config file, or specify as a CLI argument to this command. :::\n\n"
-            );
-            createCommand.showHelpAfterError();
-            return;
+            throw new Error("Either specify an app mint address in the config file or specify as a CLI argument to this command")
           }
 
           const signer = parseKeypair(keypair);
-
           if (signer) {
             const result = await createReleaseCommand({
               appMintAddress: appMintAddress,
@@ -148,10 +161,13 @@ async function main() {
               url,
               dryRun,
             });
+
+            const displayUrl = `https://solscan.io/token/${result?.releaseAddress}${generateNetworkSuffix(url)}`;
+            const resultText = `Release NFT successfully minted:\n${displayUrl}`;
+
+            showMessage("Success", resultText);
           }
-        } catch (e) {
-          showUserErrorMessage((e as Error | null)?.message ?? "");
-        }
+        });
       }
     );
 
@@ -167,23 +183,24 @@ async function main() {
       "Path to Android build tools which contains AAPT2"
     )
     .action(async ({ keypair, buildToolsPath }) => {
-      const resolvedBuildToolsPath = resolveBuildToolsPath(buildToolsPath);
-      if (resolvedBuildToolsPath === undefined) {
-        showUserErrorMessage(
-          "Please specify an Android build tools directory in the .env file or via the command line argument."
-        );
-        createCommand.showHelpAfterError();
-        return;
-      }
+      tryWithErrorMessage(async () => {
+        await checkForSelfUpdate();
 
-      const signer = parseKeypair(keypair);
+        const resolvedBuildToolsPath = resolveBuildToolsPath(buildToolsPath);
+        if (resolvedBuildToolsPath === undefined) {
+          throw new Error("Please specify an Android build tools directory in the .env file or via the command line argument.")
+        }
 
-      if (signer) {
-        await validateCommand({
-          signer,
-          buildToolsPath: resolvedBuildToolsPath,
-        });
-      }
+        const signer = parseKeypair(keypair);
+        if (signer) {
+          await validateCommand({
+            signer,
+            buildToolsPath: resolvedBuildToolsPath,
+          });
+
+          //TODO: Add pretty formatting here, but will require more work than other sections
+        }
+      });
     });
 
   const publishCommand = program
@@ -207,9 +224,13 @@ async function main() {
       "--requestor-is-authorized",
       "An attestation that the party making this Solana dApp publisher portal request is authorized to do so"
     )
+    .option(
+      "-a, --app-mint-address <app-mint-address>",
+      "The mint address of the app NFT. If not specified, the value from config.yaml will be used."
+    )
     .option(
       "-r, --release-mint-address <release-mint-address>",
-      "The mint address of the release NFT"
+      "The mint address of the release NFT. If not specified, the value from config.yaml will be used."
     )
     .option("-u, --url <url>", "RPC URL", "https://devnet.genesysgo.net")
     .option(
@@ -218,6 +239,7 @@ async function main() {
     )
     .action(
       async ({
+        appMintAddress,
         releaseMintAddress,
         keypair,
         url,
@@ -225,20 +247,19 @@ async function main() {
         requestorIsAuthorized,
         dryRun,
       }) => {
-        try {
+        tryWithErrorMessage(async () => {
+          await checkForSelfUpdate();
+
           const config = await getConfigFile();
 
           if (!hasAddressInConfig(config.release) && !releaseMintAddress) {
-            showUserErrorMessage(
-              "\n\n::: Either specify an release mint address in the config file, or specify as a CLI argument to this command. :::\n\n"
-            );
-            publishCommand.showHelpAfterError();
-            return;
+            throw new Error("Either specify a release mint address in the config file or specify as a CLI argument to this command.")
           }
 
           const signer = parseKeypair(keypair);
           if (signer) {
             await publishSubmitCommand({
+              appMintAddress,
               releaseMintAddress,
               signer,
               url,
@@ -246,10 +267,11 @@ async function main() {
               compliesWithSolanaDappStorePolicies,
               requestorIsAuthorized,
             });
+
+            const resultText = "Successfully submitted to the Solana Mobile dApp publisher portal";
+            showMessage("Success", resultText);
           }
-        } catch (e) {
-          showUserErrorMessage((e as Error | null)?.message ?? "");
-        }
+        });
       }
     );
 
@@ -270,9 +292,13 @@ async function main() {
       "--requestor-is-authorized",
       "An attestation that the party making this Solana dApp publisher portal request is authorized to do so"
     )
+    .option(
+      "-a, --app-mint-address <app-mint-address>",
+      "The mint address of the app NFT. If not specified, the value from config.yaml will be used."
+    )
     .option(
       "-r, --release-mint-address <release-mint-address>",
-      "The mint address of the release NFT"
+      "The mint address of the release NFT. If not specified, the value from config.yaml will be used."
     )
     .option("-c, --critical", "Flag for a critical app update request")
     .option("-u, --url <url>", "RPC URL", "https://devnet.genesysgo.net")
@@ -282,6 +308,7 @@ async function main() {
     )
     .action(
       async ({
+        appMintAddress,
         releaseMintAddress,
         keypair,
         url,
@@ -290,21 +317,19 @@ async function main() {
         critical,
         dryRun,
       }) => {
-        try {
+        tryWithErrorMessage(async () => {
+          await checkForSelfUpdate();
+
           const config = await getConfigFile();
 
           if (!hasAddressInConfig(config.release) && !releaseMintAddress) {
-            showUserErrorMessage(
-              "\n\n::: Either specify an release mint address in the config file, or specify as a CLI argument to this command. :::\n\n"
-            );
-            publishCommand.showHelpAfterError();
-            return;
+            throw new Error("Either specify a release mint address in the config file or specify as a CLI argument to this command.")
           }
 
           const signer = parseKeypair(keypair);
-
           if (signer) {
             await publishUpdateCommand({
+              appMintAddress,
               releaseMintAddress,
               signer,
               url,
@@ -313,10 +338,11 @@ async function main() {
               requestorIsAuthorized,
               critical,
             });
+
+            const resultText = "dApp successfully updated on the publisher portal";
+            showMessage("Success", resultText);
           }
-        } catch (e) {
-          showUserErrorMessage((e as Error | null)?.message ?? "");
-        }
+        });
       }
     );
 
@@ -333,9 +359,13 @@ async function main() {
       "--requestor-is-authorized",
       "An attestation that the party making this Solana dApp publisher portal request is authorized to do so"
     )
+    .option(
+      "-a, --app-mint-address <app-mint-address>",
+      "The mint address of the app NFT. If not specified, the value from config.yaml will be used."
+    )
     .option(
       "-r, --release-mint-address <release-mint-address>",
-      "The mint address of the release NFT"
+      "The mint address of the release NFT. If not specified, the value from config.yaml will be used."
     )
     .option("-c, --critical", "Flag for a critical app removal request")
     .option("-u, --url <url>", "RPC URL", "https://devnet.genesysgo.net")
@@ -345,6 +375,7 @@ async function main() {
     )
     .action(
       async ({
+        appMintAddress,
         releaseMintAddress,
         keypair,
         url,
@@ -352,21 +383,19 @@ async function main() {
         critical,
         dryRun,
       }) => {
-        try {
+        tryWithErrorMessage(async () => {
+          await checkForSelfUpdate();
+
           const config = await getConfigFile();
 
           if (!hasAddressInConfig(config.release) && !releaseMintAddress) {
-            showUserErrorMessage(
-              "\n\n::: Either specify an release mint address in the config file, or specify as a CLI argument to this command. :::\n\n"
-            );
-            publishCommand.showHelpAfterError();
-            return;
+            throw new Error("Either specify a release mint address in the config file or specify as a CLI argument to this command.")
           }
 
           const signer = parseKeypair(keypair);
-
           if (signer) {
             await publishRemoveCommand({
+              appMintAddress,
               releaseMintAddress,
               signer,
               url,
@@ -374,10 +403,11 @@ async function main() {
               requestorIsAuthorized,
               critical,
             });
+
+            const resultText = "dApp successfully removed from the publisher portal";
+            showMessage("Success", resultText);
           }
-        } catch (e) {
-          showUserErrorMessage((e as Error | null)?.message ?? "");
-        }
+        })
       }
     );
 
@@ -394,9 +424,13 @@ async function main() {
       "--requestor-is-authorized",
       "An attestation that the party making this Solana dApp publisher portal request is authorized to do so"
     )
+    .option(
+      "-a, --app-mint-address <app-mint-address>",
+      "The mint address of the app NFT. If not specified, the value from config.yaml will be used."
+    )
     .option(
       "-r, --release-mint-address <release-mint-address>",
-      "The mint address of the release NFT"
+      "The mint address of the release NFT. If not specified, the value from config.yaml will be used."
     )
     .option("-u, --url <url>", "RPC URL", "https://devnet.genesysgo.net")
     .option(
@@ -406,23 +440,21 @@ async function main() {
     .action(
       async (
         requestDetails,
-        { releaseMintAddress, keypair, url, requestorIsAuthorized, dryRun }
+        { appMintAddress, releaseMintAddress, keypair, url, requestorIsAuthorized, dryRun }
       ) => {
-        try {
+        tryWithErrorMessage(async () => {
+          await checkForSelfUpdate();
+
           const config = await getConfigFile();
 
           if (!hasAddressInConfig(config.release) && !releaseMintAddress) {
-            showUserErrorMessage(
-              "\n\n::: Either specify an release mint address in the config file, or specify as a CLI argument to this command. :::\n\n"
-            );
-            publishCommand.showHelpAfterError();
-            return;
+            throw new Error("Either specify a release mint address in the config file or specify as a CLI argument to this command.")
           }
 
           const signer = parseKeypair(keypair);
-
           if (signer) {
             await publishSupportCommand({
+              appMintAddress,
               releaseMintAddress,
               signer,
               url,
@@ -430,10 +462,11 @@ async function main() {
               requestorIsAuthorized,
               requestDetails,
             });
+
+            const resultText = "Support request sent successfully";
+            showMessage("Success", resultText);
           }
-        } catch (e) {
-          showUserErrorMessage((e as Error | null)?.message ?? "");
-        }
+        });
       }
     );
 

package/src/utils.ts

@@ -11,6 +11,9 @@ import { exec } from "child_process";
 import * as path from "path";
 import { BundlrStorageDriver, keypairIdentity, Metaplex, toMetaplexFile } from "@metaplex-foundation/js";
 import { imageSize } from "image-size";
+import updateNotifier from "update-notifier";
+import cliPackage from "./package.json" assert { type: "json" };
+import boxen from "boxen";
 
 import { CachedStorageDriver } from "./upload/CachedStorageDriver.js";
 
@@ -19,6 +22,15 @@ const runExec = util.promisify(exec);
 
 export const debug = debugModule("CLI");
 
+export const checkForSelfUpdate = async () => {
+  const notifier = updateNotifier({ pkg: cliPackage });
+  const updateInfo = await notifier.fetchInfo();
+
+  if (updateInfo.current != updateInfo.latest) {
+    throw new Error("Please update to the latest version of the dApp Store CLI before proceeding.");
+  }
+};
+
 export const parseKeypair = (pathToKeypairFile: string) => {
   try {
     const keypairFile = fs.readFileSync(pathToKeypairFile, "utf-8");
@@ -48,8 +60,6 @@ export const getConfigFile = async (
 
   const config = await getConfig(configFilePath);
 
-  console.info(`Pulling details from ${configFilePath}`);
-
   if (buildToolsDir && fs.lstatSync(buildToolsDir).isDirectory()) {
     // We validate that the config is going to have at least one installable asset
     const apkEntry = config.release.files.find(
@@ -122,10 +132,34 @@ const checkImageExtension = (uri: string): boolean => {
   );
 };
 
-export const showUserErrorMessage = (msg: string) => {
-  console.error("\n:::: Solana Publish CLI: Error Message ::::");
-  console.error(msg);
-  console.error("");
+export const generateNetworkSuffix = (rpcUrl: string): string => {
+  let suffix = "";
+
+  if (rpcUrl.indexOf("devnet") != -1) {
+    suffix = "?cluster=devnet";
+  } else if (rpcUrl.indexOf("testnet") != -1) {
+    suffix = "?cluster=testnet";
+  } else if (rpcUrl.indexOf("mainnet") != -1) {
+    suffix = "?cluster=mainnet";
+  }
+
+  return suffix;
+};
+
+export const showMessage = (
+  titleMessage = "",
+  contentMessage = "",
+  isError = false
+) => {
+  console.log(boxen(contentMessage, {
+    title: titleMessage,
+    padding: 1,
+    margin: 1,
+    borderStyle: 'single',
+    borderColor: isError ? "redBright" : "cyan",
+    textAlignment: "left",
+    titleAlignment: "center"
+  }));
 };
 
 const checkIconDimensions = async (iconPath: string): Promise<boolean> => {
@@ -167,7 +201,7 @@ const getAndroidDetails = async (
   let localeArray = Array.from(locales?.values() ?? []);
   if (localeArray.length == 2) {
     const localesSrc = localeArray[1];
-    localeArray = localesSrc.split("' '").slice(1);
+    localeArray = ["en-US"].concat(localesSrc.split("' '").slice(1));
   }
 
   return {