@solana-mobile/dapp-store-cli 0.4.2 → 0.5.0

package/src/CliSetup.ts

@@ -0,0 +1,511 @@
+import { Command } from "commander";
+import { validateCommand } from "./commands/index.js";
+import { createAppCommand, createPublisherCommand, createReleaseCommand } from "./commands/create/index.js";
+import {
+  publishRemoveCommand,
+  publishSubmitCommand,
+  publishSupportCommand,
+  publishUpdateCommand
+} from "./commands/publish/index.js";
+import {
+  checkForSelfUpdate,
+  checkSubmissionNetwork,
+  Constants,
+  generateNetworkSuffix,
+  parseKeypair,
+  showMessage
+} from "./CliUtils.js";
+import * as dotenv from "dotenv";
+import { initScaffold } from "./commands/scaffolding/index.js";
+import { loadPublishDetails, loadPublishDetailsWithChecks } from "./config/PublishDetails.js";
+
+dotenv.config();
+
+const hasAddressInConfig = ({ address }: { address: string }) => {
+  return !!address;
+};
+
+export const mainCli = new Command();
+
+function resolveBuildToolsPath(buildToolsPath: string | undefined) {
+  // If a path was specified on the command line, use that
+  if (buildToolsPath !== undefined) {
+    return buildToolsPath;
+  }
+
+  // If a path is specified in a .env file, use that
+  if (process.env.ANDROID_TOOLS_DIR !== undefined) {
+    return process.env.ANDROID_TOOLS_DIR;
+  }
+
+  // No path was specified
+  return;
+}
+
+/**
+ * This method should be updated with each new release of the CLI, and just do nothing when there isn't anything to report
+ */
+function latestReleaseMessage() {
+  showMessage(
+    `Publishing Tools Version ${ Constants.CLI_VERSION }`,
+    "- short_description value reduced to 30 character limit",
+    "warning"
+  );
+}
+
+async function tryWithErrorMessage(block: () => Promise<any>) {
+  try {
+    await block()
+  } catch (e) {
+    const errorMsg = (e as Error | null)?.message ?? "";
+
+    showMessage("Error", errorMsg, "error");
+  }
+}
+
+mainCli
+  .name("dapp-store")
+  .version(Constants.CLI_VERSION)
+  .description("CLI to assist with publishing to the Saga Dapp Store")
+
+export const initCliCmd = mainCli
+  .command("init")
+  .description("First-time initialization of tooling configuration")
+  .action(async () => {
+    tryWithErrorMessage(async () => {
+      const msg = initScaffold();
+
+      showMessage("Initialized", msg);
+    })
+  });
+
+export const createCliCmd = mainCli
+  .command("create")
+  .description("Create a `publisher`, `app`, or `release`")
+
+export const createPublisherCliCmd = createCliCmd
+  .command("publisher")
+  .description("Create a publisher")
+  .requiredOption(
+    "-k, --keypair <path-to-keypair-file>",
+    "Path to keypair file"
+  )
+  .option("-u, --url <url>", "RPC URL", Constants.DEFAULT_RPC_DEVNET)
+  .option("-d, --dry-run", "Flag for dry run. Doesn't mint an NFT")
+  .option("-s, --storage-config <storage-config>", "Provide alternative storage configuration details")
+  .action(async ({ keypair, url, dryRun, storageConfig }) => {
+    tryWithErrorMessage(async () => {
+      latestReleaseMessage();
+      await checkForSelfUpdate();
+
+      const signer = parseKeypair(keypair);
+      if (signer) {
+        const result: { publisherAddress: string } = await createPublisherCommand({ signer, url, dryRun, storageParams: storageConfig });
+
+        const displayUrl = `https://solscan.io/token/${result.publisherAddress}${generateNetworkSuffix(url)}`;
+        const resultText = `Publisher NFT successfully minted:\n${displayUrl}`;
+
+        showMessage("Success", resultText);
+      }
+    });
+  });
+
+export const createAppCliCmd = createCliCmd
+  .command("app")
+  .description("Create a app")
+  .requiredOption(
+    "-k, --keypair <path-to-keypair-file>",
+    "Path to keypair file"
+  )
+  .option(
+    "-p, --publisher-mint-address <publisher-mint-address>",
+    "The mint address of the publisher NFT"
+  )
+  .option("-u, --url <url>", "RPC URL", Constants.DEFAULT_RPC_DEVNET)
+  .option("-d, --dry-run", "Flag for dry run. Doesn't mint an NFT")
+  .option("-s, --storage-config <storage-config>", "Provide alternative storage configuration details")
+  .action(async ({ publisherMintAddress, keypair, url, dryRun, storageConfig }) => {
+    tryWithErrorMessage(async () => {
+      latestReleaseMessage();
+      await checkForSelfUpdate();
+
+      const config = await loadPublishDetailsWithChecks();
+
+      if (!hasAddressInConfig(config.publisher) && !publisherMintAddress) {
+        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) {
+        const result = await createAppCommand({
+          publisherMintAddress: publisherMintAddress,
+          signer,
+          url,
+          dryRun,
+          storageParams: storageConfig
+        });
+
+        const displayUrl = `https://solscan.io/token/${result.appAddress}${generateNetworkSuffix(url)}`;
+        const resultText = `App NFT successfully minted:\n${displayUrl}`;
+
+        showMessage("Success", resultText);
+      }
+    });
+  });
+
+export const createReleaseCliCmd = createCliCmd
+  .command("release")
+  .description("Create a release")
+  .requiredOption(
+    "-k, --keypair <path-to-keypair-file>",
+    "Path to keypair file"
+  )
+  .option(
+    "-a, --app-mint-address <app-mint-address>",
+    "The mint address of the app NFT"
+  )
+  .option("-u, --url <url>", "RPC URL", Constants.DEFAULT_RPC_DEVNET)
+  .option("-d, --dry-run", "Flag for dry run. Doesn't mint an NFT")
+  .option(
+    "-b, --build-tools-path <build-tools-path>",
+    "Path to Android build tools which contains AAPT2"
+  )
+  .option("-s, --storage-config <storage-config>", "Provide alternative storage configuration details")
+  .action(async ({ appMintAddress, keypair, url, dryRun, buildToolsPath, storageConfig }) => {
+      tryWithErrorMessage(async () => {
+        latestReleaseMessage();
+        await checkForSelfUpdate();
+
+        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.")
+        }
+
+        const config = await loadPublishDetailsWithChecks();
+        if (!hasAddressInConfig(config.app) && !appMintAddress) {
+          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,
+            buildToolsPath: resolvedBuildToolsPath,
+            signer,
+            url,
+            dryRun,
+            storageParams: storageConfig,
+          });
+
+          const displayUrl = `https://solscan.io/token/${result?.releaseAddress}${generateNetworkSuffix(url)}`;
+          const resultText = `Release NFT successfully minted:\n${displayUrl}`;
+
+          showMessage("Success", resultText);
+        }
+      });
+    }
+  );
+
+mainCli
+  .command("validate")
+  .description("Validates details prior to publishing")
+  .requiredOption(
+    "-k, --keypair <path-to-keypair-file>",
+    "Path to keypair file"
+  )
+  .option(
+    "-b, --build-tools-path <build-tools-path>",
+    "Path to Android build tools which contains AAPT2"
+  )
+  .action(async ({ keypair, buildToolsPath }) => {
+    tryWithErrorMessage(async () => {
+      latestReleaseMessage();
+      await checkForSelfUpdate();
+
+      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.")
+      }
+
+      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 = mainCli
+  .command("publish")
+  .description(
+    "Submit a publishing request (`submit`, `update`, `remove`, or `support`) to the Solana Mobile dApp publisher portal"
+  );
+
+publishCommand
+  .command("submit")
+  .description("Submit a new app to the Solana Mobile dApp publisher portal")
+  .requiredOption(
+    "-k, --keypair <path-to-keypair-file>",
+    "Path to keypair file"
+  )
+  .requiredOption(
+    "--complies-with-solana-dapp-store-policies",
+    "An attestation that the app complies with the Solana dApp Store policies"
+  )
+  .requiredOption(
+    "--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 your config file will be used."
+  )
+  .option(
+    "-r, --release-mint-address <release-mint-address>",
+    "The mint address of the release NFT. If not specified, the value from your config file will be used."
+  )
+  .option("-u, --url <url>", "RPC URL", Constants.DEFAULT_RPC_DEVNET)
+  .option(
+    "-d, --dry-run",
+    "Flag for dry run. Doesn't submit the request to the publisher portal."
+  )
+  .action(
+    async ({
+             appMintAddress,
+             releaseMintAddress,
+             keypair,
+             url,
+             compliesWithSolanaDappStorePolicies,
+             requestorIsAuthorized,
+             dryRun,
+           }) => {
+      tryWithErrorMessage(async () => {
+        await checkForSelfUpdate();
+        await checkSubmissionNetwork(url);
+
+        const config = await loadPublishDetails(Constants.getConfigFilePath());
+
+        if (!hasAddressInConfig(config.release) && !releaseMintAddress) {
+          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,
+            dryRun,
+            compliesWithSolanaDappStorePolicies,
+            requestorIsAuthorized,
+          });
+
+          const resultText = "Successfully submitted to the Solana Mobile dApp publisher portal";
+          showMessage("Success", resultText);
+        }
+      });
+    }
+  );
+
+publishCommand
+  .command("update")
+  .description(
+    "Update an existing app on the Solana Mobile dApp publisher portal"
+  )
+  .requiredOption(
+    "-k, --keypair <path-to-keypair-file>",
+    "Path to keypair file"
+  )
+  .requiredOption(
+    "--complies-with-solana-dapp-store-policies",
+    "An attestation that the app complies with the Solana dApp Store policies"
+  )
+  .requiredOption(
+    "--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 your config file will be used."
+  )
+  .option(
+    "-r, --release-mint-address <release-mint-address>",
+    "The mint address of the release NFT. If not specified, the value from your config file will be used."
+  )
+  .option("-c, --critical", "Flag for a critical app update request")
+  .option("-u, --url <url>", "RPC URL", Constants.DEFAULT_RPC_DEVNET)
+  .option(
+    "-d, --dry-run",
+    "Flag for dry run. Doesn't submit the request to the publisher portal."
+  )
+  .action(
+    async ({
+             appMintAddress,
+             releaseMintAddress,
+             keypair,
+             url,
+             compliesWithSolanaDappStorePolicies,
+             requestorIsAuthorized,
+             critical,
+             dryRun,
+           }) => {
+      tryWithErrorMessage(async () => {
+        await checkForSelfUpdate();
+        await checkSubmissionNetwork(url);
+
+        const config = await loadPublishDetails(Constants.getConfigFilePath())
+
+        if (!hasAddressInConfig(config.release) && !releaseMintAddress) {
+          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,
+            dryRun,
+            compliesWithSolanaDappStorePolicies,
+            requestorIsAuthorized,
+            critical,
+          });
+
+          const resultText = "dApp successfully updated on the publisher portal";
+          showMessage("Success", resultText);
+        }
+      });
+    }
+  );
+
+publishCommand
+  .command("remove")
+  .description(
+    "Remove an existing app from the Solana Mobile dApp publisher portal"
+  )
+  .requiredOption(
+    "-k, --keypair <path-to-keypair-file>",
+    "Path to keypair file"
+  )
+  .requiredOption(
+    "--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 your config file will be used."
+  )
+  .option(
+    "-r, --release-mint-address <release-mint-address>",
+    "The mint address of the release NFT. If not specified, the value from your config file will be used."
+  )
+  .option("-c, --critical", "Flag for a critical app removal request")
+  .option("-u, --url <url>", "RPC URL", Constants.DEFAULT_RPC_DEVNET)
+  .option(
+    "-d, --dry-run",
+    "Flag for dry run. Doesn't submit the request to the publisher portal."
+  )
+  .action(
+    async ({
+             appMintAddress,
+             releaseMintAddress,
+             keypair,
+             url,
+             requestorIsAuthorized,
+             critical,
+             dryRun,
+           }) => {
+      tryWithErrorMessage(async () => {
+        await checkForSelfUpdate();
+        await checkSubmissionNetwork(url);
+
+        const config = await loadPublishDetails(Constants.getConfigFilePath())
+
+        if (!hasAddressInConfig(config.release) && !releaseMintAddress) {
+          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,
+            dryRun,
+            requestorIsAuthorized,
+            critical,
+          });
+
+          const resultText = "dApp successfully removed from the publisher portal";
+          showMessage("Success", resultText);
+        }
+      })
+    }
+  );
+
+publishCommand
+  .command("support <request_details>")
+  .description(
+    "Submit a support request for an existing app on the Solana Mobile dApp publisher portal"
+  )
+  .requiredOption(
+    "-k, --keypair <path-to-keypair-file>",
+    "Path to keypair file"
+  )
+  .requiredOption(
+    "--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 your config file will be used."
+  )
+  .option(
+    "-r, --release-mint-address <release-mint-address>",
+    "The mint address of the release NFT. If not specified, the value from your config file will be used."
+  )
+  .option("-u, --url <url>", "RPC URL", Constants.DEFAULT_RPC_DEVNET)
+  .option(
+    "-d, --dry-run",
+    "Flag for dry run. Doesn't submit the request to the publisher portal."
+  )
+  .action(
+    async (
+      requestDetails,
+      { appMintAddress, releaseMintAddress, keypair, url, requestorIsAuthorized, dryRun }
+    ) => {
+      tryWithErrorMessage(async () => {
+        await checkForSelfUpdate();
+        await checkSubmissionNetwork(url);
+
+        const config = await loadPublishDetails(Constants.getConfigFilePath())
+
+        if (!hasAddressInConfig(config.release) && !releaseMintAddress) {
+          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,
+            dryRun,
+            requestorIsAuthorized,
+            requestDetails,
+          });
+
+          const resultText = "Support request sent successfully";
+          showMessage("Success", resultText);
+        }
+      });
+    }
+  );

