@secondlayer/cli 3.4.0 → 3.5.0

package/README.md

@@ -8,14 +8,33 @@ bun add -g @secondlayer/cli
 sl --version
 ```
 
-## Quickstart
+## Beta Quickstart
+
+Use this path for a first hosted demo. The CLI stores your login session,
+binds the current directory to a project, provisions a dedicated tenant, then
+deploys and queries a subgraph through short-lived tenant credentials.
+
+```bash
+bun add -g @secondlayer/cli
+
+sl login
+sl project create my-app
+sl project use my-app
+sl instance create --plan hobby
+
+sl subgraphs scaffold SP1234ABCD.my-contract -o subgraphs/my-contract.ts
+sl subgraphs deploy subgraphs/my-contract.ts --start-block <recent-block>
+sl subgraphs query my-contract <table> --sort _block_height --order desc
+```
+
+Then wire a receiver:
 
 ```bash
-sl login                         # magic-link auth, session cached at ~/.secondlayer/session.json
-sl project create my-app         # scaffold a project
-sl project use my-app            # bind cwd to the project (writes ./.secondlayer/project)
-sl instance create --plan launch # provision dedicated Postgres + API + processor
-sl subgraphs deploy ./x.ts       # deploy to your instance
+sl create subscription my-hook \
+  --runtime node \
+  --subgraph my-contract \
+  --table <table> \
+  --url https://<receiver-host>/webhook
 ```
 
 ## Command surface
@@ -49,7 +68,7 @@ One instance per project. The platform API spawns a dedicated `sl-pg-{slug}`,
 
 | Command | What it does |
 |---|---|
-| `sl instance create --plan <launch\|grow\|scale>` | Provision containers. Boxed reveal of `serviceKey` + `anonKey` (shown once). |
+| `sl instance create --plan <hobby\|launch\|grow\|scale>` | Provision containers. Boxed reveal of `serviceKey` + `anonKey` (shown once). |
 | `sl instance info` | Plan, status, resource usage |
 | `sl instance resize --plan <...>` | Recreate containers with new CPU/memory (~30s downtime) |
 | `sl instance suspend` / `resume` | Stop/start containers, volume preserved |

package/dist/cli.js

@@ -2529,7 +2529,8 @@ async function request(url, opts) {
   const res = await fetch(url, {
     method: opts.method ?? "GET",
     headers,
-    body: opts.body !== undefined ? JSON.stringify(opts.body) : undefined
+    body: opts.body !== undefined ? JSON.stringify(opts.body) : undefined,
+    signal: AbortSignal.timeout(REQUEST_TIMEOUT_MS)
   });
   if (!res.ok) {
     let body = {};
@@ -2559,7 +2560,7 @@ async function httpPlatform(path2, opts = {}) {
 async function httpPlatformAnon(path2, opts = {}) {
   return request(`${PLATFORM_API_URL}${path2}`, opts);
 }
-var CliHttpError, PLATFORM_API_URL;
+var CliHttpError, PLATFORM_API_URL, REQUEST_TIMEOUT_MS = 30000;
 var init_http = __esm(() => {
   init_session();
   CliHttpError = class CliHttpError extends Error {
@@ -12996,7 +12997,7 @@ class StacksApiClient {
   constructor(network = "mainnet", apiKey, apiUrl, slApiUrl) {
     this.useProxy = !apiUrl && network !== "devnet";
     if (this.useProxy) {
-      this.baseUrl = slApiUrl || "";
+      this.baseUrl = slApiUrl?.replace(/\/$/, "") || "";
       this.headers = {};
     } else {
       this.baseUrl = apiUrl || process.env.STACKS_NODE_RPC_URL || "http://localhost:3999";
@@ -13007,24 +13008,31 @@ class StacksApiClient {
     if (!this.useProxy || this.baseUrl)
       return;
     const { apiUrl, ephemeralKey } = await resolveActiveTenant();
-    this.baseUrl = apiUrl;
+    this.baseUrl = apiUrl.replace(/\/$/, "");
     this.headers = { authorization: `Bearer ${ephemeralKey}` };
   }
+  describeContractInfoSource() {
+    if (this.useProxy)
+      return "Secondlayer node";
+    return `Stacks node RPC at ${this.baseUrl}`;
+  }
   async fetchWithErrorHandling(url, resourceType, resourceId) {
     try {
-      const response2 = await gotWithRetry(url, {
+      const response2 = await contractFetch(url, {
         headers: this.headers,
         responseType: "json"
       });
       return response2.body;
     } catch (error2) {
-      if (error2.response?.statusCode === 401) {
+      const statusCode = typeof error2 === "object" && error2 !== null && "response" in error2 && typeof error2.response === "object" && error2.response !== null && "statusCode" in error2.response ? error2.response.statusCode : undefined;
+      const message = error2 instanceof Error ? error2.message : String(error2);
+      if (statusCode === 401) {
         throw new Error("Authentication required. Run: secondlayer auth login");
       }
-      if (error2.response?.statusCode === 404) {
+      if (statusCode === 404) {
         throw new Error(`${resourceType} not found: ${resourceId}`);
       }
-      throw new Error(`Failed to fetch ${resourceType.toLowerCase()}: ${error2.message}`);
+      throw new Error(`Failed to fetch ${resourceType.toLowerCase()}: ${message}`);
     }
   }
   async getContractInfo(contractId) {
@@ -13045,17 +13053,16 @@ class StacksApiClient {
     return data.source;
   }
 }
-var gotWithRetry;
+var contractFetch;
 var init_api = __esm(() => {
   init_source3();
   init_resolve_tenant();
-  gotWithRetry = source_default2.extend({
-    timeout: { request: 30000 },
+  contractFetch = source_default2.extend({
+    timeout: { request: 15000 },
     retry: {
-      limit: 3,
+      limit: 0,
       methods: ["GET", "POST"],
-      statusCodes: [408, 429, 500, 502, 503, 504],
-      calculateDelay: ({ attemptCount }) => attemptCount * 1000
+      statusCodes: [408, 429, 500, 502, 503, 504]
     }
   });
 });
@@ -32224,7 +32231,7 @@ Examples:`));
 No .clar files or contract addresses matched the provided inputs`));
         process.exit(1);
       }
-      const apiKey = options3.apiKey || process.env.HIRO_API_KEY;
+      const apiKey = options3.apiKey || process.env.STACKS_NODE_API_KEY || process.env.HIRO_API_KEY;
       config = await buildConfigFromInputs(parsedInputs, options3.out, apiKey);
     } else {
       config = await loadConfig2(options3.config);
@@ -32430,7 +32437,7 @@ var {
 // package.json
 var package_default = {
   name: "@secondlayer/cli",
-  version: "3.4.0",
+  version: "3.5.0",
   description: "CLI for subgraphs and blockchain indexing on Stacks",
   type: "module",
   bin: {
@@ -32472,11 +32479,11 @@ var package_default = {
   license: "MIT",
   dependencies: {
     "@inquirer/prompts": "^8.2.0",
-    "@secondlayer/bundler": "^0.3.1",
+    "@secondlayer/bundler": "^0.3.2",
     "@secondlayer/sdk": "^3.2.0",
     "@secondlayer/shared": "^4.2.0",
     "@secondlayer/stacks": "^2.0.0",
-    "@secondlayer/subgraphs": "^1.2.0",
+    "@secondlayer/subgraphs": "^1.2.1",
     "@biomejs/js-api": "^0.7.0",
     "@biomejs/wasm-nodejs": "^1.9.0",
     esbuild: "^0.19.0",
@@ -34576,6 +34583,48 @@ function parseStartBlockOption(value) {
   }
   return parsed;
 }
+function createSubgraphDeployPreview(def, options2 = {}) {
+  const tableColumns = Object.entries(def.schema).map(([table, schema]) => `${table}: ${Object.keys(schema.columns).join(", ") || "(no columns)"}`);
+  return {
+    name: def.name,
+    version: def.version ?? "(auto)",
+    description: def.description ?? "",
+    startBlock: String(def.startBlock ?? 1),
+    sources: Object.keys(def.sources).join(", ") || "(none)",
+    handlers: Object.keys(def.handlers).join(", ") || "(none)",
+    tables: Object.keys(def.schema).join(", ") || "(none)",
+    tableColumns,
+    ...options2.bundleBytes !== undefined ? { bundleSize: `${options2.bundleBytes} bytes` } : {}
+  };
+}
+function printSubgraphDeployPreview(preview, context) {
+  success("Subgraph deploy dry run passed");
+  const pairs = [
+    ["File", context.file],
+    ["Network", context.network],
+    ["Name", preview.name],
+    ["Version", preview.version],
+    ["Start Block", preview.startBlock],
+    ["Sources", preview.sources],
+    ["Handlers", preview.handlers],
+    ["Tables", preview.tables]
+  ];
+  if (preview.bundleSize)
+    pairs.push(["Bundle Size", preview.bundleSize]);
+  console.log(formatKeyValue(pairs));
+  if (preview.description) {
+    console.log(`
+${dim("Description")}  ${preview.description}`);
+  }
+  if (preview.tableColumns.length > 0) {
+    console.log(`
+${dim("Columns")}`);
+    for (const line of preview.tableColumns)
+      console.log(`  ${line}`);
+  }
+  const deployTarget = context.bundled ? "tenant API" : "local database";
+  info(`Dry run only. No ${deployTarget} changes were made.`);
+}
 function registerSubgraphsCommand(program2) {
   const subgraphs = program2.command("subgraphs").description("Manage materialized subgraphs");
   subgraphs.command("new <name>").description("Scaffold a new subgraph definition file").action(async (name) => {
@@ -34654,10 +34703,11 @@ Stopped watching.`);
     });
     await new Promise(() => {});
   });
