@meddleware/docs 0.0.3 → 0.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (27) hide show
  1. package/CHANGELOG.md +9 -0
  2. package/docs/.vitepress/config.ts +3 -3
  3. package/docs/blockchain/sui/access-gate/api/index.md +1 -0
  4. package/docs/blockchain/sui/access-gate/api/interfaces/CoreObject.md +31 -0
  5. package/docs/blockchain/sui/access-gate/api/interfaces/OwnedObjectsClient.md +2 -2
  6. package/docs/blockchain/sui/access-gate/api/interfaces/SuiObjectClient.md +2 -2
  7. package/docs/blockchain/sui/access-gate/api/typedoc-sidebar.json +1 -1
  8. package/docs/blockchain/sui/access-gate/index.md +1 -1
  9. package/docs/blockchain/sui/access-gate/reference.md +1 -1
  10. package/docs/blockchain/sui/access-gate/{using.md → walkthrough.md} +1 -1
  11. package/docs/blockchain/sui/dao/index.md +1 -1
  12. package/docs/blockchain/sui/dao/reference.md +1 -7
  13. package/docs/blockchain/sui/sealed-storage/index.md +1 -1
  14. package/docs/blockchain/sui/sealed-storage/policies.md +1 -1
  15. package/docs/blockchain/sui/sealed-storage/reference.md +1 -1
  16. package/docs/blockchain/sui/sealed-storage/{using.md → walkthrough.md} +1 -1
  17. package/docs/blockchain/sui/walrus-storage/api/index.md +2 -0
  18. package/docs/blockchain/sui/walrus-storage/api/type-aliases/CreateWalrusClientOptions.md +1 -1
  19. package/docs/blockchain/sui/walrus-storage/api/type-aliases/UploadOptions.md +1 -1
  20. package/docs/blockchain/sui/walrus-storage/api/type-aliases/WalrusClientNetwork.md +8 -0
  21. package/docs/blockchain/sui/walrus-storage/api/typedoc-sidebar.json +1 -1
  22. package/docs/blockchain/sui/walrus-storage/api/variables/LONG_TERM_EPOCHS.md +1 -1
  23. package/docs/blockchain/sui/walrus-storage/api/variables/MAX_SINGLE_RESERVATION_EPOCHS.md +10 -0
  24. package/docs/blockchain/sui/walrus-storage/index.md +1 -1
  25. package/docs/blockchain/sui/walrus-storage/reference.md +1 -1
  26. package/docs/blockchain/sui/walrus-storage/{using.md → walkthrough.md} +1 -1
  27. package/package.json +3 -3
package/CHANGELOG.md CHANGED
@@ -2,6 +2,15 @@
2
2
 
3
3
  All notable changes to `@meddleware/docs` are documented here.
4
4
 
5
+ ## [0.0.4] — 2026-09-17
6
+
7
+ Heading cleanup and naming improvements.
8
+
9
+ - Renamed `using.md` → `walkthrough.md` across all three tool sections (Walrus Storage, Sealed Storage, Access Gate); URLs updated accordingly
10
+ - Replaced all `# Feature — noun` H1 patterns with clean unhyphenated titles (`# Using Walrus Storage`, `# DAO reference`, `# Sealed Storage policies`, etc.)
11
+ - Sidebar and "Next" section links updated to "Walkthrough"
12
+ - Removed "fundraising/" qualifier from DAO governance placeholder copy
13
+
5
14
  ## [0.0.3] — 2026-09-17
6
15
 
7
16
  Restructured to a blockchain-agnostic architecture with Sui as the first active chain.
