@solana-mobile/dapp-store-cli 0.1.1-0

package/src/config/schema.json

@@ -0,0 +1,228 @@
+{
+  "type": "object",
+  "properties": {
+    "publisher": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "address": {
+          "type": "string"
+        },
+        "website": {
+          "type": "string"
+        },
+        "email": {
+          "type": "string"
+        },
+        "media": {
+          "type": "array",
+          "items": [
+            {
+              "type": "object",
+              "properties": {
+                "purpose": {
+                  "type": "string"
+                },
+                "uri": {
+                  "type": "string"
+                },
+                "width": {
+                  "type": "integer"
+                },
+                "height": {
+                  "type": "integer"
+                }
+              },
+              "required": ["purpose", "uri", "width", "height"]
+            }
+          ]
+        }
+      },
+      "required": ["name", "website", "email", "media"]
+    },
+    "app": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "address": {
+          "type": "string"
+        },
+        "android_package": {
+          "type": "string"
+        },
+        "creators": {
+          "type": "array",
+          "items": [
+            {
+              "type": "string"
+            }
+          ]
+        },
+        "urls": {
+          "type": "object",
+          "properties": {
+            "license_url": {
+              "type": "string"
+            },
+            "copyright_url": {
+              "type": "string"
+            },
+            "privacy_policy_url": {
+              "type": "string"
+            },
+            "website": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "license_url",
+            "copyright_url",
+            "privacy_policy_url",
+            "website"
+          ]
+        },
+        "media": {
+          "type": "array",
+          "items": [
+            {
+              "type": "object",
+              "properties": {
+                "purpose": {
+                  "type": "string"
+                },
+                "uri": {
+                  "type": "string"
+                },
+                "width": {
+                  "type": "integer"
+                },
+                "height": {
+                  "type": "integer"
+                }
+              },
+              "required": ["purpose", "uri", "width", "height"]
+            }
+          ]
+        }
+      },
+      "required": ["name", "android_package", "creators", "urls", "media"]
+    },
+    "release": {
+      "type": "object",
+      "properties": {
+        "version": {
+          "type": "string"
+        },
+        "address": {
+          "type": "string"
+        },
+        "media": {
+          "type": "array",
+          "items": [
+            {
+              "type": "object",
+              "properties": {
+                "purpose": {
+                  "type": "string"
+                },
+                "uri": {
+                  "type": "string"
+                },
+                "width": {
+                  "type": "integer"
+                },
+                "height": {
+                  "type": "integer"
+                }
+              },
+              "required": ["purpose", "uri", "width", "height"]
+            }
+          ]
+        },
+        "files": {
+          "type": "array",
+          "minItems": 1,
+          "contains": {
+            "type": "object",
+            "properties": {
+              "purpose": {
+                "type": "string",
+                "const": "install"
+              }
+            }
+          },
+          "items": [
+            {
+              "type": "object",
+              "properties": {
+                "purpose": {
+                  "type": "string"
+                },
+                "uri": {
+                  "type": "string"
+                }
+              },
+              "required": ["purpose", "uri"]
+            }
+          ]
+        },
+        "catalog": {
+          "type": "object",
+          "properties": {
+            "en-US": {
+              "type": "object",
+              "properties": {
+                "name": {
+                  "type": "string"
+                },
+                "short_description": {
+                  "type": "string"
+                },
+                "long_description": {
+                  "type": "string"
+                },
+                "new_in_version": {
+                  "type": "string"
+                },
+                "saga_features_localized": {
+                  "type": "string"
+                }
+              },
+              "required": [
+                "name",
+                "short_description",
+                "long_description",
+                "new_in_version",
+                "saga_features_localized"
+              ]
+            }
+          },
+          "required": ["en-US"]
+        }
+      },
+      "required": ["version", "media", "files", "catalog"]
+    },
+    "solana_mobile_dapp_publisher_portal": {
+      "type": "object",
+      "properties": {
+        "google_store_package": {
+          "type": "string"
+        },
+        "testing_instructions": {
+          "type": "string"
+        }
+      },
+      "required": ["google_store_package", "testing_instructions"]
+    }
+  },
+  "required": [
+    "publisher",
+    "app",
+    "release",
+    "solana_mobile_dapp_publisher_portal"
+  ]
+}

package/src/index.ts

