@meddleware/docs 0.0.1

package/docs/index.md

@@ -0,0 +1,58 @@
+---
+layout: home
+
+hero:
+  name: Meddleware
+  text: Sui tools, documented
+  tagline: Decentralised storage, encryption, and NFT access control on Sui — with a hosted UI for each. Learn what they are, how to use them, and when.
+  actions:
+    - theme: brand
+      text: Get started
+      link: /getting-started
+    - theme: alt
+      text: How they fit together
+      link: /architecture
+
+features:
+  - title: DAO
+    details: The platform console — treasury, commission policy, community access gates, and live on-chain activity. Read-only; no wallet needed to browse.
+    link: /dao/
+    linkText: Read more
+  - title: Walrus Storage
+    details: Upload files (blobs) to Walrus, decentralised storage on Sui. Manage blob lifetimes and extend them before they expire.
+    link: /walrus-storage/
+    linkText: Read more
+  - title: Sealed Storage
+    details: Encrypt a file in your browser, store the ciphertext on Walrus, and let only the right people decrypt it — enforced by an on-chain policy.
+    link: /sealed-storage/
+    linkText: Read more
+  - title: Access Gate
+    details: Sell or grant NFT passes that gate access to content, APIs, or apps. Ownership is checked on-chain; single-use or unlimited.
+    link: /access-gate/
+    linkText: Read more
+---
+
+## What is this?
+
+Meddleware runs a small family of **Sui tools**, each with a hosted web app you can use with your own
+wallet. This site explains each one in plain terms:
+
+- **[DAO](/dao/)** — a read-only console showing the platform's treasury, commission rate, the
+  community access gates it controls, and a live feed of gate activity.
+- **[Walrus Storage](/walrus-storage/)** — upload files to [Walrus](https://walrus.xyz), a
+  decentralised storage network on Sui, and manage how long they live.
+- **[Sealed Storage](/sealed-storage/)** — client-side encryption ([Seal](https://seal-docs.wal.app/))
+  layered on Walrus, so a file can be stored publicly yet only decrypted by whoever an on-chain
+  **policy** allows.
+- **[Access Gate](/access-gate/)** — create NFT "passes" that gate access to something; buyers
+  purchase a pass, and ownership is verified on-chain.
+
+New here? Start with **[Getting started](/getting-started)**, then see
+**[how the tools fit together](/architecture)** — Sealed Storage, for example, is Walrus + Seal +
+Access Gate working as one.
+
+::: tip Where's the developer documentation?
+This site is for **using** the tools. Building against the SDKs, self-hosting, and white-label
+deployment are covered separately on the forthcoming `dev.meddleware.co.uk`. The **API reference**
+sections here are still handy if you're a developer who just wants the shapes.
+:::

package/docs/sealed-storage/api/classes/PolicyRegistry.md

@@ -0,0 +1,103 @@
+# Class: PolicyRegistry
+
+Defined in: registry.ts:8
+
+A registry of Seal policy providers. Neither ordering nor identity is privileged — the
+consuming UI iterates `list()` to render its policy picker, so registering a new provider is
+the only change needed to expose a new policy type.
+
+## Constructors
+
+### Constructor
+
+> **new PolicyRegistry**(): `PolicyRegistry`
+
+#### Returns
+
+`PolicyRegistry`
+
+## Methods
+
+### get()
+
+> **get**\<`P`\>(`type`): [`SealPolicyProvider`](../interfaces/SealPolicyProvider.md)\<`P`\>
+
+Defined in: registry.ts:18
+
+Look up a provider by type, throwing a clear error if it is not registered.
+
+#### Type Parameters
+
+##### P
+
+`P` = `Record`\<`string`, `unknown`\>
+
+#### Parameters
+
+##### type
+
+`string`
+
+#### Returns
+
+[`SealPolicyProvider`](../interfaces/SealPolicyProvider.md)\<`P`\>
+
+***
+
+### has()
+
+> **has**(`type`): `boolean`
+
+Defined in: registry.ts:28
+
+True if a provider is registered for `type`.
+
+#### Parameters
+
+##### type
+
+`string`
+
+#### Returns
+
+`boolean`
+
+***
+
+### list()
+
+> **list**(): [`SealPolicyProvider`](../interfaces/SealPolicyProvider.md)\<`never`\>[]
+
+Defined in: registry.ts:33
+
+All registered providers, in insertion order.
+
+#### Returns
+
+[`SealPolicyProvider`](../interfaces/SealPolicyProvider.md)\<`never`\>[]
+
+***
+
+### register()
+
+> **register**\<`P`\>(`provider`): `this`
+
+Defined in: registry.ts:12
+
+Register (or replace) a provider. Returns `this` for chaining.
+
+#### Type Parameters
+
+##### P
+
+`P`
+
+#### Parameters
+
+##### provider
+
+[`SealPolicyProvider`](../interfaces/SealPolicyProvider.md)\<`P`\>
+
+#### Returns
+
+`this`

package/docs/sealed-storage/api/classes/SealController.md

@@ -0,0 +1,113 @@
+# Class: SealController
+
+Defined in: controller.ts:47
+
+Orchestrates Seal threshold encrypt/decrypt over a policy registry, and manages the per-address
+SessionKey (signed once, cached until it expires). No policy logic lives here — that is entirely
+in the registered providers, so new policy types need no controller changes.
+
+## Constructors
+
+### Constructor
+
+> **new SealController**(`cfg`, `registry`): `SealController`
+
+Defined in: controller.ts:51
+
+#### Parameters
+
+##### cfg
+
+[`SealControllerConfig`](../interfaces/SealControllerConfig.md)
+
+##### registry
+
+[`PolicyRegistry`](PolicyRegistry.md)
+
+#### Returns
+
+`SealController`
+
+## Methods
+
+### decrypt()
+
+> **decrypt**\<`P`\>(`type`, `params`, `id`, `ciphertext`, `opts`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
+
+Defined in: controller.ts:84
+
+Decrypt `ciphertext` sealed under policy `type` with identity `id` (hex, from the manifest).
+`params` supplies the on-chain objects the policy's `seal_approve` needs. Prompts a single
+wallet personal-message signature per address to mint a SessionKey (cached until expiry).
+
+#### Type Parameters
+
+##### P
+
+`P`
+
+#### Parameters
+
+##### type
+
+`string`
+
+##### params
+
+`P`
+
+##### id
+
+`string`
+
+##### ciphertext
+
+`Uint8Array`
+
+##### opts
+
+###### address
+
+`string`
+
+###### signPersonalMessage
+
+[`SignPersonalMessage`](../type-aliases/SignPersonalMessage.md)
+
+#### Returns
+
+`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
+
+***
+
+### encrypt()
+
+> **encrypt**\<`P`\>(`type`, `params`, `data`): `Promise`\<[`EncryptResult`](../interfaces/EncryptResult.md)\>
+
+Defined in: controller.ts:67
+
+Encrypt `data` under policy `type` with `params`. Returns the identity (hex) + ciphertext.
+
+#### Type Parameters
+
+##### P
+
+`P`
+
+#### Parameters
+
+##### type
+
+`string`
+
+##### params
+
+`P`
+
+##### data
+
+`Uint8Array`
+
+#### Returns
+
+`Promise`\<[`EncryptResult`](../interfaces/EncryptResult.md)\>

package/docs/sealed-storage/api/functions/buildPublishSealedContentTx.md

@@ -0,0 +1,27 @@
+# Function: buildPublishSealedContentTx()
+
+> **buildPublishSealedContentTx**(`tx`, `packageId`, `input`): `void`
+
+Defined in: sealed-content.ts:20
+
+Append `seal_policies::sealed_content::publish(...)` to `tx`. Sharing a `SealedContent` makes the
+content discoverable by a gate's pass-holders (via the `SealedContentPublished` event). The
+pointer grants nothing on its own — confidentiality is enforced by Seal + `nft_gate`.
+
+## Parameters
+
+### tx
+
+`Transaction`
+
+### packageId
+
+`string`
+
+### input
+
+[`SealedContentInput`](../interfaces/SealedContentInput.md)
+
+## Returns
+
+`void`

package/docs/sealed-storage/api/functions/bytesToHex.md

@@ -0,0 +1,17 @@
+# Function: bytesToHex()
+
+> **bytesToHex**(`bytes`): `string`
+
+Defined in: bytes.ts:16
+
+Bytes → lowercase hex (no `0x`).
+
+## Parameters
+
+### bytes
+
+`Uint8Array`
+
+## Returns
+
+`string`

package/docs/sealed-storage/api/functions/concatBytes.md

@@ -0,0 +1,17 @@
+# Function: concatBytes()
+
+> **concatBytes**(...`parts`): `Uint8Array`
+
+Defined in: bytes.ts:50
+
+Concatenate byte arrays.
+
+## Parameters
+
+### parts
+
+...`Uint8Array`\<`ArrayBufferLike`\>[]
+
+## Returns
+
+`Uint8Array`

package/docs/sealed-storage/api/functions/createDefaultRegistry.md

@@ -0,0 +1,22 @@
+# Function: createDefaultRegistry()
+
+> **createDefaultRegistry**(`accessGatePackageId?`): [`PolicyRegistry`](../classes/PolicyRegistry.md)
+
+Defined in: default-registry.ts:13
+
+A registry pre-loaded with the built-in providers (`nft-gate`, `time-lock`), registered as
+peers in no particular priority. Consumers may `.register(...)` additional providers.
+
+## Parameters
+
+### accessGatePackageId?
+
+`string` = `''`
+
+The deployed `access_gate` package ID for the target network.
+  Pass the network-specific package ID to enable `suggest()` on the nft-gate provider.
+  Omit (or pass `''`) to get a zero-config registry with no chain-suggestion capability.
+
+## Returns
+
+[`PolicyRegistry`](../classes/PolicyRegistry.md)

package/docs/sealed-storage/api/functions/createNftGateProvider.md

@@ -0,0 +1,21 @@
+# Function: createNftGateProvider()
+
+> **createNftGateProvider**(`accessGatePackageId?`): [`SealPolicyProvider`](../interfaces/SealPolicyProvider.md)\<[`NftGateParams`](../interfaces/NftGateParams.md)\>
+
+Defined in: providers/nft-gate.ts:52
+
+Create an nft-gate policy provider.
+
+## Parameters
+
+### accessGatePackageId?
+
+`string` = `''`
+
+The deployed `access_gate` package ID for the target network.
+  When non-empty, `suggest()` will query the chain for `AdminCap` objects owned by the
+  connected wallet and surface the corresponding gates as selectable options.
+
+## Returns
+
+[`SealPolicyProvider`](../interfaces/SealPolicyProvider.md)\<[`NftGateParams`](../interfaces/NftGateParams.md)\>

package/docs/sealed-storage/api/functions/hexToBytes.md

@@ -0,0 +1,17 @@
+# Function: hexToBytes()
+
+> **hexToBytes**(`hex`): `Uint8Array`
+
+Defined in: bytes.ts:5
+
+Hex (with or without `0x`) → bytes. Odd-length input is left-padded with a nibble.
+
+## Parameters
+
+### hex
+
+`string`
+
+## Returns
+
+`Uint8Array`

package/docs/sealed-storage/api/functions/objectIdBytes.md

@@ -0,0 +1,17 @@
+# Function: objectIdBytes()
+
+> **objectIdBytes**(`id`): `Uint8Array`
+
+Defined in: bytes.ts:23
+
+A Sui object id → its canonical 32-byte (right-aligned) representation.
+
+## Parameters
+
+### id
+
+`string`
+
+## Returns
+
+`Uint8Array`

package/docs/sealed-storage/api/functions/randomBytes.md

@@ -0,0 +1,17 @@
+# Function: randomBytes()
+
+> **randomBytes**(`len`): `Uint8Array`
+
+Defined in: bytes.ts:45
+
+Cryptographically-random bytes (Web Crypto; available in browsers and Node ≥ 18).
+
+## Parameters
+
+### len
+
+`number`
+
+## Returns
+
+`Uint8Array`

package/docs/sealed-storage/api/functions/sealedContentEventType.md

@@ -0,0 +1,17 @@
+# Function: sealedContentEventType()
+
+> **sealedContentEventType**(`packageId`): `string`
+
+Defined in: sealed-content.ts:47
+
+The Move event type used to index published pointers, e.g. for `queryEvents`.
+
+## Parameters
+
+### packageId
+
+`string`
+
+## Returns
+
+`string`

package/docs/sealed-storage/api/functions/u64beBytes.md

@@ -0,0 +1,17 @@
+# Function: u64beBytes()
+
+> **u64beBytes**(`v`): `Uint8Array`
+
+Defined in: bytes.ts:33
+
+A u64 → 8 big-endian bytes (matches the on-chain decode in `seal_policies::timelock`).
+
+## Parameters
+
+### v
+
+`number` \| `bigint`
+
+## Returns
+
+`Uint8Array`

package/docs/sealed-storage/api/index.md

@@ -0,0 +1,45 @@
+# Seal client API
+
+## Classes
+
+- [PolicyRegistry](classes/PolicyRegistry.md)
+- [SealController](classes/SealController.md)
+
+## Interfaces
+
+- [EncryptResult](interfaces/EncryptResult.md)
+- [FieldSpec](interfaces/FieldSpec.md)
+- [FieldSuggestion](interfaces/FieldSuggestion.md)
+- [KeyServerConfig](interfaces/KeyServerConfig.md)
+- [NftGateParams](interfaces/NftGateParams.md)
+- [PolicyDescriptor](interfaces/PolicyDescriptor.md)
+- [SealControllerConfig](interfaces/SealControllerConfig.md)
+- [SealedContentInput](interfaces/SealedContentInput.md)
+- [SealedContentPointer](interfaces/SealedContentPointer.md)
+- [SealedManifest](interfaces/SealedManifest.md)
+- [SealPolicyProvider](interfaces/SealPolicyProvider.md)
+- [SealSuggestClient](interfaces/SealSuggestClient.md)
+- [SuggestContext](interfaces/SuggestContext.md)
+- [TimeLockParams](interfaces/TimeLockParams.md)
+
+## Type Aliases
+
+- [SignPersonalMessage](type-aliases/SignPersonalMessage.md)
+
+## Variables
+
+- [~~nftGateProvider~~](variables/nftGateProvider.md)
+- [timeLockProvider](variables/timeLockProvider.md)
+
+## Functions
+
+- [buildPublishSealedContentTx](functions/buildPublishSealedContentTx.md)
+- [bytesToHex](functions/bytesToHex.md)
+- [concatBytes](functions/concatBytes.md)
+- [createDefaultRegistry](functions/createDefaultRegistry.md)
+- [createNftGateProvider](functions/createNftGateProvider.md)
+- [hexToBytes](functions/hexToBytes.md)
+- [objectIdBytes](functions/objectIdBytes.md)
+- [randomBytes](functions/randomBytes.md)
+- [sealedContentEventType](functions/sealedContentEventType.md)
+- [u64beBytes](functions/u64beBytes.md)

package/docs/sealed-storage/api/interfaces/EncryptResult.md

@@ -0,0 +1,23 @@
+# Interface: EncryptResult
+
+Defined in: controller.ts:35
+
+## Properties
+
+### ciphertext
+
+> **ciphertext**: `Uint8Array`
+
+Defined in: controller.ts:39
+
+The encrypted object bytes to store (e.g. upload to Walrus).
+
+***
+
+### id
+
+> **id**: `string`
+
+Defined in: controller.ts:37
+
+Seal identity (hex, no `0x`) — persist this in the manifest; required verbatim to decrypt.

package/docs/sealed-storage/api/interfaces/FieldSpec.md

@@ -0,0 +1,51 @@
+# Interface: FieldSpec
+
+Defined in: types.ts:42
+
+A single input field a policy needs, used to render encrypt/decrypt forms generically.
+
+## Properties
+
+### help?
+
+> `optional` **help?**: `string`
+
+Defined in: types.ts:50
+
+***
+
+### kind
+
+> **kind**: `"boolean"` \| `"text"` \| `"objectId"` \| `"datetime"`
+
+Defined in: types.ts:48
+
+Rendering/validation hint.
+
+***
+
+### label
+
+> **label**: `string`
+
+Defined in: types.ts:46
+
+Human label for the form.
+
+***
+
+### name
+
+> **name**: `string`
+
+Defined in: types.ts:44
+
+Key in the provider's params object.
+
+***
+
+### required
+
+> **required**: `boolean`
+
+Defined in: types.ts:49

package/docs/sealed-storage/api/interfaces/FieldSuggestion.md

@@ -0,0 +1,21 @@
+# Interface: FieldSuggestion
+
+Defined in: types.ts:4
+
+A suggested value for a policy form field, sourced from chain state.
+
+## Properties
+
+### label
+
+> **label**: `string`
+
+Defined in: types.ts:6
+
+***
+
+### value
+
+> **value**: `string`
+
+Defined in: types.ts:5

package/docs/sealed-storage/api/interfaces/KeyServerConfig.md

@@ -0,0 +1,35 @@
+# Interface: KeyServerConfig
+
+Defined in: controller.ts:8
+
+One key server in the threshold committee.
+
+## Properties
+
+### aggregatorUrl?
+
+> `optional` **aggregatorUrl?**: `string`
+
+Defined in: controller.ts:14
+
+Aggregator URL — required for committee-mode key servers (all fetch-key calls proxy it).
+
+***
+
+### objectId
+
+> **objectId**: `string`
+
+Defined in: controller.ts:10
+
+On-chain key server object id.
+
+***
+
+### weight?
+
+> `optional` **weight?**: `number`
+
+Defined in: controller.ts:12
+
+Contribution toward the threshold (default 1).

package/docs/sealed-storage/api/interfaces/NftGateParams.md

@@ -0,0 +1,33 @@
+# Interface: NftGateParams
+
+Defined in: providers/nft-gate.ts:4
+
+## Properties
+
+### gateId
+
+> **gateId**: `string`
+
+Defined in: providers/nft-gate.ts:6
+
+Access gate shared object id (0x…). Needed to encrypt AND decrypt.
+
+***
+
+### nftId?
+
+> `optional` **nftId?**: `string`
+
+Defined in: providers/nft-gate.ts:8
+
+The holder's pass NFT object id. Needed only to decrypt.
+
+***
+
+### soulbound?
+
+> `optional` **soulbound?**: `boolean`
+
+Defined in: providers/nft-gate.ts:10
+
+Whether the gate mints soulbound passes. Needed only to decrypt.