@solana-mobile/dapp-store-cli 0.4.0 → 0.4.1

package/lib/types/commands/scaffolding/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/commands/scaffolding/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/commands/scaffolding/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC"}

package/lib/types/config/PublishDetails.d.ts

@@ -0,0 +1,17 @@
+import type { App, Publisher, Release, SolanaMobileDappPublisherPortal } from "@solana-mobile/dapp-store-publishing-tools";
+export interface PublishDetails {
+    publisher: Publisher;
+    app: App;
+    release: Release;
+    solana_mobile_dapp_publisher_portal: SolanaMobileDappPublisherPortal;
+}
+declare type SaveToConfigArgs = {
+    publisher?: Pick<Publisher, "address">;
+    app?: Pick<App, "address">;
+    release?: Pick<Release, "address">;
+};
+export declare const loadPublishDetails: (configPath: string) => Promise<PublishDetails>;
+export declare const loadPublishDetailsWithChecks: (buildToolsDir?: string | null) => Promise<PublishDetails>;
+export declare const writeToPublishDetails: ({ publisher, app, release }: SaveToConfigArgs) => Promise<void>;
+export {};
+//# sourceMappingURL=PublishDetails.d.ts.map

package/lib/types/config/PublishDetails.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PublishDetails.d.ts","sourceRoot":"","sources":["../../../src/config/PublishDetails.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAEV,GAAG,EACH,SAAS,EACT,OAAO,EACP,+BAA+B,EAChC,MAAM,4CAA4C,CAAC;AAgBpD,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE,SAAS,CAAC;IACrB,GAAG,EAAE,GAAG,CAAC;IACT,OAAO,EAAE,OAAO,CAAC;IACjB,mCAAmC,EAAE,+BAA+B,CAAC;CACtE;AAYD,aAAK,gBAAgB,GAAG;IACtB,SAAS,CAAC,EAAE,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IACvC,GAAG,CAAC,EAAE,IAAI,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;IAC3B,OAAO,CAAC,EAAE,IAAI,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;CACpC,CAAC;AAKF,eAAO,MAAM,kBAAkB,eAAsB,MAAM,4BAW1D,CAAC;AAEF,eAAO,MAAM,4BAA4B,mBACxB,MAAM,GAAG,IAAI,KAC3B,QAAQ,cAAc,CA8ExB,CAAC;AA4GF,eAAO,MAAM,qBAAqB,gCAAuC,gBAAgB,kBAuBxF,CAAC"}

package/lib/types/upload/CachedStorageDriver.d.ts

@@ -1,11 +1,11 @@
 import type { MetaplexFile, StorageDriver } from "@metaplex-foundation/js";