@@ -0,0 +1,435 @@
+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 { getConfigFile, parseKeypair, showUserErrorMessage } from "./utils.js";
+
+import * as dotenv from "dotenv";
+
+dotenv.config();
+
+const hasAddressInConfig = ({ address }: { address: string }) => {
+  return !!address;
+};
+
+const program = 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;
+}
+
+async function main() {
+  program
+    .name("dapp-store")
+    .version("0.1.0")
+    .description("CLI to assist with publishing to the Saga Dapp Store");
+
+  const createCommand = program
+    .command("create")
+    .description("Create a `publisher`, `app`, or `release`");
+
+  createCommand
+    .command("publisher")
+    .description("Create a publisher")
+    .requiredOption(
+      "-k, --keypair <path-to-keypair-file>",
+      "Path to keypair file"
+    )
+    .option("-u, --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);
+
+      if (signer) {
+        const result = await createPublisherCommand({ signer, url, dryRun });
+      }
+    });
+
+  createCommand
+    .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", "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 }) => {
+      const config = await getConfigFile();
+      if (!config.isValid) return;
+
+      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;
+      }
+
+      const signer = parseKeypair(keypair);
+      if (signer) {
+        await createAppCommand({
+          publisherMintAddress: publisherMintAddress,
+          signer,
+          url,
+          dryRun,
+        });
+      }
+    });
+
+  createCommand
+    .command("release <version>")
+    .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", "RPC URL", "https://devnet.genesysgo.net")
+    .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"
+    )
+    .action(
+      async (
+        version,
+        { appMintAddress, keypair, url, dryRun, buildToolsPath }
+      ) => {
+        const toolsEnvDir = process.env.ANDROID_TOOLS_DIR ?? "";
+
+        let buildTools = "";
+        if (toolsEnvDir && toolsEnvDir.length > 0) {
+          buildTools = toolsEnvDir;
+        } else if (buildToolsPath) {
+          buildTools = buildToolsPath;
+        } else {
+          showUserErrorMessage(
+            "\n\n::: Please specify an Android build tools directory in the .env file or via the command line argument. :::\n\n"
+          );
+          createCommand.showHelpAfterError();
+          return;
+        }
+
+        const config = await getConfigFile();
+        if (!config.isValid) return;
+
+        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;
+        }
+
+        const signer = parseKeypair(keypair);
+
+        if (signer) {
+          const result = await createReleaseCommand({
+            appMintAddress: appMintAddress,
+            version,
+            buildToolsPath: buildTools,
+            signer,
+            url,
+            dryRun,
+          });
+        }
+      }
+    );
+
+  program
+    .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 }) => {
+      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;
+      }
+
+      const signer = parseKeypair(keypair);
+
+      if (signer) {
+        await validateCommand({
+          signer,
+          buildToolsPath: resolvedBuildToolsPath,
+        });
+      }
+    });
+
+  const publishCommand = program
+    .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(
+      "-r, --release-mint-address <release-mint-address>",
+      "The mint address of the release NFT"
+    )
+    .option("-u, --url", "RPC URL", "https://devnet.genesysgo.net")
+    .option(
+      "-d, --dry-run",
+      "Flag for dry run. Doesn't submit the request to the publisher portal."
+    )
+    .action(
+      async ({
+        releaseMintAddress,
+        keypair,
+        url,
+        compliesWithSolanaDappStorePolicies,
+        requestorIsAuthorized,
+        dryRun,
+      }) => {
+        const config = await getConfigFile();
+        if (!config.isValid) return;
+
+        if (!hasAddressInConfig(config.publisher) && !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;
+        }
+
+        const signer = parseKeypair(keypair);
+        if (signer) {
+          await publishSubmitCommand({
+            releaseMintAddress,
+            signer,
+            url,
+            dryRun,
+            compliesWithSolanaDappStorePolicies,
+            requestorIsAuthorized,
+          });
+        }
+      }
+    );
+
+  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(
+      "-r, --release-mint-address <release-mint-address>",
+      "The mint address of the release NFT"
+    )
+    .option("-c, --critical", "Flag for a critical app update request")
+    .option("-u, --url", "RPC URL", "https://devnet.genesysgo.net")
+    .option(
+      "-d, --dry-run",
+      "Flag for dry run. Doesn't submit the request to the publisher portal."
+    )
+    .action(
+      async ({
+        releaseMintAddress,
+        keypair,
+        url,
+        compliesWithSolanaDappStorePolicies,
+        requestorIsAuthorized,
+        critical,
+        dryRun,
+      }) => {
+        const config = await getConfigFile();
+        if (!config.isValid) return;
+
+        if (!hasAddressInConfig(config.publisher) && !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;
+        }
+
+        const signer = parseKeypair(keypair);
+
+        if (signer) {
+          await publishUpdateCommand({
+            releaseMintAddress,
+            signer,
+            url,
+            dryRun,
+            compliesWithSolanaDappStorePolicies,
+            requestorIsAuthorized,
+            critical,
+          });
+        }
+      }
+    );
+
+  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(
+      "-r, --release-mint-address <release-mint-address>",
+      "The mint address of the release NFT"
+    )
+    .option("-c, --critical", "Flag for a critical app removal request")
+    .option("-u, --url", "RPC URL", "https://devnet.genesysgo.net")
+    .option(
+      "-d, --dry-run",
+      "Flag for dry run. Doesn't submit the request to the publisher portal."
+    )
+    .action(
+      async ({
+        releaseMintAddress,
+        keypair,
+        url,
+        requestorIsAuthorized,
+        critical,
+        dryRun,
+      }) => {
+        const config = await getConfigFile();
+        if (!config.isValid) return;
+
+        if (!hasAddressInConfig(config.publisher) && !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;
+        }
+
+        const signer = parseKeypair(keypair);
+
+        if (signer) {
+          await publishRemoveCommand({
+            releaseMintAddress,
+            signer,
+            url,
+            dryRun,
+            requestorIsAuthorized,
+            critical,
+          });
+        }
+      }
+    );
+
+  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(
+      "-r, --release-mint-address <release-mint-address>",
+      "The mint address of the release NFT"
+    )
+    .option("-u, --url", "RPC URL", "https://devnet.genesysgo.net")
+    .option(
+      "-d, --dry-run",
+      "Flag for dry run. Doesn't submit the request to the publisher portal."
+    )
+    .action(
+      async (
+        requestDetails,
+        { releaseMintAddress, keypair, url, requestorIsAuthorized, dryRun }
+      ) => {
+        const config = await getConfigFile();
+        if (!config.isValid) return;
+
+        if (!hasAddressInConfig(config.publisher) && !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;
+        }
+
+        const signer = parseKeypair(keypair);
+
+        if (signer) {
+          await publishSupportCommand({
+            releaseMintAddress,
+            signer,
+            url,
+            dryRun,
+            requestorIsAuthorized,
+            requestDetails,
+          });
+        }
+      }
+    );
+
+  await program.parseAsync(process.argv);
+}
+main();