@meddleware/docs 0.0.2 → 0.0.3

package/docs/index.md

@@ -3,56 +3,23 @@ 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.
+  text: Developer tools for decentralised applications
+  tagline: Explore our tools — built to work with leading blockchain ecosystems. Sui available now, with more to come.
   actions:
     - theme: brand
-      text: Get started
-      link: /getting-started
+      text: Explore Sui tools
+      link: /blockchain/sui/
     - theme: alt
-      text: How they fit together
-      link: /architecture
+      text: Blockchains
+      link: /blockchain/
 
 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
+  - title: Sui
+    details: Decentralised storage, threshold encryption, NFT access control, and a transparent DAO console — four tools, one connected platform. Available now on testnet.
+    link: /blockchain/sui/
+    linkText: Explore
+  - title: More blockchains
+    details: Additional blockchain ecosystems are in the works. The platform is designed from the ground up to be blockchain-agnostic.
+    link: /blockchain/
+    linkText: Coming soon
 ---
-
-## 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/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@meddleware/docs",
-  "version": "0.0.2",
-  "description": "Meddleware user documentation site (docs.meddleware.co.uk) — VitePress. Explains the DAO, Walrus Storage, Sealed Storage, and Access Gate: what each is, how to use it, and when.",
+  "version": "0.0.3",
+  "description": "Meddleware developer tools documentation site (docs.meddleware.co.uk) — VitePress. Blockchain-agnostic with Sui as the first active chain.",
   "author": "Meddleware <dev@meddleware.co.uk>",
   "license": "0BSD",
   "repository": {

package/scripts/gen-api.mjs

@@ -21,9 +21,9 @@ const docsRoot = join(root, 'docs')
 
 // Each SDK → where its generated reference lands under docs/.
 const targets = [
-  { pkg: '@meddleware/walrus-client', out: 'walrus-storage/api', name: 'Walrus client API' },
-  { pkg: '@meddleware/seal-client', out: 'sealed-storage/api', name: 'Seal client API' },
-  { pkg: '@meddleware/nft-gate-client', out: 'access-gate/api', name: 'NFT-gate client API' },
+  { pkg: '@meddleware/walrus-client', out: 'blockchain/sui/walrus-storage/api', name: 'Walrus client API' },
+  { pkg: '@meddleware/seal-client', out: 'blockchain/sui/sealed-storage/api', name: 'Seal client API' },
+  { pkg: '@meddleware/nft-gate-client', out: 'blockchain/sui/access-gate/api', name: 'NFT-gate client API' },
 ]
 
 // Resolve the SDK's TypeScript entry. These packages export their `.` as `./src/index.ts`

package/docs/access-gate/api/typedoc-sidebar.json

@@ -1 +0,0 @@
-[{"text":"Interfaces","collapsed":true,"items":[{"text":"AccessGateConfig","link":"/docs/access-gate/api/interfaces/AccessGateConfig.md"},{"text":"AccessProof","link":"/docs/access-gate/api/interfaces/AccessProof.md"},{"text":"Challenge","link":"/docs/access-gate/api/interfaces/Challenge.md"},{"text":"GateAdminContext","link":"/docs/access-gate/api/interfaces/GateAdminContext.md"},{"text":"OwnedAccessNft","link":"/docs/access-gate/api/interfaces/OwnedAccessNft.md"},{"text":"OwnedGate","link":"/docs/access-gate/api/interfaces/OwnedGate.md"},{"text":"OwnedObjectsClient","link":"/docs/access-gate/api/interfaces/OwnedObjectsClient.md"},{"text":"SuiObjectClient","link":"/docs/access-gate/api/interfaces/SuiObjectClient.md"}]},{"text":"Type Aliases","collapsed":true,"items":[{"text":"PersonalMessageSigner","link":"/docs/access-gate/api/type-aliases/PersonalMessageSigner.md"}]},{"text":"Functions","collapsed":true,"items":[{"text":"buildAccessProof","link":"/docs/access-gate/api/functions/buildAccessProof.md"},{"text":"buildAirdropTx","link":"/docs/access-gate/api/functions/buildAirdropTx.md"},{"text":"buildConsumeTx","link":"/docs/access-gate/api/functions/buildConsumeTx.md"},{"text":"buildCreateGateTx","link":"/docs/access-gate/api/functions/buildCreateGateTx.md"},{"text":"buildMakeGateImmutableTx","link":"/docs/access-gate/api/functions/buildMakeGateImmutableTx.md"},{"text":"buildPurchaseTx","link":"/docs/access-gate/api/functions/buildPurchaseTx.md"},{"text":"buildSetAutoBurnAtZeroTx","link":"/docs/access-gate/api/functions/buildSetAutoBurnAtZeroTx.md"},{"text":"buildSetDefaultUsesTx","link":"/docs/access-gate/api/functions/buildSetDefaultUsesTx.md"},{"text":"buildSetNftDescriptionTx","link":"/docs/access-gate/api/functions/buildSetNftDescriptionTx.md"},{"text":"buildSetNftImageUrlTx","link":"/docs/access-gate/api/functions/buildSetNftImageUrlTx.md"},{"text":"buildSetNftNameTx","link":"/docs/access-gate/api/functions/buildSetNftNameTx.md"},{"text":"buildSetPausedTx","link":"/docs/access-gate/api/functions/buildSetPausedTx.md"},{"text":"buildSetPaymentRecipientTx","link":"/docs/access-gate/api/functions/buildSetPaymentRecipientTx.md"},{"text":"buildSetPriceTx","link":"/docs/access-gate/api/functions/buildSetPriceTx.md"},{"text":"buildSetSoulboundTx","link":"/docs/access-gate/api/functions/buildSetSoulboundTx.md"},{"text":"decodeAccessProof","link":"/docs/access-gate/api/functions/decodeAccessProof.md"},{"text":"encodeAccessProof","link":"/docs/access-gate/api/functions/encodeAccessProof.md"},{"text":"fetchAccessNftById","link":"/docs/access-gate/api/functions/fetchAccessNftById.md"},{"text":"fetchAccessNfts","link":"/docs/access-gate/api/functions/fetchAccessNfts.md"},{"text":"fetchAdminCaps","link":"/docs/access-gate/api/functions/fetchAdminCaps.md"},{"text":"fetchChallenge","link":"/docs/access-gate/api/functions/fetchChallenge.md"},{"text":"fetchGate","link":"/docs/access-gate/api/functions/fetchGate.md"},{"text":"fetchOwnedGates","link":"/docs/access-gate/api/functions/fetchOwnedGates.md"},{"text":"ownsAccessNft","link":"/docs/access-gate/api/functions/ownsAccessNft.md"},{"text":"parseAdminCap","link":"/docs/access-gate/api/functions/parseAdminCap.md"},{"text":"parseGate","link":"/docs/access-gate/api/functions/parseGate.md"},{"text":"parseOwnedAccessNft","link":"/docs/access-gate/api/functions/parseOwnedAccessNft.md"},{"text":"personalMessageForNonce","link":"/docs/access-gate/api/functions/personalMessageForNonce.md"}]}]

package/docs/sealed-storage/api/typedoc-sidebar.json

@@ -1 +0,0 @@
-[{"text":"Classes","collapsed":true,"items":[{"text":"PolicyRegistry","link":"/docs/sealed-storage/api/classes/PolicyRegistry.md"},{"text":"SealController","link":"/docs/sealed-storage/api/classes/SealController.md"}]},{"text":"Interfaces","collapsed":true,"items":[{"text":"EncryptResult","link":"/docs/sealed-storage/api/interfaces/EncryptResult.md"},{"text":"FieldSpec","link":"/docs/sealed-storage/api/interfaces/FieldSpec.md"},{"text":"FieldSuggestion","link":"/docs/sealed-storage/api/interfaces/FieldSuggestion.md"},{"text":"KeyServerConfig","link":"/docs/sealed-storage/api/interfaces/KeyServerConfig.md"},{"text":"NftGateParams","link":"/docs/sealed-storage/api/interfaces/NftGateParams.md"},{"text":"PolicyDescriptor","link":"/docs/sealed-storage/api/interfaces/PolicyDescriptor.md"},{"text":"SealControllerConfig","link":"/docs/sealed-storage/api/interfaces/SealControllerConfig.md"},{"text":"SealedContentInput","link":"/docs/sealed-storage/api/interfaces/SealedContentInput.md"},{"text":"SealedContentPointer","link":"/docs/sealed-storage/api/interfaces/SealedContentPointer.md"},{"text":"SealedManifest","link":"/docs/sealed-storage/api/interfaces/SealedManifest.md"},{"text":"SealPolicyProvider","link":"/docs/sealed-storage/api/interfaces/SealPolicyProvider.md"},{"text":"SealSuggestClient","link":"/docs/sealed-storage/api/interfaces/SealSuggestClient.md"},{"text":"SuggestContext","link":"/docs/sealed-storage/api/interfaces/SuggestContext.md"},{"text":"TimeLockParams","link":"/docs/sealed-storage/api/interfaces/TimeLockParams.md"}]},{"text":"Type Aliases","collapsed":true,"items":[{"text":"SignPersonalMessage","link":"/docs/sealed-storage/api/type-aliases/SignPersonalMessage.md"}]},{"text":"Variables","collapsed":true,"items":[{"text":"nftGateProvider","link":"/docs/sealed-storage/api/variables/nftGateProvider.md"},{"text":"timeLockProvider","link":"/docs/sealed-storage/api/variables/timeLockProvider.md"}]},{"text":"Functions","collapsed":true,"items":[{"text":"buildPublishSealedContentTx","link":"/docs/sealed-storage/api/functions/buildPublishSealedContentTx.md"},{"text":"bytesToHex","link":"/docs/sealed-storage/api/functions/bytesToHex.md"},{"text":"concatBytes","link":"/docs/sealed-storage/api/functions/concatBytes.md"},{"text":"createDefaultRegistry","link":"/docs/sealed-storage/api/functions/createDefaultRegistry.md"},{"text":"createNftGateProvider","link":"/docs/sealed-storage/api/functions/createNftGateProvider.md"},{"text":"hexToBytes","link":"/docs/sealed-storage/api/functions/hexToBytes.md"},{"text":"objectIdBytes","link":"/docs/sealed-storage/api/functions/objectIdBytes.md"},{"text":"randomBytes","link":"/docs/sealed-storage/api/functions/randomBytes.md"},{"text":"sealedContentEventType","link":"/docs/sealed-storage/api/functions/sealedContentEventType.md"},{"text":"u64beBytes","link":"/docs/sealed-storage/api/functions/u64beBytes.md"}]}]

package/docs/walrus-storage/api/typedoc-sidebar.json

@@ -1 +0,0 @@
-[{"text":"Classes","collapsed":true,"items":[{"text":"RetryableWalrusClientError","link":"/docs/walrus-storage/api/classes/RetryableWalrusClientError.md"},{"text":"WalrusFile","link":"/docs/walrus-storage/api/classes/WalrusFile.md"}]},{"text":"Interfaces","collapsed":true,"items":[{"text":"CertifyOptions","link":"/docs/walrus-storage/api/interfaces/CertifyOptions.md"},{"text":"StorageCost","link":"/docs/walrus-storage/api/interfaces/StorageCost.md"}]},{"text":"Type Aliases","collapsed":true,"items":[{"text":"AccessProofInput","link":"/docs/walrus-storage/api/type-aliases/AccessProofInput.md"},{"text":"CreateWalrusClientOptions","link":"/docs/walrus-storage/api/type-aliases/CreateWalrusClientOptions.md"},{"text":"ExtendOptions","link":"/docs/walrus-storage/api/type-aliases/ExtendOptions.md"},{"text":"OwnedBlob","link":"/docs/walrus-storage/api/type-aliases/OwnedBlob.md"},{"text":"PersonalMessageSigner","link":"/docs/walrus-storage/api/type-aliases/PersonalMessageSigner.md"},{"text":"RelayChallenge","link":"/docs/walrus-storage/api/type-aliases/RelayChallenge.md"},{"text":"UploadOptions","link":"/docs/walrus-storage/api/type-aliases/UploadOptions.md"},{"text":"UploadResult","link":"/docs/walrus-storage/api/type-aliases/UploadResult.md"},{"text":"WalrusClient","link":"/docs/walrus-storage/api/type-aliases/WalrusClient.md"},{"text":"WalrusNetwork","link":"/docs/walrus-storage/api/type-aliases/WalrusNetwork.md"}]},{"text":"Variables","collapsed":true,"items":[{"text":"DEFAULT_RPC_URLS","link":"/docs/walrus-storage/api/variables/DEFAULT_RPC_URLS.md"},{"text":"LONG_TERM_EPOCHS","link":"/docs/walrus-storage/api/variables/LONG_TERM_EPOCHS.md"},{"text":"MAINNET_WALRUS_PACKAGE_CONFIG","link":"/docs/walrus-storage/api/variables/MAINNET_WALRUS_PACKAGE_CONFIG.md"},{"text":"PUBLIC_UPLOAD_RELAY_HOSTS","link":"/docs/walrus-storage/api/variables/PUBLIC_UPLOAD_RELAY_HOSTS.md"},{"text":"TESTNET_WALRUS_PACKAGE_CONFIG","link":"/docs/walrus-storage/api/variables/TESTNET_WALRUS_PACKAGE_CONFIG.md"},{"text":"WALRUS_AGGREGATOR_HOSTS","link":"/docs/walrus-storage/api/variables/WALRUS_AGGREGATOR_HOSTS.md"}]},{"text":"Functions","collapsed":true,"items":[{"text":"buildAccessProofToken","link":"/docs/walrus-storage/api/functions/buildAccessProofToken.md"},{"text":"certifyBlobTransaction","link":"/docs/walrus-storage/api/functions/certifyBlobTransaction.md"},{"text":"createBlobUploadFlow","link":"/docs/walrus-storage/api/functions/createBlobUploadFlow.md"},{"text":"createRelayAccessToken","link":"/docs/walrus-storage/api/functions/createRelayAccessToken.md"},{"text":"createUploadFlow","link":"/docs/walrus-storage/api/functions/createUploadFlow.md"},{"text":"createWalrusClient","link":"/docs/walrus-storage/api/functions/createWalrusClient.md"},{"text":"estimateStorageCost","link":"/docs/walrus-storage/api/functions/estimateStorageCost.md"},{"text":"extendBlobLifetime","link":"/docs/walrus-storage/api/functions/extendBlobLifetime.md"},{"text":"extendBlobLifetimeTransaction","link":"/docs/walrus-storage/api/functions/extendBlobLifetimeTransaction.md"},{"text":"fetchOwnedWalrusBlobs","link":"/docs/walrus-storage/api/functions/fetchOwnedWalrusBlobs.md"},{"text":"fetchRelayChallenge","link":"/docs/walrus-storage/api/functions/fetchRelayChallenge.md"},{"text":"getWalrusPackageConfig","link":"/docs/walrus-storage/api/functions/getWalrusPackageConfig.md"},{"text":"personalMessageForNonce","link":"/docs/walrus-storage/api/functions/personalMessageForNonce.md"},{"text":"readBlobAttributes","link":"/docs/walrus-storage/api/functions/readBlobAttributes.md"},{"text":"setBlobAttributes","link":"/docs/walrus-storage/api/functions/setBlobAttributes.md"},{"text":"setBlobAttributesTransaction","link":"/docs/walrus-storage/api/functions/setBlobAttributesTransaction.md"},{"text":"uploadBytes","link":"/docs/walrus-storage/api/functions/uploadBytes.md"},{"text":"uploadImageBytes","link":"/docs/walrus-storage/api/functions/uploadImageBytes.md"},{"text":"uploadLocalFile","link":"/docs/walrus-storage/api/functions/uploadLocalFile.md"},{"text":"walrusBlobUrl","link":"/docs/walrus-storage/api/functions/walrusBlobUrl.md"}]}]