@meddleware/dev 0.0.1

package/docs/sui/walrus-storage/integration.md

@@ -0,0 +1,127 @@
+# Walrus Storage — Integration guide
+
+## Upload with progress
+
+```ts
+import { WalrusRelayClient } from '@meddleware/walrus-client'
+
+async function uploadFile(
+  walrus: WalrusRelayClient,
+  file: File,
+  epochs = 5,
+  onProgress?: (pct: number) => void,
+): Promise<string> {
+  const result = await walrus.store(file, {
+    epochs,
+    onProgress,
+  })
+  return result.blobId
+}
+```
+
+## Upload with wallet signing (gated relay)
+
+When the relay requires an NFT gate proof, supply a `Transaction` signer:
+
+```ts
+import { useSignAndExecuteTransaction, useCurrentAccount } from '@mysten/dapp-kit'
+
+const account = useCurrentAccount()
+const { mutateAsync: signAndExecute } = useSignAndExecuteTransaction()
+
+const result = await walrus.store(file, {
+  epochs: 5,
+  signer: {
+    address: account.value!.address,
+    signAndExecute: (tx) => signAndExecute({ transaction: tx }),
+  },
+})
+```
+
+The client registers a fresh nonce with the relay, constructs the access-gate proof, submits the transaction, and then uploads the blob — all transparently.
+
+## Read a blob
+
+```ts
+const data = await walrus.read(blobId)
+
+// As a Blob for download
+const blob = new Blob([data])
+const url  = URL.createObjectURL(blob)
+```
+
+## Extend blob lifetime
+
+```ts
+await walrus.extend(blobId, { extraEpochs: 10, signer })
+```
+
+## List owned blobs
+
+```ts
+const blobs = await walrus.listOwned(ownerAddress)
+// BlobInfo[]: blobId, size, expiryEpoch, owner
+```
+
+## Tip estimation
+
+The relay may charge a tip per upload. Estimate the tip before showing a confirmation UI:
+
+```ts
+const estimate = await walrus.estimateTip(file.size, epochs)
+// { tipMist: bigint, relayUrl: string }
+```
+
+Display `estimate.tipMist / 1_000_000_000n` SUI to the user.
+
+## Error handling
+
+```ts
+try {
+  const result = await walrus.store(file, { epochs })
+} catch (err) {
+  if (err instanceof WalrusRelayError) {
+    switch (err.code) {
+      case 'RATE_LIMITED':      // relay rate limit exceeded
+      case 'INSUFFICIENT_FUNDS': // wallet balance too low
+      case 'NFT_GATE_DENIED':   // no valid access-gate pass
+      case 'RELAY_UNAVAILABLE': // relay returned 5xx
+    }
+  }
+  throw err
+}
+```
+
+## Vue composable pattern
+
+```ts
+// composables/useWalrusUpload.ts
+import { ref } from 'vue'
+import { WalrusRelayClient } from '@meddleware/walrus-client'
+
+export function useWalrusUpload(walrus: WalrusRelayClient) {
+  const uploading = ref(false)
+  const progress  = ref(0)
+  const blobId    = ref<string | null>(null)
+  const error     = ref<Error | null>(null)
+
+  async function upload(file: File, epochs = 5) {
+    uploading.value = true
+    progress.value  = 0
+    error.value     = null
+    try {
+      const result = await walrus.store(file, {
+        epochs,
+        onProgress: (pct) => { progress.value = pct },
+      })
+      blobId.value = result.blobId
+    } catch (e) {
+      error.value = e as Error
+    } finally {
+      uploading.value = false
+    }
+  }
+
+  return { uploading, progress, blobId, error, upload }
+}
+```

package/docs/sui/walrus-storage/relay-self-host.md

