create-planet 1.0.0

package/index.js

@@ -0,0 +1,235 @@
+#!/usr/bin/env node
+import * as p from "@clack/prompts";
+import { execSync, execFileSync } from "child_process";
+import { cpSync, readFileSync, writeFileSync, existsSync, mkdirSync, readdirSync } from "fs";
+import path from "path";
+import { fileURLToPath } from "url";
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+const TEMPLATE_DIR = path.join(__dirname, "template");
+
+const WARP_LINK_SUGGESTIONS = [
+  "https://prime.federatedplanets.com/",
+  "https://waystation.federatedplanets.com/",
+  "https://interchange.federatedplanets.com/",
+  "https://port-cassini.federatedplanets.com/",
+  "https://terminus.federatedplanets.com/",
+  "https://driftyard.federatedplanets.com/",
+  "https://towel-42.federatedplanets.com/",
+];
+
+const checkWrangler = () => {
+  try {
+    execSync("wrangler whoami", { stdio: "pipe" });
+    return true;
+  } catch {
+    return false;
+  }
+};
+
+const runWrangler = (args) => {
+  try {
+    const output = execFileSync("npx", ["wrangler", ...args], {
+      stdio: "pipe",
+      encoding: "utf-8",
+    });
+    return output;
+  } catch (e) {
+    return e.stdout || "";
+  }
+};
+
+const parseKvId = (output) => {
+  const match = output.match(/"id":\s*"([^"]+)"/);
+  return match?.[1] ?? null;
+};
+
+const parseD1Id = (output) => {
+  const match = output.match(/"uuid":\s*"([^"]+)"/);
+  return match?.[1] ?? null;
+};
+
+const patchConfigTs = (filePath, name, description, warpLinks) => {
+  let content = readFileSync(filePath, "utf-8");
+
+  content = content.replace(
+    /export const PLANET_NAME = ".*?";/,
+    `export const PLANET_NAME = ${JSON.stringify(name)};`,
+  );
+
+  content = content.replace(
+    /export const PLANET_DESCRIPTION =\s*"[\s\S]*?";/,
+    `export const PLANET_DESCRIPTION =\n  ${JSON.stringify(description)};`,
+  );
+
+  if (warpLinks.length > 0) {
+    const linksTs = warpLinks
+      .map((url, i) => {
+        const name = url
+          .replace(/https?:\/\//, "")
+          .replace(/\/$/, "")
+          .split(".")[0]
+          .replace(/-/g, " ")
+          .replace(/\b\w/g, (c) => c.toUpperCase());
+        return i === 0
+          ? `  {\n    name: ${JSON.stringify(name)},\n    url: ${JSON.stringify(url)},\n  }`
+          : `  { name: ${JSON.stringify(name)}, url: ${JSON.stringify(url)} }`;
+      })
+      .join(",\n");
+    content = content.replace(
+      /export const DEFAULT_WARP_LINKS = \[[\s\S]*?\];/,
+      `export const DEFAULT_WARP_LINKS = [\n${linksTs},\n];`,
+    );
+  }
+
+  writeFileSync(filePath, content);
+};
+
+const main = async () => {
+  p.intro("Welcome to Federated Planets — create a new planet");
+
+  const answers = await p.group(
+    {
+      dir: () =>
+        p.text({
+          message: "Output directory",
+          placeholder: "my-planet",
+          defaultValue: "my-planet",
+          validate: (v) => (v.trim() ? undefined : "Directory name is required"),
+        }),
+      planetName: () =>
+        p.text({
+          message: "Planet name",
+          placeholder: "My Space Outpost",
+          defaultValue: "My Space Outpost",
+          validate: (v) => (v.trim() ? undefined : "Planet name is required"),
+        }),
+      planetDescription: () =>
+        p.text({
+          message: "Planet description",
+          placeholder: "A remote outpost in the Federated Planets.",
+          defaultValue: "A remote outpost in the Federated Planets.",
+        }),
+      warpLinks: () =>
+        p.text({
+          message: `Warp links (comma-separated URLs, leave empty to use defaults)\nSuggestions: ${WARP_LINK_SUGGESTIONS.slice(0, 4).join(", ")} ...`,
+          placeholder: "(leave empty for defaults)",
+        }),
+      workerName: ({ results }) =>
+        p.text({
+          message: "Cloudflare worker name",
+          placeholder: results.dir,
+          defaultValue: results.dir,
+          validate: (v) => (v.trim() ? undefined : "Worker name is required"),
+        }),
+    },
+    {
+      onCancel: () => {
+        p.cancel("Setup cancelled.");
+        process.exit(0);
+      },
+    },
+  );
+
+  const outDir = path.resolve(answers.dir);
+
+  // Validate output directory
+  if (existsSync(outDir)) {
+    const files = readdirSync(outDir);
+    if (files.length > 0) {
+      p.cancel(`Directory "${answers.dir}" already exists and is not empty.`);
+      process.exit(1);
+    }
+  }
+
+  // Check wrangler auth
+  const s = p.spinner();
+  s.start("Checking Wrangler authentication...");
+  if (!checkWrangler()) {
+    s.stop("Wrangler not authenticated.");
+    p.note(
+      "Run `npx wrangler login` to authenticate, then try again.",
+      "Authentication required",
+    );
+    process.exit(1);
+  }
+  s.stop("Wrangler authenticated.");
+
+  // Copy template
+  s.start("Copying template files...");
+  mkdirSync(outDir, { recursive: true });
+  cpSync(TEMPLATE_DIR, outDir, { recursive: true });
+  s.stop("Template copied.");
+
+  // Patch config.ts
+  s.start("Configuring planet...");
+  const configPath = path.join(outDir, "src/lib/config.ts");
+  const warpLinks = answers.warpLinks
+    ? answers.warpLinks.split(",").map((u) => u.trim()).filter(Boolean)
+    : [];
+  patchConfigTs(configPath, answers.planetName, answers.planetDescription, warpLinks);
+  s.stop("Planet configured.");
+
+  // Update package.json name
+  const pkgPath = path.join(outDir, "package.json");
+  const pkg = JSON.parse(readFileSync(pkgPath, "utf-8"));
+  pkg.name = answers.workerName;
+  writeFileSync(pkgPath, JSON.stringify(pkg, null, 2) + "\n");
+
+  // Create Cloudflare resources
+  s.start("Creating KV namespace...");
+  const kvOutput = runWrangler(["kv", "namespace", "create", "KV", "--json"]);
+  const kvId = parseKvId(kvOutput);
+  if (!kvId) {
+    s.stop("Failed to create KV namespace.");
+    p.note(kvOutput, "Wrangler output");
+    process.exit(1);
+  }
+  s.stop(`KV namespace created: ${kvId}`);
+
+  s.start("Creating D1 database...");
+  const d1Output = runWrangler(["d1", "create", "planet_db", "--json"]);
+  const d1Id = parseD1Id(d1Output);
+  if (!d1Id) {
+    s.stop("Failed to create D1 database.");
+    p.note(d1Output, "Wrangler output");
+    process.exit(1);
+  }
+  s.stop(`D1 database created: ${d1Id}`);
+
+  // Write wrangler.jsonc
+  s.start("Writing wrangler.jsonc...");
+  const wranglerConfig = {
+    name: answers.workerName,
+    main: "dist/server/entry.mjs",
+    compatibility_date: "2026-03-31",
+    assets: { directory: "dist/client", binding: "STATIC_ASSETS" },
+    d1_databases: [
+      {
+        binding: "DB",
+        database_name: "planet_db",
+        database_id: d1Id,
+        migrations_dir: "migrations",
+      },
+    ],
+    kv_namespaces: [{ binding: "KV", id: kvId }],
+    durable_objects: {
+      bindings: [{ name: "TRAFFIC_CONTROL", class_name: "TrafficControl" }],
+    },
+    migrations: [{ tag: "v1", new_classes: ["TrafficControl"] }],
+  };
+  writeFileSync(
+    path.join(outDir, "wrangler.jsonc"),
+    JSON.stringify(wranglerConfig, null, 2) + "\n",
+  );
+  s.stop("wrangler.jsonc written.");
+
+  p.outro(
+    `Your planet is ready!\n\n  cd ${answers.dir}\n  npm install\n  npm run dev\n\nTo deploy, connect ${answers.dir} to Cloudflare Workers CI\nand set the deploy command to: npx wrangler deploy -c wrangler.jsonc`,
+  );
+};
+
+main().catch((e) => {
+  console.error(e);
+  process.exit(1);
+});

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "create-planet",
+  "version": "1.0.0",
+  "description": "Scaffold a new Federated Planets planet",
+  "type": "module",
+  "bin": {
+    "create-planet": "index.js"
+  },
+  "files": [
+    "index.js",
+    "template/"
+  ],
+  "scripts": {
+    "sync-template": "node scripts/sync-template.js",
+    "prepublishOnly": "node scripts/sync-template.js"
+  },
+  "dependencies": {
+    "@clack/prompts": "^0.9.0"
+  }
+}

