@dcasegr/skein 0.0.0-stage → 0.1.1

package/images/default/README.md

@@ -0,0 +1,38 @@
+# The default image
+
+One genesis for everyone, with no root in it (#89, #143). It has the front
+door, the messagebox, the wallet (#116, #130), the admin routes (root's:
+nobody holds root yet) and the claim route, open: the first claim's sender
+is granted root (#127: never a key in its body) — the claimant's own
+message, or a claim signed before the instance existed, which the host
+forwards into it — and the claim route is removed. **It has no apps**
+(#152): root installs them by message after the claim (`skein install
+<dir>`), and a reinstall of a newer version keeps the app's state (docs/APPS.md,
+"Reconfiguration"). Nothing is served at `/` until root routes it.
+docs/BOOTSTRAP.md, "The default image".
+
+- `bin/frontdoor.cid`, `bin/messagebox.cid`: the kernel's pinned modules
+  (`wasm/`), by CID; `scripts/pin-programs.sh` keeps them current.
+- `bin/wallet.cid`, `bin/wallet.json` (#116, #130): the wallet — core, in
+  every skein — the same program record as src/runtime/programs.ts
+  `WALLET`: a skein made from the image pays its host from it (docs/VM.md
+  "Billing").
+- `etc/dispatch.json` (#143: routes, no senders): the claim route, `:ack`
+  (an event route), the handshake route, the messagebox's http routes and
+  the explorer behind `kernel.brc104` (the explorer gated by root: every
+  genesis's `roles`). No route to the wallet: root funds the skein by the
+  wallet's `internalize` message on a route of its own (docs/WALLET.md).
+- `etc/config.json`: `{collect: []}`.
+- `chain/` (#132): **not in the repo** — the host adds it. The image a
+  host boots skeins from is this directory with the whole header chain at
+  `chain/headers/<first>` (2016 raw headers a block) and `chain/tip`, grown
+  with every header the host receives (src/host/image-chain.ts; host.db
+  `image`, `image_chain`, `image_blocks`), so a skein is born with the
+  chain up to the current tip, for the chain app to read once root installs
+  it. From then on the host pushes it its headers feed (the chain app's
+  event row), first the headers between its tip and the host's.
+  docs/BOOTSTRAP.md, "The image's chain part".
+
+The host skein boots from the host image: `images/host` merged over this
+one, its `etc/apps.json` naming shruggr/skein-onboard v0.4.0 by its release
+tarball (images/README.md).

package/images/default/bin/frontdoor.cid

@@ -0,0 +1 @@
+bafkreicakz7f6hjd6jh2ldecvaw3duqib2fsziuco7mebmuicugtxdf5zq

package/images/default/bin/frontdoor.json

@@ -0,0 +1,5 @@
+{
+  "inputs": {},
+  "services": [],
+  "description": "The front door (#68): the instance's middleware, stepped on every request a transport carries in (http: BRC-103/104 against its session records, head frontdoor/sessions; libp2p: the GossipSub signature; local: a provider's signed message), routed by the kernel's dispatch rows for its transport, the handler an in-VM call, the answer signed on the session. Called (fn read) for a route whose answer is a read of live state."
+}

package/images/default/bin/messagebox.cid

@@ -0,0 +1 @@
+bafkreihbdgqextmp444phd4h6vpngwkekmefo3m3pqa43sos765oltbgae

package/images/default/bin/messagebox.json

@@ -0,0 +1,8 @@
+{
+  "inputs": {
+    "box": "string?",
+    "event": "cid?"
+  },
+  "services": [],
+  "description": "The BRC-33 messagebox (#40): the front door's sendMessage (one `mail` entry), listMessages (a read), acknowledgeMessage (an `ack` event); stepped, keeps the mail a subscription routes to it (head `mailbox`); launched as a message's delivery thread (#70), emits the `deliver` intention (#157), which the host carries over BRC-103/104, and is stepped by its answer."
+}

package/images/default/bin/wallet.cid

@@ -0,0 +1 @@
+bafkreifmo2fz45wn3vukhcf226bpnfh6klu7w5m43of76mx6olgghnzqkq

package/images/default/bin/wallet.json

@@ -0,0 +1,14 @@
+{
+  "inputs": {
+    "envelope": "cid",
+    "body": "cid",
+    "box": "string",
+    "sender": "identity",
+    "event": "cid"
+  },
+  "services": [
+    "wallet",
+    "http"
+  ],
+  "description": "The wallet (#29, #79, #116: core): its own records under wallet/ over the chain app's chain/state. A message's body {op: internalize|createAction|signAction|list, …} (BRC-100's; every transaction ingested at the chain app); the kernel's pay step, args {pay: {to, x, checkpoint}} (#130: X sats, or all it has if less, to the host, the state record committed in a 0-sat OP_RETURN output, emitted as the event `payment`). Prints the result record's CID."
+}

package/images/default/etc/config.json

@@ -0,0 +1 @@
+{ "collect": [] }

package/images/default/etc/dispatch.json

@@ -0,0 +1,82 @@
+[
+  {
+    "address": "claim",
+    "program": "kernel",
+    "fn": "claim"
+  },
+  {
+    "transport": "event",
+    "address": ":ack",
+    "program": "messagebox"
+  },
+  {
+    "transport": "http",
+    "address": "/.well-known/auth",
+    "program": "frontdoor",
+    "fn": "handshake"
+  },
+  {
+    "transport": "http",
+    "address": "/sendMessage",
+    "filters": [
+      "kernel.brc104"
+    ],
+    "program": "messagebox",
+    "fn": "sendMessage"
+  },
+  {
+    "transport": "http",
+    "address": "/listMessages",
+    "filters": [
+      "kernel.brc104"
+    ],
+    "program": "messagebox",
+    "fn": "listMessages"
+  },
+  {
+    "transport": "http",
+    "address": "/acknowledgeMessage",
+    "filters": [
+      "kernel.brc104"
+    ],
+    "program": "messagebox",
+    "fn": "acknowledgeMessage"
+  },
+  {
+    "transport": "http",
+    "address": "/messagebox/sendMessage",
+    "filters": [
+      "kernel.brc104"
+    ],
+    "program": "messagebox",
+    "fn": "sendMessage"
+  },
+  {
+    "transport": "http",
+    "address": "/messagebox/listMessages",
+    "filters": [
+      "kernel.brc104"
+    ],
+    "program": "messagebox",
+    "fn": "listMessages"
+  },
+  {
+    "transport": "http",
+    "address": "/messagebox/acknowledgeMessage",
+    "filters": [
+      "kernel.brc104"
+    ],
+    "program": "messagebox",
+    "fn": "acknowledgeMessage"
+  },
+  {
+    "transport": "http",
+    "address": "/explore",
+    "prefix": true,
+    "filters": [
+      "kernel.brc104"
+    ],
+    "program": "frontdoor",
+    "fn": "explore"
+  }
+]

package/images/host/etc/apps.json

@@ -0,0 +1,8 @@
+{
+  "install": [
+    {
+      "url": "https://github.com/shruggr/skein-onboard/archive/refs/tags/v0.4.0.tar.gz",
+      "hash": "ba29f99adb0d2d1849aa7f0cf72ceeefde88c5ae"
+    }
+  ]
+}