-  subgraphs.command("deploy <file>").description("Deploy a subgraph definition file").option("--version <semver>", "Explicit version (default: auto-increment patch)").option("--start-block <n>", "Override the subgraph definition startBlock for this deploy").option("--force", "Skip confirmation prompt for reindex operations").action(async (file, options2) => {
+  subgraphs.command("deploy <file>").description("Deploy a subgraph definition file").option("--version <semver>", "Explicit version (default: auto-increment patch)").option("--start-block <n>", "Override the subgraph definition startBlock for this deploy").option("--dry-run", "Validate and preview deploy without writing changes").option("--preview", "Alias for --dry-run").option("--force", "Skip confirmation prompt for reindex operations").action(async (file, options2) => {
     try {
       const absPath = resolve3(file);
       const config = await loadConfig();
+      const dryRun = options2.dryRun || options2.preview;
       const startBlock = parseStartBlockOption(options2.startBlock);
       if (startBlock !== undefined) {
         warn(`--start-block ${startBlock} overrides the definition's startBlock for this deploy.`);
@@ -34667,14 +34717,27 @@ Stopped watching.`);
       const def = mod.default ?? mod;
       const effectiveDef = startBlock === undefined ? def : { ...def, startBlock };
       const { validateSubgraphDefinition } = await import("@secondlayer/subgraphs/validate");
-      validateSubgraphDefinition(effectiveDef);
+      const validated = validateSubgraphDefinition(effectiveDef);
       if (config.network !== "local") {
-        info(`Bundling for remote deploy (${config.network})...`);
+        info(`${dryRun ? "Bundling for remote deploy dry run" : "Bundling for remote deploy"} (${config.network})...`);
         const { readFile: readFile4 } = await import("node:fs/promises");
         const source = await readFile4(absPath, "utf8");
         const { bundleSubgraphCode } = await import("@secondlayer/bundler");
         const bundled = await bundleSubgraphCode(source);
         const handlerCode = bundled.handlerCode;
+        if (dryRun) {
+          printSubgraphDeployPreview(createSubgraphDeployPreview({
+            ...validated,
+            version: options2.version ?? validated.version
+          }, {
+            bundleBytes: Buffer.byteLength(handlerCode, "utf8")
+          }), {
+            network: config.network,
+            file: absPath,
+            bundled: true
+          });
+          return;
+        }
         const result = await deploySubgraphApi({
           name: effectiveDef.name,
           version: options2.version,
@@ -34722,6 +34785,17 @@ Stopped watching.`);
           success(`Subgraph "${effectiveDef.name}" updated → v${result.version}`);
         }
       } else {
+        if (dryRun) {
+          printSubgraphDeployPreview(createSubgraphDeployPreview({
+            ...validated,
+            version: options2.version ?? validated.version
+          }), {
+            network: config.network,
+            file: absPath,
+            bundled: false
+          });
+          return;
+        }
         const { deploySchema } = await import("@secondlayer/subgraphs");
         const { getDb: getDb2, closeDb } = await import("@secondlayer/shared/db");
         const db = getDb2();
@@ -34956,7 +35030,7 @@ ${rows.length} row(s)`));
       handleApiError(err, "delete subgraph");
     }
   });
-  subgraphs.command("scaffold <contractAddress>").description("Scaffold a defineSubgraph() file from a contract ABI").option("-o, --output <path>", "Output file path (required)").option("--api-key <key>", "Hiro API key").action(async (contractAddress, options2) => {
+  subgraphs.command("scaffold <contractAddress>").description("Scaffold a defineSubgraph() file from a contract ABI").option("-o, --output <path>", "Output file path (required)").option("--api-key <key>", "Stacks node API key for direct RPC URLs").action(async (contractAddress, options2) => {
     try {
       if (!options2.output) {
         error("--output <path> is required");
@@ -34964,9 +35038,9 @@ ${rows.length} row(s)`));
       }
       const outPath = resolve3(options2.output);
       const network = inferNetwork(contractAddress) ?? "mainnet";
-      const apiKey = options2.apiKey ?? process.env.HIRO_API_KEY;
-      info(`Fetching ABI for ${contractAddress}...`);
+      const apiKey = options2.apiKey ?? process.env.STACKS_NODE_API_KEY ?? process.env.HIRO_API_KEY;
       const client = new StacksApiClient(network, apiKey);
+      info(`Fetching ABI for ${contractAddress} via ${client.describeContractInfoSource()}...`);
       const contractInfo = await client.getContractInfo(contractAddress);
       const abi = parseApiResponse(contractInfo);
       info("Generating scaffold...");
@@ -36324,7 +36398,7 @@ Quickstart:
   $ sl instance create --plan launch  # Provision a dedicated instance
   $ sl subgraphs deploy ./x.ts      # Deploy a subgraph — targets your instance
 `);
-program.command("generate [files...]").aliases(["gen", "codegen"]).description("Generate TypeScript interfaces from Clarity contracts").option("-c, --config <path>", "Path to config file").option("-o, --out <path>", "Output file path (required when using direct files)").option("-k, --api-key <key>", "Hiro API key (or set HIRO_API_KEY env var)").option("-w, --watch", "Watch for changes").action(async (files, options3) => {
+program.command("generate [files...]").aliases(["gen", "codegen"]).description("Generate TypeScript interfaces from Clarity contracts").option("-c, --config <path>", "Path to config file").option("-o, --out <path>", "Output file path (required when using direct files)").option("-k, --api-key <key>", "Stacks node API key for direct RPC URLs").option("-w, --watch", "Watch for changes").action(async (files, options3) => {
   const { generate: generate2 } = await Promise.resolve().then(() => (init_generate(), exports_generate));
   await generate2(files, options3);
 });
@@ -36349,5 +36423,5 @@ registerLocalCommand(program);
 registerAccountCommand(program);
 program.parse();
 
-//# debugId=5D73330C3279063064756E2164756E21
+//# debugId=02FDB52BEFC9082464756E2164756E21
 //# sourceMappingURL=cli.js.map