@tangle-network/starter-foundry 0.5.4 → 0.7.0

package/registry/layers/framework/aptos-move/files/AGENTS.md

@@ -0,0 +1,58 @@
+# AGENTS.md — {{projectName}} (Aptos Move)
+
+This is an **Aptos Move** package — not Sui Move. Imports use `aptos_framework::*`.
+
+## Prerequisites
+
+```bash
+brew install aptos          # macOS
+# or: curl -fsSL "https://aptos.dev/scripts/install_cli.py" | python3
+```
+
+## Commands
+
+```bash
+# Type-check and compile
+aptos move compile --named-addresses {{projectName}}=default
+
+# Run Move unit tests
+aptos move test --named-addresses {{projectName}}=default
+
+# Initialize a devnet account (once)
+aptos init --network devnet
+
+# Fund the account on devnet
+aptos account fund-with-faucet --account default
+
+# Publish the module
+aptos move publish --named-addresses {{projectName}}=default
+
+# Call the initialize entry function on-chain
+aptos move run \
+  --function-id default::{{moduleName}}::initialize \
+  --named-addresses {{projectName}}=default
+```
+
+## Structure
+
+| Path | Purpose |
+|------|---------|
+| `Move.toml` | Package manifest; pins AptosFramework to `mainnet` branch |
+| `sources/{{moduleName}}.move` | Main module: Counter resource, entry functions, `#[view]` |
+| `tests/{{moduleName}}Tests.move` | Unit tests using `#[test]` and `#[expected_failure]` |
+
+## Extending
+
+1. Add new resource structs to `sources/{{moduleName}}.move`
+2. Add `public entry fun` functions for transaction-callable operations
+3. Add `#[view]` functions for read-only queries
+4. Mirror tests in `tests/{{moduleName}}Tests.move`
+
+## Critical rules
+
+- Any function that reads or writes a resource must declare `acquires ResourceType`
+- Guard `move_to` with `assert!(!exists<T>(addr), ...)` to prevent double-init aborts
+- `signer` is non-copyable — always pass as `&signer`, never store or clone it
+- Named address `{{projectName}}` resolves to `default` in CLI flags; supply the real hex address for mainnet
+- Aptos events: annotate the struct with `#[event]` and emit via `event::emit(MyEvent { ... })`
+- `aptos move test` runs in an in-VM harness — always do a real publish test before production

package/registry/layers/framework/aptos-move/files/Move.toml

@@ -0,0 +1,10 @@
+[package]
+name = "{{projectName}}"
+version = "1.0.0"
+authors = []
+
+[addresses]
+{{projectName}} = "_"
+
+[dependencies]
+AptosFramework = { git = "https://github.com/aptos-labs/aptos-core.git", subdir = "aptos-move/framework/aptos-framework/", rev = "mainnet" }

package/registry/layers/framework/aptos-move/files/module.move

@@ -0,0 +1,46 @@
+module {{projectName}}::{{moduleName}} {
+    use std::signer;
+    use aptos_framework::event;
+
+    /// Resource stored under the owner's account. Holds a u64 counter.
+    struct Counter has key {
+        owner: address,
+        value: u64,
+    }
+
+    #[event]
+    struct IncrementedEvent has drop, store {
+        account: address,
+        new_value: u64,
+    }
+
+    /// Error: trying to initialize a Counter that already exists.
+    const E_ALREADY_INITIALIZED: u64 = 1;
+    /// Error: trying to read/increment a Counter that was never initialized.
+    const E_NOT_INITIALIZED: u64 = 2;
+
+    /// Called once per account to publish a Counter resource under `account`.
+    public entry fun initialize(account: &signer) {
+        let owner = signer::address_of(account);
+        assert!(!exists<Counter>(owner), E_ALREADY_INITIALIZED);
+        move_to(account, Counter { owner, value: 0 });
+    }
+
+    /// Increments the Counter stored under the caller's address. Emits an event.
+    public entry fun increment(account: &signer) acquires Counter {
+        let owner = signer::address_of(account);
+        assert!(exists<Counter>(owner), E_NOT_INITIALIZED);
+        let counter = borrow_global_mut<Counter>(owner);
+        counter.value = counter.value + 1;
+        event::emit(IncrementedEvent { account: owner, new_value: counter.value });
+    }
+
+    #[view]
+    public fun value_of(owner: address): u64 acquires Counter {
+        if (exists<Counter>(owner)) {
+            borrow_global<Counter>(owner).value
+        } else {
+            0
+        }
+    }
+}

