@secondlayer/cli 8.6.4 → 8.7.1

package/README.md

@@ -30,8 +30,11 @@ export SL_API_KEY=sk-sl_xxxxxxxx
 source (and exits non-zero when not logged in). The global `--api-key` /
 `--api-url` flags (and `SL_API_KEY` / `SL_API_URL`) apply to every command.
 
-During open beta, reads are public (no key needed). Writes — deploying or
-managing subgraphs and subscriptions — require a session or an `sk-sl_` key.
+During open beta, reads are public (no key needed) — for subgraphs that means
+**public** subgraphs only (managed deploys default public; BYO deploys and all
+pre-existing subgraphs are private, readable with your key). Writes — deploying,
+publishing, or managing subgraphs and subscriptions — require a session or an
+`sk-sl_` key.
 
 ## Quickstart
 
@@ -86,7 +89,8 @@ scoped reads and cannot mint (403). Minted keys inherit your plan's tier.
 |---|---|
 | `sl subgraphs create <name>` | Scaffold a definition file |
 | `sl subgraphs scaffold <SP...::contract> [-o <path>] [--no-install]` | Generate a subgraph from a deployed contract |
-| `sl subgraphs deploy <file> [--start-block <n>]` | Deploy; `--start-block` overrides the definition |
+| `sl subgraphs deploy <file> [--start-block <n>] [--visibility public\|private]` | Deploy; `--start-block` overrides the definition. Managed deploys default `public`, BYO default `private` |
+| `sl subgraphs publish <name>` / `unpublish <name>` | Flip visibility; publish claims the global public name (409 `PUBLIC_NAME_TAKEN` if claimed) |
 | `sl subgraphs dev <file>` | Watch + hot-redeploy |
 | `sl subgraphs query <name> <table>` | Query a table with filters, sort, pagination |
 | `sl subgraphs list` / `status <name>` / `gaps <name>` | Inspect deployments |

package/dist/cli.js