package/template/.claude/settings.json

@@ -0,0 +1,5 @@
+{
+  "permissions": {
+    "allow": ["Bash(npm run format:*)", "Bash(npm run build:*)"]
+  }
+}

package/template/.prettierrc

@@ -0,0 +1,11 @@
+{
+  "plugins": ["prettier-plugin-astro"],
+  "overrides": [
+    {
+      "files": "*.astro",
+      "options": {
+        "parser": "astro"
+      }
+    }
+  ]
+}

package/template/AGENTS.md

@@ -0,0 +1,96 @@
+# Implementation Plan: Space Travel Protocol
+
+This document outlines the technical strategy for implementing the **Elected Traffic Controllers (ETC)** protocol within the Astro-based `planet` implementation.
+
+## Development Notes
+
+After any code changes:
+
+1. Run `npm run format` to format all files with Prettier.
+2. Run `npm run build` to verify the build succeeds.
+
+Run these commands one after another to make sure they match permissions.
+
+## 1. Architecture Overview
+
+- **Framework:** Astro (SSR mode)
+- **Runtime:** Cloudflare Workers (Note: This is a Worker project, NOT a Pages project)
+- **Database:** Cloudflare D1 (Local state, Mission Archive, Traffic Logs)
+- **State/Cache:** Cloudflare KV (Cryptographic keys, Distributed Ledger cache)
+- **Validation:** Zod
+- **Hashing:** MD5 (via `md5` package)
+- **Cryptography:** Web Crypto API (Ed25519 signatures)
+
+## 2. Phase 1: Foundation & Data Model
+
+### 2.1 Manifest Update
+
+- Add `space_port` field to `public/manifest.json`.
+- Endpoint: `https://<domain>/api/v1/port`
+
+### 2.2 Database Schema (D1)
+
+Create `schema.sql`:
+
+- `travel_plans`: `id`, `ship_id`, `origin_url`, `destination_url`, `start_timestamp`, `end_timestamp`, `status` (PREPARING, TRANSIT, ARRIVED), `signatures` (JSON array).
+- `mission_archive`: `id`, `ship_id`, `event` (ARRIVED, DEPARTED), `location_name`, `location_url`, `timestamp`.
+- `traffic_controllers`: Cache of known neighbor manifests and their `space_port` status.
+
+### 2.3 Cryptography Utility
+
+- Implement `crypto.ts` to manage the planet's identity.
+- Generate and store an Ed25519 KeyPair in KV if it doesn't exist.
+- Methods for `sign(data)` and `verify(data, signature, publicKey)`.
+
+## 3. Phase 2: Core Protocol Logic
+
+### 3.1 Travel Calculator
+
+- Implement 3D distance: `sqrt(dx² + dy² + dz²)`.
+- Travel time: `distance / 100` hours (Flight-Years).
+
+### 3.2 Proximity-Based Sortition
+
+- Function to fetch neighbors' `manifest.json`.
+- Filter for those with active `space_port`.
+- Deterministic sort: `sort(neighbors by hash(seed + neighbor_url))`.
+- Select top $N = 3f + 1$.
+
+### 3.3 API Endpoints (`src/pages/api/v1/port.ts`)
+
+- `POST /initiate`:
+  1. Validate request (Origin must be local).
+  2. Calculate travel plan.
+  3. Elect Traffic Controllers.
+  4. Broadcast `pre-prepare` to TCs.
+- `POST /prepare`: Receive and validate a plan from another node. Verify coordinates and timing.
+- `POST /commit`: Finalize consensus and sign the plan.
+
+## 4. Phase 3: UI Integration
+
+### 4.1 Dynamic Star Map
+
+- Update `index.astro` to fetch live traffic from D1.
+- Pass real coordinates from the database to the ThreeJS map.
+
+### 4.2 Flight Deck
+
+- Create a UI component to initiate travel to a neighbor.
+- Show "Consensus in Progress" spinner during the PBFT phases.
+- Transition status from "Preparing" to "Departing" based on timestamps.
+
+### 4.3 Mission Archive
+
+- Display the last 10 records from the `mission_archive` table.
+
+## 5. Phase 4: Validation & Simulation
+
+- Create a mock "Neighbor" node (or use a second local dev instance).
+- Simulate a full journey:
+  1. Click "Jump" on Planet A.
+  2. TCs (including Planet B if it's a neighbor) reach consensus.
+  3. Planet A shows "Preparing".
+  4. Wait for `Start_Timestamp`.
+  5. Planet A shows "Departing", Planet B shows "Incoming".
+  6. Wait for `End_Timestamp`.
+  7. Complete landing at Planet B.

package/template/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.