package/registry/layers/framework/aptos-move/files/package.json

@@ -0,0 +1,9 @@
+{
+  "name": "{{projectName}}",
+  "version": "1.0.0",
+  "private": true,
+  "scripts": {
+    "build": "aptos move compile --named-addresses {{projectName}}=default",
+    "test": "aptos move test --named-addresses {{projectName}}=default"
+  }
+}

package/registry/layers/framework/aptos-move/files/scripts/deploy.sh

@@ -0,0 +1,21 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+# Deploy {{projectName}} to Aptos devnet.
+# Run `aptos init --network devnet` once before using this script.
+
+NAMED_ADDR="{{projectName}}=default"
+
+echo "==> Compiling..."
+aptos move compile --named-addresses "$NAMED_ADDR"
+
+echo "==> Running tests..."
+aptos move test --named-addresses "$NAMED_ADDR"
+
+echo "==> Funding account..."
+aptos account fund-with-faucet --account default
+
+echo "==> Publishing..."
+aptos move publish --named-addresses "$NAMED_ADDR"
+
+echo "Done. Module published as default::{{moduleName}}"

package/registry/layers/framework/aptos-move/files/test.move

@@ -0,0 +1,30 @@
+#[test_only]
+module {{projectName}}::{{moduleName}}Tests {
+    use {{projectName}}::{{moduleName}};
+
+    #[test(account = @{{projectName}})]
+    fun initializes_to_zero(account: signer) {
+        {{moduleName}}::initialize(&account);
+        assert!({{moduleName}}::value_of(@{{projectName}}) == 0, 100);
+    }
+
+    #[test(account = @{{projectName}})]
+    fun increments_counter(account: signer) {
+        {{moduleName}}::initialize(&account);
+        {{moduleName}}::increment(&account);
+        {{moduleName}}::increment(&account);
+        assert!({{moduleName}}::value_of(@{{projectName}}) == 2, 101);
+    }
+
+    #[test(account = @{{projectName}})]
+    #[expected_failure(abort_code = 1, location = {{projectName}}::{{moduleName}})]
+    fun rejects_double_init(account: signer) {
+        {{moduleName}}::initialize(&account);
+        {{moduleName}}::initialize(&account);
+    }
+
+    #[test]
+    fun value_of_uninitialized_is_zero() {
+        assert!({{moduleName}}::value_of(@0xDEAD) == 0, 102);
+    }
+}

package/registry/layers/framework/aptos-move/manifest.json

