Early Access The dStorage SDK is under active development (v0.0.x). APIs may still change — it's safe to follow the guides, but hold off on production use for now.
dStoragedocs

Appearance

Troubleshooting ​

Maximum call stack size exceeded when encrypting files ​

Caused by spreading large Uint8Array values into String.fromCharCode(). This was fixed in the SDK by processing the buffer in 8 KB chunks. Ensure you are on a version that includes this fix.

Failed to parse result provided by node / instanceof BN failure ​

[email protected] appears more than once in node_modules — instanceof BN fails across module boundaries. Fix: pin [email protected] in root package.json dependencies and delete any nested copies under node_modules. Run npm install afterwards.

Invalid URL instead of an init() error ​

The chain adapter's _getAPI() is called before init() completes, hitting an endpoint that has no URL yet. Make sure await sdk.init() resolves fully before any store() or retrieve*() call.

ZK artifacts not found / Invalid URL at runtime ​

  • Node.js: verify zkArtifactsPath points to the directory containing keys/ and zkir/ sub-directories, not to a JS file or parent directory.
  • Browser: confirm the artifacts were copied into public/ and that zkConfigBaseUrl is set.

Wallet extension not detected in browser connector mode ​

Confirm a Midnight wallet extension (1AM, Lace, or another wallet implementing the dApp Connector API) is installed and enabled in your browser. The connector flow enumerates window.midnight and calls connect() on the discovered wallet — if no extension is installed or enabled, this call rejects. Reload the page after installing/enabling the extension.

Integration tests stall or never complete ​

Check that the required Docker containers are running (docker ps). Confirm port availability: arlocal on 1984, proof server on 6300. The Midnight full-stack suite generates ZK proofs which can take 30–90 seconds each — this is expected.

How do I reuse a deployed DataRegistry contract across integration test runs? ​

On the first run, copy the contract address printed in the test output, then add it to .env.integration:

INTEGRATION_CONTRACT_ADDRESS=02abc123…

Subsequent runs will join the existing contract, skipping the slow deployment step.