package/src/CliUtils.ts

@@ -2,15 +2,23 @@ import fs from "fs";
 import type { Connection } from "@solana/web3.js";
 import { Keypair, PublicKey } from "@solana/web3.js";
 import debugModule from "debug";
-import { BundlrStorageDriver, keypairIdentity, Metaplex } from "@metaplex-foundation/js";
+import {
+  BundlrStorageDriver,
+  keypairIdentity,
+  Metaplex,
+} from "@metaplex-foundation/js";
 import updateNotifier from "update-notifier";
 import cliPackage from "./package.json" assert { type: "json" };
 import boxen from "boxen";
 import ver from "semver";
 import { CachedStorageDriver } from "./upload/CachedStorageDriver.js";
+import { EnvVariables } from "./config/index.js";
+import { S3Client } from "@aws-sdk/client-s3";
+import { awsStorage } from "@metaplex-foundation/js-plugin-aws";
+import { S3StorageManager } from "./config/index.js";
 
 export class Constants {
-  static CLI_VERSION = "0.4.2";
+  static CLI_VERSION = "0.5.0";
   static CONFIG_FILE_NAME = "config.yaml";
   static DEFAULT_RPC_DEVNET = "https://api.devnet.solana.com";
 
@@ -28,21 +36,35 @@ export const checkForSelfUpdate = async () => {
   const latestVer = new ver.SemVer(updateInfo.latest);
   const currentVer = new ver.SemVer(updateInfo.current);
 
-  if (latestVer.major > currentVer.major || latestVer.minor > currentVer.minor) {
-    throw new Error("Please update to the latest version of the dApp Store CLI before proceeding.");
+  if (
+    latestVer.major > currentVer.major ||
+    latestVer.minor > currentVer.minor
+  ) {
+    throw new Error(
+      "Please update to the latest version of the dApp Store CLI before proceeding."
+    );
   }
 };
 
-export const checkMintedStatus = async (conn: Connection, pubAddr: string, appAddr: string, releaseAddr: string) => {
+export const checkMintedStatus = async (
+  conn: Connection,
+  pubAddr: string,
+  appAddr: string,
+  releaseAddr: string
+) => {
   const results = await conn.getMultipleAccountsInfo([
     new PublicKey(pubAddr),
     new PublicKey(appAddr),
     new PublicKey(releaseAddr),
   ]);
 
-  const rentAccounts = results.filter((item) => !(item == undefined) && item?.lamports > 0);
+  const rentAccounts = results.filter(
+    (item) => !(item == undefined) && item?.lamports > 0
+  );
   if (rentAccounts?.length != 3) {
-    throw new Error("Please ensure you have minted all of your NFTs before submitting to the Solana Mobile dApp publisher portal.");
+    throw new Error(
+      "Please ensure you have minted all of your NFTs before submitting to the Solana Mobile dApp publisher portal."
+    );
   }
 };
 
@@ -51,12 +73,12 @@ export const parseKeypair = (pathToKeypairFile: string) => {
     const keypairFile = fs.readFileSync(pathToKeypairFile, "utf-8");
     return Keypair.fromSecretKey(Buffer.from(JSON.parse(keypairFile)));
   } catch (e) {
-    showMessage
-    (
+    showMessage(
       "KeyPair Error",
-      "Something went wrong when attempting to retrieve the keypair at " + pathToKeypairFile,
+      "Something went wrong when attempting to retrieve the keypair at " +
+        pathToKeypairFile,
       "error"
-    )
+    );
   }
 };
 
@@ -70,7 +92,9 @@ export const isTestnet = (rpcUrl: string): boolean => {
 
 export const checkSubmissionNetwork = (rpcUrl: string) => {
   if (isDevnet(rpcUrl) || isTestnet(rpcUrl)) {
-    throw new Error("It looks like you are attempting to submit a request with a devnet or testnet RPC endpoint. Please ensure that your NFTs are minted on mainnet beta, and re-run with a mainnet beta RPC endpoint.");
+    throw new Error(
+      "It looks like you are attempting to submit a request with a devnet or testnet RPC endpoint. Please ensure that your NFTs are minted on mainnet beta, and re-run with a mainnet beta RPC endpoint."
+    );
   }
 };
 
@@ -91,7 +115,7 @@ export const generateNetworkSuffix = (rpcUrl: string): string => {
 export const showMessage = (
   titleMessage = "",
   contentMessage = "",
-  type: "standard" | "error" | "warning" = "standard",
+  type: "standard" | "error" | "warning" = "standard"
 ): string => {
   let color = "cyan";
   if (type == "error") {
@@ -104,7 +128,7 @@ export const showMessage = (
     title: titleMessage,
     padding: 1,
     margin: 1,
-    borderStyle: 'single',
+    borderStyle: "single",
     borderColor: color,
     textAlignment: "left",
     titleAlignment: "center",
@@ -116,24 +140,45 @@ export const showMessage = (
 
 export const getMetaplexInstance = (
   connection: Connection,
-  keypair: Keypair
+  keypair: Keypair,
+  storageParams: string = ""
 ) => {
   const metaplex = Metaplex.make(connection).use(keypairIdentity(keypair));
   const isDevnet = connection.rpcEndpoint.includes("devnet");
 
-  const bundlrStorageDriver = isDevnet
-    ? new BundlrStorageDriver(metaplex, {
+  //TODO: Use DI for this
+  const s3Mgr = new S3StorageManager(new EnvVariables());
+  s3Mgr.parseCmdArg(storageParams);
+
+  if (s3Mgr.hasS3Config) {
+    const awsClient = new S3Client({
+      region: s3Mgr.s3Config.regionName,
+      credentials: {
+        accessKeyId: s3Mgr.s3Config.accessKey,
+        secretAccessKey: s3Mgr.s3Config.secretKey,
+      },
+    });
+
+    const bucketPlugin = awsStorage(awsClient, s3Mgr.s3Config.bucketName);
+    metaplex.use(bucketPlugin);
+  } else {
+    const bundlrStorageDriver = isDevnet
+      ? new BundlrStorageDriver(metaplex, {
         address: "https://devnet.bundlr.network",
         providerUrl: Constants.DEFAULT_RPC_DEVNET,
       })
-    : new BundlrStorageDriver(metaplex);
+      : new BundlrStorageDriver(metaplex);
+
+    metaplex.storage().setDriver(bundlrStorageDriver);
+  }
 
   metaplex.storage().setDriver(
-    new CachedStorageDriver(bundlrStorageDriver, {
+    new CachedStorageDriver(metaplex.storage().driver(), {
       assetManifestPath: isDevnet
         ? "./.asset-manifest-devnet.json"
         : "./.asset-manifest.json",
     })
   );
+
   return metaplex;
 };