@solana-mobile/dapp-store-cli 0.9.4 → 0.10.0

package/src/CliSetup.ts

@@ -11,6 +11,7 @@ import {
   checkForSelfUpdate,
   checkSubmissionNetwork,
   Constants,
+  alphaAppSubmissionMessage,
   dryRunSuccessMessage,
   generateNetworkSuffix,
   parseKeypair,
@@ -50,6 +51,7 @@ function resolveBuildToolsPath(buildToolsPath: string | undefined) {
  */
 function latestReleaseMessage() {
   const messages = [
+    `- App details page now supports a Banner Graphic image of size 1200x600px and a Feature Graphic image of size 1200x1200px (optional)`,
     `- App details page now supports video files. (mp4 file format only and minimum resolution 720p)`,
     `- priority fee has been updated to ${Constants.DEFAULT_PRIORITY_FEE} lamports = ${Constants.DEFAULT_PRIORITY_FEE / LAMPORTS_PER_SOL} SOL. To adjust this value use param "-p" or "--priority-fee-lamports"`,
     `- At least 4 screenshots are now required to update or release a new app`,
@@ -303,6 +305,7 @@ publishCommand
     "-d, --dry-run",
     "Flag for dry run. Doesn't submit the request to the publisher portal."
   )
+  .option("-l, --alpha", "Flag to mark the submission as alpha test.")
   .action(
     async ({
              appMintAddress,
@@ -312,6 +315,7 @@ publishCommand
              compliesWithSolanaDappStorePolicies,
              requestorIsAuthorized,
              dryRun,
+             alpha,
            }) => {
       await tryWithErrorMessage(async () => {
         await checkForSelfUpdate();
@@ -323,6 +327,10 @@ publishCommand
           throw new Error("Either specify a release mint address in the config file or specify as a CLI argument to this command.")
         }
 
+        if (alpha) {
+          alphaAppSubmissionMessage()
+        }
+
         const signer = parseKeypair(keypair);
         if (signer) {
           if (config.lastUpdatedVersionOnStore != null && config.lastSubmittedVersionOnChain.address != null) {
@@ -335,6 +343,7 @@ publishCommand
                 compliesWithSolanaDappStorePolicies: compliesWithSolanaDappStorePolicies,
                 requestorIsAuthorized: requestorIsAuthorized,
                 critical: false,
+                alphaTest: alpha,
               });
           } else {
             await publishSubmitCommand({
@@ -345,6 +354,7 @@ publishCommand
               dryRun: dryRun,
               compliesWithSolanaDappStorePolicies: compliesWithSolanaDappStorePolicies,
               requestorIsAuthorized: requestorIsAuthorized,
+              alphaTest: alpha,
             });
           }
 
@@ -389,6 +399,7 @@ publishCommand
     "-d, --dry-run",
     "Flag for dry run. Doesn't submit the request to the publisher portal."
   )
+  .option("-l, --alpha", "Flag to mark the submission as alpha test.")
   .action(
     async ({
              appMintAddress,
@@ -399,6 +410,7 @@ publishCommand
              requestorIsAuthorized,
              critical,
              dryRun,
+             alpha,
            }) => {
       await tryWithErrorMessage(async () => {
         await checkForSelfUpdate();
@@ -410,6 +422,10 @@ publishCommand
           throw new Error("Either specify a release mint address in the config file or specify as a CLI argument to this command.")
         }
 
+        if (alpha) {
+          alphaAppSubmissionMessage()
+        }
+
         const signer = parseKeypair(keypair);
         if (signer) {
           await publishUpdateCommand({
@@ -421,6 +437,7 @@ publishCommand
             compliesWithSolanaDappStorePolicies,
             requestorIsAuthorized,
             critical,
+            alphaTest: alpha,
           });
 
           if (dryRun) {

package/src/CliUtils.ts

@@ -19,7 +19,7 @@ import { awsStorage } from "@metaplex-foundation/js-plugin-aws";
 import { S3StorageManager } from "./config/index.js";
 
 export class Constants {
-  static CLI_VERSION = "0.9.4";
+  static CLI_VERSION = "0.10.0";
   static CONFIG_FILE_NAME = "config.yaml";
   static DEFAULT_RPC_DEVNET = "https://api.devnet.solana.com";
   static DEFAULT_PRIORITY_FEE = 500000;
@@ -143,6 +143,15 @@ export const dryRunSuccessMessage = () => {
   showMessage("Dry run", "Dry run was successful", "standard")
 }
 
+export const alphaAppSubmissionMessage = () => {
+  showMessage(
+    "Alpha release", 
+    "Alpha releases are not reviewed on dApp store and are meant for internal testing only.\n" +
+    "Run the `npx dapp-store publish submit ...` command again without the `--alpha` param to publish the app",
+    "warning"
+  )
+}
+
 export const showNetworkWarningIfApplicable = (rpcUrl: string) => {
   if (isDevnet(rpcUrl)) {
     showMessage("Devnet Mode", "Running on Devnet", "warning")

package/src/commands/publish/PublishCliSubmit.ts

@@ -14,6 +14,7 @@ type PublishSubmitCommandInput = {
   dryRun: boolean;
   compliesWithSolanaDappStorePolicies: boolean;
   requestorIsAuthorized: boolean;
+  alphaTest?: boolean;
 };
 
 export const publishSubmitCommand = async ({
@@ -24,6 +25,7 @@ export const publishSubmitCommand = async ({
   dryRun = false,
   compliesWithSolanaDappStorePolicies = false,
   requestorIsAuthorized = false,
+  alphaTest
 }: PublishSubmitCommandInput) => {
   showMessage(
     `Publishing Estimates`,
@@ -52,6 +54,10 @@ export const publishSubmitCommand = async ({
     lastUpdatedVersionOnStore: lastUpdatedVersionOnStore,
   } = await loadPublishDetailsWithChecks();
 
+  if (alphaTest && solanaMobileDappPublisherPortalDetails.alpha_testers == undefined) {
+    throw new Error(`Alpha test submission without specifying any testers.\nAdd field alpha_testers in your 'config.yaml' file.`)
+  }
+
   const sign = ((buf: Buffer) =>
     nacl.sign(buf, signer.secretKey)) as SignWithPublisherKeypair;
 
@@ -74,12 +80,15 @@ export const publishSubmitCommand = async ({
       solanaMobileDappPublisherPortalDetails,
       compliesWithSolanaDappStorePolicies,
       requestorIsAuthorized,
+      alphaTest,
     },
     dryRun
   );
 
-  await writeToPublishDetails(
-    {
-      lastUpdatedVersionOnStore: { address: releaseAddr }
-    });
+  if (!alphaTest) {
+    await writeToPublishDetails(
+      {
+        lastUpdatedVersionOnStore: { address: releaseAddr }
+      });
+  }
 };

package/src/commands/publish/PublishCliUpdate.ts

@@ -14,6 +14,7 @@ type PublishUpdateCommandInput = {
   compliesWithSolanaDappStorePolicies: boolean;
   requestorIsAuthorized: boolean;
   critical: boolean;
+  alphaTest?: boolean;
 };
 
 export const publishUpdateCommand = async ({
@@ -25,6 +26,7 @@ export const publishUpdateCommand = async ({
   compliesWithSolanaDappStorePolicies = false,
   requestorIsAuthorized = false,
   critical = false,
+  alphaTest,
 }: PublishUpdateCommandInput) => {
 
   showMessage(
@@ -60,6 +62,10 @@ export const publishUpdateCommand = async ({
     lastUpdatedVersionOnStore: lastUpdatedVersionOnStore
   } = await loadPublishDetailsWithChecks();
 
+  if (alphaTest && solanaMobileDappPublisherPortalDetails.alpha_testers == undefined) {
+    throw new Error(`Alpha test submission without specifying any testers.\nAdd field alpha_testers in your 'config.yaml' file.`)
+  }
+
   const sign = ((buf: Buffer) =>
     nacl.sign(buf, signer.secretKey)) as SignWithPublisherKeypair;
 
@@ -83,11 +89,14 @@ export const publishUpdateCommand = async ({
       compliesWithSolanaDappStorePolicies,
       requestorIsAuthorized,
       criticalUpdate: critical,
+      alphaTest,
     },
     dryRun
   );
-  await writeToPublishDetails(
-    {
-      lastUpdatedVersionOnStore: { address: releaseAddr }
-    });
+  if (!alphaTest) {
+    await writeToPublishDetails(
+      {
+        lastUpdatedVersionOnStore: { address: releaseAddr }
+      });
+  }
 };

package/src/config/PublishDetails.ts

@@ -20,6 +20,7 @@ import util from "util";
 import { imageSize } from "image-size";
 import { exec } from "child_process";
 import getVideoDimensions from "get-video-dimensions";
+import { PublicKey } from "@solana/web3.js";
 
 const runImgSize = util.promisify(imageSize);
 const runExec = util.promisify(exec);
@@ -126,6 +127,24 @@ export const loadPublishDetailsWithChecks = async (
     throw new Error("Please specify at least one media entry of type icon in your configuration file");
   }
 
+  const banner = config.release.media?.find(
+      (asset: any) => asset.purpose === "banner"
+    )?.uri;
+
+    if (banner) {
+      const bannerPath = path.join(process.cwd(), banner);
+      await checkBannerCompatibility(bannerPath);
+    }
+
+  const featureGraphic = config.release.media?.find(
+    (asset: any) => asset.purpose === "featureGraphic"
+  )?.uri;
+
+  if (featureGraphic) {
+    const featureGraphicPath = path.join(process.cwd(), featureGraphic);
+    await checkFeatureGraphicCompatibility(featureGraphicPath);
+  }
+
   config.release.media.forEach((item: PublishDetails["release"]["media"][0]) => {
     const mediaPath = path.join(process.cwd(), item.uri);
     if (!fs.existsSync(mediaPath)) {
@@ -148,7 +167,7 @@ export const loadPublishDetailsWithChecks = async (
 
   for (const item of screenshots) {
     const mediaPath = path.join(process.cwd(), item.uri);
-    if (await checkScreenshotSize(mediaPath)) {
+    if (await checkScreenshotDimensions(mediaPath)) {
       throw new Error(`Screenshot ${mediaPath} must be at least 1080px in width and height.`);
     }
   }
@@ -159,7 +178,7 @@ export const loadPublishDetailsWithChecks = async (
 
   for (const video of videos) {
     const mediaPath = path.join(process.cwd(), video.uri);
-    if (await checkVideoSize(mediaPath)) {
+    if (await checkVideoDimensions(mediaPath)) {
       throw new Error(`Video ${mediaPath} must be at least 720px in width and height.`);
     }
   }
@@ -179,6 +198,21 @@ export const loadPublishDetailsWithChecks = async (
     }
   }
 
+  const alpha_testers = config.solana_mobile_dapp_publisher_portal.alpha_testers;
+  if (alpha_testers !== undefined) {
+    for (const wallet of alpha_testers) {
+      try {
+        void new PublicKey(wallet.address);
+      } catch (e: unknown) {
+        throw new Error(`invalid alpha tester wallet address <${wallet}>`);
+      }
+    }
+
+    if (alpha_testers.size > 10) {
+      throw new Error(`Alpha testers are limited to 10 per app submission`);
+    }
+  }
+
   return config;
 };
 
@@ -192,6 +226,26 @@ const checkIconCompatibility = async (path: string, typeString: string) => {
   }
 };
 
+const checkBannerCompatibility = async (path: string) => {
+  if (!fs.existsSync(path) || !checkImageExtension(path)) {
+    throw new Error(`Please check the path to your banner image and ensure the file is a jpeg, png, or webp file.`);
+  }
+
+  if (await checkBannerDimensions(path)) {
+    throw new Error("Banner must be 1200px by 600px.");
+  }
+};
+
+const checkFeatureGraphicCompatibility = async (path: string) => {
+  if (!fs.existsSync(path) || !checkImageExtension(path)) {
+    throw new Error(`Please check the path to your featureGraphic image and ensure the file is a jpeg, png, or webp file.`);
+  }
+
+  if (await checkFeatureGraphicDimensions(path)) {
+    throw new Error("Feature Graphic must be 1200px by 1200px.");
+  }
+};
+
 const checkImageExtension = (uri: string): boolean => {
   const fileExt = path.extname(uri).toLowerCase();
   return (
@@ -241,13 +295,25 @@ const checkIconDimensions = async (iconPath: string): Promise<boolean> => {
   return size?.width != size?.height || (size?.width ?? 0) != 512;
 };
 
-const checkScreenshotSize = async (imagePath: string): Promise<boolean> => {
+const checkScreenshotDimensions = async (imagePath: string): Promise<boolean> => {
   const size = await runImgSize(imagePath);
 
   return (size?.width ?? 0) < 1080 || (size?.height ?? 0) < 1080;
 }
 
-const checkVideoSize = async (imagePath: string): Promise<boolean> => {
+const checkBannerDimensions = async (imagePath: string): Promise<boolean> => {
+  const size = await runImgSize(imagePath);
+
+  return (size?.width ?? 0) != 1200 || (size?.height ?? 0) != 600;
+}
+
+const checkFeatureGraphicDimensions = async (imagePath: string): Promise<boolean> => {
+  const size = await runImgSize(imagePath);
+
+  return (size?.width ?? 0) != 1200 || (size?.height ?? 0) != 1200;
+}
+
+const checkVideoDimensions = async (imagePath: string): Promise<boolean> => {
   const size = await getVideoDimensions(imagePath);
 
   return (size?.width ?? 0) < 720 || (size?.height ?? 0) < 720;

package/src/prebuild_schema/publishing_source.yaml

@@ -23,6 +23,10 @@ release:
   media:
     - purpose: icon
       uri: <<RELATIVE_PATH_TO_RELEASE_ICON>>
+    - purpose: banner
+      uri: <<RELATIVE_PATH_TO_BANNER>>
+    - purpose: featureGraphic
+      uri: <<RELATIVE_PATH_TO_FEATURE_GRAPHIC>>
     - purpose: screenshot
       uri: <<RELATIVE_PATH_TO_SCREENSHOT1>>
     - purpose: screenshot
@@ -51,4 +55,9 @@ release:
 solana_mobile_dapp_publisher_portal:
   google_store_package: <<ANDROID_PACKAGE_NAME_OF_GOOGLE_PLAY_STORE_VERSION_IF_DIFFERENT>>
   testing_instructions: >-
-    <<TESTING_INSTRUCTIONS>>
+    <<TESTING_INSTRUCTIONS>>
+  alpha_testers: 
+    - address: <<genesis token wallet address>>
+      comment: <<Optional. For internal use only>>
+    - address: <<genesis token wallet address>>
+      comment: <<Optional. For internal use only>>