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

package/src/index.ts

@@ -7,11 +7,20 @@ import {
   publishSupportCommand,
   publishUpdateCommand
 } from "./commands/publish/index.js";
-import { checkForSelfUpdate, generateNetworkSuffix, getConfigFile, parseKeypair, showMessage } from "./utils.js";
+import {
+  checkForSelfUpdate,
+  checkSubmissionNetwork,
+  Constants,
+  generateNetworkSuffix,
+  getConfigFile,
+  parseKeypair,
+  showMessage
+} from "./utils.js";
 import terminalLink from "terminal-link";
 import boxen from "boxen";
 
 import * as dotenv from "dotenv";
+import { initScaffold } from "./commands/scaffolding/index.js";
 
 dotenv.config();
 
@@ -49,9 +58,20 @@ async function tryWithErrorMessage(block: () => Promise<any>) {
 async function main() {
   program
     .name("dapp-store")
-    .version("0.1.8")
+    .version(Constants.CLI_VERSION)
     .description("CLI to assist with publishing to the Saga Dapp Store");
 
+  const initCommand = program
+    .command("init")
+    .description("First-time initialization of tooling configuration")
+    .action(async () => {
+      tryWithErrorMessage(async () => {
+        const msg = initScaffold();
+
+        showMessage("Initialized", msg);
+      })
+    });
+
   const createCommand = program
     .command("create")
     .description("Create a `publisher`, `app`, or `release`");
@@ -226,11 +246,11 @@ async function main() {
     )
     .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."
+      "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 config.yaml will be used."
+      "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", "https://devnet.genesysgo.net")
     .option(
@@ -249,6 +269,7 @@ async function main() {
       }) => {
         tryWithErrorMessage(async () => {
           await checkForSelfUpdate();
+          await checkSubmissionNetwork(url);
 
           const config = await getConfigFile();
 
@@ -294,11 +315,11 @@ async function main() {
     )
     .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."
+      "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 config.yaml will be used."
+      "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", "https://devnet.genesysgo.net")
@@ -319,6 +340,7 @@ async function main() {
       }) => {
         tryWithErrorMessage(async () => {
           await checkForSelfUpdate();
+          await checkSubmissionNetwork(url);
 
           const config = await getConfigFile();
 
@@ -361,11 +383,11 @@ async function main() {
     )
     .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."
+      "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 config.yaml will be used."
+      "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", "https://devnet.genesysgo.net")
@@ -385,6 +407,7 @@ async function main() {
       }) => {
         tryWithErrorMessage(async () => {
           await checkForSelfUpdate();
+          await checkSubmissionNetwork(url);
 
           const config = await getConfigFile();
 
@@ -426,11 +449,11 @@ async function main() {
     )
     .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."
+      "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 config.yaml will be used."
+      "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", "https://devnet.genesysgo.net")
     .option(
@@ -444,6 +467,7 @@ async function main() {
       ) => {
         tryWithErrorMessage(async () => {
           await checkForSelfUpdate();
+          await checkSubmissionNetwork(url);
 
           const config = await getConfigFile();
 

package/src/prebuild_schema/publishing_source.yaml

@@ -0,0 +1,44 @@
+publisher:
+  name: <<YOUR_PUBLISHER_NAME>>
+  address: ""
+  website: <<URL_OF_PUBLISHER_WEBSITE>>
+  email: <<EMAIL_ADDRESS_TO_CONTACT_PUBLISHER>>
+  media:
+    - purpose: icon
+      uri: <<RELATIVE_PATH_TO_PUBLISHER_ICON>>
+app:
+  name: <<APP_NAME>>
+  address: ""
+  android_package: <<ANDROID_PACKAGE_NAME>>
+  urls:
+    license_url: <<URL_OF_APP_LICENSE_OR_TERMS_OF_SERVICE>>
+    copyright_url: <<URL_OF_COPYRIGHT_DETAILS_FOR_APP>>
+    privacy_policy_url: <<URL_OF_APP_PRIVACY_POLICY>>
+    website: <<URL_OF_APP_WEBSITE>>
+  media:
+    - purpose: icon
+      uri: <<RELATIVE_PATH_TO_APP_ICON>>
+release:
+  address: ""
+  media:
+    - purpose: icon
+      uri: <<RELATIVE_PATH_TO_RELEASE_ICON>>
+    - purpose: screenshot
+      uri: <<RELATIVE_PATH_TO_SCREENSHOT>>
+  files:
+    - purpose: install
+      uri: <<RELATIVE_PATH_TO_APK>>
+  catalog:
+    en-US:
+      name: |
+        <<APP_NAME>>
+      long_description: |
+        <<LONG_APP_DESCRIPTION>>
+      new_in_version: |
+        <<WHATS_NEW_IN_THIS_VERSION>>
+      saga_features: |
+        <<ANY_FEATURES_ONLY_AVAILBLE_WHEN_RUNNING_ON_SAGA>>
+solana_mobile_dapp_publisher_portal:
+  google_store_package: <<ANDROID_PACKAGE_NAME_OF_GOOGLE_PLAY_STORE_VERSION_IF_DIFFERENT>>
+  testing_instructions: >
+    <<TESTING_INSTRUCTIONS>>

package/src/prebuild_schema/schemagen.js

@@ -0,0 +1,20 @@
+import fs, { read } from "fs";
+import yaml from "js-yaml";
+import generateSchema from "generate-schema";
+
+try {
+  const yamlSrc = fs.readFileSync('./src/prebuild_schema/publishing_source.yaml', 'utf8')
+  const convertedYaml = yaml.load(yamlSrc);
+  fs.writeFileSync('./src/generated/config_obj.json', Buffer.from(JSON.stringify(convertedYaml)), 'utf-8');
+
+  const schema = generateSchema.json('result', convertedYaml);
+
+  // Generator adds some keys/values we don't need & mess up validation
+  delete schema.$schema;
+  delete schema.title;
+
+  const toWrite = Buffer.from(JSON.stringify(schema));
+  fs.writeFileSync('./src/generated/config_schema.json', toWrite, 'utf-8');
+} catch (e) {
+  console.log(":: Schema generation step failed ::");
+}

package/src/utils.ts

@@ -1,7 +1,7 @@
 import fs from "fs";
 import type { AndroidDetails, App, Publisher, Release } from "@solana-mobile/dapp-store-publishing-tools";
 import type { Connection } from "@solana/web3.js";
-import { Keypair } from "@solana/web3.js";
+import { Keypair, PublicKey } from "@solana/web3.js";
 import type { CLIConfig } from "./config/index.js";
 import { getConfig } from "./config/index.js";
 import debugModule from "debug";
@@ -14,23 +14,45 @@ import { imageSize } from "image-size";
 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";
 
 const runImgSize = util.promisify(imageSize);
 const runExec = util.promisify(exec);
 
+export class Constants {
+  static CLI_VERSION = "0.2.0";
+  static CONFIG_FILE_NAME = "config.yaml";
+}
+
 export const debug = debugModule("CLI");
 
 export const checkForSelfUpdate = async () => {
   const notifier = updateNotifier({ pkg: cliPackage });
   const updateInfo = await notifier.fetchInfo();
 
-  if (updateInfo.current != updateInfo.latest) {
+  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.");
   }
 };
 
+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);
+  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.");
+  }
+};
+
 export const parseKeypair = (pathToKeypairFile: string) => {
   try {
     const keypairFile = fs.readFileSync(pathToKeypairFile, "utf-8");
@@ -56,7 +78,7 @@ const AaptPrefixes = {
 export const getConfigFile = async (
   buildToolsDir: string | null = null
 ): Promise<CLIConfig> => {
-  const configFilePath = `${process.cwd()}/config.yaml`;
+  const configFilePath = `${process.cwd()}/${Constants.CONFIG_FILE_NAME}`;
 
   const config = await getConfig(configFilePath);
 
@@ -79,37 +101,38 @@ export const getConfigFile = async (
   const publisherIcon = config.publisher.media?.find(
     (asset: any) => asset.purpose === "icon"
   )?.uri;
+
   if (publisherIcon) {
     const iconPath = path.join(process.cwd(), publisherIcon);
-    if (!fs.existsSync(iconPath) || !checkImageExtension(iconPath)) {
-      throw new Error("Please check the path to your Publisher icon and ensure the file is a jpeg, png, or webp file.");
-    }
+    await checkIconCompatibility(iconPath, "Publisher");
 
     const iconBuffer = await fs.promises.readFile(iconPath);
-
-    if (await checkIconDimensions(iconPath)) {
-      throw new Error("Icons must have square dimensions and be no greater than 512px by 512px.")
-    }
-
     config.publisher.icon = toMetaplexFile(iconBuffer, publisherIcon);
   }
 
   const appIcon = config.app.media?.find(
     (asset: any) => asset.purpose === "icon"
   )?.uri;
+
   if (appIcon) {
     const iconPath = path.join(process.cwd(), appIcon);
-    if (!fs.existsSync(iconPath) || !checkImageExtension(iconPath)) {
-      throw new Error("Please check the path to your App icon and ensure the file is a jpeg, png, or webp file.")
-    }
+    await checkIconCompatibility(iconPath, "App");
 
     const iconBuffer = await fs.promises.readFile(iconPath);
+    config.app.icon = toMetaplexFile(iconBuffer, appIcon);
+  }
 
-    if (await checkIconDimensions(iconPath)) {
-      throw new Error("Icons must have square dimensions and be no greater than 512px by 512px.")
-    }
+  const releaseIcon = config.release.media?.find(
+    (asset: any) => asset.purpose === "icon"
+  )?.uri;
 
-    config.app.icon = toMetaplexFile(iconBuffer, appIcon);
+  if (releaseIcon) {
+    const iconPath = path.join(process.cwd(), releaseIcon);
+    await checkIconCompatibility(iconPath, "Release");
+  }
+
+  if (!appIcon && !releaseIcon) {
+    throw new Error("Please specify at least one media entry of type icon in your configuration file");
   }
 
   config.release.media.forEach((item: CLIConfig["release"]["media"][0]) => {
@@ -122,6 +145,16 @@ export const getConfigFile = async (
   return config;
 };
 
+const checkIconCompatibility = async (path: string, typeString: string) => {
+  if (!fs.existsSync(path) || !checkImageExtension(path)) {
+    throw new Error(`Please check the path to your ${typeString} icon and ensure the file is a jpeg, png, or webp file.`)
+  }
+
+  if (await checkIconDimensions(path)) {
+    throw new Error("Icons must have square dimensions and be no greater than 512px by 512px.")
+  }
+};
+
 const checkImageExtension = (uri: string): boolean => {
   const fileExt = path.extname(uri).toLowerCase();
   return (
@@ -132,14 +165,28 @@ const checkImageExtension = (uri: string): boolean => {
   );
 };
 
+export const isDevnet = (rpcUrl: string): boolean => {
+  return rpcUrl.indexOf("devnet") != -1;
+};
+
+export const isTestnet = (rpcUrl: string): boolean => {
+  return rpcUrl.indexOf("testnet") != -1;
+};
+
+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.");
+  }
+};
+
 export const generateNetworkSuffix = (rpcUrl: string): string => {
   let suffix = "";
 
-  if (rpcUrl.indexOf("devnet") != -1) {
+  if (isDevnet(rpcUrl)) {
     suffix = "?cluster=devnet";
-  } else if (rpcUrl.indexOf("testnet") != -1) {
+  } else if (isTestnet(rpcUrl)) {
     suffix = "?cluster=testnet";
-  } else if (rpcUrl.indexOf("mainnet") != -1) {
+  } else {
     suffix = "?cluster=mainnet";
   }
 
@@ -248,7 +295,7 @@ export const saveToConfig = async ({
   };
 
   // TODO(jon): Verify the contents of the YAML file
-  fs.writeFileSync(`${process.cwd()}/config.yaml`, dump(newConfig));
+  fs.writeFileSync(`${process.cwd()}/${Constants.CONFIG_FILE_NAME}`, dump(newConfig));
 };
 
 export const getMetaplexInstance = (

package/lib/esm/config/schema.json

@@ -1,195 +0,0 @@
-{
-    "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"
-                                }
-                            },
-                            "required": ["purpose", "uri"]
-                        }
-                    ]
-                }
-            },
-            "required": ["name", "website", "email", "media"]
-        },
-        "app": {
-            "type": "object",
-            "properties": {
-                "name": {
-                    "type": "string"
-                },
-                "address": {
-                    "type": "string"
-                },
-                "android_package": {
-                    "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"
-                                }
-                            },
-                            "required": ["purpose", "uri"]
-                        }
-                    ]
-                }
-            },
-            "required": ["name", "android_package", "urls", "media"]
-        },
-        "release": {
-            "type": "object",
-            "properties": {
-                "address": {
-                    "type": "string"
-                },
-                "media": {
-                    "type": "array",
-                    "items": [
-                        {
-                            "type": "object",
-                            "properties": {
-                                "purpose": {
-                                    "type": "string"
-                                },
-                                "uri": {
-                                    "type": "string"
-                                }
-                            },
-                            "required": ["purpose", "uri"]
-                        }
-                    ]
-                },
-                "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",
-                    "patternProperties": {
-                        "^[a-zA-Z]{2,8}(-[a-zA-Z0-9]{2,8})*$": {
-                            "type": "object",
-                            "properties": {
-                                "name": {
-                                    "type": "string"
-                                },
-                                "long_description": {
-                                    "type": "string"
-                                },
-                                "new_in_version": {
-                                    "type": "string"
-                                },
-                                "saga_features": {
-                                    "type": "string"
-                                }
-                            },
-                            "required": [
-                                "name",
-                                "long_description",
-                                "new_in_version",
-                                "saga_features"
-                            ]
-                        }
-                    },
-                    "additionalProperties": false
-                }
-            },
-            "required": ["media", "files", "catalog"]
-        },
-        "solana_mobile_dapp_publisher_portal": {
-            "type": "object",
-            "properties": {
-                "google_store_package": {
-                    "type": "string"
-                },
-                "testing_instructions": {
-                    "type": "string"
-                }
-            },
-            "required": ["testing_instructions"]
-        }
-    },
-    "required": [
-        "publisher",
-        "app",
-        "release",
-        "solana_mobile_dapp_publisher_portal"
-    ]
-}