Type Alias: CreateWalrusClientOptions

CreateWalrusClientOptions = object

Defined in: @meddleware/walrus-storage-client/src/client.ts:60

Options accepted by createWalrusClient.

Properties

disableUploadRelay?

optional disableUploadRelay?: boolean

Defined in: @meddleware/walrus-storage-client/src/client.ts:107

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-storage-client/src/client.ts:62

Target network (default 'testnet'). Use 'localnet' with walrusPackageConfig + rpcUrl.

---

rpcUrl?

optional rpcUrl?: string

Defined in: @meddleware/walrus-storage-client/src/client.ts:64

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-storage-client/src/client.ts:77

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-storage-client/src/client.ts:95

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-storage-client/src/client.ts:85

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-storage-client/src/client.ts:101

Maximum tip payment to the upload relay in MIST (default DEFAULT_UPLOAD_RELAY_MAX_TIP_MIST = 0.005 SUI). The relay may request less; the SDK refuses a relay whose tip exceeds this cap, so it must sit above any legitimate tip.

---

walrusPackageConfig?

optional walrusPackageConfig?: WalrusPackageConfig

Defined in: @meddleware/walrus-storage-client/src/client.ts:72

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-storage-client/src/client.ts:79

Optional WASM bundle URL for the Walrus WASM client.