@@ -73,7 +73,7 @@ export default defineConfig({
73
73
  collapsed: false,
74
74
  items: [
75
75
  { text: 'Overview', link: '/blockchain/sui/walrus-storage/' },
76
- { text: 'Using it', link: '/blockchain/sui/walrus-storage/using' },
76
+ { text: 'Walkthrough', link: '/blockchain/sui/walrus-storage/walkthrough' },
77
77
  { text: 'Reference', link: '/blockchain/sui/walrus-storage/reference' },
78
78
  ],
79
79
  },
@@ -82,7 +82,7 @@ export default defineConfig({
82
82
  collapsed: false,
83
83
  items: [
84
84
  { text: 'Overview', link: '/blockchain/sui/sealed-storage/' },
85
- { text: 'Using it', link: '/blockchain/sui/sealed-storage/using' },
85
+ { text: 'Walkthrough', link: '/blockchain/sui/sealed-storage/walkthrough' },
86
86
  { text: 'Policies', link: '/blockchain/sui/sealed-storage/policies' },
87
87
  { text: 'Reference', link: '/blockchain/sui/sealed-storage/reference' },
88
88
  ],
@@ -92,7 +92,7 @@ export default defineConfig({
92
92
  collapsed: false,
93
93
  items: [
94
94
  { text: 'Overview', link: '/blockchain/sui/access-gate/' },
95
- { text: 'Using it', link: '/blockchain/sui/access-gate/using' },
95
+ { text: 'Walkthrough', link: '/blockchain/sui/access-gate/walkthrough' },
96
96
  { text: 'Reference', link: '/blockchain/sui/access-gate/reference' },
97
97
  ],
98
98
  },
@@ -5,6 +5,7 @@
5
5
  - [AccessGateConfig](interfaces/AccessGateConfig.md)
6
6
  - [AccessProof](interfaces/AccessProof.md)
7
7
  - [Challenge](interfaces/Challenge.md)
8
+ - [CoreObject](interfaces/CoreObject.md)
8
9
  - [GateAdminContext](interfaces/GateAdminContext.md)
9
10
  - [OwnedAccessNft](interfaces/OwnedAccessNft.md)
10
11
  - [OwnedGate](interfaces/OwnedGate.md)
@@ -0,0 +1,31 @@
1
+ # Interface: CoreObject
2
+
3
+ Defined in: types.ts:104
4
+
5
+ A single owned/read object as returned by the unified core API (`SuiGrpcClient`): the id and
6
+ Move struct type are top-level; the struct fields come back under `json` (opt-in). Kept as a
7
+ structural subset so any client exposing the core API satisfies it without importing the SDK.
8
+
9
+ ## Properties
10
+
11
+ ### json?
12
+
13
+ > `optional` **json?**: `Record`\<`string`, `unknown`\>
14
+
15
+ Defined in: types.ts:107
16
+
17
+ ***
18
+
19
+ ### objectId
20
+
21
+ > **objectId**: `string`
22
+
23
+ Defined in: types.ts:105
24
+
25
+ ***
26
+
27
+ ### type?
28
+
29
+ > `optional` **type?**: `string`
30
+
31
+ Defined in: types.ts:106
@@ -14,7 +14,7 @@ Defined in: types.ts:112
14
14
 
15
15
  #### listOwnedObjects()
16
16
 
17
- > **listOwnedObjects**(`options`): `Promise`\<\{ `cursor`: `string`; `hasNextPage`: `boolean`; `objects`: `CoreObject`[]; \}\>
17
+ > **listOwnedObjects**(`options`): `Promise`\<\{ `cursor`: `string`; `hasNextPage`: `boolean`; `objects`: [`CoreObject`](CoreObject.md)[]; \}\>
18
18
 
19
19
  ##### Parameters
20
20
 
@@ -46,4 +46,4 @@ Defined in: types.ts:112
46
46
 
47
47
  ##### Returns
48
48
 
49
- `Promise`\<\{ `cursor`: `string`; `hasNextPage`: `boolean`; `objects`: `CoreObject`[]; \}\>
49
+ `Promise`\<\{ `cursor`: `string`; `hasNextPage`: `boolean`; `objects`: [`CoreObject`](CoreObject.md)[]; \}\>
@@ -14,7 +14,7 @@ Defined in: types.ts:125
14
14
 
15
15
  #### getObject()
16
16
 
17
- > **getObject**(`options`): `Promise`\<\{ `object`: `CoreObject`; \}\>
17
+ > **getObject**(`options`): `Promise`\<\{ `object`: [`CoreObject`](CoreObject.md); \}\>
18
18
 
19
19
  ##### Parameters
20
20
 
@@ -34,4 +34,4 @@ Defined in: types.ts:125
34
34
 
35
35
  ##### Returns
36
36
 
37
- `Promise`\<\{ `object`: `CoreObject`; \}\>
37
+ `Promise`\<\{ `object`: [`CoreObject`](CoreObject.md); \}\>
@@ -1 +1 @@
1
- [{"text":"Interfaces","collapsed":true,"items":[{"text":"AccessGateConfig","link":"/docs/blockchain/sui/access-gate/api/interfaces/AccessGateConfig.md"},{"text":"AccessProof","link":"/docs/blockchain/sui/access-gate/api/interfaces/AccessProof.md"},{"text":"Challenge","link":"/docs/blockchain/sui/access-gate/api/interfaces/Challenge.md"},{"text":"GateAdminContext","link":"/docs/blockchain/sui/access-gate/api/interfaces/GateAdminContext.md"},{"text":"OwnedAccessNft","link":"/docs/blockchain/sui/access-gate/api/interfaces/OwnedAccessNft.md"},{"text":"OwnedGate","link":"/docs/blockchain/sui/access-gate/api/interfaces/OwnedGate.md"},{"text":"OwnedObjectsClient","link":"/docs/blockchain/sui/access-gate/api/interfaces/OwnedObjectsClient.md"},{"text":"SuiObjectClient","link":"/docs/blockchain/sui/access-gate/api/interfaces/SuiObjectClient.md"}]},{"text":"Type Aliases","collapsed":true,"items":[{"text":"PersonalMessageSigner","link":"/docs/blockchain/sui/access-gate/api/type-aliases/PersonalMessageSigner.md"}]},{"text":"Functions","collapsed":true,"items":[{"text":"buildAccessProof","link":"/docs/blockchain/sui/access-gate/api/functions/buildAccessProof.md"},{"text":"buildAirdropTx","link":"/docs/blockchain/sui/access-gate/api/functions/buildAirdropTx.md"},{"text":"buildConsumeTx","link":"/docs/blockchain/sui/access-gate/api/functions/buildConsumeTx.md"},{"text":"buildCreateGateTx","link":"/docs/blockchain/sui/access-gate/api/functions/buildCreateGateTx.md"},{"text":"buildMakeGateImmutableTx","link":"/docs/blockchain/sui/access-gate/api/functions/buildMakeGateImmutableTx.md"},{"text":"buildPurchaseTx","link":"/docs/blockchain/sui/access-gate/api/functions/buildPurchaseTx.md"},{"text":"buildSetAutoBurnAtZeroTx","link":"/docs/blockchain/sui/access-gate/api/functions/buildSetAutoBurnAtZeroTx.md"},{"text":"buildSetDefaultUsesTx","link":"/docs/blockchain/sui/access-gate/api/functions/buildSetDefaultUsesTx.md"},{"text":"buildSetNftDescriptionTx","link":"/docs/blockchain/sui/access-gate/api/functions/buildSetNftDescriptionTx.md"},{"text":"buildSetNftImageUrlTx","link":"/docs/blockchain/sui/access-gate/api/functions/buildSetNftImageUrlTx.md"},{"text":"buildSetNftNameTx","link":"/docs/blockchain/sui/access-gate/api/functions/buildSetNftNameTx.md"},{"text":"buildSetPausedTx","link":"/docs/blockchain/sui/access-gate/api/functions/buildSetPausedTx.md"},{"text":"buildSetPaymentRecipientTx","link":"/docs/blockchain/sui/access-gate/api/functions/buildSetPaymentRecipientTx.md"},{"text":"buildSetPriceTx","link":"/docs/blockchain/sui/access-gate/api/functions/buildSetPriceTx.md"},{"text":"buildSetSoulboundTx","link":"/docs/blockchain/sui/access-gate/api/functions/buildSetSoulboundTx.md"},{"text":"decodeAccessProof","link":"/docs/blockchain/sui/access-gate/api/functions/decodeAccessProof.md"},{"text":"encodeAccessProof","link":"/docs/blockchain/sui/access-gate/api/functions/encodeAccessProof.md"},{"text":"fetchAccessNftById","link":"/docs/blockchain/sui/access-gate/api/functions/fetchAccessNftById.md"},{"text":"fetchAccessNfts","link":"/docs/blockchain/sui/access-gate/api/functions/fetchAccessNfts.md"},{"text":"fetchAdminCaps","link":"/docs/blockchain/sui/access-gate/api/functions/fetchAdminCaps.md"},{"text":"fetchChallenge","link":"/docs/blockchain/sui/access-gate/api/functions/fetchChallenge.md"},{"text":"fetchGate","link":"/docs/blockchain/sui/access-gate/api/functions/fetchGate.md"},{"text":"fetchOwnedGates","link":"/docs/blockchain/sui/access-gate/api/functions/fetchOwnedGates.md"},{"text":"ownsAccessNft","link":"/docs/blockchain/sui/access-gate/api/functions/ownsAccessNft.md"},{"text":"parseAdminCap","link":"/docs/blockchain/sui/access-gate/api/functions/parseAdminCap.md"},{"text":"parseGate","link":"/docs/blockchain/sui/access-gate/api/functions/parseGate.md"},{"text":"parseOwnedAccessNft","link":"/docs/blockchain/sui/access-gate/api/functions/parseOwnedAccessNft.md"},{"text":"personalMessageForNonce","link":"/docs/blockchain/sui/access-gate/api/functions/personalMessageForNonce.md"}]}]
1
+ [{"text":"Interfaces","collapsed":true,"items":[{"text":"AccessGateConfig","link":"/docs/blockchain/sui/access-gate/api/interfaces/AccessGateConfig.md"},{"text":"AccessProof","link":"/docs/blockchain/sui/access-gate/api/interfaces/AccessProof.md"},{"text":"Challenge","link":"/docs/blockchain/sui/access-gate/api/interfaces/Challenge.md"},{"text":"CoreObject","link":"/docs/blockchain/sui/access-gate/api/interfaces/CoreObject.md"},{"text":"GateAdminContext","link":"/docs/blockchain/sui/access-gate/api/interfaces/GateAdminContext.md"},{"text":"OwnedAccessNft","link":"/docs/blockchain/sui/access-gate/api/interfaces/OwnedAccessNft.md"},{"text":"OwnedGate","link":"/docs/blockchain/sui/access-gate/api/interfaces/OwnedGate.md"},{"text":"OwnedObjectsClient","link":"/docs/blockchain/sui/access-gate/api/interfaces/OwnedObjectsClient.md"},{"text":"SuiObjectClient","link":"/docs/blockchain/sui/access-gate/api/interfaces/SuiObjectClient.md"}]},{"text":"Type Aliases","collapsed":true,"items":[{"text":"PersonalMessageSigner","link":"/docs/blockchain/sui/access-gate/api/type-aliases/PersonalMessageSigner.md"}]},{"text":"Functions","collapsed":true,"items":[{"text":"buildAccessProof","link":"/docs/blockchain/sui/access-gate/api/functions/buildAccessProof.md"},{"text":"buildAirdropTx","link":"/docs/blockchain/sui/access-gate/api/functions/buildAirdropTx.md"},{"text":"buildConsumeTx","link":"/docs/blockchain/sui/access-gate/api/functions/buildConsumeTx.md"},{"text":"buildCreateGateTx","link":"/docs/blockchain/sui/access-gate/api/functions/buildCreateGateTx.md"},{"text":"buildMakeGateImmutableTx","link":"/docs/blockchain/sui/access-gate/api/functions/buildMakeGateImmutableTx.md"},{"text":"buildPurchaseTx","link":"/docs/blockchain/sui/access-gate/api/functions/buildPurchaseTx.md"},{"text":"buildSetAutoBurnAtZeroTx","link":"/docs/blockchain/sui/access-gate/api/functions/buildSetAutoBurnAtZeroTx.md"},{"text":"buildSetDefaultUsesTx","link":"/docs/blockchain/sui/access-gate/api/functions/buildSetDefaultUsesTx.md"},{"text":"buildSetNftDescriptionTx","link":"/docs/blockchain/sui/access-gate/api/functions/buildSetNftDescriptionTx.md"},{"text":"buildSetNftImageUrlTx","link":"/docs/blockchain/sui/access-gate/api/functions/buildSetNftImageUrlTx.md"},{"text":"buildSetNftNameTx","link":"/docs/blockchain/sui/access-gate/api/functions/buildSetNftNameTx.md"},{"text":"buildSetPausedTx","link":"/docs/blockchain/sui/access-gate/api/functions/buildSetPausedTx.md"},{"text":"buildSetPaymentRecipientTx","link":"/docs/blockchain/sui/access-gate/api/functions/buildSetPaymentRecipientTx.md"},{"text":"buildSetPriceTx","link":"/docs/blockchain/sui/access-gate/api/functions/buildSetPriceTx.md"},{"text":"buildSetSoulboundTx","link":"/docs/blockchain/sui/access-gate/api/functions/buildSetSoulboundTx.md"},{"text":"decodeAccessProof","link":"/docs/blockchain/sui/access-gate/api/functions/decodeAccessProof.md"},{"text":"encodeAccessProof","link":"/docs/blockchain/sui/access-gate/api/functions/encodeAccessProof.md"},{"text":"fetchAccessNftById","link":"/docs/blockchain/sui/access-gate/api/functions/fetchAccessNftById.md"},{"text":"fetchAccessNfts","link":"/docs/blockchain/sui/access-gate/api/functions/fetchAccessNfts.md"},{"text":"fetchAdminCaps","link":"/docs/blockchain/sui/access-gate/api/functions/fetchAdminCaps.md"},{"text":"fetchChallenge","link":"/docs/blockchain/sui/access-gate/api/functions/fetchChallenge.md"},{"text":"fetchGate","link":"/docs/blockchain/sui/access-gate/api/functions/fetchGate.md"},{"text":"fetchOwnedGates","link":"/docs/blockchain/sui/access-gate/api/functions/fetchOwnedGates.md"},{"text":"ownsAccessNft","link":"/docs/blockchain/sui/access-gate/api/functions/ownsAccessNft.md"},{"text":"parseAdminCap","link":"/docs/blockchain/sui/access-gate/api/functions/parseAdminCap.md"},{"text":"parseGate","link":"/docs/blockchain/sui/access-gate/api/functions/parseGate.md"},{"text":"parseOwnedAccessNft","link":"/docs/blockchain/sui/access-gate/api/functions/parseOwnedAccessNft.md"},{"text":"personalMessageForNonce","link":"/docs/blockchain/sui/access-gate/api/functions/personalMessageForNonce.md"}]}]
@@ -56,6 +56,6 @@ treasury; the rest goes to the operator. The rate is set in shared on-chain conf
56
56
 
57
57
  ## Next
58
58
 
59
- - **[Using it](/blockchain/sui/access-gate/using)** — create and manage a gate; buy and use a pass.
59
+ - **[Walkthrough](/blockchain/sui/access-gate/walkthrough)** — create and manage a gate; buy and use a pass.
60
60
  - **[Reference](/blockchain/sui/access-gate/reference)** — objects, entry functions, events, the gateway, and the
61
61
  SDK API.
@@ -1,4 +1,4 @@
1
- # Access Gate reference
1
+ # Access Gate reference
2
2
 
3
3
  The on-chain `access_gate` contract, its gateway, and the client SDK. Move tables are curated from
4
4
  source; the TypeScript SDK reference is [auto-generated](#sdk-api).
@@ -1,4 +1,4 @@
1
- # Access Gate — using it
1
+ # Using Access Gate
2
2
 
3
3
  Two audiences: **operators** who run gates, and **buyers** who hold passes.
4
4
 
@@ -41,7 +41,7 @@ name, price, and object ID (linked to a Sui explorer).
41
41
  ### Proposals
42
42
 
43
43
  Reserved for on-chain governance proposals. This is a **placeholder** today — the governance module
44
- isn't deployed yet, so the tab shows an empty state. It will list fundraising/governance proposals
44
+ isn't deployed yet, so the tab shows an empty state. It will list governance proposals
45
45
  when that module ships.
46
46
 
47
47
  ### Governance
@@ -1,4 +1,4 @@
1
- # DAO reference
1
+ # DAO reference
2
2
 
3
3
  Shapes and identifiers the DAO console reads. These are **on-chain** objects and events from the
4
4
  `access_gate` package; the console only displays them.
@@ -81,12 +81,6 @@ Example (as decoded JSON):
81
81
  The console queries each event type independently and merges them, sorted by checkpoint
82
82
  (newest first), tolerating any single type being pruned or unavailable.
83
83
 
84
- ## Roadmap: `vault_dao`
85
-
86
- The **Proposals** and **Governance actions** are placeholders pending an on-chain `vault_dao` module.
87
- When it ships, proposals will be read from its registry; the console's display shapes are already
88
- stable so wiring it in won't change the UI.
89
-
90
84
  ::: tip Developer note
91
85
  Full SDK/contract API reference (entry functions, exhaustive event schemas) is covered in the
92
86
  forthcoming developer documentation. The [Access Gate reference](/blockchain/sui/access-gate/reference) already
@@ -63,6 +63,6 @@ committee is available — the app shows a clear notice until then.
63
63
 
64
64
  ## Next
65
65
 
66
- - **[Using it](/blockchain/sui/sealed-storage/using)** — encrypt, share, and decrypt step by step.
66
+ - **[Walkthrough](/blockchain/sui/sealed-storage/walkthrough)** — encrypt, share, and decrypt step by step.
67
67
  - **[Policies](/blockchain/sui/sealed-storage/policies)** — the access rules you can choose, and when to use each.
68
68
  - **[Reference](/blockchain/sui/sealed-storage/reference)** — manifest shape and the SDK API.
@@ -1,4 +1,4 @@
1
- # Sealed Storage policies
1
+ # Sealed Storage policies
2
2
 
3
3
  A **policy** is the on-chain rule that decides who may decrypt sealed content. You choose one when you
4
4
  encrypt. Each policy is a self-contained on-chain module with a matching option in the app.
@@ -1,4 +1,4 @@
1
- # Sealed Storage reference
1
+ # Sealed Storage reference
2
2
 
3
3
  Shapes and identifiers behind Sealed Storage. The **exhaustive, always-current API** is auto-generated
4
4
  from the `@meddleware/seal-client` SDK — see [SDK API](#sdk-api).
@@ -1,4 +1,4 @@
1
- # Sealed Storage — using it
1
+ # Using Sealed Storage
2
2
 
3
3
  A walkthrough of the [Sealed Storage app](https://sui-seal.meddleware.co.uk). You'll need a
4
4
  [Sui wallet](/blockchain/sui/getting-started); browsing policies needs nothing, but decrypting requires a signature.
@@ -21,6 +21,7 @@
21
21
  - [UploadOptions](type-aliases/UploadOptions.md)
22
22
  - [UploadResult](type-aliases/UploadResult.md)
23
23
  - [WalrusClient](type-aliases/WalrusClient.md)
24
+ - [WalrusClientNetwork](type-aliases/WalrusClientNetwork.md)
24
25
  - [WalrusNetwork](type-aliases/WalrusNetwork.md)
25
26
 
26
27
  ## Variables
@@ -28,6 +29,7 @@
28
29
  - [DEFAULT\_RPC\_URLS](variables/DEFAULT_RPC_URLS.md)
29
30
  - [LONG\_TERM\_EPOCHS](variables/LONG_TERM_EPOCHS.md)
30
31
  - [MAINNET\_WALRUS\_PACKAGE\_CONFIG](variables/MAINNET_WALRUS_PACKAGE_CONFIG.md)
32
+ - [MAX\_SINGLE\_RESERVATION\_EPOCHS](variables/MAX_SINGLE_RESERVATION_EPOCHS.md)
31
33
  - [PUBLIC\_UPLOAD\_RELAY\_HOSTS](variables/PUBLIC_UPLOAD_RELAY_HOSTS.md)
32
34
  - [TESTNET\_WALRUS\_PACKAGE\_CONFIG](variables/TESTNET_WALRUS_PACKAGE_CONFIG.md)
33
35
  - [WALRUS\_AGGREGATOR\_HOSTS](variables/WALRUS_AGGREGATOR_HOSTS.md)
@@ -22,7 +22,7 @@ server-side Node.js scripts where relay infra is unnecessary.
22
22
 
23
23
  ### network?
24
24
 
25
- > `optional` **network?**: `WalrusClientNetwork`
25
+ > `optional` **network?**: [`WalrusClientNetwork`](WalrusClientNetwork.md)
26
26
 
27
27
  Defined in: @meddleware/walrus-client/src/client.ts:61
28
28
 
@@ -24,7 +24,7 @@ Whether the blob can be deleted by its owner (default false).
24
24
 
25
25
  Defined in: @meddleware/walrus-client/src/upload.ts:29
26
26
 
27
- Storage epochs to reserve (default: MAX\_SINGLE\_RESERVATION\_EPOCHS).
27
+ Storage epochs to reserve (default: [MAX\_SINGLE\_RESERVATION\_EPOCHS](../variables/MAX_SINGLE_RESERVATION_EPOCHS.md)).
28
28
 
29
29
  ***
30
30
 
@@ -0,0 +1,8 @@
1
+ # Type Alias: WalrusClientNetwork
2
+
3
+ > **WalrusClientNetwork** = [`WalrusNetwork`](WalrusNetwork.md) \| `"localnet"`
4
+
5
+ Defined in: @meddleware/walrus-client/src/client.ts:15
6
+
7
+ Network label accepted by [createWalrusClient](../functions/createWalrusClient.md). `'localnet'` targets a local testbed and
8
+ REQUIRES a caller-supplied `walrusPackageConfig` + `rpcUrl` (the SDK bundles no localnet config).
@@ -1 +1 @@
1
- [{"text":"Classes","collapsed":true,"items":[{"text":"RetryableWalrusClientError","link":"/docs/blockchain/sui/walrus-storage/api/classes/RetryableWalrusClientError.md"},{"text":"WalrusFile","link":"/docs/blockchain/sui/walrus-storage/api/classes/WalrusFile.md"}]},{"text":"Interfaces","collapsed":true,"items":[{"text":"CertifyOptions","link":"/docs/blockchain/sui/walrus-storage/api/interfaces/CertifyOptions.md"},{"text":"StorageCost","link":"/docs/blockchain/sui/walrus-storage/api/interfaces/StorageCost.md"}]},{"text":"Type Aliases","collapsed":true,"items":[{"text":"AccessProofInput","link":"/docs/blockchain/sui/walrus-storage/api/type-aliases/AccessProofInput.md"},{"text":"CreateWalrusClientOptions","link":"/docs/blockchain/sui/walrus-storage/api/type-aliases/CreateWalrusClientOptions.md"},{"text":"ExtendOptions","link":"/docs/blockchain/sui/walrus-storage/api/type-aliases/ExtendOptions.md"},{"text":"OwnedBlob","link":"/docs/blockchain/sui/walrus-storage/api/type-aliases/OwnedBlob.md"},{"text":"PersonalMessageSigner","link":"/docs/blockchain/sui/walrus-storage/api/type-aliases/PersonalMessageSigner.md"},{"text":"RelayChallenge","link":"/docs/blockchain/sui/walrus-storage/api/type-aliases/RelayChallenge.md"},{"text":"UploadOptions","link":"/docs/blockchain/sui/walrus-storage/api/type-aliases/UploadOptions.md"},{"text":"UploadResult","link":"/docs/blockchain/sui/walrus-storage/api/type-aliases/UploadResult.md"},{"text":"WalrusClient","link":"/docs/blockchain/sui/walrus-storage/api/type-aliases/WalrusClient.md"},{"text":"WalrusNetwork","link":"/docs/blockchain/sui/walrus-storage/api/type-aliases/WalrusNetwork.md"}]},{"text":"Variables","collapsed":true,"items":[{"text":"DEFAULT_RPC_URLS","link":"/docs/blockchain/sui/walrus-storage/api/variables/DEFAULT_RPC_URLS.md"},{"text":"LONG_TERM_EPOCHS","link":"/docs/blockchain/sui/walrus-storage/api/variables/LONG_TERM_EPOCHS.md"},{"text":"MAINNET_WALRUS_PACKAGE_CONFIG","link":"/docs/blockchain/sui/walrus-storage/api/variables/MAINNET_WALRUS_PACKAGE_CONFIG.md"},{"text":"PUBLIC_UPLOAD_RELAY_HOSTS","link":"/docs/blockchain/sui/walrus-storage/api/variables/PUBLIC_UPLOAD_RELAY_HOSTS.md"},{"text":"TESTNET_WALRUS_PACKAGE_CONFIG","link":"/docs/blockchain/sui/walrus-storage/api/variables/TESTNET_WALRUS_PACKAGE_CONFIG.md"},{"text":"WALRUS_AGGREGATOR_HOSTS","link":"/docs/blockchain/sui/walrus-storage/api/variables/WALRUS_AGGREGATOR_HOSTS.md"}]},{"text":"Functions","collapsed":true,"items":[{"text":"buildAccessProofToken","link":"/docs/blockchain/sui/walrus-storage/api/functions/buildAccessProofToken.md"},{"text":"certifyBlobTransaction","link":"/docs/blockchain/sui/walrus-storage/api/functions/certifyBlobTransaction.md"},{"text":"createBlobUploadFlow","link":"/docs/blockchain/sui/walrus-storage/api/functions/createBlobUploadFlow.md"},{"text":"createRelayAccessToken","link":"/docs/blockchain/sui/walrus-storage/api/functions/createRelayAccessToken.md"},{"text":"createUploadFlow","link":"/docs/blockchain/sui/walrus-storage/api/functions/createUploadFlow.md"},{"text":"createWalrusClient","link":"/docs/blockchain/sui/walrus-storage/api/functions/createWalrusClient.md"},{"text":"estimateStorageCost","link":"/docs/blockchain/sui/walrus-storage/api/functions/estimateStorageCost.md"},{"text":"extendBlobLifetime","link":"/docs/blockchain/sui/walrus-storage/api/functions/extendBlobLifetime.md"},{"text":"extendBlobLifetimeTransaction","link":"/docs/blockchain/sui/walrus-storage/api/functions/extendBlobLifetimeTransaction.md"},{"text":"fetchOwnedWalrusBlobs","link":"/docs/blockchain/sui/walrus-storage/api/functions/fetchOwnedWalrusBlobs.md"},{"text":"fetchRelayChallenge","link":"/docs/blockchain/sui/walrus-storage/api/functions/fetchRelayChallenge.md"},{"text":"getWalrusPackageConfig","link":"/docs/blockchain/sui/walrus-storage/api/functions/getWalrusPackageConfig.md"},{"text":"personalMessageForNonce","link":"/docs/blockchain/sui/walrus-storage/api/functions/personalMessageForNonce.md"},{"text":"readBlobAttributes","link":"/docs/blockchain/sui/walrus-storage/api/functions/readBlobAttributes.md"},{"text":"setBlobAttributes","link":"/docs/blockchain/sui/walrus-storage/api/functions/setBlobAttributes.md"},{"text":"setBlobAttributesTransaction","link":"/docs/blockchain/sui/walrus-storage/api/functions/setBlobAttributesTransaction.md"},{"text":"uploadBytes","link":"/docs/blockchain/sui/walrus-storage/api/functions/uploadBytes.md"},{"text":"uploadImageBytes","link":"/docs/blockchain/sui/walrus-storage/api/functions/uploadImageBytes.md"},{"text":"uploadLocalFile","link":"/docs/blockchain/sui/walrus-storage/api/functions/uploadLocalFile.md"},{"text":"walrusBlobUrl","link":"/docs/blockchain/sui/walrus-storage/api/functions/walrusBlobUrl.md"}]}]
1
+ [{"text":"Classes","collapsed":true,"items":[{"text":"RetryableWalrusClientError","link":"/docs/blockchain/sui/walrus-storage/api/classes/RetryableWalrusClientError.md"},{"text":"WalrusFile","link":"/docs/blockchain/sui/walrus-storage/api/classes/WalrusFile.md"}]},{"text":"Interfaces","collapsed":true,"items":[{"text":"CertifyOptions","link":"/docs/blockchain/sui/walrus-storage/api/interfaces/CertifyOptions.md"},{"text":"StorageCost","link":"/docs/blockchain/sui/walrus-storage/api/interfaces/StorageCost.md"}]},{"text":"Type Aliases","collapsed":true,"items":[{"text":"AccessProofInput","link":"/docs/blockchain/sui/walrus-storage/api/type-aliases/AccessProofInput.md"},{"text":"CreateWalrusClientOptions","link":"/docs/blockchain/sui/walrus-storage/api/type-aliases/CreateWalrusClientOptions.md"},{"text":"ExtendOptions","link":"/docs/blockchain/sui/walrus-storage/api/type-aliases/ExtendOptions.md"},{"text":"OwnedBlob","link":"/docs/blockchain/sui/walrus-storage/api/type-aliases/OwnedBlob.md"},{"text":"PersonalMessageSigner","link":"/docs/blockchain/sui/walrus-storage/api/type-aliases/PersonalMessageSigner.md"},{"text":"RelayChallenge","link":"/docs/blockchain/sui/walrus-storage/api/type-aliases/RelayChallenge.md"},{"text":"UploadOptions","link":"/docs/blockchain/sui/walrus-storage/api/type-aliases/UploadOptions.md"},{"text":"UploadResult","link":"/docs/blockchain/sui/walrus-storage/api/type-aliases/UploadResult.md"},{"text":"WalrusClient","link":"/docs/blockchain/sui/walrus-storage/api/type-aliases/WalrusClient.md"},{"text":"WalrusClientNetwork","link":"/docs/blockchain/sui/walrus-storage/api/type-aliases/WalrusClientNetwork.md"},{"text":"WalrusNetwork","link":"/docs/blockchain/sui/walrus-storage/api/type-aliases/WalrusNetwork.md"}]},{"text":"Variables","collapsed":true,"items":[{"text":"DEFAULT_RPC_URLS","link":"/docs/blockchain/sui/walrus-storage/api/variables/DEFAULT_RPC_URLS.md"},{"text":"LONG_TERM_EPOCHS","link":"/docs/blockchain/sui/walrus-storage/api/variables/LONG_TERM_EPOCHS.md"},{"text":"MAINNET_WALRUS_PACKAGE_CONFIG","link":"/docs/blockchain/sui/walrus-storage/api/variables/MAINNET_WALRUS_PACKAGE_CONFIG.md"},{"text":"MAX_SINGLE_RESERVATION_EPOCHS","link":"/docs/blockchain/sui/walrus-storage/api/variables/MAX_SINGLE_RESERVATION_EPOCHS.md"},{"text":"PUBLIC_UPLOAD_RELAY_HOSTS","link":"/docs/blockchain/sui/walrus-storage/api/variables/PUBLIC_UPLOAD_RELAY_HOSTS.md"},{"text":"TESTNET_WALRUS_PACKAGE_CONFIG","link":"/docs/blockchain/sui/walrus-storage/api/variables/TESTNET_WALRUS_PACKAGE_CONFIG.md"},{"text":"WALRUS_AGGREGATOR_HOSTS","link":"/docs/blockchain/sui/walrus-storage/api/variables/WALRUS_AGGREGATOR_HOSTS.md"}]},{"text":"Functions","collapsed":true,"items":[{"text":"buildAccessProofToken","link":"/docs/blockchain/sui/walrus-storage/api/functions/buildAccessProofToken.md"},{"text":"certifyBlobTransaction","link":"/docs/blockchain/sui/walrus-storage/api/functions/certifyBlobTransaction.md"},{"text":"createBlobUploadFlow","link":"/docs/blockchain/sui/walrus-storage/api/functions/createBlobUploadFlow.md"},{"text":"createRelayAccessToken","link":"/docs/blockchain/sui/walrus-storage/api/functions/createRelayAccessToken.md"},{"text":"createUploadFlow","link":"/docs/blockchain/sui/walrus-storage/api/functions/createUploadFlow.md"},{"text":"createWalrusClient","link":"/docs/blockchain/sui/walrus-storage/api/functions/createWalrusClient.md"},{"text":"estimateStorageCost","link":"/docs/blockchain/sui/walrus-storage/api/functions/estimateStorageCost.md"},{"text":"extendBlobLifetime","link":"/docs/blockchain/sui/walrus-storage/api/functions/extendBlobLifetime.md"},{"text":"extendBlobLifetimeTransaction","link":"/docs/blockchain/sui/walrus-storage/api/functions/extendBlobLifetimeTransaction.md"},{"text":"fetchOwnedWalrusBlobs","link":"/docs/blockchain/sui/walrus-storage/api/functions/fetchOwnedWalrusBlobs.md"},{"text":"fetchRelayChallenge","link":"/docs/blockchain/sui/walrus-storage/api/functions/fetchRelayChallenge.md"},{"text":"getWalrusPackageConfig","link":"/docs/blockchain/sui/walrus-storage/api/functions/getWalrusPackageConfig.md"},{"text":"personalMessageForNonce","link":"/docs/blockchain/sui/walrus-storage/api/functions/personalMessageForNonce.md"},{"text":"readBlobAttributes","link":"/docs/blockchain/sui/walrus-storage/api/functions/readBlobAttributes.md"},{"text":"setBlobAttributes","link":"/docs/blockchain/sui/walrus-storage/api/functions/setBlobAttributes.md"},{"text":"setBlobAttributesTransaction","link":"/docs/blockchain/sui/walrus-storage/api/functions/setBlobAttributesTransaction.md"},{"text":"uploadBytes","link":"/docs/blockchain/sui/walrus-storage/api/functions/uploadBytes.md"},{"text":"uploadImageBytes","link":"/docs/blockchain/sui/walrus-storage/api/functions/uploadImageBytes.md"},{"text":"uploadLocalFile","link":"/docs/blockchain/sui/walrus-storage/api/functions/uploadLocalFile.md"},{"text":"walrusBlobUrl","link":"/docs/blockchain/sui/walrus-storage/api/functions/walrusBlobUrl.md"}]}]
@@ -6,7 +6,7 @@ Defined in: @meddleware/walrus-client/src/upload.ts:24
6
6
 
7
7
  Recommended TARGET lifetime for critical assets (~7.7 years at a ~2-week epoch
8
8
  cadence). NOTE: this cannot be reached in one reservation — it exceeds
9
- MAX\_SINGLE\_RESERVATION\_EPOCHS. Reaching it requires periodic renewal via
9
+ [MAX\_SINGLE\_RESERVATION\_EPOCHS](MAX_SINGLE_RESERVATION_EPOCHS.md). Reaching it requires periodic renewal via
10
10
  [extendBlobLifetime](../functions/extendBlobLifetime.md) before expiry. When passing this as an initial
11
11
  `epochs` value, clamp to `MAX_SINGLE_RESERVATION_EPOCHS` first, or pass an
12
12
  explicit `epochs <= 53`.
@@ -0,0 +1,10 @@
1
+ # Variable: MAX\_SINGLE\_RESERVATION\_EPOCHS
2
+
3
+ > `const` **MAX\_SINGLE\_RESERVATION\_EPOCHS**: `53` = `53`
4
+
5
+ Defined in: @meddleware/walrus-client/src/upload.ts:14
6
+
7
+ Maximum epochs a SINGLE Walrus reservation accepts (`max_epochs_ahead` on the
8
+ Walrus system object; 53 on testnet/mainnet). Passing more to `writeBlob` /
9
+ `writeFiles` aborts on-chain (`reserve_space`, MoveAbort code 2). ~2 years at
10
+ the ~2-week epoch cadence.
@@ -50,5 +50,5 @@ for the exact shapes.
50
50
 
51
51
  ## Next
52
52
 
53
- - **[Using it](/blockchain/sui/walrus-storage/using)** — upload, view, and extend blobs step by step.
53
+ - **[Walkthrough](/blockchain/sui/walrus-storage/walkthrough)** — upload, view, and extend blobs step by step.
54
54
  - **[Reference](/blockchain/sui/walrus-storage/reference)** — blob/relay shapes and the SDK API.
@@ -1,4 +1,4 @@
1
- # Walrus Storage reference
1
+ # Walrus Storage reference
2
2
 
3
3
  Shapes and identifiers behind the Walrus Storage app. Conceptual here; the **exhaustive, always-current
4
4
  API** is auto-generated from the `@meddleware/walrus-client` SDK — see [SDK API](#sdk-api).
@@ -1,4 +1,4 @@
1
- # Walrus Storage — using it
1
+ # Using Walrus Storage
2
2
 
3
3
  A walkthrough of the [Walrus Storage app](https://sui-walrus.meddleware.co.uk). You'll need a
4
4
  [Sui wallet with a little SUI](/blockchain/sui/getting-started).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@meddleware/docs",
3
- "version": "0.0.3",
3
+ "version": "0.0.4",
4
4
  "description": "Meddleware developer tools documentation site (docs.meddleware.co.uk) — VitePress. Blockchain-agnostic with Sui as the first active chain.",
5
5
  "author": "Meddleware <dev@meddleware.co.uk>",
6
6
  "license": "0BSD",
@@ -30,9 +30,9 @@
30
30
  "@meddleware/design-tokens": "^0.1.2"
31
31
  },
32
32
  "devDependencies": {
33
- "@meddleware/nft-gate-client": "^0.0.6",
33
+ "@meddleware/nft-gate-client": "^0.0.7",
34
34
  "@meddleware/seal-client": "^0.0.3",
35
- "@meddleware/walrus-client": "^0.0.11",
35
+ "@meddleware/walrus-client": "^0.0.12",
36
36
  "@mysten/seal": "^1.4.7",
37
37
  "@mysten/sui": "^2.30.0",
38
38
  "@mysten/walrus": "^0.7.0",