@meddleware/docs 0.0.1

package/docs/walrus-storage/api/functions/fetchRelayChallenge.md

@@ -0,0 +1,32 @@
+# Function: fetchRelayChallenge()
+
+> **fetchRelayChallenge**(`relayHost`, `opts?`): `Promise`\<`Challenge`\>
+
+Defined in: @meddleware/walrus-client/src/access.ts:54
+
+Fetch a fresh challenge from the gateway's `GET /v1/challenge` endpoint.
+Tolerates both `expiresAt` (camelCase) and `expires_at` (snake_case) response shapes.
+
+## Parameters
+
+### relayHost
+
+`string`
+
+### opts?
+
+#### signal?
+
+`AbortSignal`
+
+## Returns
+
+`Promise`\<`Challenge`\>
+
+## Throws
+
+if the network request fails or the gateway returns a non-2xx status.
+
+## Throws
+
+if the response body is missing the required `nonce` field.

package/docs/walrus-storage/api/functions/getWalrusPackageConfig.md

@@ -0,0 +1,25 @@
+# Function: getWalrusPackageConfig()
+
+> **getWalrusPackageConfig**(`network`): `object`
+
+Defined in: @meddleware/walrus-client/src/client.ts:54
+
+Return the Walrus on-chain package config for the given network.
+
+## Parameters
+
+### network
+
+[`WalrusNetwork`](../type-aliases/WalrusNetwork.md)
+
+## Returns
+
+`object`
+
+### stakingPoolId
+
+> **stakingPoolId**: `string`
+
+### systemObjectId
+
+> **systemObjectId**: `string`

package/docs/walrus-storage/api/functions/personalMessageForNonce.md

@@ -0,0 +1,18 @@
+# Function: personalMessageForNonce()
+
+> **personalMessageForNonce**(`nonce`): `Uint8Array`
+
+Defined in: @meddleware/nft-gate-client/dist/proof.d.ts:6
+
+The exact bytes a wallet signs (as a personal message) to answer a challenge. Both the
+client (signing) and the gateway (verifying) MUST derive the message identically.
+
+## Parameters
+
+### nonce
+
+`string`
+
+## Returns
+
+`Uint8Array`

package/docs/walrus-storage/api/functions/readBlobAttributes.md

@@ -0,0 +1,27 @@
+# Function: readBlobAttributes()
+
+> **readBlobAttributes**(`client`, `blobObjectId`): `Promise`\<`Record`\<`string`, `string`\>\>
+
+Defined in: @meddleware/walrus-client/src/manage.ts:197
+
+Read a blob's on-chain attributes.
+
+## Parameters
+
+### client
+
+`ClientWithExtensions`
+
+A Walrus-extended client.
+
+### blobObjectId
+
+`string`
+
+The on-chain Blob object id.
+
+## Returns
+
+`Promise`\<`Record`\<`string`, `string`\>\>
+
+The attribute map, or `null` if the blob has none.

package/docs/walrus-storage/api/functions/setBlobAttributes.md

@@ -0,0 +1,40 @@
+# Function: setBlobAttributes()
+
+> **setBlobAttributes**(`client`, `blobObjectId`, `signer`, `attributes`): `Promise`\<\{ `digest`: `string`; \}\>
+
+Defined in: @meddleware/walrus-client/src/manage.ts:142
+
+Set on-chain key/value attributes on a blob (Node.js — signs and executes). A
+`null` value deletes that attribute.
+
+## Parameters
+
+### client
+
+`ClientWithExtensions`
+
+A Walrus-extended client.
+
+### blobObjectId
+
+`string`
+
+The on-chain Blob object id.
+
+### signer
+
+`Signer`
+
+The keypair authorising the write.
+
+### attributes
+
+`Record`\<`string`, `string` \| `null`\>
+
+Attributes to set; `null` deletes the key.
+
+## Returns
+
+`Promise`\<\{ `digest`: `string`; \}\>
+
+The executed transaction digest.

package/docs/walrus-storage/api/functions/setBlobAttributesTransaction.md

