@secondlayer/cli 8.6.4 → 8.7.0

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.0",
   repository: {
     type: "git",
     url: "git+https://github.com/ryanwaits/secondlayer.git",
@@ -31861,9 +31861,9 @@ 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/sdk": "^6.20.0",
+    "@secondlayer/shared": "^6.29.0",
+    "@secondlayer/stacks": "^2.5.0",
     "@secondlayer/subgraphs": "^3.10.0",
     "@biomejs/js-api": "^0.7.0",
     "@biomejs/wasm-nodejs": "^1.9.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}",
@@ -34672,8 +34678,8 @@ function sbtcFlows(name) {
  * 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}",
@@ -34743,8 +34749,8 @@ function poxStacking(name) {
  * the dataset shows one possible shape.
  *
  * 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}",
@@ -34794,8 +34800,8 @@ function bnsNames(name) {
  * 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 +34913,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 +35279,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 +35287,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 +35344,22 @@ Stopped watching.`);
           handlerCode,
           sourceCode: source,
           ...deployStartBlock !== undefined ? { startBlock: deployStartBlock } : {},
-          ...options2.databaseUrl ? { databaseUrl: options2.databaseUrl } : {}
+          ...options2.databaseUrl ? { databaseUrl: options2.databaseUrl } : {},
+          ...visibility ? { visibility } : {}
         });
         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 +35824,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
@@ -37916,5 +37972,5 @@ registerAccountCommand(program);
 registerKeysCommand(program);
 program.parse();
 
-//# debugId=D852EB907B2A586864756E2164756E21
+//# debugId=5C2D0497F3EEA0AA64756E2164756E21
 //# sourceMappingURL=cli.js.map