@@ -0,0 +1,88 @@
+{
+  "id": "aptos-move",
+  "description": "Aptos Move package framework layer — Move.toml with AptosFramework dep, resource-based module, #[test] suite.",
+  "appliesTo": ["aptos-move"],
+  "files": [
+    {
+      "source": "files/package.json",
+      "target": "package.json",
+      "templateVars": ["projectName"]
+    },
+    {
+      "source": "files/Move.toml",
+      "target": "Move.toml",
+      "templateVars": ["projectName"]
+    },
+    {
+      "source": "files/module.move",
+      "target": "sources/{{moduleName}}.move",
+      "templateVars": ["projectName", "moduleName"]
+    },
+    {
+      "source": "files/test.move",
+      "target": "tests/{{moduleName}}Tests.move",
+      "templateVars": ["projectName", "moduleName"]
+    },
+    {
+      "source": "files/scripts/deploy.sh",
+      "target": "scripts/deploy.sh",
+      "templateVars": ["projectName", "moduleName"]
+    },
+    {
+      "source": "files/AGENTS.md",
+      "target": "AGENTS.md",
+      "templateVars": ["projectName", "moduleName"]
+    }
+  ],
+  "contextHints": {
+    "commands": [
+      "aptos move compile --named-addresses {{projectName}}=default",
+      "aptos move test --named-addresses {{projectName}}=default",
+      "aptos move publish --named-addresses {{projectName}}=<your_address>"
+    ],
+    "entrypoints": [
+      "Move.toml",
+      "sources/{{moduleName}}.move"
+    ],
+    "preview": null,
+    "extensionPoints": [
+      "sources/{{moduleName}}.move",
+      "tests/{{moduleName}}Tests.move"
+    ]
+  },
+  "buildHints": {
+    "whenToUse": "Aptos blockchain smart contracts — resource-based modules, on-chain state management, token contracts, DeFi protocols, or any product that needs to deploy and call Move modules on Aptos mainnet/devnet.",
+    "architectureNotes": [
+      "Aptos Move: resources stored under signer account via move_to / borrow_global",
+      "Entry functions are callable from transactions; #[view] functions are read-only reads",
+      "Named address key matches the project name (defined in Move.toml [addresses]); supply the real address with --named-addresses {{projectName}}=<your_address> at compile/publish time",
+      "Counter resource (key ability) stored under the owner's address; holds a u64 value and emits IncrementedEvent on each increment"
+    ],
+    "firstSteps": [
+      "Install the Aptos CLI: brew install aptos (macOS) or see https://aptos.dev/tools/aptos-cli/install-cli/",
+      "Run `aptos move compile --named-addresses {{projectName}}=default` to type-check the module",
+      "Run `aptos move test --named-addresses {{projectName}}=default` to execute the Move unit tests",
+      "Initialize a devnet account with `aptos init --network devnet` before publishing",
+      "Fund the account with `aptos account fund-with-faucet --account default` then publish with `aptos move publish --named-addresses {{projectName}}=<your_address>`"
+    ],
+    "gotchas": [
+      "Aptos Move is NOT Sui Move — imports are aptos_framework::*, not sui::*. Don't copy Sui module patterns.",
+      "Resources can only be accessed with acquires: add `acquires Counter` to any function that reads/writes the resource.",
+      "move_to fails if the resource already exists under that account — use exists<T>(addr) as a guard in initialize.",
+      "Signer capability is non-copyable and non-droppable — pass by &signer reference, never try to store or clone.",
+      "Publishing requires the named address to be a real account with APT for gas: `aptos account fund-with-faucet` on devnet.",
+      "Move unit tests run in-VM and DON'T exercise storage the same way as on-chain execution — still test with real publish for production code.",
+      "Use a snake_case project name (e.g. my_counter) — Move named address identifiers do not allow hyphens."
+    ],
+    "placeholders": [
+      {
+        "path": "Move.toml",
+        "description": "{{projectName}} — Move package name and named-address key (e.g. my_counter). Used in Move.toml [package].name, [addresses].{{projectName}}, and compile/publish CLI flags. Use snake_case — Move identifiers do not allow hyphens."
+      },
+      {
+        "path": "sources/{{moduleName}}.move",
+        "description": "{{moduleName}} — Move module name (e.g. Counter). Used in the module declaration header and as the source/test filename. Default: HelloAptos."
+      }
+    ]
+  }
+}

package/registry/layers/framework/arkworks-prover/manifest.json

@@ -0,0 +1,6 @@
+{
+  "id": "arkworks-prover",
+  "description": "Framework layer for arkworks-prover — content ships from the family scaffold (registry/families/arkworks-prover/files/). This layer is the scaffold declaration that selectStarter emits.",
+  "appliesTo": ["arkworks-prover"],
+  "files": []
+}

package/registry/layers/framework/astro-static/files/astro.config.mjs

@@ -0,0 +1,9 @@
+import { defineConfig } from 'astro/config'
+
+export default defineConfig({
+  output: 'static',
+  site: 'https://example.com',
+  build: {
+    format: 'directory',
+  },
+})

package/registry/layers/framework/astro-static/files/src/env.d.ts

@@ -0,0 +1 @@
+/// <reference types="astro/client" />

package/registry/layers/framework/astro-static/files/src/layouts/Base.astro