@@ -0,0 +1,82 @@
+# Self-host a Walrus relay
+
+The Meddleware Walrus relay is an HTTP gateway that accepts blob uploads, pays Walrus storage fees on behalf of the uploader (recovering costs via tips), and optionally gates uploads behind an NFT access pass.
+
+The relay source lives at `repos/walrus-relay-ui/` (frontend) and `services/walrus-relay/` (backend). The backend is a Cloudflare Worker.
+
+## Architecture
+
+```
+Client → CF Worker relay
+               │ tip payment (on-chain)
+               │ Walrus upload (Walrus publisher)
+               └─→ Walrus storage network
+```
+
+The relay:
+1. Receives an upload request with an optional NFT gate proof.
+2. Verifies the proof on-chain (if gate is configured).
+3. Accepts a tip payment via a PTB signed by the client.
+4. Forwards the blob to a Walrus publisher.
+5. Returns the `blobId` to the client.
+
+## Deploying on Cloudflare Workers
+
+### Prerequisites
+
+- A Cloudflare account with Workers enabled.
+- A Sui address funded with enough SUI to cover Walrus storage fees.
+- A Walrus publisher URL (testnet: `https://publisher.walrus-testnet.walrus.space`).
+
+### Configuration
+
+```toml
+# wrangler.toml (in services/walrus-relay/)
+name = "walrus-relay"
+main = "src/index.ts"
+compatibility_date = "2025-01-01"
+
+[vars]
+WALRUS_PUBLISHER_URL = "https://publisher.walrus-testnet.walrus.space"
+WALRUS_AGGREGATOR_URL = "https://aggregator.walrus-testnet.walrus.space"
+SUI_NETWORK = "testnet"
+# Optional: NFT gate contract address for access-gated relay
+NFT_GATE_PACKAGE_ID = ""
+```
+
+Store secrets securely — never commit them:
+
+```bash
+wrangler secret put RELAY_PRIVATE_KEY   # base64-encoded Ed25519 key for tip collection
+wrangler secret put TIP_RECIPIENT       # Sui address that receives tips
+```
+
+### Deploy
+
+```bash
+cd services/walrus-relay
+npm install
+wrangler deploy
+```
+
+### Tip configuration
+
+The relay uses a `tip_config` object to determine the tip amount per byte per epoch. Update this via the DAO or directly in the Worker KV if you run your own relay.
+
+```ts
+const tipConfig = {
+  minTipMist: 1_000_000n,      // minimum tip regardless of size (1 mSUI)
+  perBytePerEpoch: 100n,       // tip in MIST per byte per storage epoch
+  maxEpochs: 52,               // maximum epochs the relay will accept
+}
+```
+
+## Registering your relay URL
+
+To surface your relay in the Meddleware relay picker UI, add it to the relay registry config. The relay must respond to `GET /health` with `{ status: "ok" }`.
+
+::: tip Register fresh, never resume
+The relay embeds a tip+nonce in the register transaction. Never resume a partially-completed registration. Always call the register endpoint fresh — it is idempotent on success.
+:::
+
+<!-- white-label: operator customization guide (custom domain, branding, fee collection address, gate config) — planned -->

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@meddleware/dev",
+  "version": "0.0.1",
+  "description": "Meddleware developer documentation site (dev.meddleware.co.uk) — VitePress. Integration guides, design system usage, and Sui development patterns.",
+  "homepage": "https://dev.meddleware.co.uk/",
+  "author": "Meddleware <dev@meddleware.co.uk>",
+  "license": "0BSD",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/meddleware-org/dev.git"
+  },
+  "type": "module",
+  "files": [
+    "docs",
+    "tsconfig.json",
+    "CHANGELOG.md"
+  ],
+  "scripts": {
+    "dev": "vitepress dev docs",
+    "build": "vitepress build docs",
+    "preview": "vitepress preview docs",
+    "type-check": "tsc --noEmit"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@meddleware/design-tokens": "^0.1.3"
+  },
+  "devDependencies": {
+    "@types/node": "~24.12.2",
+    "typescript": "~6.0.0",
+    "vitepress": "2.0.0-alpha.20",
+    "vue": "^3.5.43"
+  },
+  "engines": {
+    "node": "^22.18.0 || >=24.12.0"
+  }
+}

package/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "resolveJsonModule": true,
+    "types": ["node"]
+  },
+  "include": ["docs/.vitepress/**/*.ts"]
+}