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

package/lib/CliUtils.js

@@ -0,0 +1,309 @@
+function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) {
+    try {
+        var info = gen[key](arg);
+        var value = info.value;
+    } catch (error) {
+        reject(error);
+        return;
+    }
+    if (info.done) {
+        resolve(value);
+    } else {
+        Promise.resolve(value).then(_next, _throw);
+    }
+}
+function _async_to_generator(fn) {
+    return function() {
+        var self = this, args = arguments;
+        return new Promise(function(resolve, reject) {
+            var gen = fn.apply(self, args);
+            function _next(value) {
+                asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value);
+            }
+            function _throw(err) {
+                asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err);
+            }
+            _next(undefined);
+        });
+    };
+}
+function _class_call_check(instance, Constructor) {
+    if (!(instance instanceof Constructor)) {
+        throw new TypeError("Cannot call a class as a function");
+    }
+}
+function _define_property(obj, key, value) {
+    if (key in obj) {
+        Object.defineProperty(obj, key, {
+            value: value,
+            enumerable: true,
+            configurable: true,
+            writable: true
+        });
+    } else {
+        obj[key] = value;
+    }
+    return obj;
+}
+function _ts_generator(thisArg, body) {
+    var f, y, t, g, _ = {
+        label: 0,
+        sent: function() {
+            if (t[0] & 1) throw t[1];
+            return t[1];
+        },
+        trys: [],
+        ops: []
+    };
+    return(g = {
+        next: verb(0),
+        "throw": verb(1),
+        "return": verb(2)
+    }, typeof Symbol === "function" && (g[Symbol.iterator] = function() {
+        return this;
+    }), g);
+    function verb(n) {
+        return function(v) {
+            return step([
+                n,
+                v
+            ]);
+        };
+    }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while(_)try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [
+                op[0] & 2,
+                t.value
+            ];
+            switch(op[0]){
+                case 0:
+                case 1:
+                    t = op;
+                    break;
+                case 4:
+                    _.label++;
+                    return {
+                        value: op[1],
+                        done: false
+                    };
+                case 5:
+                    _.label++;
+                    y = op[1];
+                    op = [
+                        0
+                    ];
+                    continue;
+                case 7:
+                    op = _.ops.pop();
+                    _.trys.pop();
+                    continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) {
+                        _ = 0;
+                        continue;
+                    }
+                    if (op[0] === 3 && (!t || op[1] > t[0] && op[1] < t[3])) {
+                        _.label = op[1];
+                        break;
+                    }
+                    if (op[0] === 6 && _.label < t[1]) {
+                        _.label = t[1];
+                        t = op;
+                        break;
+                    }
+                    if (t && _.label < t[2]) {
+                        _.label = t[2];
+                        _.ops.push(op);
+                        break;
+                    }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop();
+                    continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) {
+            op = [
+                6,
+                e
+            ];
+            y = 0;
+        } finally{
+            f = t = 0;
+        }
+        if (op[0] & 5) throw op[1];
+        return {
+            value: op[0] ? op[1] : void 0,
+            done: true
+        };
+    }
+}
+import fs from "fs";
+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";
+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 var Constants = function Constants() {
+    "use strict";
+    _class_call_check(this, Constants);
+};
+_define_property(Constants, "CLI_VERSION", "0.4.3");
+_define_property(Constants, "CONFIG_FILE_NAME", "config.yaml");
+_define_property(Constants, "DEFAULT_RPC_DEVNET", "https://api.devnet.solana.com");
+_define_property(Constants, "getConfigFilePath", function() {
+    return "".concat(process.cwd(), "/").concat(Constants.CONFIG_FILE_NAME);
+});
+export var debug = debugModule("CLI");
+export var checkForSelfUpdate = function() {
+    var _ref = _async_to_generator(function() {
+        var notifier, updateInfo, latestVer, currentVer;
+        return _ts_generator(this, function(_state) {
+            switch(_state.label){
+                case 0:
+                    notifier = updateNotifier({
+                        pkg: cliPackage
+                    });
+                    return [
+                        4,
+                        notifier.fetchInfo()
+                    ];
+                case 1:
+                    updateInfo = _state.sent();
+                    latestVer = new ver.SemVer(updateInfo.latest);
+                    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.");
+                    }
+                    return [
+                        2
+                    ];
+            }
+        });
+    });
+    return function checkForSelfUpdate() {
+        return _ref.apply(this, arguments);
+    };
+}();
+export var checkMintedStatus = function() {
+    var _ref = _async_to_generator(function(conn, pubAddr, appAddr, releaseAddr) {
+        var results, rentAccounts;
+        return _ts_generator(this, function(_state) {
+            switch(_state.label){
+                case 0:
+                    return [
+                        4,
+                        conn.getMultipleAccountsInfo([
+                            new PublicKey(pubAddr),
+                            new PublicKey(appAddr),
+                            new PublicKey(releaseAddr)
+                        ])
+                    ];
+                case 1:
+                    results = _state.sent();
+                    rentAccounts = results.filter(function(item) {
+                        return !(item == undefined) && (item === null || item === void 0 ? void 0 : item.lamports) > 0;
+                    });
+                    if ((rentAccounts === null || rentAccounts === void 0 ? void 0 : rentAccounts.length) != 3) {
+                        throw new Error("Please ensure you have minted all of your NFTs before submitting to the Solana Mobile dApp publisher portal.");
+                    }
+                    return [
+                        2
+                    ];
+            }
+        });
+    });
+    return function checkMintedStatus(conn, pubAddr, appAddr, releaseAddr) {
+        return _ref.apply(this, arguments);
+    };
+}();
+export var parseKeypair = function(pathToKeypairFile) {
+    try {
+        var 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 var isDevnet = function(rpcUrl) {
+    return rpcUrl.indexOf("devnet") != -1;
+};
+export var isTestnet = function(rpcUrl) {
+    return rpcUrl.indexOf("testnet") != -1;
+};
+export var checkSubmissionNetwork = function(rpcUrl) {
+    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 var generateNetworkSuffix = function(rpcUrl) {
+    var suffix = "";
+    if (isDevnet(rpcUrl)) {
+        suffix = "?cluster=devnet";
+    } else if (isTestnet(rpcUrl)) {
+        suffix = "?cluster=testnet";
+    } else {
+        suffix = "?cluster=mainnet";
+    }
+    return suffix;
+};
+export var showMessage = function() {
+    var titleMessage = arguments.length > 0 && arguments[0] !== void 0 ? arguments[0] : "", contentMessage = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : "", type = arguments.length > 2 && arguments[2] !== void 0 ? arguments[2] : "standard";
+    var color = "cyan";
+    if (type == "error") {
+        color = "redBright";
+    } else if (type == "warning") {
+        color = "yellow";
+    }
+    var msg = boxen(contentMessage, {
+        title: titleMessage,
+        padding: 1,
+        margin: 1,
+        borderStyle: "single",
+        borderColor: color,
+        textAlignment: "left",
+        titleAlignment: "center"
+    });
+    console.log(msg);
+    return msg;
+};
+export var getMetaplexInstance = function(connection, keypair) {
+    var storageParams = arguments.length > 2 && arguments[2] !== void 0 ? arguments[2] : "";
+    var metaplex = Metaplex.make(connection).use(keypairIdentity(keypair));
+    var isDevnet = connection.rpcEndpoint.includes("devnet");
+    //TODO: Use DI for this
+    var s3Mgr = new S3StorageManager(new EnvVariables());
+    s3Mgr.parseCmdArg(storageParams);
+    if (s3Mgr.hasS3Config) {
+        var awsClient = new S3Client({
+            region: s3Mgr.s3Config.regionName,
+            credentials: {
+                accessKeyId: s3Mgr.s3Config.accessKey,
+                secretAccessKey: s3Mgr.s3Config.secretKey
+            }
+        });
+        var bucketPlugin = awsStorage(awsClient, s3Mgr.s3Config.bucketName);
+        metaplex.use(bucketPlugin);
+    } else {
+        var bundlrStorageDriver = isDevnet ? new BundlrStorageDriver(metaplex, {
+            address: "https://devnet.bundlr.network",
+            providerUrl: Constants.DEFAULT_RPC_DEVNET
+        }) : new BundlrStorageDriver(metaplex);
+        metaplex.storage().setDriver(bundlrStorageDriver);
+    }
+    metaplex.storage().setDriver(new CachedStorageDriver(metaplex.storage().driver(), {
+        assetManifestPath: isDevnet ? "./.asset-manifest-devnet.json" : "./.asset-manifest.json"
+    }));
+    return metaplex;
+};

package/lib/__tests__/CliSetupTest.js

@@ -0,0 +1,140 @@
+import { beforeEach, expect } from "@jest/globals";
+import { createAppCliCmd, createCliCmd, createPublisherCliCmd, createReleaseCliCmd, initCliCmd, mainCli } from "../CliSetup";
+import { Constants } from "../CliUtils";
+describe("Cli Setup & Execution", function() {
+    var outputHelpReference = "(outputHelp)";
+    var errorOutput = "";
+    var otherOutput = "";
+    beforeEach(function() {
+        errorOutput = "";
+        otherOutput = "";
+        mainCli.exitOverride();
+        mainCli.configureOutput({
+            getOutHelpWidth: function getOutHelpWidth() {
+                return 250;
+            },
+            getErrHelpWidth: function getErrHelpWidth() {
+                return 250;
+            },
+            writeOut: function writeOut(str) {
+                otherOutput = str;
+            },
+            writeErr: function writeErr(str) {
+                errorOutput = str;
+            }
+        });
+    });
+    test("Cli version argument reports correct version", function() {
+        expect(function() {
+            mainCli.parse([
+                "npx",
+                "dapp-store",
+                "-V"
+            ]);
+        }).toThrow(Constants.CLI_VERSION);
+    });
+    test("Calling cli with no parameters displays general help", function() {
+        expect(function() {
+            mainCli.parse([
+                "npx",
+                "dapp-store"
+            ]);
+        }).toThrow(outputHelpReference);
+        expect(generalHelp).toEqual(errorOutput);
+    });
+    test("Calling init command with help parameter shows contextual help info", function() {
+        initCliCmd.exitOverride();
+        expect(function() {
+            initCliCmd.parse([
+                "dapp-store",
+                "init",
+                "-h"
+            ]);
+        }).toThrow(outputHelpReference);
+        expect(otherOutput).toEqual(initHelp);
+    });
+    test("Calling create command with no options lists all options", function() {
+        createCliCmd.exitOverride();
+        expect(function() {
+            createCliCmd.parse([
+                "dapp-store",
+                "create"
+            ]);
+        }).toThrow(outputHelpReference);
+        expect(errorOutput).toEqual(createHelp);
+    });
+    test("Calling create publisher command with no arguments warns about required argument", function() {
+        createPublisherCliCmd.exitOverride();
+        expect(function() {
+            createPublisherCliCmd.parse([
+                "dapp-store",
+                "create",
+                "publisher"
+            ]);
+        }).toThrow(keyPairArgHelp);
+    });
+    test("Calling create publisher command with help flag shows contextual help", function() {
+        createPublisherCliCmd.exitOverride();
+        expect(function() {
+            createPublisherCliCmd.parse([
+                "dapp-store",
+                "create",
+                "publisher",
+                "-h"
+            ]);
+        }).toThrow(outputHelpReference);
+        expect(otherOutput).toEqual(createPublisherHelp);
+    });
+    test("Calling create app command with no arguments warns about required argument", function() {
+        createAppCliCmd.exitOverride();
+        expect(function() {
+            createAppCliCmd.parse([
+                "dapp-store",
+                "create",
+                "app"
+            ]);
+        }).toThrow(keyPairArgHelp);
+    });
+    test("Calling create app command with help flag shows contextual help", function() {
+        createAppCliCmd.exitOverride();
+        expect(function() {
+            createAppCliCmd.parse([
+                "dapp-store",
+                "create",
+                "app",
+                "-h"
+            ]);
+        }).toThrow(outputHelpReference);
+        expect(otherOutput).toEqual(createAppHelp);
+    });
+    test("Calling create release command with no arguments warns about required argument", function() {
+        createReleaseCliCmd.exitOverride();
+        expect(function() {
+            createReleaseCliCmd.parse([
+                "dapp-store",
+                "create",
+                "release"
+            ]);
+        }).toThrow(keyPairArgHelp);
+    });
+    test("Calling create release command with help flag shows contextual help", function() {
+        createReleaseCliCmd.exitOverride();
+        expect(function() {
+            createReleaseCliCmd.parse([
+                "dapp-store",
+                "create",
+                "release",
+                "-h"
+            ]);
+        }).toThrow(outputHelpReference);
+        expect(otherOutput).toEqual(createReleaseHelp);
+    });
+    //--------------------------------------------------
+    var generalHelp = "Usage: dapp-store [options] [command]\n\nCLI to assist with publishing to the Saga Dapp Store\n\nOptions:\n  -V, --version       output the version number\n  -h, --help          display help for command\n\nCommands:\n  init                First-time initialization of tooling configuration\n  create              Create a `publisher`, `app`, or `release`\n  validate [options]  Validates details prior to publishing\n  publish             Submit a publishing request (`submit`, `update`, `remove`, or `support`) to the Solana Mobile dApp publisher portal\n  help [command]      display help for command\n";
+    var initHelp = "Usage: dapp-store init [options]\n\nFirst-time initialization of tooling configuration\n\nOptions:\n  -h, --help  display help for command\n";
+    var keyPairArgHelp = "error: required option '-k, --keypair <path-to-keypair-file>' not specified";
+    var createHelp = "Usage: dapp-store create [options] [command]\n\nCreate a `publisher`, `app`, or `release`\n\nOptions:\n  -h, --help           display help for command\n\nCommands:\n  publisher [options]  Create a publisher\n  app [options]        Create a app\n  release [options]    Create a release\n  help [command]       display help for command\n";
+    var createPublisherHelp = 'Usage: dapp-store create publisher [options]\n\nCreate a publisher\n\nOptions:\n  -k, --keypair <path-to-keypair-file>   Path to keypair file\n  -u, --url <url>                        RPC URL (default: "https://api.devnet.solana.com")\n  -d, --dry-run                          Flag for dry run. Doesn\'t mint an NFT\n  -s, --storage-config <storage-config>  Provide alternative storage configuration details\n  -h, --help                             display help for command\n';
+    var createAppHelp = 'Usage: dapp-store create app [options]\n\nCreate a app\n\nOptions:\n  -k, --keypair <path-to-keypair-file>                   Path to keypair file\n  -p, --publisher-mint-address <publisher-mint-address>  The mint address of the publisher NFT\n  -u, --url <url>                                        RPC URL (default: "https://api.devnet.solana.com")\n  -d, --dry-run                                          Flag for dry run. Doesn\'t mint an NFT\n  -s, --storage-config <storage-config>                  Provide alternative storage configuration details\n  -h, --help                                             display help for command\n';
+    var createReleaseHelp = 'Usage: dapp-store create release [options]\n\nCreate a release\n\nOptions:\n  -k, --keypair <path-to-keypair-file>       Path to keypair file\n  -a, --app-mint-address <app-mint-address>  The mint address of the app NFT\n  -u, --url <url>                            RPC URL (default: "https://api.devnet.solana.com")\n  -d, --dry-run                              Flag for dry run. Doesn\'t mint an NFT\n  -b, --build-tools-path <build-tools-path>  Path to Android build tools which contains AAPT2\n  -s, --storage-config <storage-config>      Provide alternative storage configuration details\n  -h, --help                                 display help for command\n';
+});

package/lib/commands/ValidateCommand.js

@@ -0,0 +1,201 @@
+function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) {
+    try {
+        var info = gen[key](arg);
+        var value = info.value;
+    } catch (error) {
+        reject(error);
+        return;
+    }
+    if (info.done) {
+        resolve(value);
+    } else {
+        Promise.resolve(value).then(_next, _throw);
+    }
+}
+function _async_to_generator(fn) {
+    return function() {
+        var self = this, args = arguments;
+        return new Promise(function(resolve, reject) {
+            var gen = fn.apply(self, args);
+            function _next(value) {
+                asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value);
+            }
+            function _throw(err) {
+                asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err);
+            }
+            _next(undefined);
+        });
+    };
+}
+function _ts_generator(thisArg, body) {
+    var f, y, t, g, _ = {
+        label: 0,
+        sent: function() {
+            if (t[0] & 1) throw t[1];
+            return t[1];
+        },
+        trys: [],
+        ops: []
+    };
+    return(g = {
+        next: verb(0),
+        "throw": verb(1),
+        "return": verb(2)
+    }, typeof Symbol === "function" && (g[Symbol.iterator] = function() {
+        return this;
+    }), g);
+    function verb(n) {
+        return function(v) {
+            return step([
+                n,
+                v
+            ]);
+        };
+    }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while(_)try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [
+                op[0] & 2,
+                t.value
+            ];
+            switch(op[0]){
+                case 0:
+                case 1:
+                    t = op;
+                    break;
+                case 4:
+                    _.label++;
+                    return {
+                        value: op[1],
+                        done: false
+                    };
+                case 5:
+                    _.label++;
+                    y = op[1];
+                    op = [
+                        0
+                    ];
+                    continue;
+                case 7:
+                    op = _.ops.pop();
+                    _.trys.pop();
+                    continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) {
+                        _ = 0;
+                        continue;
+                    }
+                    if (op[0] === 3 && (!t || op[1] > t[0] && op[1] < t[3])) {
+                        _.label = op[1];
+                        break;
+                    }
+                    if (op[0] === 6 && _.label < t[1]) {
+                        _.label = t[1];
+                        t = op;
+                        break;
+                    }
+                    if (t && _.label < t[2]) {
+                        _.label = t[2];
+                        _.ops.push(op);
+                        break;
+                    }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop();
+                    continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) {
+            op = [
+                6,
+                e
+            ];
+            y = 0;
+        } finally{
+            f = t = 0;
+        }
+        if (op[0] & 5) throw op[1];
+        return {
+            value: op[0] ? op[1] : void 0,
+            done: true
+        };
+    }
+}
+import { createAppJson, createPublisherJson, createReleaseJson, validateApp, validatePublisher, validateRelease, metaplexFileReplacer } from "@solana-mobile/dapp-store-publishing-tools";
+import { debug } from "../CliUtils.js";
+import { loadPublishDetailsWithChecks } from "../config/PublishDetails.js";
+export var validateCommand = function() {
+    var _ref = _async_to_generator(function(param) {
+        var signer, buildToolsPath, _ref, publisherDetails, appDetails, releaseDetails, publisherJson, _publisherJson_image, appJson, _appJson_image, releaseJson, objStringified;
+        return _ts_generator(this, function(_state) {
+            switch(_state.label){
+                case 0:
+                    signer = param.signer, buildToolsPath = param.buildToolsPath;
+                    return [
+                        4,
+                        loadPublishDetailsWithChecks(buildToolsPath)
+                    ];
+                case 1:
+                    _ref = _state.sent(), publisherDetails = _ref.publisher, appDetails = _ref.app, releaseDetails = _ref.release;
+                    debug({
+                        publisherDetails: publisherDetails,
+                        appDetails: appDetails,
+                        releaseDetails: releaseDetails
+                    });
+                    publisherJson = createPublisherJson(publisherDetails);
+                    if (typeof publisherJson.image !== "string") {
+                        ;
+                        publisherJson.image = (_publisherJson_image = publisherJson.image) === null || _publisherJson_image === void 0 ? void 0 : _publisherJson_image.fileName;
+                    }
+                    debug("publisherJson=", JSON.stringify({
+                        publisherJson: publisherJson
+                    }, metaplexFileReplacer, 2));
+                    try {
+                        validatePublisher(publisherJson);
+                        console.info("Publisher JSON valid!");
+                    } catch (e) {
+                        console.error(e);
+                    }
+                    appJson = createAppJson(appDetails, signer.publicKey);
+                    if (typeof appJson.image !== "string") {
+                        ;
+                        appJson.image = (_appJson_image = appJson.image) === null || _appJson_image === void 0 ? void 0 : _appJson_image.fileName;
+                    }
+                    debug("appJson=", JSON.stringify({
+                        appJson: appJson
+                    }, metaplexFileReplacer, 2));
+                    try {
+                        validateApp(appJson);
+                        console.info("App JSON valid!");
+                    } catch (e) {
+                        console.error(e);
+                    }
+                    return [
+                        4,
+                        createReleaseJson({
+                            releaseDetails: releaseDetails,
+                            appDetails: appDetails,
+                            publisherDetails: publisherDetails
+                        }, signer.publicKey)
+                    ];
+                case 2:
+                    releaseJson = _state.sent();
+                    objStringified = JSON.stringify(releaseJson, metaplexFileReplacer, 2);
+                    debug("releaseJson=", objStringified);
+                    try {
+                        validateRelease(JSON.parse(objStringified));
+                        console.info("Release JSON valid!");
+                    } catch (e) {
+                        console.error(e);
+                    }
+                    return [
+                        2
+                    ];
+            }
+        });
+    });
+    return function validateCommand(_) {
+        return _ref.apply(this, arguments);
+    };
+}();