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.

Skip to content

Main Navigation Guide Features FAQ

Appearance

Sidebar Navigation

FAQ

Overview

Concepts & Features

What is dStorage?

Who is dStorage designed for?

What problem does it solve?

What is an on-chain reference and why does it matter?

What does the SDK store on-chain vs off-chain?

What happens, step by step, when I call `store()`?

Can dStorage operators read my data?

What is a `refId`?

What is a `storageId`?

Does dStorage work without a blockchain?

Does dStorage support large files?

What networks and storage providers are supported today?

What tokens are used for payments?

What does `isPublic: true` do?

Developers

What is the minimal working setup?

What does `sdk.init()` do?

Should I call `sdk.destroy()` when I'm done, and why?

What happens if `store()` succeeds at the storage layer but fails to write the on-chain reference?

How do I preserve a deployed contract address across runs?

Can I estimate costs before uploading?

How do I pass metadata to an upload?

How do I run tests?

How do I run only a single integration suite?

What scrypt params should I use in tests?

What is the build order for packages?

Can I integrate dStorage into an existing Midnight app?

What is `executeMetaTransaction()` and when should I use it?

How do I update the content stored at an existing reference?

How do I rotate encryption adapters without re-uploading content?

How do I list all my on-chain references?

How do I remove an on-chain reference?

What Node.js version is required?

Does the SDK work in the browser?

Encryption & Security

What encryption scheme does the SDK use?

What is the DEK/KEK model?

What encryption adapters are available?

Why does `MnemonicEncryptionAdapter` require 24 words?

Can multiple adapters decrypt the same upload?

What happens if I lose my encryption key / password?

Is `PasswordEncryptionAdapter` post-quantum safe?

What is `generatePqsPassword()`?

What makes a password acceptable to `PasswordEncryptionAdapter`?

How does the SDK prevent swapping chunks or blobs in transit?

How does the SDK verify that an Arweave gateway hasn't tampered with the retrieved data?

Is the storage pointer on-chain encrypted?

What is the on-chain content hash and what does it protect against?

Is the on-chain content hash computed from the plaintext or the ciphertext?

How does the on-chain hash differ from the `X-Content-Hash` Arweave tag?

What is `ownerSecret` and why is it not stored?

What exactly changes when I call `rotateKeys()` — and what stays the same?

If I call `update()`, what happens to the original content on the storage network?

Deployment & Configuration

What are the prerequisites for running the SDK locally?

How do I start the local Midnight proof server?

How do I start a local Arweave node for testing?

What Midnight networks does the adapter support?

How do I configure `MidnightChainAdapter` for browser vs Node.js?

How do I configure `ArweaveBundlerStorageAdapter` for managed uploads?

How do I reuse an existing DataRegistry contract?

Where do ZK artifacts live and how are they served?

What environment variables does the integration test suite need?

Can I skip integration services in CI?

Adapters

What is an adapter and how do the three types compose?

`MockStorageAdapter`

`ArweaveStorageAdapter`

`ArweaveLocalStorageAdapter`

`ArweaveBundlerStorageAdapter`

`MockChainAdapter`

`HttpGatewayChainAdapter`

`MidnightSimulatorChainAdapter`

`MidnightChainAdapter`

`PasswordEncryptionAdapter`

`MnemonicEncryptionAdapter`

`KeypairEncryptionAdapter`

Managed Payments & dStorage Pro

What is dStorage Pro?

What does the managed service see?

How do I configure the managed payment flow?

Where do I get an auth token?

How do I set the credentials via environment variables?

What is `ArweaveBundlerStorageAdapter` and how does it differ from `ArweaveStorageAdapter`?

What does the managed Midnight chain payment flow look like?

Does the managed service support the bboard quick-start example?

Is there a known security limitation with the managed payment response?

What payment tokens does the managed service handle?

How do I test the managed payment code path without real dStorage Pro credentials?

What type of API token do I need to use the managed service?

Can I use a `ds_*` token in browser-side JavaScript?

What is a JWT token and why does the service support it?

What do JWT tokens provide that a `ds_*` token does not?

Troubleshooting

`Maximum call stack size exceeded` when encrypting files

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

`Invalid URL` instead of an `init()` error

ZK artifacts not found / `Invalid URL` at runtime

Wallet extension not detected in browser connector mode

Integration tests stall or never complete

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

On this page

FAQ

Concepts & Features
Developers
Encryption & Security
Deployment & Configuration
Adapters
Managed Payments & dStorage Pro
Troubleshooting

Pager

Next pageConcepts & Features