@@ -0,0 +1,34 @@
+# Function: setBlobAttributesTransaction()
+
+> **setBlobAttributesTransaction**(`client`, `blobObjectId`, `attributes`): `Promise`\<`Transaction`\>
+
+Defined in: @meddleware/walrus-client/src/manage.ts:182
+
+Build (but do not sign) a set-blob-attributes transaction for a browser wallet
+to sign. Browser counterpart of [setBlobAttributes](setBlobAttributes.md).
+
+## Parameters
+
+### client
+
+`ClientWithExtensions`
+
+A Walrus-extended client.
+
+### blobObjectId
+
+`string`
+
+The on-chain Blob object id.
+
+### attributes
+
+`Record`\<`string`, `string` \| `null`\>
+
+Attributes to set; `null` deletes the key.
+
+## Returns
+
+`Promise`\<`Transaction`\>
+
+An unsigned `Transaction`.

package/docs/walrus-storage/api/functions/uploadBytes.md

@@ -0,0 +1,38 @@
+# Function: uploadBytes()
+
+> **uploadBytes**(`client`, `contents`, `identifier`, `signer`, `options?`): `Promise`\<[`UploadResult`](../type-aliases/UploadResult.md)\>
+
+Defined in: @meddleware/walrus-client/src/upload.ts:50
+
+Upload raw bytes as a Walrus quilt (file bundle). Use this from Node.js with a keypair
+signer; use [createUploadFlow](createUploadFlow.md) in the browser for wallet-popup-safe signing.
+
+## Parameters
+
+### client
+
+`ClientWithExtensions`
+
+### contents
+
+`Uint8Array`
+
+### identifier
+
+`string`
+
+### signer
+
+`Signer`
+
+### options?
+
+[`UploadOptions`](../type-aliases/UploadOptions.md) = `{}`
+
+## Returns
+
+`Promise`\<[`UploadResult`](../type-aliases/UploadResult.md)\>
+
+## Throws
+
+if the Walrus write transaction fails or the signer rejects.

package/docs/walrus-storage/api/functions/uploadImageBytes.md

@@ -0,0 +1,34 @@
+# Function: uploadImageBytes()
+
+> **uploadImageBytes**(`client`, `contents`, `signer`, `options?`): `Promise`\<[`UploadResult`](../type-aliases/UploadResult.md)\>
+
+Defined in: @meddleware/walrus-client/src/upload.ts:113
+
+Upload raw bytes as a Walrus raw blob (served directly at `/v1/blobs/<blobId>`).
+Use this for assets that must be URL-addressable (e.g. token icons). Node.js only.
+
+## Parameters
+
+### client
+
+`ClientWithExtensions`
+
+### contents
+
+`Uint8Array`
+
+### signer
+
+`Signer`
+
+### options?
+
+[`UploadOptions`](../type-aliases/UploadOptions.md) = `{}`
+
+## Returns
+
+`Promise`\<[`UploadResult`](../type-aliases/UploadResult.md)\>
+
+## Throws
+
+if the Walrus write transaction fails or the signer rejects.

package/docs/walrus-storage/api/functions/uploadLocalFile.md

@@ -0,0 +1,37 @@
+# Function: uploadLocalFile()
+
+> **uploadLocalFile**(`client`, `filePath`, `identifier`, `signer`, `options?`): `Promise`\<[`UploadResult`](../type-aliases/UploadResult.md)\>
+
+Defined in: @meddleware/walrus-client/src/upload.ts:74
+
+Read a local file and upload it as a Walrus quilt. Node.js only.
+
+## Parameters
+
+### client
+
+`ClientWithExtensions`
+
+### filePath
+
+`string`
+
+### identifier
+
+`string`
+
+### signer
+
+`Signer`
+
+### options?
+
+[`UploadOptions`](../type-aliases/UploadOptions.md) = `{}`
+
+## Returns
+
+`Promise`\<[`UploadResult`](../type-aliases/UploadResult.md)\>
+
+## Throws
+
+if the file cannot be read or the upload fails.

package/docs/walrus-storage/api/functions/walrusBlobUrl.md

@@ -0,0 +1,26 @@
+# Function: walrusBlobUrl()
+
+> **walrusBlobUrl**(`network`, `blobId`, `aggregatorHost?`): `string`
+
+Defined in: @meddleware/walrus-client/src/client.ts:44
+
+Public URL that serves a RAW blob's bytes (e.g. a token icon). Only meaningful
+for blobs written with `uploadImageBytes` / `writeBlob` (raw), NOT quilts.
+
+## Parameters
+
+### network
+
+[`WalrusNetwork`](../type-aliases/WalrusNetwork.md)
+
+### blobId
+
+`string`
+
+### aggregatorHost?
+
+`string`
+
+## Returns
+
+`string`

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