@@ -0,0 +1,33 @@
+---
+interface Props {
+  title: string
+  description?: string
+}
+
+const { title, description = '{{subheadline}}' } = Astro.props
+---
+
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta name="generator" content={Astro.generator} />
+    <meta name="description" content={description} />
+    <title>{title}</title>
+  </head>
+  <body>
+    <slot />
+    <style is:global>
+      :root {
+        --fg: #0a0a0a;
+        --bg: #ffffff;
+        --accent: #4338ca;
+      }
+      html { font-family: system-ui, sans-serif; background: var(--bg); color: var(--fg); }
+      body { margin: 0; }
+      main { max-width: 64ch; margin: 0 auto; padding: 4rem 1.5rem; }
+      a { color: var(--accent); }
+    </style>
+  </body>
+</html>

package/registry/layers/framework/astro-static/files/src/pages/index.astro

@@ -0,0 +1,18 @@
+---
+import Base from '../layouts/Base.astro'
+
+const headline = '{{headline}}'
+const subheadline = '{{subheadline}}'
+---
+
+<Base title={headline} description={subheadline}>
+  <main>
+    <h1>{headline}</h1>
+    <p>{subheadline}</p>
+    <p>
+      Edit <code>src/pages/index.astro</code> to replace this placeholder with
+      the product's real content. Add new routes by dropping <code>.astro</code>
+      or <code>.md</code> files into <code>src/pages/</code>.
+    </p>
+  </main>
+</Base>

package/registry/layers/framework/astro-static/manifest.json

@@ -0,0 +1,75 @@
+{
+  "id": "astro-static",
+  "description": "Astro static framework layer — astro.config.mjs, Base layout, index page, and env.d.ts wired for zero-JS static output.",
+  "appliesTo": ["astro-static"],
+  "files": [
+    {
+      "source": "files/astro.config.mjs",
+      "target": "astro.config.mjs"
+    },
+    {
+      "source": "files/src/env.d.ts",
+      "target": "src/env.d.ts"
+    },
+    {
+      "source": "files/src/pages/index.astro",
+      "target": "src/pages/index.astro"
+    },
+    {
+      "source": "files/src/layouts/Base.astro",
+      "target": "src/layouts/Base.astro"
+    }
+  ],
+  "packageDeps": {
+    "dependencies": {
+      "astro": "^5.2.0"
+    },
+    "devDependencies": {
+      "@astrojs/check": "^0.9.4",
+      "typescript": "^5.7.0"
+    }
+  },
+  "buildHints": {
+    "whenToUse": "Content-focused static sites (marketing, docs, blogs) where you want islands of interactivity without shipping a full SPA runtime.",
+    "firstSteps": [
+      "Run `pnpm install` then `pnpm dev` — Astro's Vite dev server binds to http://localhost:4321 with HMR.",
+      "Pages live in `src/pages/` — every `.astro`, `.md`, or `.mdx` file becomes a route automatically.",
+      "Shared HTML shell is in `src/layouts/Base.astro`. Wrap each page with `<Base title=\"...\">...</Base>`.",
+      "Build with `pnpm build` — emits fully static HTML/CSS/JS to `./dist/`. Preview with `pnpm preview`."
+    ],
+    "gotchas": [
+      "Frontmatter in `.astro` files runs at BUILD time — browser globals (`window`, `document`) are not available there; put client code inside `<script>` tags or `client:*` directives.",
+      "To add a React/Vue/Svelte island you must install `@astrojs/<framework>` AND add it to `astro.config.mjs`'s `integrations` array — just importing a `.jsx` file silently fails.",
+      "`import.meta.env.PUBLIC_*` is the only env prefix exposed to client bundles — non-prefixed vars are build-time server-only."
+    ],
+    "architectureNotes": [
+      "Astro ships ZERO JS by default — interactivity is opt-in per component via `client:load`, `client:idle`, `client:visible`, or `client:only`.",
+      "Output mode is `static` in astro.config.mjs — switch to `server` or `hybrid` only if SSR is actually needed."
+    ],
+    "placeholders": [
+      {
+        "path": "src/pages/index.astro",
+        "description": "Placeholder hero page using `{{headline}}` and `{{subheadline}}` tokens resolved from defaults. Replace with real product copy before shipping."
+      },
+      {
+        "path": "src/layouts/Base.astro",
+        "description": "Shared HTML shell with meta tags and minimal global CSS. Update OG/meta tags and replace the `{{subheadline}}` default before production."
+      }
+    ]
+  },
+  "contextHints": {
+    "commands": ["pnpm install", "pnpm dev", "pnpm build", "pnpm preview"],
+    "entrypoints": ["src/pages/index.astro", "astro.config.mjs"],
+    "preview": {
+      "port": 4321,
+      "path": "/"
+    },
+    "extensionPoints": [
+      "src/pages",
+      "src/components",
+      "src/content",
+      "src/layouts",
+      "public"
+    ]
+  }
+}

