@meddleware/docs 0.0.1

package/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+All notable changes to `@meddleware/docs` are documented here.
+
+## [0.0.1] — 2026-09-17
+
+Initial release. VitePress documentation site for `docs.meddleware.co.uk` covering the four
+Meddleware Sui tools: DAO, Walrus Storage, Sealed Storage, and Access Gate.
+
+- Hand-authored narrative (what/how/when) for all four tools
+- Auto-generated SDK API reference via TypeDoc (walrus-client, seal-client, nft-gate-client)
+- On-brand via `@meddleware/design-tokens` (Oxblood/Indigo/Gold)
+- Local search across all sections
+- Dark-first appearance

package/LICENSE

@@ -0,0 +1,14 @@
+BSD Zero Clause License
+
+Copyright (c) Meddleware
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
+OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
+TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
+THIS SOFTWARE.

package/README.md

@@ -0,0 +1,54 @@
+# @meddleware/docs
+
+User-facing documentation for the Meddleware Sui tools, served at
+[`docs.meddleware.co.uk`](https://docs.meddleware.co.uk). Built with [VitePress](https://vitepress.dev).
+
+One site, one section per service — **DAO**, **Walrus Storage**, **Sealed Storage**, **Access Gate** —
+each answering *what it is*, *how to use it*, and *when to use it*, plus a reference layer (object/
+event shapes and auto-generated SDK API).
+
+## Structure
+
+```
+docs/
+  index.md                 Landing / overview
+  getting-started.md       Wallet basics, testnet vs mainnet, first steps
+  architecture.md          How the four tools fit together
+  dao/                     DAO console
+  walrus-storage/          Decentralised blob storage
+  sealed-storage/          Encrypted, access-gated storage
+  access-gate/             NFT access gates
+  .vitepress/
+    config.ts              Nav, sidebar, search, brand theme
+    theme/                 Design-token brand overrides
+scripts/gen-api.mjs        TypeDoc autodoc for the SDK reference sections
+```
+
+## Develop
+
+```sh
+npm install
+npm run dev        # gen:api (TypeDoc) + vitepress dev → http://localhost:5173
+```
+
+## Build
+
+```sh
+npm run build      # gen:api + vitepress build → dist/
+docker build -t docs .
+```
+
+The build emits a static site to `dist/` (pinned via `outDir` in `.vitepress/config.ts`), which the
+runtime image serves with the shared `static-server`.
+
+## Content boundary
+
+This site is **user-facing**. Developer integration guides, self-host instructions, and white-label
+operator guides are intentionally **out of scope** — they live (planned) in each package's
+README/CLAUDE.md and will surface on the future `dev.meddleware.co.uk`. The auto-generated SDK API
+reference *is* included here (useful to users and bots) but without the "wire it into your app"
+tutorials.
+
+## License
+
+BSD Zero Clause License (`0BSD`). See [LICENSE](LICENSE).

package/docs/.vitepress/config.ts

@@ -0,0 +1,101 @@
+import { defineConfig } from 'vitepress'
+import { fileURLToPath } from 'node:url'
+
+// User-facing documentation for the Meddleware Sui tools. One site, one section per service.
+// Output is pinned to the repo-root dist/ so the Dockerfile's `COPY --from=build /app/dist`
+// (the shared static-server image pattern) works unchanged.
+const outDir = fileURLToPath(new URL('../../dist', import.meta.url))
+
+export default defineConfig({
+  title: 'Meddleware Docs',
+  description:
+    'How to use the Meddleware Sui tools — the DAO console, Walrus Storage, Sealed Storage, and Access Gate.',
+  lang: 'en-GB',
+  outDir,
+  cleanUrls: true,
+  lastUpdated: true,
+  // The per-service `api/` subtrees are generated at build time by scripts/gen-api.mjs (TypeDoc);
+  // their exact filenames depend on the TypeDoc version, so don't fail the build on links into them.
+  ignoreDeadLinks: [/\/api\//],
+  // Match the estate's dark-first aesthetic; users can still toggle.
+  appearance: 'dark',
+  head: [['meta', { name: 'theme-color', content: '#5e1622' }]],
+
+  themeConfig: {
+    search: { provider: 'local' },
+
+    nav: [
+      { text: 'Start here', link: '/getting-started' },
+      { text: 'DAO', link: '/dao/' },
+      { text: 'Walrus Storage', link: '/walrus-storage/' },
+      { text: 'Sealed Storage', link: '/sealed-storage/' },
+      { text: 'Access Gate', link: '/access-gate/' },
+      {
+        text: 'Tools',
+        items: [
+          { text: 'Tools hub', link: 'https://sui.meddleware.co.uk' },
+          { text: 'DAO console', link: 'https://sui-dao.meddleware.co.uk' },
+          { text: 'Walrus Storage', link: 'https://sui-walrus.meddleware.co.uk' },
+          { text: 'Sealed Storage', link: 'https://sui-seal.meddleware.co.uk' },
+          { text: 'Access Gate', link: 'https://sui-access-gate.meddleware.co.uk' },
+        ],
+      },
+    ],
+
+    sidebar: {
+      '/': [
+        {
+          text: 'Introduction',
+          items: [
+            { text: 'Overview', link: '/' },
+            { text: 'Getting started', link: '/getting-started' },
+            { text: 'How the tools fit together', link: '/architecture' },
+          ],
+        },
+        {
+          text: 'DAO',
+          collapsed: false,
+          items: [
+            { text: 'Overview', link: '/dao/' },
+            { text: 'Reference', link: '/dao/reference' },
+          ],
+        },
+        {
+          text: 'Walrus Storage',
+          collapsed: false,
+          items: [
+            { text: 'Overview', link: '/walrus-storage/' },
+            { text: 'Using it', link: '/walrus-storage/using' },
+            { text: 'Reference', link: '/walrus-storage/reference' },
+          ],
+        },
+        {
+          text: 'Sealed Storage',
+          collapsed: false,
+          items: [
+            { text: 'Overview', link: '/sealed-storage/' },
+            { text: 'Using it', link: '/sealed-storage/using' },
+            { text: 'Policies', link: '/sealed-storage/policies' },
+            { text: 'Reference', link: '/sealed-storage/reference' },
+          ],
+        },
+        {
+          text: 'Access Gate',
+          collapsed: false,
+          items: [
+            { text: 'Overview', link: '/access-gate/' },
+            { text: 'Using it', link: '/access-gate/using' },
+            { text: 'Reference', link: '/access-gate/reference' },
+          ],
+        },
+      ],
+    },
+
+    socialLinks: [{ icon: 'github', link: 'https://github.com/meddleware-org' }],
+
+    footer: {
+      message: 'Documentation for the Meddleware Sui tools.',
+      copyright: 'Meddleware · 0BSD',
+    },
+  },
+})

package/docs/.vitepress/theme/custom.css

@@ -0,0 +1,51 @@
+/*
+ * Meddleware brand overrides for the VitePress default theme.
+ * Brand ramp = Oxblood (primary) with Indigo/Gold accents, sourced from
+ * @meddleware/design-tokens so the docs stay in lockstep with the apps.
+ */
+
+:root {
+  /* Brand = Oxblood */
+  --vp-c-brand-1: var(--mw-oxblood-500);
+  --vp-c-brand-2: var(--mw-oxblood-400);
+  --vp-c-brand-3: var(--mw-oxblood-400);
+  --vp-c-brand-soft: var(--mw-oxblood-100);
+
+  /* Home hero: Oxblood → Indigo wash, Gold glow */
+  --vp-home-hero-name-color: transparent;
+  --vp-home-hero-name-background: linear-gradient(
+    120deg,
+    var(--mw-oxblood-500),
+    var(--mw-indigo-500)
+  );
+  --vp-home-hero-image-background-image: linear-gradient(
+    120deg,
+    var(--mw-oxblood-400),
+    var(--mw-gold-500)
+  );
+  --vp-home-hero-image-filter: blur(44px);
+}
+
+.dark {
+  /* Dark mode: lightened Oxblood for legibility (mirrors --accent in tokens) */
+  --vp-c-brand-1: #b0465a;
+  --vp-c-brand-2: var(--mw-oxblood-400);
+  --vp-c-brand-3: var(--mw-oxblood-500);
+  --vp-c-brand-soft: color-mix(in srgb, var(--mw-oxblood-500) 30%, transparent);
+
+  --vp-home-hero-name-background: linear-gradient(
+    120deg,
+    #b0465a,
+    var(--mw-indigo-300)
+  );
+  --vp-home-hero-image-background-image: linear-gradient(
+    120deg,
+    var(--mw-oxblood-500),
+    var(--mw-gold-400)
+  );
+}
+
+/* Gold for "tip" custom blocks keeps the accent role consistent with the apps. */
+.vp-doc .custom-block.tip {
+  border-color: var(--mw-gold-500);
+}

package/docs/.vitepress/theme/index.ts

@@ -0,0 +1,8 @@
+// Docs theme = VitePress default theme + Meddleware brand overrides.
+// The design-token CSS is imported so the palette stays in lockstep with the apps; custom.css
+// maps VitePress's --vp-c-brand-* onto the Oxblood/Indigo/Gold ramps.
+import DefaultTheme from 'vitepress/theme'
+import '@meddleware/design-tokens/tokens.css'
+import './custom.css'
+
+export default DefaultTheme

package/docs/access-gate/api/functions/buildAccessProof.md

@@ -0,0 +1,38 @@
+# Function: buildAccessProof()
+
+> **buildAccessProof**(`opts`): `Promise`\<`string`\>
+
+Defined in: proof.ts:44
+
+Sign a challenge and assemble the encoded access-proof token to hand to any gateway as its
+auth bearer (e.g. an upload-relay client's auth-token option, an `Authorization` header).
+
+## Parameters
+
+### opts
+
+#### address
+
+`string`
+
+#### challenge
+
+[`Challenge`](../interfaces/Challenge.md)
+
+#### consumeDigest?
+
+`string`
+
+Present for single-use gates: the `consume` tx digest.
+
+#### sign
+
+[`PersonalMessageSigner`](../type-aliases/PersonalMessageSigner.md)
+
+## Returns
+
+`Promise`\<`string`\>
+
+## Throws
+
+if the wallet signer rejects or fails to sign the message.

package/docs/access-gate/api/functions/buildAirdropTx.md

@@ -0,0 +1,21 @@
+# Function: buildAirdropTx()
+
+> **buildAirdropTx**(`ctx`, `recipient`): `Transaction`
+
+Defined in: ptb.ts:142
+
+AdminCap-gated free grant (airdrop) of the gate's NFT flavour to `recipient`.
+
+## Parameters
+
+### ctx
+
+[`GateAdminContext`](../interfaces/GateAdminContext.md)
+
+### recipient
+
+`string`
+
+## Returns
+
+`Transaction`

package/docs/access-gate/api/functions/buildConsumeTx.md

@@ -0,0 +1,27 @@
+# Function: buildConsumeTx()
+
+> **buildConsumeTx**(`cfg`, `nftId`, `nonce`): `Transaction`
+
+Defined in: ptb.ts:24
+
+Build a PTB that consumes one use of a single-use NFT, binding it to `nonce`. Selects
+`consume` or `consume_soulbound` from `cfg.soulbound`. For unlimited passes there is
+nothing to consume — do not call this.
+
+## Parameters
+
+### cfg
+
+[`AccessGateConfig`](../interfaces/AccessGateConfig.md)
+
+### nftId
+
+`string`
+
+### nonce
+
+`string`
+
+## Returns
+
+`Transaction`

package/docs/access-gate/api/functions/buildCreateGateTx.md

@@ -0,0 +1,52 @@
+# Function: buildCreateGateTx()
+
+> **buildCreateGateTx**(`packageId`, `opts`): `Transaction`
+
+Defined in: ptb.ts:43
+
+Build a PTB that creates a new gate. Mostly for tooling/operators; the frontend usually
+only purchases/consumes an existing gate.
+
+## Parameters
+
+### packageId
+
+`string`
+
+### opts
+
+#### autoBurnAtZero
+
+`boolean`
+
+#### defaultUses
+
+`number` \| `bigint`
+
+#### nftDescription
+
+`string`
+
+#### nftImageUrl
+
+`string`
+
+#### nftName
+
+`string`
+
+#### paymentRecipient
+
+`string`
+
+#### priceMist
+
+`number` \| `bigint`
+
+#### soulbound
+
+`boolean`
+
+## Returns
+
+`Transaction`

package/docs/access-gate/api/functions/buildMakeGateImmutableTx.md

@@ -0,0 +1,19 @@
+# Function: buildMakeGateImmutableTx()
+
+> **buildMakeGateImmutableTx**(`ctx`): `Transaction`
+
+Defined in: ptb.ts:151
+
+Make the gate immutable — **irreversible**. Consumes the `AdminCap` (passed by value) and sets
+`Gate.frozen = true`, permanently ending all setters and `airdrop`. `purchase`/`consume` remain
+permissionless. Grant everything first, then freeze.
+
+## Parameters
+
+### ctx
+
+[`GateAdminContext`](../interfaces/GateAdminContext.md)
+
+## Returns
+
+`Transaction`

package/docs/access-gate/api/functions/buildPurchaseTx.md

@@ -0,0 +1,23 @@
+# Function: buildPurchaseTx()
+
+> **buildPurchaseTx**(`cfg`, `priceMist`): `Transaction`
+
+Defined in: ptb.ts:9
+
+Build a PTB that purchases access: split `priceMist` from the gas coin and call
+`access_gate::purchase(gate, payment)`. Overpayment is refunded on-chain, so the split
+must be exactly the price. The caller signs + executes with their wallet.
+
+## Parameters
+
+### cfg
+
+[`AccessGateConfig`](../interfaces/AccessGateConfig.md)
+
+### priceMist
+
+`number` \| `bigint`
+
+## Returns
+
+`Transaction`

package/docs/access-gate/api/functions/buildSetAutoBurnAtZeroTx.md

@@ -0,0 +1,21 @@
+# Function: buildSetAutoBurnAtZeroTx()
+
+> **buildSetAutoBurnAtZeroTx**(`ctx`, `autoBurn`): `Transaction`
+
+Defined in: ptb.ts:122
+
+Toggle the auto-burn-at-zero policy for future mints.
+
+## Parameters
+
+### ctx
+
+[`GateAdminContext`](../interfaces/GateAdminContext.md)
+
+### autoBurn
+
+`boolean`
+
+## Returns
+
+`Transaction`

package/docs/access-gate/api/functions/buildSetDefaultUsesTx.md

@@ -0,0 +1,21 @@
+# Function: buildSetDefaultUsesTx()
+
+> **buildSetDefaultUsesTx**(`ctx`, `defaultUses`): `Transaction`
+
+Defined in: ptb.ts:112
+
+Change the default uses for future mints (0 ⇒ unlimited pass; N ⇒ single-use with N).
+
+## Parameters
+
+### ctx
+
+[`GateAdminContext`](../interfaces/GateAdminContext.md)
+
+### defaultUses
+
+`number` \| `bigint`
+
+## Returns
+
+`Transaction`

package/docs/access-gate/api/functions/buildSetNftDescriptionTx.md

@@ -0,0 +1,21 @@
+# Function: buildSetNftDescriptionTx()
+
+> **buildSetNftDescriptionTx**(`ctx`, `description`): `Transaction`
+
+Defined in: ptb.ts:137
+
+Update the default NFT description for future mints.
+
+## Parameters
+
+### ctx
+
+[`GateAdminContext`](../interfaces/GateAdminContext.md)
+
+### description
+
+`string`
+
+## Returns
+
+`Transaction`

package/docs/access-gate/api/functions/buildSetNftImageUrlTx.md

@@ -0,0 +1,21 @@
+# Function: buildSetNftImageUrlTx()
+
+> **buildSetNftImageUrlTx**(`ctx`, `url`): `Transaction`
+
+Defined in: ptb.ts:132
+
+Update the default NFT image URL for future mints.
+
+## Parameters
+
+### ctx
+
+[`GateAdminContext`](../interfaces/GateAdminContext.md)
+
+### url
+
+`string`
+
+## Returns
+
+`Transaction`

package/docs/access-gate/api/functions/buildSetNftNameTx.md

@@ -0,0 +1,21 @@
+# Function: buildSetNftNameTx()
+
+> **buildSetNftNameTx**(`ctx`, `name`): `Transaction`
+
+Defined in: ptb.ts:127
+
+Update the default NFT display name for future mints.
+
+## Parameters
+
+### ctx
+
+[`GateAdminContext`](../interfaces/GateAdminContext.md)
+
+### name
+
+`string`
+
+## Returns
+
+`Transaction`

package/docs/access-gate/api/functions/buildSetPausedTx.md

@@ -0,0 +1,21 @@
+# Function: buildSetPausedTx()
+
+> **buildSetPausedTx**(`ctx`, `paused`): `Transaction`
+
+Defined in: ptb.ts:107
+
+Pause or unpause `purchase` (paused ⇒ `purchase` aborts with `E_PAUSED`).
+
+## Parameters
+
+### ctx
+
+[`GateAdminContext`](../interfaces/GateAdminContext.md)
+
+### paused
+
+`boolean`
+
+## Returns
+
+`Transaction`

package/docs/access-gate/api/functions/buildSetPaymentRecipientTx.md

@@ -0,0 +1,21 @@
+# Function: buildSetPaymentRecipientTx()
+
+> **buildSetPaymentRecipientTx**(`ctx`, `recipient`): `Transaction`
+
+Defined in: ptb.ts:102
+
+Redirect future purchase payments to a new recipient address.
+
+## Parameters
+
+### ctx
+
+[`GateAdminContext`](../interfaces/GateAdminContext.md)
+
+### recipient
+
+`string`
+
+## Returns
+
+`Transaction`

package/docs/access-gate/api/functions/buildSetPriceTx.md

@@ -0,0 +1,21 @@
+# Function: buildSetPriceTx()
+
+> **buildSetPriceTx**(`ctx`, `priceMist`): `Transaction`
+
+Defined in: ptb.ts:97
+
+Set the gate price (in MIST) charged by future `purchase` calls (0 = free).
+
+## Parameters
+
+### ctx
+
+[`GateAdminContext`](../interfaces/GateAdminContext.md)
+
+### priceMist
+
+`number` \| `bigint`
+
+## Returns
+
+`Transaction`

package/docs/access-gate/api/functions/buildSetSoulboundTx.md

@@ -0,0 +1,21 @@
+# Function: buildSetSoulboundTx()
+
+> **buildSetSoulboundTx**(`ctx`, `soulbound`): `Transaction`
+
+Defined in: ptb.ts:117
+
+Switch the soulbound flag for future mints (does not affect already-minted NFTs).
+
+## Parameters
+
+### ctx
+
+[`GateAdminContext`](../interfaces/GateAdminContext.md)
+
+### soulbound
+
+`boolean`
+
+## Returns
+
+`Transaction`

package/docs/access-gate/api/functions/decodeAccessProof.md

@@ -0,0 +1,17 @@
+# Function: decodeAccessProof()
+
+> **decodeAccessProof**(`token`): [`AccessProof`](../interfaces/AccessProof.md)
+
+Defined in: proof.ts:25
+
+Decode a proof token produced by [encodeAccessProof](encodeAccessProof.md). Throws on malformed input.
+
+## Parameters
+
+### token
+
+`string`
+
+## Returns
+
+[`AccessProof`](../interfaces/AccessProof.md)

package/docs/access-gate/api/functions/encodeAccessProof.md

@@ -0,0 +1,17 @@
+# Function: encodeAccessProof()
+
+> **encodeAccessProof**(`proof`): `string`
+
+Defined in: proof.ts:20
+
+Encode a proof as the compact Bearer token carried in the relay auth header.
+
+## Parameters
+
+### proof
+
+[`AccessProof`](../interfaces/AccessProof.md)
+
+## Returns
+
+`string`