@@ -31811,7 +31811,7 @@ var {
 // package.json
 var package_default = {
   name: "@secondlayer/cli",
-  version: "8.6.4",
+  version: "8.7.1",
   repository: {
     type: "git",
     url: "git+https://github.com/ryanwaits/secondlayer.git",
@@ -31861,10 +31861,10 @@ var package_default = {
     "@inquirer/prompts": "^8.2.0",
     "@secondlayer/bundler": "^0.3.7",
     "@secondlayer/scaffold": "^1.2.0",
-    "@secondlayer/sdk": "^6.19.0",
-    "@secondlayer/shared": "^6.28.1",
-    "@secondlayer/stacks": "^2.4.0",
-    "@secondlayer/subgraphs": "^3.10.0",
+    "@secondlayer/sdk": "^6.21.0",
+    "@secondlayer/shared": "^6.30.0",
+    "@secondlayer/stacks": "^2.5.0",
+    "@secondlayer/subgraphs": "^3.11.0",
     "@biomejs/js-api": "^0.7.0",
     "@biomejs/wasm-nodejs": "^1.9.0",
     esbuild: "^0.19.0",
@@ -32026,6 +32026,12 @@ async function deleteSubgraphApi(name, options) {
 async function deploySubgraphApi(data) {
   return (await getPlatformClient()).subgraphs.deploy(data);
 }
+async function publishSubgraphApi(name) {
+  return (await getPlatformClient()).subgraphs.publish(name);
+}
+async function unpublishSubgraphApi(name) {
+  return (await getPlatformClient()).subgraphs.unpublish(name);
+}
 async function querySubgraphTable(name, table, params = {}) {
   return (await getPlatformClient()).subgraphs.queryTable(name, table, params);
 }
@@ -34595,8 +34601,8 @@ function sip010Balances(name) {
  * source filter.
  *
  * Query examples once deployed:
- *   GET /api/subgraphs/${name}/balances?_search=SP1...
- *   GET /api/subgraphs/${name}/balances?holder=SP1...
+ *   GET /v1/subgraphs/${name}/balances?_search=SP1...
+ *   GET /v1/subgraphs/${name}/balances?holder=SP1...
  */
 export default defineSubgraph({
   name: "${name}",
@@ -34666,14 +34672,13 @@ function sbtcFlows(name) {
 
 /**
  * Track sBTC protocol flows: deposits, withdrawals, signer rotations,
- * governance updates. Mirrors the shape of the Foundation Datasets
- * \`/v1/datasets/sbtc/events\` surface but in your own subgraph.
+ * governance updates — your own indexed view of the sbtc-registry contract.
  *
  * Source contract: sbtc-registry (mainnet).
  *
  * Query examples once deployed:
- *   GET /api/subgraphs/${name}/flows?topic=completed-deposit
- *   GET /api/subgraphs/${name}/flows?topic=withdrawal-create
+ *   GET /v1/subgraphs/${name}/flows?topic=completed-deposit
+ *   GET /v1/subgraphs/${name}/flows?topic=withdrawal-create
  */
 export default defineSubgraph({
   name: "${name}",
@@ -34734,17 +34739,14 @@ function poxStacking(name) {
 
 /**
  * Track Stacking lifecycle calls on PoX-4 — solo stacking, delegation,
- * extension, increase, aggregation, signer-key authorizations. Mirrors
- * the shape of the Foundation Datasets \`/v1/datasets/pox-4/calls\`
- * surface as your own subgraph.
+ * extension, increase, aggregation, signer-key authorizations.
  *
  * Note: PoX-4 emits zero print events; this subgraph captures contract
- * calls. Decoding function args + raw_result is left to your handler —
- * the dataset shows one possible shape.
+ * calls. Decoding function args + raw_result is left to your handler.
  *
  * Query examples once deployed:
- *   GET /api/subgraphs/${name}/calls?function_name=stack-stx
- *   GET /api/subgraphs/${name}/calls?caller=SP1...
+ *   GET /v1/subgraphs/${name}/calls?function_name=stack-stx
+ *   GET /v1/subgraphs/${name}/calls?caller=SP1...
  */
 export default defineSubgraph({
   name: "${name}",
@@ -34788,14 +34790,13 @@ function bnsNames(name) {
 
 /**
  * Track BNS-V2 name lifecycle events — registrations, transfers,
- * renewals, burns, airdrops. Mirrors the Foundation Datasets
- * \`/v1/datasets/bns/name-events\` surface as your own subgraph.
+ * renewals, burns, airdrops.
  *
  * Source: BNS-V2 print events (topic-discriminated payloads).
  *
  * Query examples once deployed:
- *   GET /api/subgraphs/${name}/names?owner=SP1...
- *   GET /api/subgraphs/${name}/names?_search=alice
+ *   GET /v1/subgraphs/${name}/names?owner=SP1...
+ *   GET /v1/subgraphs/${name}/names?_search=alice
  */
 export default defineSubgraph({
   name: "${name}",
@@ -34907,6 +34908,13 @@ function parseStartBlockOption(value) {
   }
   return parsed;
 }
+function parseVisibilityOption(value) {
+  if (value === undefined)
+    return;
+  if (value === "public" || value === "private")
+    return value;
+  throw new Error('--visibility must be "public" or "private"');
+}
 function parseSubgraphSpecFormat(value) {
   const format = value ?? "openapi";
   if (format === "openapi" || format === "agent" || format === "markdown") {
@@ -35266,7 +35274,7 @@ Stopped watching.`);
     });
     await new Promise(() => {});
   });
-  subgraphs.command("deploy <file>").alias("update").description("Deploy a subgraph definition file (alias: update — deploy is create-or-update)").option("--start-block <n>", "Override the subgraph definition startBlock for this deploy").option("--dry-run", "Validate and preview deploy without writing changes").option("-y, --yes", "Skip the reindex confirmation prompt").option("--database-url <url>", "BYO data plane: write the subgraph's schema/rows to your own Postgres. With --dry-run, prints the DDL + grant script and verifies the connection.").option("--strict", "Run `tsc --noEmit` against the handler before deploy (slower; catches TS type errors)").action(async (file, options2) => {
+  subgraphs.command("deploy <file>").alias("update").description("Deploy a subgraph definition file (alias: update — deploy is create-or-update)").option("--start-block <n>", "Override the subgraph definition startBlock for this deploy").option("--dry-run", "Validate and preview deploy without writing changes").option("-y, --yes", "Skip the reindex confirmation prompt").option("--database-url <url>", "BYO data plane: write the subgraph's schema/rows to your own Postgres. With --dry-run, prints the DDL + grant script and verifies the connection.").option("--strict", "Run `tsc --noEmit` against the handler before deploy (slower; catches TS type errors)").option("--visibility <visibility>", "Read visibility: public (anon /v1 reads, global name claim) or private (your key only). Defaults: managed → public, BYO → private.").action(async (file, options2) => {
     try {
       const absPath = resolve2(file);
       const config = await loadConfig();
@@ -35274,6 +35282,16 @@ Stopped watching.`);
         await requireAuth();
       }
       const dryRun = options2.dryRun;
+      const visibility = parseVisibilityOption(options2.visibility);
+      if (visibility === "public" && options2.databaseUrl && !options2.yes) {
+        const confirmed = await confirm3({
+          message: "⚠  Public BYO subgraph: anonymous reads will query YOUR database. Continue?"
+        });
+        if (!confirmed) {
+          info("Aborted.");
+          process.exit(0);
+        }
+      }
       const startBlock = parseStartBlockOption(options2.startBlock);
       if (startBlock !== undefined) {
         warn(`--start-block ${startBlock} overrides the definition's startBlock for this deploy.`);
@@ -35321,16 +35339,25 @@ Stopped watching.`);
           handlerCode,
           sourceCode: source,
           ...deployStartBlock !== undefined ? { startBlock: deployStartBlock } : {},
-          ...options2.databaseUrl ? { databaseUrl: options2.databaseUrl } : {}
+          ...options2.databaseUrl ? { databaseUrl: options2.databaseUrl } : {},
+          ...visibility ? { visibility } : {}
         });
+        if (result.start_block_clamped) {
+          info(`  Free tier indexes forward from deploy (start block ${result.start_block}) — upgrade for genesis backfill.`);
+        }
         const printDeployFooter = async () => {
           try {
             const { apiUrl } = await resolveAuth();
             const baseUrl = deriveBaseUrl(apiUrl);
             const firstTable = Object.keys(effectiveDef.schema ?? {})[0];
+            const isPublic = result.visibility === "public";
             info(`  Dashboard: ${baseUrl}/platform/subgraphs/${effectiveDef.name}`);
-            if (firstTable) {
+            if (isPublic && firstTable) {
+              info(`  Read:      ${apiUrl}/v1/subgraphs/${effectiveDef.name}/${firstTable}`);
+              info(`  Share:     ${apiUrl}/v1/subgraphs/${effectiveDef.name} (public — no key needed)`);
+            } else if (firstTable) {
               info(`  REST:      ${apiUrl}/api/subgraphs/${effectiveDef.name}/${firstTable}`);
+              info(`  Publish:   sl subgraphs publish ${effectiveDef.name} (open anon /v1 reads)`);
             }
             info(`  Watch:     sl subgraphs status ${effectiveDef.name}`);
           } catch {}
@@ -35795,6 +35822,33 @@ ${rows.length} row(s)`));
       handleApiError(err, "delete subgraph");
     }
   });
+  subgraphs.command("publish <name>").description("Make a subgraph publicly readable on /v1/subgraphs/<name> (claims the name globally, no key needed to read)").action(async (name) => {
+    try {
+      await requireAuth();
+      const result = await publishSubgraphApi(name);
+      success(`Subgraph "${name}" is now public`);
+      try {
+        const { apiUrl } = await resolveAuth();
+        info(`  Share: ${apiUrl}${result.url} (no key needed)`);
+      } catch {}
+    } catch (err) {
+      const status2 = err?.status;
+      if (status2 === 409) {
+        error(`Public name "${name}" is already taken by another account. Rename the subgraph (redeploy under a new name) or keep it private.`);
+        process.exit(1);
+      }
+      handleApiError(err, "publish subgraph");
+    }
+  });
+  subgraphs.command("unpublish <name>").description("Make a subgraph private again — reads require your API key, the public name claim is released").action(async (name) => {
+    try {
+      await requireAuth();
+      await unpublishSubgraphApi(name);
+      success(`Subgraph "${name}" is now private (reads need your key)`);
+    } catch (err) {
+      handleApiError(err, "unpublish subgraph");
+    }
+  });
   subgraphs.command("scaffold [contractAddress]").description("Scaffold a defineSubgraph() file from a contract or trait").option("-o, --output <path>", "Output file path (required)").option("-k, --api-key <key>", "Stacks node API key for direct RPC URLs").option("--functions <names>", "Comma-separated public functions to index as typed contract_call tables").option("--trait <std>", "Scaffold a trait-scoped source (sip-009|sip-010|sip-013) — no contract needed").option("--no-install", "Skip bun install after writing package.json").addHelpText("after", `
 Examples:
   $ sl subgraphs scaffold SP3D6PV2ACBPEKYJTCMH7HEN02KP87QSP8KTEH335.megapont-ape-club-nft -o subgraphs/apes.ts
@@ -36098,72 +36152,16 @@ Examples:
     }
   });
 }
-// src/commands/datasets.ts
-init_output();
-import { CURSOR_SLUGS, Datasets } from "@secondlayer/sdk";
-var DEFAULT_BASE_URL3 = "https://api.secondlayer.tools";
-function client2() {
-  return new Datasets({ baseUrl: process.env.SL_API_URL ?? DEFAULT_BASE_URL3 });
-}
-function parseFilters(pairs) {
-  const out = {};
-  for (const pair of pairs ?? []) {
-    const eq = pair.indexOf("=");
-    if (eq <= 0) {
-      throw new Error(`invalid --filter "${pair}" (expected key=value)`);
-    }
-    out[pair.slice(0, eq)] = pair.slice(eq + 1);
-  }
-  return out;
-}
-function registerDatasetsCommand(program2) {
-  const datasets = program2.command("datasets").description("Query Foundation Datasets (sBTC, BNS, PoX-4, STX transfers)");
-  datasets.command("list").description("List the dataset catalog + freshness").action(async () => {
-    try {
-      const catalog = await client2().listDatasets();
-      writeData(JSON.stringify(catalog, null, 2));
-    } catch (err) {
-      error(`Failed to list datasets: ${err}`);
-      process.exit(1);
-    }
-  });
-  datasets.command("query <dataset>").description(`Query a cursor-paginated dataset (${Object.keys(CURSOR_SLUGS).join(", ")})`).option("--filter <key=value...>", "Filter as key=value (e.g. --filter stacker=SP… --filter address=SP…)").option("--limit <n>", "Rows per page").option("--cursor <cursor>", "Resume token from a previous next_cursor").option("--json", "Print the full envelope as JSON").addHelpText("after", `
-Examples:
-  $ sl datasets query stx-transfers --filter sender=SP2J6ZY... --limit 100
-  $ sl datasets query sbtc-events --filter amount.gte=1000
-  $ sl datasets query bns-events --cursor 150000:3 --json`).action(async (dataset, options2) => {
-    try {
-      const params = parseFilters(options2.filter);
-      if (options2.limit)
-        params.limit = Number.parseInt(options2.limit, 10);
-      if (options2.cursor)
-        params.cursor = options2.cursor;
-      const env = await client2().query(dataset, params);
-      output({
-        json: options2.json,
-        data: env,
-        human: () => {
-          writeData(JSON.stringify(env.rows, null, 2));
-          if (env.next_cursor)
-            note(`next_cursor: ${env.next_cursor}`);
-        }
-      });
-    } catch (err) {
-      error(`Failed to query dataset: ${err}`);
-      process.exit(1);
-    }
-  });
-}
 // src/commands/index-api.ts
 init_output();
 init_fs();
 init_resolve_auth();
 import { resolve as resolve3 } from "node:path";
 import { Index } from "@secondlayer/sdk";
-var DEFAULT_BASE_URL4 = "https://api.secondlayer.tools";
-function client3() {
+var DEFAULT_BASE_URL3 = "https://api.secondlayer.tools";
+function client2() {
   return new Index({
-    baseUrl: process.env.SL_API_URL ?? DEFAULT_BASE_URL4,
+    baseUrl: process.env.SL_API_URL ?? DEFAULT_BASE_URL3,
     apiKey: resolveEnvKey()
   });
 }
@@ -36239,7 +36237,7 @@ function registerIndexCommand(program2) {
   const heightFlags = (cmd) => cmd.option("--from-height <n>", "Start block height (inclusive)").option("--to-height <n>", "End block height (inclusive)").option("--cursor <cursor>", "Resume token from a previous next_cursor").option("--limit <n>", "Rows per page").option("--json", "Print the full envelope as JSON");
   rangeFlags(index.command("ft-transfers")).description("List decoded SIP-010 fungible-token transfers").option("--sender <principal>", "Filter by sender").option("--recipient <principal>", "Filter by recipient").action(async (o) => {
     try {
-      emit(await client3().ftTransfers.list({
+      emit(await client2().ftTransfers.list({
         ...rangeParams(o),
         sender: o.sender,
         recipient: o.recipient
@@ -36250,7 +36248,7 @@ function registerIndexCommand(program2) {
   });
   rangeFlags(index.command("nft-transfers")).description("List decoded SIP-009 non-fungible-token transfers").option("--sender <principal>", "Filter by sender").option("--recipient <principal>", "Filter by recipient").option("--asset-identifier <id>", "Filter by asset identifier").action(async (o) => {
     try {
-      emit(await client3().nftTransfers.list({
+      emit(await client2().nftTransfers.list({
         ...rangeParams(o),
         sender: o.sender,
         recipient: o.recipient,
@@ -36262,7 +36260,7 @@ function registerIndexCommand(program2) {
   });
   rangeFlags(index.command("events")).description("List decoded events by type (stx_*, ft/nft mint/burn, print, …)").requiredOption("--event-type <type>", "Decoded event type (required)").option("--sender <principal>", "Filter by sender").option("--recipient <principal>", "Filter by recipient").option("--asset-identifier <id>", "Filter by asset identifier").action(async (o) => {
     try {
-      emit(await client3().events.list({
+      emit(await client2().events.list({
         eventType: o.eventType,
         ...rangeParams(o),
         sender: o.sender,
@@ -36275,7 +36273,7 @@ function registerIndexCommand(program2) {
   });
   rangeFlags(index.command("contract-calls")).description("List decoded contract calls (function, args, result)").option("--function-name <name>", "Filter by called function").option("--sender <principal>", "Filter by caller").action(async (o) => {
     try {
-      emit(await client3().contractCalls.list({
+      emit(await client2().contractCalls.list({
         ...rangeParams(o),
         functionName: o.functionName,
         sender: o.sender
@@ -36286,21 +36284,21 @@ function registerIndexCommand(program2) {
   });
   heightFlags(index.command("canonical")).description("List the canonical Stacks block sequence (height + hash)").action(async (o) => {
     try {
-      emit(await client3().canonical.list(heightParams(o)), o.json);
+      emit(await client2().canonical.list(heightParams(o)), o.json);
     } catch (err) {
       fail("list canonical blocks", err);
     }
   });
   const blocks = heightFlags(index.command("blocks")).description("List decoded blocks (run `blocks get <ref>` for one block)").action(async (o) => {
     try {
-      emit(await client3().blocks.list(heightParams(o)), o.json);
+      emit(await client2().blocks.list(heightParams(o)), o.json);
     } catch (err) {
       fail("list blocks", err);
     }
   });
   blocks.command("get <ref>").description("Get a single block by height or block hash").option("--json", "Print as JSON").action(async (ref, o) => {
     try {
-      const block = await client3().blocks.get(/^\d+$/.test(ref) ? Number.parseInt(ref, 10) : ref);
+      const block = await client2().blocks.get(/^\d+$/.test(ref) ? Number.parseInt(ref, 10) : ref);
       emitOne(block, `block ${ref}`, o.json);
     } catch (err) {
       fail("get block", err);
@@ -36308,7 +36306,7 @@ function registerIndexCommand(program2) {
   });
   const transactions = rangeFlags(index.command("transactions")).description("List decoded transactions (run `transactions get <txId>` for one)").option("--type <type>", "Filter by transaction type").option("--sender <principal>", "Filter by sender").action(async (o) => {
     try {
-      emit(await client3().transactions.list({
+      emit(await client2().transactions.list({
         ...rangeParams(o),
         type: o.type,
         sender: o.sender
@@ -36319,14 +36317,14 @@ function registerIndexCommand(program2) {
   });
   transactions.command("get <txId>").description("Get a single transaction by tx_id").option("--json", "Print as JSON").action(async (txId, o) => {
     try {
-      emitOne(await client3().transactions.get(txId), `tx ${txId}`, o.json);
+      emitOne(await client2().transactions.get(txId), `tx ${txId}`, o.json);
     } catch (err) {
       fail("get transaction", err);
     }
   });
   heightFlags(index.command("stacking")).description("List decoded PoX-4 stacking actions").option("--function-name <name>", "Filter by PoX function name").option("--stacker <principal>", "Filter by stacker").option("--caller <principal>", "Filter by caller").action(async (o) => {
     try {
-      emit(await client3().stacking.list({
+      emit(await client2().stacking.list({
         ...heightParams(o),
         functionName: o.functionName,
         stacker: o.stacker,
@@ -36338,7 +36336,7 @@ function registerIndexCommand(program2) {
   });
   const mempool = index.command("mempool").description("List pending mempool transactions (run `mempool get <txId>` for one)").option("--contract-id <id>", "Filter to pending calls to a contract").option("--sender <principal>", "Filter by sender").option("--type <type>", "Filter by transaction type").option("--cursor <cursor>", "Resume token from a previous next_cursor").option("--limit <n>", "Rows per page").option("--json", "Print the full envelope as JSON").action(async (o) => {
     try {
-      emit(await client3().mempool.list({
+      emit(await client2().mempool.list({
         contractId: o.contractId,
         sender: o.sender,
         type: o.type,
@@ -36351,7 +36349,7 @@ function registerIndexCommand(program2) {
   });
   mempool.command("get <txId>").description("Get a single pending transaction by tx_id (404 once mined)").option("--json", "Print as JSON").action(async (txId, o) => {
     try {
-      emitOne(await client3().mempool.get(txId), `pending tx ${txId}`, o.json);
+      emitOne(await client2().mempool.get(txId), `pending tx ${txId}`, o.json);
     } catch (err) {
       fail("get mempool tx", err);
     }
@@ -36361,7 +36359,7 @@ function registerIndexCommand(program2) {
 init_output();
 init_resolve_auth();
 import { SecondLayer as SecondLayer4 } from "@secondlayer/sdk";
-var DEFAULT_BASE_URL5 = "https://api.secondlayer.tools";
+var DEFAULT_BASE_URL4 = "https://api.secondlayer.tools";
 function registerKeysCommand(program2) {
   const keys = program2.command("keys").description("Manage API keys");
   keys.command("create").description("Mint a scoped streams/index read key (requires an account-level key)").option("--product <product>", "Key scope: streams or index", "streams").option("--name <name>", "Optional label for the key").option("--json", "Print the full response as JSON").action(async (o) => {
@@ -36376,7 +36374,7 @@ function registerKeysCommand(program2) {
     }
     try {
       const sl = new SecondLayer4({
-        baseUrl: process.env.SL_API_URL ?? DEFAULT_BASE_URL5,
+        baseUrl: process.env.SL_API_URL ?? DEFAULT_BASE_URL4,
         apiKey
       });
       const minted = await sl.apiKeys.create({
@@ -37888,7 +37886,6 @@ program.commandsGroup("Data products:");
 registerSubgraphsCommand(program);
 registerSubscriptionsCommand(program);
 registerStreamsCommand(program);
-registerDatasetsCommand(program);
 registerIndexCommand(program);
 program.commandsGroup("Project & codegen:");
 registerProjectCommand(program);
@@ -37916,5 +37913,5 @@ registerAccountCommand(program);
 registerKeysCommand(program);
 program.parse();
 
-//# debugId=D852EB907B2A586864756E2164756E21
+//# debugId=C4DF51841ACD727C64756E2164756E21
 //# sourceMappingURL=cli.js.map