-type URI = string;
-type Asset = {
+declare type URI = string;
+declare type Asset = {
     path: string;
     sha256: string;
     uri: URI;
 };
-export type AssetManifestSchema = {
+export declare type AssetManifestSchema = {
     schema_version: string;
     assets: {
         [path: string]: Asset;

package/lib/types/upload/CachedStorageDriver.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CachedStorageDriver.d.ts","sourceRoot":"","sources":["../../../src/upload/CachedStorageDriver.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAG3E,KAAK,GAAG,GAAG,MAAM,CAAC;AAElB,KAAK,KAAK,GAAG;IACX,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,GAAG,CAAC;CACV,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,cAAc,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE;QACN,CAAC,IAAI,EAAE,MAAM,GAAG,KAAK,CAAC;KACvB,CAAC;CACH,CAAC;AAGF,qBAAa,mBAAoB,YAAW,aAAa;IAGvD,MAAM,CAAC,QAAQ,CAAC,cAAc,SAAS;IAEvC,aAAa,EAAE,mBAAmB,CAAC;IACnC,iBAAiB,EAAE,MAAM,CAAC;IAC1B,aAAa,EAAE,aAAa,CAAC;gBAG3B,aAAa,EAAE,aAAa,EAC5B,EAAE,iBAAiB,EAAE,EAAE;QAAE,iBAAiB,EAAE,MAAM,CAAA;KAAE;IAWhD,cAAc,CAAC,KAAK,EAAE,MAAM;IAIlC,iBAAiB,CAAC,QAAQ,EAAE,MAAM,GAAG,mBAAmB,GAAG,SAAS;IAWpE,aAAa,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,EAAE;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE;IAOxD,MAAM,CAAC,IAAI,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC;CA0ClD"}
+{"version":3,"file":"CachedStorageDriver.d.ts","sourceRoot":"","sources":["../../../src/upload/CachedStorageDriver.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAG3E,aAAK,GAAG,GAAG,MAAM,CAAC;AAElB,aAAK,KAAK,GAAG;IACX,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,GAAG,CAAC;CACV,CAAC;AAEF,oBAAY,mBAAmB,GAAG;IAChC,cAAc,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE;QACN,CAAC,IAAI,EAAE,MAAM,GAAG,KAAK,CAAC;KACvB,CAAC;CACH,CAAC;AAGF,qBAAa,mBAAoB,YAAW,aAAa;IAGvD,MAAM,CAAC,QAAQ,CAAC,cAAc,SAAS;IAEvC,aAAa,EAAE,mBAAmB,CAAC;IACnC,iBAAiB,EAAE,MAAM,CAAC;IAC1B,aAAa,EAAE,aAAa,CAAC;gBAG3B,aAAa,EAAE,aAAa,EAC5B,EAAE,iBAAiB,EAAE,EAAE;QAAE,iBAAiB,EAAE,MAAM,CAAA;KAAE;IAWhD,cAAc,CAAC,KAAK,EAAE,MAAM;IAIlC,iBAAiB,CAAC,QAAQ,EAAE,MAAM,GAAG,mBAAmB,GAAG,SAAS;IAWpE,aAAa,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,EAAE;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE;IAOxD,MAAM,CAAC,IAAI,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC;CA0ClD"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@solana-mobile/dapp-store-cli",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "license": "Apache-2.0",
   "type": "module",
   "sideEffects": false,
@@ -36,7 +36,7 @@
     "shx": "^0.3.4"
   },
   "dependencies": {
-    "@solana-mobile/dapp-store-publishing-tools": "0.4.0",
+    "@solana-mobile/dapp-store-publishing-tools": "0.4.1",
     "@solana/web3.js": "1.68.0",
     "@types/semver": "^7.3.13",
     "ajv": "^8.11.0",

package/src/CliUtils.ts

@@ -0,0 +1,135 @@
+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 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";
+
+export class Constants {
+  static CLI_VERSION = "0.4.1";
+  static CONFIG_FILE_NAME = "config.yaml";
+  static DEFAULT_RPC_DEVNET = "https://api.devnet.solana.com";
+}
+
+export const debug = debugModule("CLI");
+
+export const checkForSelfUpdate = async () => {
+  const notifier = updateNotifier({ pkg: cliPackage });
+  const updateInfo = await notifier.fetchInfo();
+
+  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");
+    return Keypair.fromSecretKey(Buffer.from(JSON.parse(keypairFile)));
+  } catch (e) {
+    showMessage
+    (
+      "KeyPair Error",
+      "Something went wrong when attempting to retrieve the keypair at " + pathToKeypairFile,
+      "error"
+    )
+  }
+};
+
+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 (isDevnet(rpcUrl)) {
+    suffix = "?cluster=devnet";
+  } else if (isTestnet(rpcUrl)) {
+    suffix = "?cluster=testnet";
+  } else {
+    suffix = "?cluster=mainnet";
+  }
+
+  return suffix;
+};
+
+export const showMessage = (
+  titleMessage = "",
+  contentMessage = "",
+  type: "standard" | "error" | "warning" = "standard",
+): string => {
+  let color = "cyan";
+  if (type == "error") {
+    color = "redBright";
+  } else if (type == "warning") {
+    color = "yellow";
+  }
+
+  const msg = boxen(contentMessage, {
+    title: titleMessage,
+    padding: 1,
+    margin: 1,
+    borderStyle: 'single',
+    borderColor: color,
+    textAlignment: "left",
+    titleAlignment: "center",
+  });
+
+  console.log(msg);
+  return msg;
+};
+
+export const getMetaplexInstance = (
+  connection: Connection,
+  keypair: Keypair
+) => {
+  const metaplex = Metaplex.make(connection).use(keypairIdentity(keypair));
+  const isDevnet = connection.rpcEndpoint.includes("devnet");
+
+  const bundlrStorageDriver = isDevnet
+    ? new BundlrStorageDriver(metaplex, {
+        address: "https://devnet.bundlr.network",
+        providerUrl: Constants.DEFAULT_RPC_DEVNET,
+      })
+    : new BundlrStorageDriver(metaplex);
+
+  metaplex.storage().setDriver(
+    new CachedStorageDriver(bundlrStorageDriver, {
+      assetManifestPath: isDevnet
+        ? "./.asset-manifest-devnet.json"
+        : "./.asset-manifest.json",
+    })
+  );
+  return metaplex;
+};

package/src/commands/{validate.ts → ValidateCommand.ts}

@@ -7,11 +7,12 @@ import {
   validateRelease,
   metaplexFileReplacer,
 } from "@solana-mobile/dapp-store-publishing-tools";
-import { debug, getConfigWithChecks } from "../utils.js";
+import { debug } from "../CliUtils.js";
 
 import type { Keypair } from "@solana/web3.js";
 import type { MetaplexFile } from "@metaplex-foundation/js";
 import { isMetaplexFile } from "@metaplex-foundation/js";
+import { loadPublishDetailsWithChecks } from "../config/PublishDetails.js";
 
 export const validateCommand = async ({
   signer,
@@ -24,7 +25,7 @@ export const validateCommand = async ({
     publisher: publisherDetails,
     app: appDetails,
     release: releaseDetails,
-  } = await getConfigWithChecks(buildToolsPath);
+  } = await loadPublishDetailsWithChecks(buildToolsPath);
 
   debug({ publisherDetails, appDetails, releaseDetails });
 

package/src/commands/create/{app.ts → CreateCliApp.ts}

@@ -8,10 +8,9 @@ import {
 } from "@solana/web3.js";
 
 import {
-  getConfigWithChecks,
   getMetaplexInstance,
-  saveToConfig,
-} from "../../utils.js";
+} from "../../CliUtils.js";
+import { loadPublishDetailsWithChecks, writeToPublishDetails } from "../../config/PublishDetails.js";
 
 const createAppNft = async (
   {
@@ -71,7 +70,7 @@ export const createAppCommand = async ({
   const connection = new Connection(url);
 
   const { app: appDetails, publisher: publisherDetails } =
-    await getConfigWithChecks();
+    await loadPublishDetailsWithChecks();
 
   const { appAddress } = await createAppNft(
     {
@@ -84,7 +83,7 @@ export const createAppCommand = async ({
   );
 
   if (!dryRun) {
-    saveToConfig({ app: { address: appAddress } });
+    writeToPublishDetails({ app: { address: appAddress } });
   }
 
   return { appAddress };

package/src/commands/create/{publisher.ts → CreateCliPublisher.ts}

@@ -7,10 +7,9 @@ import {
 } from "@solana/web3.js";
 
 import {
-  getConfigWithChecks,
   getMetaplexInstance,
-  saveToConfig,
-} from "../../utils.js";
+} from "../../CliUtils.js";
+import { loadPublishDetailsWithChecks, writeToPublishDetails } from "../../config/PublishDetails.js";
 
 const createPublisherNft = async (
   {
@@ -62,7 +61,7 @@ export const createPublisherCommand = async ({
 }) => {
   const connection = new Connection(url);
 
-  const { publisher: publisherDetails } = await getConfigWithChecks();
+  const { publisher: publisherDetails } = await loadPublishDetailsWithChecks();
 
   const { publisherAddress } = await createPublisherNft(
     {
@@ -74,7 +73,7 @@ export const createPublisherCommand = async ({
   );
 
   // TODO(sdlaver): dry-run should not modify config
-  saveToConfig({ publisher: { address: publisherAddress } });
+  writeToPublishDetails({ publisher: { address: publisherAddress } });
 
   return { publisherAddress };
 };

package/src/commands/create/{release.ts → CreateCliRelease.ts}

@@ -10,13 +10,10 @@ import {
   PublicKey,
   sendAndConfirmTransaction,
 } from "@solana/web3.js";
-import { CachedStorageDriver } from "../../upload/CachedStorageDriver.js";
-
 import {
-  getConfigWithChecks,
   getMetaplexInstance,
-  saveToConfig,
-} from "../../utils.js";
+} from "../../CliUtils.js";
+import { loadPublishDetailsWithChecks, writeToPublishDetails } from "../../config/PublishDetails.js";
 
 type CreateReleaseCommandInput = {
   appMintAddress: string;
@@ -83,7 +80,7 @@ export const createReleaseCommand = async ({
 }: CreateReleaseCommandInput) => {
   const connection = new Connection(url);
 
-  const { release, app, publisher } = await getConfigWithChecks(buildToolsPath);
+  const { release, app, publisher } = await loadPublishDetailsWithChecks(buildToolsPath);
 
   if (!dryRun) {
     const { releaseAddress } = await createReleaseNft({
@@ -97,7 +94,7 @@ export const createReleaseCommand = async ({
       publisherDetails: publisher,
     });
 
-    saveToConfig({
+    writeToPublishDetails({
       release: { address: releaseAddress },
     });
 

package/src/commands/create/index.ts

@@ -1,6 +1,6 @@
-export * from "./publisher.js";
-export * from "./app.js";
-export * from "./release.js";
+export * from "./CreateCliPublisher.js";
+export * from "./CreateCliApp.js";
+export * from "./CreateCliRelease.js";
 
 /*
  * Module responsible for creating publishers, apps, and releases (in that order)

package/src/commands/index.ts

@@ -1,3 +1,3 @@
 export * from "./create/index.js";
 export * from "./publish/index.js";
-export * from "./validate.js";
+export * from "./ValidateCommand.js";

package/src/commands/publish/{remove.ts → PublishCliRemove.ts}

@@ -1,8 +1,9 @@
 import { Connection, Keypair } from "@solana/web3.js";
 import type { SignWithPublisherKeypair } from "@solana-mobile/dapp-store-publishing-tools";
 import { publishRemove } from "@solana-mobile/dapp-store-publishing-tools";
-import { checkMintedStatus, getConfigWithChecks } from "../../utils.js";
+import { checkMintedStatus } from "../../CliUtils.js";
 import nacl from "tweetnacl";
+import { loadPublishDetailsWithChecks } from "../../config/PublishDetails.js";
 
 type PublishRemoveCommandInput = {
   appMintAddress: string;
@@ -35,7 +36,7 @@ export const publishRemoveCommand = async ({
     publisher: publisherDetails,
     app: appDetails,
     release: releaseDetails,
-  } = await getConfigWithChecks();
+  } = await loadPublishDetailsWithChecks();
 
   const sign = ((buf: Buffer) =>
     nacl.sign(buf, signer.secretKey)) as SignWithPublisherKeypair;

package/src/commands/publish/{submit.ts → PublishCliSubmit.ts}

@@ -2,8 +2,9 @@ import { AccountInfo, Connection, Keypair, PublicKey } from "@solana/web3.js";
 import type { SignWithPublisherKeypair } from "@solana-mobile/dapp-store-publishing-tools";
 import { publishSubmit } from "@solana-mobile/dapp-store-publishing-tools";
 import nacl from "tweetnacl";
-import { checkMintedStatus, getConfigWithChecks } from "../../utils.js";
+import { checkMintedStatus } from "../../CliUtils.js";
 import { Buffer } from "buffer";
+import { loadPublishDetailsWithChecks } from "../../config/PublishDetails.js";
 
 type PublishSubmitCommandInput = {
   appMintAddress: string;
@@ -42,7 +43,7 @@ export const publishSubmitCommand = async ({
     app: appDetails,
     release: releaseDetails,
     solana_mobile_dapp_publisher_portal: solanaMobileDappPublisherPortalDetails,
-  } = await getConfigWithChecks();
+  } = await loadPublishDetailsWithChecks();
 
   const sign = ((buf: Buffer) =>
     nacl.sign(buf, signer.secretKey)) as SignWithPublisherKeypair;

package/src/commands/publish/{support.ts → PublishCliSupport.ts}

@@ -1,8 +1,9 @@
 import { Connection, Keypair } from "@solana/web3.js";
 import type { SignWithPublisherKeypair } from "@solana-mobile/dapp-store-publishing-tools";
 import { publishSupport } from "@solana-mobile/dapp-store-publishing-tools";
-import { checkMintedStatus, getConfigWithChecks } from "../../utils.js";
+import { checkMintedStatus } from "../../CliUtils.js";
 import nacl from "tweetnacl";
+import { loadPublishDetailsWithChecks } from "../../config/PublishDetails.js";
 
 type PublishSupportCommandInput = {
   appMintAddress: string;
@@ -35,7 +36,7 @@ export const publishSupportCommand = async ({
     publisher: publisherDetails,
     app: appDetails,
     release: releaseDetails,
-  } = await getConfigWithChecks();
+  } = await loadPublishDetailsWithChecks();
 
   const sign = ((buf: Buffer) =>
     nacl.sign(buf, signer.secretKey)) as SignWithPublisherKeypair;

package/src/commands/publish/{update.ts → PublishCliUpdate.ts}

@@ -1,8 +1,9 @@
 import { Connection, Keypair } from "@solana/web3.js";
 import type { SignWithPublisherKeypair } from "@solana-mobile/dapp-store-publishing-tools";
 import { publishUpdate } from "@solana-mobile/dapp-store-publishing-tools";
-import { checkMintedStatus, getConfigWithChecks } from "../../utils.js";
+import { checkMintedStatus } from "../../CliUtils.js";
 import nacl from "tweetnacl";
+import { loadPublishDetailsWithChecks } from "../../config/PublishDetails.js";
 
 type PublishUpdateCommandInput = {
   appMintAddress: string;
@@ -43,7 +44,7 @@ export const publishUpdateCommand = async ({
     app: appDetails,
     release: releaseDetails,
     solana_mobile_dapp_publisher_portal: solanaMobileDappPublisherPortalDetails,
-  } = await getConfigWithChecks();
+  } = await loadPublishDetailsWithChecks();
 
   const sign = ((buf: Buffer) =>
     nacl.sign(buf, signer.secretKey)) as SignWithPublisherKeypair;

package/src/commands/publish/index.ts

@@ -1,7 +1,7 @@
-export * from "./remove.js";
-export * from "./submit.js";
-export * from "./support.js";
-export * from "./update.js";
+export * from "./PublishCliRemove.js";
+export * from "./PublishCliSubmit.js";
+export * from "./PublishCliSupport.js";
+export * from "./PublishCliUpdate.js";
 
 /*
  * Module responsible for submitting requests to the Solana dApp Store publisher portal

package/src/commands/scaffolding/{init.ts → ScaffoldInit.ts}

@@ -3,7 +3,7 @@ import yaml, { dump } from "js-yaml";
 // eslint-disable-next-line require-extensions/require-extensions
 import releaseSchema from "../../generated/config_obj.json" assert { type: "json" };
 import fs from "fs";
-import { Constants } from "../../utils.js";
+import { Constants } from "../../CliUtils.js";
 
 export const initScaffold = (): string => {
   const outputYaml = Constants.CONFIG_FILE_NAME;

package/src/commands/scaffolding/index.ts

@@ -1 +1 @@
-export * from "./init.js";
+export * from "./ScaffoldInit.js";