@@ -0,0 +1,56 @@
+# Walrus client API
+
+## Classes
+
+- [RetryableWalrusClientError](classes/RetryableWalrusClientError.md)
+- [WalrusFile](classes/WalrusFile.md)
+
+## Interfaces
+
+- [CertifyOptions](interfaces/CertifyOptions.md)
+- [StorageCost](interfaces/StorageCost.md)
+
+## Type Aliases
+
+- [AccessProofInput](type-aliases/AccessProofInput.md)
+- [CreateWalrusClientOptions](type-aliases/CreateWalrusClientOptions.md)
+- [ExtendOptions](type-aliases/ExtendOptions.md)
+- [OwnedBlob](type-aliases/OwnedBlob.md)
+- [PersonalMessageSigner](type-aliases/PersonalMessageSigner.md)
+- [RelayChallenge](type-aliases/RelayChallenge.md)
+- [UploadOptions](type-aliases/UploadOptions.md)
+- [UploadResult](type-aliases/UploadResult.md)
+- [WalrusClient](type-aliases/WalrusClient.md)
+- [WalrusNetwork](type-aliases/WalrusNetwork.md)
+
+## Variables
+
+- [DEFAULT\_RPC\_URLS](variables/DEFAULT_RPC_URLS.md)
+- [LONG\_TERM\_EPOCHS](variables/LONG_TERM_EPOCHS.md)
+- [MAINNET\_WALRUS\_PACKAGE\_CONFIG](variables/MAINNET_WALRUS_PACKAGE_CONFIG.md)
+- [PUBLIC\_UPLOAD\_RELAY\_HOSTS](variables/PUBLIC_UPLOAD_RELAY_HOSTS.md)
+- [TESTNET\_WALRUS\_PACKAGE\_CONFIG](variables/TESTNET_WALRUS_PACKAGE_CONFIG.md)
+- [WALRUS\_AGGREGATOR\_HOSTS](variables/WALRUS_AGGREGATOR_HOSTS.md)
+
+## Functions
+
+- [buildAccessProofToken](functions/buildAccessProofToken.md)
+- [certifyBlobTransaction](functions/certifyBlobTransaction.md)
+- [createBlobUploadFlow](functions/createBlobUploadFlow.md)
+- [createRelayAccessToken](functions/createRelayAccessToken.md)
+- [createUploadFlow](functions/createUploadFlow.md)
+- [createWalrusClient](functions/createWalrusClient.md)
+- [estimateStorageCost](functions/estimateStorageCost.md)
+- [extendBlobLifetime](functions/extendBlobLifetime.md)
+- [extendBlobLifetimeTransaction](functions/extendBlobLifetimeTransaction.md)
+- [fetchOwnedWalrusBlobs](functions/fetchOwnedWalrusBlobs.md)
+- [fetchRelayChallenge](functions/fetchRelayChallenge.md)
+- [getWalrusPackageConfig](functions/getWalrusPackageConfig.md)
+- [personalMessageForNonce](functions/personalMessageForNonce.md)
+- [readBlobAttributes](functions/readBlobAttributes.md)
+- [setBlobAttributes](functions/setBlobAttributes.md)
+- [setBlobAttributesTransaction](functions/setBlobAttributesTransaction.md)
+- [uploadBytes](functions/uploadBytes.md)
+- [uploadImageBytes](functions/uploadImageBytes.md)
+- [uploadLocalFile](functions/uploadLocalFile.md)
+- [walrusBlobUrl](functions/walrusBlobUrl.md)

package/docs/walrus-storage/api/interfaces/CertifyOptions.md

@@ -0,0 +1,46 @@
+# Interface: CertifyOptions
+
+Defined in: @meddleware/walrus-client/src/manage.ts:71
+
+A blob's storage-node availability certificate, serialized as base64 (from the upload step).
+
+## Properties
+
+### blobId
+
+> **blobId**: `string`
+
+Defined in: @meddleware/walrus-client/src/manage.ts:73
+
+The Walrus blob id.
+
+***
+
+### blobObjectId
+
+> **blobObjectId**: `string`
+
+Defined in: @meddleware/walrus-client/src/manage.ts:75
+
+The on-chain Blob object id (not the blob id).
+
+***
+
+### certificate
+
+> **certificate**: `string`
+
+Defined in: @meddleware/walrus-client/src/manage.ts:80
+
+The base64 availability certificate returned by the upload step. `@mysten/walrus` accepts the
+base64 string directly (it parses it internally), so no BCS handling is needed here.
+
+***
+
+### deletable?
+
+> `optional` **deletable?**: `boolean`
+
+Defined in: @meddleware/walrus-client/src/manage.ts:82
+
+Must match how the blob was registered (our uploads register non-deletable).