package/registry/layers/framework/bevy-web/files/src/main.rs

@@ -0,0 +1,79 @@
+//! Minimal Bevy 0.14 app: DefaultPlugins, camera, light, rotating cube targeting WASM.
+
+use bevy::prelude::*;
+
+fn main() {
+    // WASM panics are invisible on the canvas without this hook.
+    #[cfg(target_arch = "wasm32")]
+    console_error_panic_hook::set_once();
+
+    App::new()
+        .add_plugins(DefaultPlugins.set(WindowPlugin {
+            primary_window: Some(Window {
+                title: "bevy-web starter".into(),
+                // Resizes the Bevy canvas to match the parent element — needed when the page owns layout.
+                fit_canvas_to_parent: true,
+                // Pass F11/ESC to the page instead of Bevy intercepting them.
+                prevent_default_event_handling: false,
+                ..default()
+            }),
+            ..default()
+        }))
+        .add_systems(Startup, setup)
+        .add_systems(Update, rotate_cubes)
+        .run();
+}
+
+#[derive(Component)]
+struct Spinner {
+    speed: f32,
+}
+
+fn setup(
+    mut commands: Commands,
+    mut meshes: ResMut<Assets<Mesh>>,
+    mut materials: ResMut<Assets<StandardMaterial>>,
+) {
+    commands.spawn(Camera3dBundle {
+        transform: Transform::from_xyz(2.5, 2.5, 4.0).looking_at(Vec3::ZERO, Vec3::Y),
+        ..default()
+    });
+
+    commands.spawn(DirectionalLightBundle {
+        directional_light: DirectionalLight {
+            illuminance: 10_000.0,
+            shadows_enabled: false,
+            ..default()
+        },
+        transform: Transform::from_xyz(4.0, 8.0, 4.0).looking_at(Vec3::ZERO, Vec3::Y),
+        ..default()
+    });
+
+    commands.insert_resource(AmbientLight {
+        color: Color::WHITE,
+        brightness: 0.25,
+    });
+
+    commands.spawn((
+        PbrBundle {
+            mesh: meshes.add(Cuboid::new(1.0, 1.0, 1.0)),
+            material: materials.add(StandardMaterial {
+                base_color: Color::srgb(0.43, 0.66, 1.0),
+                perceptual_roughness: 0.35,
+                metallic: 0.1,
+                ..default()
+            }),
+            transform: Transform::from_xyz(0.0, 0.0, 0.0),
+            ..default()
+        },
+        Spinner { speed: 0.9 },
+    ));
+}
+
+fn rotate_cubes(time: Res<Time>, mut query: Query<(&mut Transform, &Spinner)>) {
+    let dt = time.delta().as_secs_f32();
+    for (mut transform, spinner) in &mut query {
+        transform.rotate_y(spinner.speed * dt);
+        transform.rotate_x(spinner.speed * 0.6 * dt);
+    }
+}

package/registry/layers/framework/bevy-web/manifest.json

