@settlemint/sdk-cli 2.2.0-prc00b96af → 2.2.0-prdfa9d68b

package/README.md

@@ -131,7 +131,7 @@ settlemint platform create --help
 
 To use the SettleMint CLI, you first need to authenticate with the platform. Create a Personal Access Token (PAT) on the SettleMint platformand paste it when prompted by the login command.
 
-Visit [the documentation](https://console.settlemint.com/documentation) to learn how to create a Personal Access Token.
+Visit [the documentation](https://console.settlemint.com/documentation/platform-components/security-and-authentication/personal-access-tokens) to learn how to create a Personal Access Token.
 
 Then run the login command and paste your token when prompted:
 

package/dist/cli.js

@@ -245345,7 +245345,7 @@ function pruneCurrentEnv(currentEnv, env2) {
 var package_default = {
   name: "@settlemint/sdk-cli",
   description: "Command-line interface for SettleMint SDK, providing development tools and project management capabilities",
-  version: "2.2.0-prc00b96af",
+  version: "2.2.0-prdfa9d68b",
   type: "module",
   private: false,
   license: "FSL-1.1-MIT",
@@ -245394,8 +245394,8 @@ var package_default = {
     "@inquirer/input": "4.1.9",
     "@inquirer/password": "4.0.12",
     "@inquirer/select": "4.2.0",
-    "@settlemint/sdk-js": "2.2.0-prc00b96af",
-    "@settlemint/sdk-utils": "2.2.0-prc00b96af",
+    "@settlemint/sdk-js": "2.2.0-prdfa9d68b",
+    "@settlemint/sdk-utils": "2.2.0-prdfa9d68b",
     "@types/node": "22.15.3",
     "@types/semver": "7.7.0",
     "@types/which": "3.0.4",
@@ -246587,20 +246587,21 @@ var CommandError = class extends Error {
   }
 };
 async function executeCommand(command, args, options) {
-  const child = spawn(command, args, { env: { ...process.env, ...options?.env } });
+  const { silent, ...spawnOptions } = options ?? {};
+  const child = spawn(command, args, { ...spawnOptions, env: { ...process.env, ...options?.env } });
   process.stdin.pipe(child.stdin);
   const output = [];
   return new Promise((resolve, reject) => {
     child.stdout.on("data", (data) => {
       const maskedData = maskTokens2(data.toString());
-      if (!options?.silent) {
+      if (!silent) {
         process.stdout.write(maskedData);
       }
       output.push(maskedData);
     });
     child.stderr.on("data", (data) => {
       const maskedData = maskTokens2(data.toString());
-      if (!options?.silent) {
+      if (!silent) {
         process.stderr.write(maskedData);
       }
       output.push(maskedData);
@@ -251522,6 +251523,7 @@ var Xe2 = o7(({ config: e10, path: t8 }, s7 = ze2()) => {
 async function codegenTsconfig(env2, thegraphSubgraphNames) {
   const tsconfig = he4();
   if (!tsconfig?.config) {
+    note("No tsconfig found, skipping codegen for hasura, portal, thegraph and blockscout", "warn");
     return {
       hasura: false,
       portal: false,
@@ -253202,7 +253204,20 @@ async function blockchainNodeOrLoadBalancerPrompt({
 
 // src/commands/connect.ts
 function connectCommand() {
-  return new Command("connect").option("--prod", "Connect to your production environment").option("-a, --accept-defaults", "Accept the default and previously set values").option("-i, --instance <instance>", "The instance to connect to (defaults to the instance in the .env file)").description("Connects your project to your application on SettleMint").action(async ({ acceptDefaults, prod, instance }) => {
+  return new Command("connect").option("--prod", "Connect to your production environment").option("-a, --accept-defaults", "Accept the default and previously set values").option("-i, --instance <instance>", "The instance to connect to (defaults to the instance in the .env file)").description("Connects your project to your application on SettleMint").usage(createExamples([
+    {
+      description: "Connect to your environment",
+      command: "settlemint connect"
+    },
+    {
+      description: "Connect to your environment using defaults from the .env file",
+      command: "settlemint connect --accept-defaults"
+    },
+    {
+      description: "Connect to your production environment",
+      command: "settlemint connect --prod"
+    }
+  ])).action(async ({ acceptDefaults, prod, instance }) => {
     intro("Connecting your dApp to SettleMint");
     const env2 = await loadEnv(false, !!prod);
     const selectedInstance = instance ? sanitizeAndValidateInstanceUrl(instance) : await instancePrompt(env2, true);
@@ -256651,7 +256666,20 @@ async function downloadAndExtractNpmPackage({
 
 // src/commands/create.ts
 function createCommand2() {
-  return new Command("create").description("Bootstrap your SettleMint project").option("-n, --project-name <name>", "The name for your SettleMint project").option("-t, --template <template>", "The template for your SettleMint project (run `settlemint platform config` to see available templates)").option("-v, --version <version>", "Specify the template version to use (defaults to latest stable version)").option("-i, --instance <instance>", "The instance to connect to").action(async ({ projectName, template, version, instance }) => {
+  return new Command("create").description("Create a new application from a template").option("-n, --project-name <name>", "The name for your SettleMint project").option("-t, --template <template>", "The template for your SettleMint project (run `settlemint platform config` to see available templates)").option("-v, --version <version>", "Specify the template version to use (defaults to latest stable version)").option("-i, --instance <instance>", "The instance to connect to").usage(createExamples([
+    {
+      description: "Create a new application from a template",
+      command: "settlemint create"
+    },
+    {
+      description: "Create a new asset tokenization application",
+      command: "settlemint create --template asset-tokenization"
+    },
+    {
+      description: "Create a new asset tokenization application from a specific version",
+      command: "settlemint create --template asset-tokenization --version 1.0.0"
+    }
+  ])).action(async ({ projectName, template, version, instance }) => {
     intro("Creating a new SettleMint project");
     const env2 = await loadEnv(false, false);
     if (version && !template) {
@@ -256965,7 +256993,16 @@ function loginCommand() {
 
 // src/commands/logout.ts
 function logoutCommand() {
-  return new Command("logout").description("Logout from your SettleMint account").option("--all", "Logout from all instances").action(async (options) => {
+  return new Command("logout").description("Logout from your SettleMint account").option("--all", "Logout from all instances").usage(createExamples([
+    {
+      description: "Logout from your SettleMint account",
+      command: "settlemint logout"
+    },
+    {
+      description: "Logout from all instances",
+      command: "settlemint logout --all"
+    }
+  ])).action(async (options) => {
     intro("Logging out from SettleMint");
     const instances = await getInstances();
     if (instances.length === 0) {
@@ -257021,7 +257058,16 @@ async function pincodeVerificationPrompt(verificationChallenges) {
 
 // src/commands/pincode-verification-response.ts
 function pincodeVerificationResponseCommand() {
-  return new Command("pincode-verification-response").alias("pvr").description("Get pincode verification response for a blockchain node").requiredOption("--wallet-address <walletAddress>", "The wallet address to get pincode verification response for").option("-i, --instance <instance>", "The instance to connect to (defaults to the instance in the .env file)").option("--blockchain-node <blockchainNode>", "Blockchain Node unique name to get pincode verification response for").action(async ({ instance, blockchainNode, walletAddress }) => {
+  return new Command("pincode-verification-response").alias("pvr").description("Get pincode verification response for a blockchain node").requiredOption("--wallet-address <walletAddress>", "The wallet address to get pincode verification response for").option("-i, --instance <instance>", "The instance to connect to (defaults to the instance in the .env file)").option("--blockchain-node <blockchainNode>", "Blockchain Node unique name to get pincode verification response for").usage(createExamples([
+    {
+      description: "Get pincode verification response for a wallet address",
+      command: "settlemint pincode-verification-response --wallet-address 0x1234567890123456789012345678901234567890"
+    },
+    {
+      description: "Get pincode verification response for a wallet address and connect to a specific blockchain node",
+      command: "settlemint pincode-verification-response --wallet-address 0x1234567890123456789012345678901234567890 --blockchain-node my-blockchain-node"
+    }
+  ])).action(async ({ instance, blockchainNode, walletAddress }) => {
     intro("Generating pincode verification response for wallet address");
     const env2 = await loadEnv(false, false);
     const applicationUniqueName = env2.SETTLEMINT_APPLICATION;
@@ -257890,6 +257936,14 @@ function blockscoutInsightsCreateCommand() {
       {
         description: "Create a Blockscout insights service in a different application",
         command: "platform create insights blockscout my-blockscout --application app-123"
+      },
+      {
+        description: "Create a Blockscout insights service and connect to a specific load balancer",
+        command: "platform create insights blockscout my-blockscout --load-balancer my-load-balancer"
+      },
+      {
+        description: "Create a Blockscout insights service and connect to a specific blockchain node",
+        command: "platform create insights blockscout my-blockscout --blockchain-node my-blockchain-node"
       }
     ]
   });
@@ -258146,6 +258200,14 @@ function graphMiddlewareCreateCommand() {
       {
         description: "Create a graph middleware in a different application",
         command: "platform create middleware graph my-graph --application my-app --blockchain-node node-123"
+      },
+      {
+        description: "Create a graph middleware and connect to a specific load balancer",
+        command: "platform create middleware graph my-graph --load-balancer my-load-balancer"
+      },
+      {
+        description: "Create a graph middleware and connect to a specific blockchain node",
+        command: "platform create middleware graph my-graph --blockchain-node my-blockchain-node"
       }
     ]
   });
@@ -258253,6 +258315,14 @@ function smartContractPortalMiddlewareCreateCommand() {
       {
         description: "Create a smart contract portal middleware in a different application",
         command: "platform create middleware smart-contract-portal my-portal --application my-app --blockchain-node node-123"
+      },
+      {
+        description: "Create a smart contract portal middleware and connect to a specific blockchain node",
+        command: "platform create middleware smart-contract-portal my-portal --blockchain-node my-blockchain-node"
+      },
+      {
+        description: "Create a smart contract portal middleware and connect to a specific load balancer",
+        command: "platform create middleware smart-contract-portal my-portal --load-balancer my-load-balancer"
       }
     ]
   });
@@ -258567,7 +258637,7 @@ function storageCreateCommand() {
 
 // src/commands/platform/create.ts
 function createCommand3() {
-  return new Command("create").alias("c").description("Create a resource in the SettleMint platform").addCommand(workspaceCreateCommand()).addCommand(applicationCreateCommand()).addCommand(blockchainNetworkCreateCommand()).addCommand(blockchainNodeCreateCommand()).addCommand(privateKeyCreateCommand()).addCommand(middlewareCreateCommand()).addCommand(storageCreateCommand()).addCommand(integrationToolCreateCommand()).addCommand(insightsCreateCommand()).addCommand(applicationAccessTokenCreateCommand()).addCommand(loadBalancerCreateCommand());
+  return new Command("create").alias("c").description("Create a resource in the SettleMint platform").addCommand(applicationAccessTokenCreateCommand()).addCommand(applicationCreateCommand()).addCommand(blockchainNetworkCreateCommand()).addCommand(blockchainNodeCreateCommand()).addCommand(insightsCreateCommand()).addCommand(integrationToolCreateCommand()).addCommand(loadBalancerCreateCommand()).addCommand(middlewareCreateCommand()).addCommand(privateKeyCreateCommand()).addCommand(storageCreateCommand()).addCommand(workspaceCreateCommand());
 }
 
 // src/prompts/delete-confirmation.prompt.ts
@@ -258687,7 +258757,7 @@ function applicationDeleteCommand() {
 
 // src/commands/platform/delete.ts
 function deleteCommand() {
-  return new Command("delete").alias("d").description("Delete a resource in the SettleMint platform").addCommand(workspaceDeleteCommand()).addCommand(applicationDeleteCommand());
+  return new Command("delete").alias("d").description("Delete a resource in the SettleMint platform").addCommand(applicationDeleteCommand()).addCommand(workspaceDeleteCommand());
 }
 
 // src/commands/platform/common/restart-command.ts
@@ -258763,6 +258833,19 @@ function blockchainNetworkRestartCommand() {
   });
 }
 
+// src/commands/platform/blockchain-node/restart.ts
+function blockchainNodeRestartCommand() {
+  return getRestartCommand({
+    name: "blockchain-node",
+    type: "blockchain node",
+    alias: "bn",
+    envKey: "SETTLEMINT_BLOCKCHAIN_NODE",
+    restartFunction: async (settlemint, id) => {
+      return settlemint.blockchainNode.restart(id);
+    }
+  });
+}
+
 // src/commands/platform/custom-deployments/restart.ts
 function customDeploymentRestartCommand() {
   return getRestartCommand({
@@ -258894,13 +258977,22 @@ function storageRestartCommand() {
 
 // src/commands/platform/restart.ts
 function restartCommand() {
-  const cmd2 = new Command("restart").description("Restart a resource in the SettleMint platform").addCommand(blockchainNetworkRestartCommand()).addCommand(customDeploymentRestartCommand()).addCommand(insightsRestartCommand()).addCommand(integrationToolRestartCommand()).addCommand(middlewareRestartCommand()).addCommand(storageRestartCommand()).addCommand(loadBalancerRestartCommand());
+  const cmd2 = new Command("restart").description("Restart a resource in the SettleMint platform").addCommand(blockchainNetworkRestartCommand()).addCommand(blockchainNodeRestartCommand()).addCommand(customDeploymentRestartCommand()).addCommand(insightsRestartCommand()).addCommand(integrationToolRestartCommand()).addCommand(loadBalancerRestartCommand()).addCommand(middlewareRestartCommand()).addCommand(storageRestartCommand());
   return cmd2;
 }
 
 // src/commands/platform/custom-deployments/update.ts
 function customDeploymentsUpdateCommand() {
-  return new Command("custom-deployment").alias("cd").argument("<tag>", "The tag to update the custom deployment to").option("--unique-name <uniqueName>", "The unique name of the custom deployment to update. If not provided, will use SETTLEMINT_CUSTOM_DEPLOYMENT from env").option("--prod", "Connect to your production environment").option("--wait", "Wait for the custom deployment to be redeployed").description("Update a custom deployment in the SettleMint platform").action(async (tag, { uniqueName, prod, wait }) => {
+  return new Command("custom-deployment").alias("cd").argument("<tag>", "The tag to update the custom deployment to").option("--unique-name <uniqueName>", "The unique name of the custom deployment to update. If not provided, will use SETTLEMINT_CUSTOM_DEPLOYMENT from env").option("--prod", "Connect to your production environment").option("--wait", "Wait for the custom deployment to be redeployed").description("Update a custom deployment in the SettleMint platform").usage(createExamples([
+    {
+      description: "Update a custom deployment",
+      command: "settlemint custom-deployment update v1.0.0"
+    },
+    {
+      description: "Update a custom deployment with a specific unique name",
+      command: "settlemint custom-deployment update v1.0.0 --unique-name my-custom-deployment"
+    }
+  ])).action(async (tag, { uniqueName, prod, wait }) => {
     intro("Updating custom deployment in the SettleMint platform");
     const env2 = await loadEnv(false, !!prod);
     const customDeploymentUniqueName = uniqueName ?? env2.SETTLEMINT_CUSTOM_DEPLOYMENT;
@@ -258999,7 +259091,20 @@ function yamlOutput(data) {
 
 // src/commands/platform/config.ts
 function configCommand() {
-  return new Command("config").alias("cfg").description("Get platform configuration").option("--prod", "Connect to your production environment").option("-i, --instance <instance>", "The instance to connect to (defaults to the instance in the .env file)").addOption(new Option("-o, --output <output>", "The output format").choices(["json", "yaml"])).action(async ({ prod, instance, output }) => {
+  return new Command("config").alias("cfg").description("Get platform configuration").option("--prod", "Connect to your production environment").option("-i, --instance <instance>", "The instance to connect to (defaults to the instance in the .env file)").addOption(new Option("-o, --output <output>", "The output format").choices(["json", "yaml"])).usage(createExamples([
+    {
+      description: "Get platform configuration",
+      command: "settlemint config"
+    },
+    {
+      description: "Get platform configuration in JSON format",
+      command: "settlemint config -o json"
+    },
+    {
+      description: "Get platform configuration in YAML format",
+      command: "settlemint config -o yaml"
+    }
+  ])).action(async ({ prod, instance, output }) => {
     intro("Getting platform configuration");
     const env2 = await loadEnv(false, !!prod);
     const selectedInstance = instance ? sanitizeAndValidateInstanceUrl(instance) : await instancePrompt(env2, true);
@@ -259424,12 +259529,12 @@ function workspacesListCommand() {
 
 // src/commands/platform/list.ts
 function listCommand() {
-  return new Command("list").alias("ls").description("List resources in the SettleMint platform").addCommand(servicesCommand()).addCommand(workspacesListCommand()).addCommand(applicationsListCommand());
+  return new Command("list").alias("ls").description("List resources in the SettleMint platform").addCommand(applicationsListCommand()).addCommand(servicesCommand()).addCommand(workspacesListCommand());
 }
 
 // src/commands/platform.ts
 function platformCommand() {
-  return new Command("platform").description("Manage SettleMint platform resources").addCommand(configCommand()).addCommand(createCommand3()).addCommand(updateCommand()).addCommand(deleteCommand()).addCommand(restartCommand()).addCommand(listCommand());
+  return new Command("platform").description("Manage SettleMint platform resources").addCommand(configCommand()).addCommand(createCommand3()).addCommand(deleteCommand()).addCommand(listCommand()).addCommand(restartCommand()).addCommand(updateCommand());
 }
 
 // src/commands/smart-contract-set/create.ts
@@ -259487,7 +259592,12 @@ async function executeFoundryCommand(command, args) {
 
 // src/commands/smart-contract-set/create.ts
 function createCommand4() {
-  return new Command("create").description("Bootstrap your smart contract set").option("-n, --project-name <name>", "The name for your smart contract set project").option("--use-case <useCase>", "Use case for the smart contract set (run `settlemint platform config` to see available use cases)").option("-i, --instance <instance>", "The instance to connect to").action(async ({ projectName, useCase, instance }) => {
+  return new Command("create").description("Bootstrap your smart contract set").option("-n, --project-name <name>", "The name for your smart contract set project").option("--use-case <useCase>", "Use case for the smart contract set (run `settlemint platform config` to see available use cases)").option("-i, --instance <instance>", "The instance to connect to").usage(createExamples([
+    {
+      description: "Create a new solidity-token-erc20 smart contract set",
+      command: "settlemint smart-contract-set create --project-name erc20-contracts --use-case solidity-token-erc20"
+    }
+  ])).action(async ({ projectName, useCase, instance }) => {
     intro("Creating a new smart contract set");
     const env2 = await loadEnv(false, false);
     const name3 = await projectNamePrompt(env2, projectName);
@@ -259982,7 +260092,12 @@ function hardhatNetworkCommand() {
 
 // src/commands/smart-contract-set/hardhat/script/local.ts
 function hardhatScriptLocalCommand() {
-  return new Command("local").description("Run a Hardhat script to deploy a contract on the platform or interact with a deployed contract.").requiredOption("-s, --script <script>", 'The script to run with Hardhat , e.g. "scripts/deploy.ts"').option("--no-compile", "Don't compile before running this task").action(async ({ script, compile }) => {
+  return new Command("local").description("Run a Hardhat script on a local development network.").requiredOption("-s, --script <script>", 'The script to run with Hardhat , e.g. "scripts/deploy.ts"').option("--no-compile", "Don't compile before running this task").usage(createExamples([
+    {
+      description: "Run a Hardhat script on a local network",
+      command: "settlemint hardhat script local --script scripts/deploy.ts"
+    }
+  ])).action(async ({ script, compile }) => {
     intro("Running Hardhat script on local network");
     await validateIfRequiredPackagesAreInstalled(["hardhat"]);
     const { command, args } = await getPackageManagerExecutable();
@@ -260001,7 +260116,20 @@ function hardhatScriptLocalCommand() {
 
 // src/commands/smart-contract-set/hardhat/script/remote.ts
 function hardhatScriptRemoteCommand() {
-  const cmd2 = new Command("remote").description("Run a Hardhat script to deploy a contract on the platform or interact with a deployed contract.").requiredOption("-s, --script <script>", 'The script to run with Hardhat , e.g. "scripts/deploy.ts"').option("--blockchain-node <blockchainNode>", "Blockchain Node unique name (optional, defaults to the blockchain node in the environment)").option("--prod", "Connect to your production environment").option("-a, --accept-defaults", "Accept the default and previously set values").option("--no-compile", "Don't compile before running this task");
+  const cmd2 = new Command("remote").description("Run a Hardhat script on a remote network on the platform.").requiredOption("-s, --script <script>", 'The script to run with Hardhat , e.g. "scripts/deploy.ts"').option("--blockchain-node <blockchainNode>", "Blockchain Node unique name (optional, defaults to the blockchain node in the environment)").option("--prod", "Connect to your production environment").option("-a, --accept-defaults", "Accept the default and previously set values").option("--no-compile", "Don't compile before running this task").usage(createExamples([
+    {
+      description: "Run a Hardhat script on a remote network",
+      command: "settlemint hardhat script remote --script scripts/deploy.ts"
+    },
+    {
+      description: "Run a Hardhat script on a remote network with a specific blockchain node",
+      command: "settlemint hardhat script remote --script scripts/deploy.ts --blockchain-node my-blockchain-node"
+    },
+    {
+      description: "Run a Hardhat script on a remote network without compiling",
+      command: "settlemint hardhat script remote --script scripts/deploy.ts --no-compile"
+    }
+  ]));
   cmd2.action(async ({ script, prod, blockchainNode: blockchainNodeUniqueName, acceptDefaults, compile }) => {
     intro("Running Hardhat script on remote network");
     await validateIfRequiredPackagesAreInstalled(["hardhat"]);
@@ -260216,7 +260344,12 @@ async function getNodeName({
 
 // src/commands/smart-contract-set/subgraph/build.ts
 function subgraphBuildCommand() {
-  return new Command("build").description("Build the subgraph").action(async () => {
+  return new Command("build").description("Build the subgraph").usage(createExamples([
+    {
+      description: "Build the subgraph",
+      command: "settlemint subgraph build"
+    }
+  ])).action(async () => {
     intro("Building subgraph");
     await validateIfRequiredPackagesAreInstalled(["@graphprotocol/graph-cli"]);
     await subgraphSetup({
@@ -260234,7 +260367,12 @@ function subgraphBuildCommand() {
 // src/commands/smart-contract-set/subgraph/codegen.ts
 import { dirname as dirname11 } from "node:path";
 function subgraphCodegenCommand() {
-  return new Command("codegen").description("Codegen the subgraph types").action(async () => {
+  return new Command("codegen").description("Codegen the subgraph types").usage(createExamples([
+    {
+      description: "Generate subgraph types",
+      command: "settlemint subgraph codegen"
+    }
+  ])).action(async () => {
     intro("Generating subgraph types");
     await validateIfRequiredPackagesAreInstalled(["@graphprotocol/graph-cli"]);
     await subgraphSetup({
@@ -260532,15 +260670,15 @@ ${error5.stack}`));
 function registerCommands() {
   const sdkcli = new Command;
   sdkcli.name("settlemint").usage("[command]").description(`CLI for SettleMint (v${package_default.version})`).version(package_default.version, "-v, --version", "Output the current version").helpOption("-h, --help", "Display help for command").allowUnknownOption().showSuggestionAfterError(true).showHelpAfterError().passThroughOptions();
-  sdkcli.addCommand(connectCommand());
   sdkcli.addCommand(codegenCommand());
-  sdkcli.addCommand(platformCommand());
-  sdkcli.addCommand(smartContractSetCommand());
+  sdkcli.addCommand(connectCommand());
   sdkcli.addCommand(createCommand2());
+  sdkcli.addCommand(hasuraCommand());
   sdkcli.addCommand(loginCommand());
   sdkcli.addCommand(logoutCommand());
   sdkcli.addCommand(pincodeVerificationResponseCommand());
-  sdkcli.addCommand(hasuraCommand());
+  sdkcli.addCommand(platformCommand());
+  sdkcli.addCommand(smartContractSetCommand());
   return sdkcli;
 }
 async function sdkCliCommand(argv = process.argv) {
@@ -260560,4 +260698,4 @@ async function sdkCliCommand(argv = process.argv) {
 // src/cli.ts
 sdkCliCommand();
 
-//# debugId=BA9DB8BA4E9687D764756E2164756E21
+//# debugId=FDA3C16C631724F264756E2164756E21