package/docs/walrus-storage/api/interfaces/StorageCost.md

@@ -0,0 +1,35 @@
+# Interface: StorageCost
+
+Defined in: @meddleware/walrus-client/src/manage.ts:105
+
+Breakdown of the on-chain cost (in MIST) of storing a blob of `size` bytes for `epochs` epochs.
+
+## Properties
+
+### storageCost
+
+> **storageCost**: `bigint`
+
+Defined in: @meddleware/walrus-client/src/manage.ts:107
+
+Per-epoch storage cost × epochs (the part that scales with duration / that an extend pays).
+
+***
+
+### totalCost
+
+> **totalCost**: `bigint`
+
+Defined in: @meddleware/walrus-client/src/manage.ts:111
+
+`storageCost + writeCost`.
+
+***
+
+### writeCost
+
+> **writeCost**: `bigint`
+
+Defined in: @meddleware/walrus-client/src/manage.ts:109
+
+One-time write cost (paid on registration, not on extend).

package/docs/walrus-storage/api/type-aliases/AccessProofInput.md

@@ -0,0 +1,7 @@
+# Type Alias: AccessProofInput
+
+> **AccessProofInput** = `AccessProof`
+
+Defined in: @meddleware/walrus-client/src/access.ts:30
+
+The proof payload; `consumeDigest` is present only for single-use gates.

package/docs/walrus-storage/api/type-aliases/CreateWalrusClientOptions.md