@@ -0,0 +1,48 @@
+{
+  "id": "bevy-web",
+  "description": "Bevy web framework layer — src/main.rs with a real App, DefaultPlugins, camera, light, and a rotating cube driven by a system.",
+  "appliesTo": ["bevy-web"],
+  "files": [
+    {
+      "source": "files/src/main.rs",
+      "target": "src/main.rs"
+    }
+  ],
+  "buildHints": {
+    "whenToUse": "Rust-first game or interactive 3D content that must run in the browser. Bevy supplies an ECS, PBR renderer, input, and audio; Trunk handles the WASM build and asset pipeline. Choose this over a JS-based framework when the logic is inherently systems-based or you want Rust's type safety across the whole codebase.",
+    "firstSteps": [
+      "Install the toolchain once: `rustup target add wasm32-unknown-unknown` then `cargo install --locked trunk`.",
+      "Run `trunk serve` — it compiles Rust to WASM, runs wasm-bindgen, and opens http://localhost:8080 with hot-reload on Rust file changes.",
+      "The Bevy app is in `src/main.rs`: DefaultPlugins + a Camera3dBundle, DirectionalLight, AmbientLight, and a rotating cube. Start replacing the cube with your geometry and adding systems.",
+      "Run `trunk build --release` to emit a production bundle in `dist/` — deploy to any static host."
+    ],
+    "gotchas": [
+      "`wasm-bindgen-cli` must match the version in Cargo.lock. Always install with `--locked`; version drift causes cryptic `imported memory` linker errors.",
+      "WebGPU is Chrome/Edge 113+ and Safari 18+; Firefox stable falls back to WebGL2. Guard any WebGPU-only features behind a capability check.",
+      "WASM binaries are large by default (~10–20 MB debug, ~3–6 MB release). Always ship `trunk build --release`, which runs wasm-opt -Oz automatically.",
+      "Assets loaded via `AssetServer` are fetched relative to the HTML page. Files must be under `public/` (Trunk copies them to `dist/`) — dropping assets next to `src/` causes 404s at runtime."
+    ],
+    "architectureNotes": [
+      "One `App::new()` per process — Bevy is not reentrant. All plugins, systems, and resources attach to that single app.",
+      "Systems are stateless functions operating on queries and resources. State belongs in `Resource`s or `Component`s, not in system-local variables across frames.",
+      "Keep WASM-specific code under `#[cfg(target_arch = \"wasm32\")]` so the crate also builds natively for fast iteration without a browser."
+    ],
+    "placeholders": [
+      {
+        "path": "src/main.rs",
+        "description": "Minimal Bevy app: DefaultPlugins, Camera3dBundle, DirectionalLight, AmbientLight, and a PbrBundle cube with a per-frame rotation system. Replace the cube mesh and material with real geometry, add input and audio systems, or swap DefaultPlugins for a narrower plugin group to reduce bundle size."
+      }
+    ]
+  },
+  "contextHints": {
+    "commands": [
+      "rustup target add wasm32-unknown-unknown",
+      "cargo install --locked trunk",
+      "trunk serve",
+      "trunk build --release"
+    ],
+    "entrypoints": ["src/main.rs"],
+    "preview": { "path": "/" },
+    "extensionPoints": ["src/main.rs"]
+  }
+}

package/registry/layers/framework/bun-http/files/handlers.ts

@@ -0,0 +1,25 @@
+// Route handlers for the Bun HTTP starter. Extend by adding entries to the
+// routes map; each handler receives the raw Request and returns Response.
+
+type Handler = (request: Request) => Response | Promise<Response>
+
+interface HealthPayload {
+  status: 'ok'
+  service: string
+  database: string
+  sdk: string
+}
+
+function health(): Response {
+  const payload: HealthPayload = {
+    status: 'ok',
+    service: '{{serviceName}}',
+    database: '{{databaseProvider}}',
+    sdk: process.env.SDK_PROVIDER ?? 'none',
+  }
+  return Response.json(payload)
+}
+
+export const routes: Record<string, Handler> = {
+  '/health': health,
+}

package/registry/layers/framework/bun-http/files/server.ts

@@ -0,0 +1,15 @@
+import { routes } from './handlers'
+
+const port = Number(process.env.PORT ?? '{{port}}')
+
+const server = Bun.serve({
+  port,
+  fetch(request) {
+    const url = new URL(request.url)
+    const handler = routes[url.pathname]
+    if (handler) return handler(request)
+    return new Response('not found', { status: 404 })
+  },
+})
+
+console.log(`{{serviceName}} listening on http://${server.hostname}:${server.port}`)

package/registry/layers/framework/bun-http/manifest.json

@@ -0,0 +1,15 @@
+{
+  "id": "bun-http",
+  "description": "Bun.serve-based HTTP framework layer for Bun API starters.",
+  "appliesTo": ["bun-http"],
+  "files": [
+    {
+      "source": "files/server.ts",
+      "target": "src/server.ts"
+    },
+    {
+      "source": "files/handlers.ts",
+      "target": "src/handlers.ts"
+    }
+  ]
+}