Skip to main content

Configuration

Use this page to pick the right config shape quickly.

MemWalConfig

Used by:

  • MemWal.create(config)
  • withMemWal(model, options)
FieldRequiredNotes
keyyesDelegate private key in hex
accountIdyesMemWalAccount object ID on Sui
serverUrlnoRelayer URL. Default: https://relayer.memory.walrus.xyz
namespacenoDefault memory boundary. Default: "default"

MemWalManualConfig

Used by:

  • MemWalManual.create(config)

Core fields:

FieldRequiredNotes
keyyesDelegate private key in hex
serverUrlnoRelayer URL
embeddingApiKeyyesOpenAI/OpenRouter-compatible embedding key
embeddingApiBasenoDefault: https://api.openai.com/v1
embeddingModelnoDefault: text-embedding-3-small
packageIdyesWalrus Memory package ID on Sui
accountIdyesMemWalAccount object ID
namespacenoDefault namespace

Sui signer fields:

FieldRequiredNotes
suiPrivateKeyone of twoUse for local signing
walletSignerone of twoUse a connected browser wallet instead
suiClientnoOptional pre-configured Sui client

Walrus and network fields:

FieldRequiredNotes
suiNetworknotestnet or mainnet. Default: mainnet
sealServerConfigsnoFull Seal configs for independent or committee servers. Committee entries require aggregatorUrl
sealKeyServersnoLegacy override for independent Seal key server object IDs
sealThresholdnoDefault: 2, capped to total configured server weight
walrusEpochsnoDefault: 50
walrusAggregatorUrlnoWalrus download endpoint. Defaults follow suiNetwork
walrusPublisherUrlnoWalrus upload endpoint. Defaults follow suiNetwork

WithMemWalOptions

withMemWal(model, options) accepts all MemWalConfig fields plus:

FieldRequiredNotes
maxMemoriesnoDefault: 5
autoSavenoDefault: true
minRelevancenoDefault: 0.3
debugnoDefault: false

Rules that matter

  • namespace defaults to "default" when omitted.
  • MemWal is the default relayer-handled path.
  • MemWalManual is the manual client path, but it still uses the relayer for registration, search, and restore.
  • withMemWal builds on top of MemWal, so it uses the same relayer-backed config shape.
  • MemWalManual now defaults to mainnet network settings unless you pass suiNetwork: "testnet".
  • sealServerConfigs takes priority over sealKeyServers; sealKeyServers remains supported for legacy independent key server lists.
  • Relayer/sidecar Seal defaults use Mysten's initial committee aggregator on testnet. mainnet keeps the legacy independent key server pair until an official Mainnet committee aggregator is available.
  • MemWalManual keeps the legacy independent Testnet default for compatibility. Pass sealServerConfigs to use a committee aggregator manually.
  • Use sealServerConfigs to override the built-in default with another committee by providing objectId, weight, and aggregatorUrl.