@@ -0,0 +1,113 @@
+# Type Alias: CreateWalrusClientOptions
+
+> **CreateWalrusClientOptions** = `object`
+
+Defined in: @meddleware/walrus-client/src/client.ts:59
+
+Options accepted by [createWalrusClient](../functions/createWalrusClient.md).
+
+## Properties
+
+### disableUploadRelay?
+
+> `optional` **disableUploadRelay?**: `boolean`
+
+Defined in: @meddleware/walrus-client/src/client.ts:105
+
+When true, build a client with NO upload relay (direct-to-storage-node).
+Overrides `uploadRelayHost` and the default relay fallback. Useful for
+server-side Node.js scripts where relay infra is unnecessary.
+
+***
+
+### network?
+
+> `optional` **network?**: `WalrusClientNetwork`
+
+Defined in: @meddleware/walrus-client/src/client.ts:61
+
+Target network (default `'testnet'`). Use `'localnet'` with `walrusPackageConfig` + `rpcUrl`.
+
+***
+
+### rpcUrl?
+
+> `optional` **rpcUrl?**: `string`
+
+Defined in: @meddleware/walrus-client/src/client.ts:63
+
+Override the Sui JSON-RPC/gRPC fullnode URL. Defaults to the public Mysten endpoint for the network.
+
+***
+
+### storageNodeUrlScheme?
+
+> `optional` **storageNodeUrlScheme?**: `"http"` \| `"https"`
+
+Defined in: @meddleware/walrus-client/src/client.ts:76
+
+URL scheme used when contacting storage nodes. Defaults to `'https'`. Set `'http'` for a localnet
+testbed whose storage nodes do not terminate TLS.
+
+***
+
+### uploadRelayAuthToken?
+
+> `optional` **uploadRelayAuthToken?**: `string` \| (() => `string` \| `undefined`)
+
+Defined in: @meddleware/walrus-client/src/client.ts:94
+
+Bearer token for the upload relay `Authorization` header. Obtain via
+`createRelayAccessToken` from the `access` module when the relay is NFT-gated.
+
+May be a **provider function** resolved per request instead of a static string. This lets a
+retained upload flow be resumed with a FRESH token: an interrupted single-use upload keeps its
+on-chain consume (the `consumeDigest`) but must present a new challenge signature on retry, so
+the client reads the current token on each relay call rather than baking one in at construction.
+
+***
+
+### uploadRelayHost?
+
+> `optional` **uploadRelayHost?**: `string`
+
+Defined in: @meddleware/walrus-client/src/client.ts:84
+
+Upload relay host URL. Defaults to the public Mysten relay for the network.
+Operators running their own relay (e.g. Meddleware's NFT-gated relay) should
+pass their relay URL here alongside `uploadRelayAuthToken`.
+
+***
+
+### uploadRelayMaxTipMist?
+
+> `optional` **uploadRelayMaxTipMist?**: `number`
+
+Defined in: @meddleware/walrus-client/src/client.ts:99
+
+Maximum tip payment to the upload relay in MIST (default 1,000,000 = 0.001 SUI).
+The relay may request less; this cap prevents the client from overpaying.
+
+***
+
+### walrusPackageConfig?
+
+> `optional` **walrusPackageConfig?**: `WalrusPackageConfig`
+
+Defined in: @meddleware/walrus-client/src/client.ts:71
+
+Custom Walrus on-chain package config (system object / staking pool / exchange ids). Supply this
+to target a network the SDK does not bundle — e.g. a localnet testbed whose ids are harvested at
+deploy time. When set it is passed to the Walrus extension in place of the bundled network config.
+**Caller-supplied only** — never hardcode addresses here (keeps the "no hardcoded package
+addresses" invariant intact; the value is discovered at runtime, e.g. from `.env.localnet`).
+
+***
+
+### wasmUrl?
+
+> `optional` **wasmUrl?**: `string`
+
+Defined in: @meddleware/walrus-client/src/client.ts:78
+
+Optional WASM bundle URL for the Walrus WASM client.

package/docs/walrus-storage/api/type-aliases/ExtendOptions.md

@@ -0,0 +1,8 @@
+# Type Alias: ExtendOptions
+
+> **ExtendOptions** = \{ `endEpoch?`: `never`; `epochs`: `number`; \} \| \{ `endEpoch`: `number`; `epochs?`: `never`; \}
+
+Defined in: @meddleware/walrus-client/src/manage.ts:25
+
+How to extend a blob's storage: either add `epochs` more, or extend up to an
+absolute `endEpoch`. Exactly one of the two must be provided.

package/docs/walrus-storage/api/type-aliases/OwnedBlob.md

@@ -0,0 +1,57 @@
+# Type Alias: OwnedBlob
+
+> **OwnedBlob** = `object`
+
+Defined in: @meddleware/walrus-client/src/query.ts:19
+
+A Walrus blob object owned by a Sui address.
+
+## Properties
+
+### blobId
+
+> **blobId**: `string`
+
+Defined in: @meddleware/walrus-client/src/query.ts:23
+
+Aggregator-URL-compatible blob id string (`GET /v1/blobs/<blobId>`).
+
+***
+
+### certified
+
+> **certified**: `boolean`
+
+Defined in: @meddleware/walrus-client/src/query.ts:29
+
+Whether the blob has been certified.
+
+***
+
+### endEpoch
+
+> **endEpoch**: `number`
+
+Defined in: @meddleware/walrus-client/src/query.ts:27
+
+Epoch at which the blob's storage expires.
+
+***
+
+### objectId
+
+> **objectId**: `string`
+
+Defined in: @meddleware/walrus-client/src/query.ts:21
+
+The on-chain Blob object id.
+
+***
+
+### size
+
+> **size**: `number`
+
+Defined in: @meddleware/walrus-client/src/query.ts:25
+
+Size in bytes.

package/docs/walrus-storage/api/type-aliases/PersonalMessageSigner.md

@@ -0,0 +1,17 @@
+# Type Alias: PersonalMessageSigner
+
+> **PersonalMessageSigner** = (`message`) => `Promise`\<\{ `signature`: `string`; \}\>
+
+Defined in: @meddleware/nft-gate-client/dist/proof.d.ts:12
+
+A wallet-provided personal-message signer (e.g. wallet-standard `sui:signPersonalMessage`).
+
+## Parameters
+
+### message
+
+`Uint8Array`
+
+## Returns
+
+`Promise`\<\{ `signature`: `string`; \}\>

package/docs/walrus-storage/api/type-aliases/RelayChallenge.md

@@ -0,0 +1,7 @@
+# Type Alias: RelayChallenge
+
+> **RelayChallenge** = `Challenge`
+
+Defined in: @meddleware/walrus-client/src/access.ts:27
+
+A server-issued, time-bound challenge from the gateway's `GET /v1/challenge`.