For the complete documentation index, see llms.txt

Guides

Find the guide for the task in front of you, from choosing a network to deploying a smart contract. Start with one of the common tasks below, or pick a guide from the full list.

Common tasks

✦

Connect to a network

Choose between the local, Preview, Preprod, and Mainnet networks, then point your DApp at the right network ID and endpoints.

Choose a network→

✦

Fund a wallet

Get tNIGHT from the faucet and register it for DUST generation, so that your wallet can pay transaction fees.

Get test tokens→

✦

Deploy a smart contract

Configure the Midnight.js providers, deploy a Compact contract to a network, observe its state, and keep it updatable.

Deploy your contract→

✦

Secure a smart contract

Authenticate callers, validate inputs, enforce deadlines, and prevent replay attacks, with a test that proves each control.

Secure your contract→

All guides

Set up your environment

• Networks and environments: choose a network, look up its endpoints, run a local network, and prepare for Mainnet.
• Run the proof server: start the proof server from Docker Desktop, for wallet users rather than DApp builders.
• Prove locally: run a local proof server or delegate proving to the wallet, see what a proof server receives, and learn why remote proving isn't recommended.
• Windows Compact setup: set up WSL, Docker Desktop, the proof server, and the Compact compiler on Windows.
• Set up Bun for Midnight development: install Bun and the Compact compiler, then compile a contract and use it from a Bun application.

Fund a wallet and pay fees

• Fund a wallet: get tNIGHT from the faucet and register it for DUST generation, in Lace or with the wallet SDK.
• Manage DUST: read DUST balances, estimate a fee, send several transactions from one wallet, and resolve DUST errors.
• Run a wallet in Node.js: build a wallet from a seed in a Node.js process, keep its state across restarts, and deploy from a script.
• DUST sponsorship: pay DUST fees on behalf of your users.

Test, deploy, and secure a smart contract

• Build a private smart contract: keep data on-device, disclose only what is needed, then compile and test the contract locally.
• Use Compact contracts from JavaScript: implement witnesses, call circuits, and write unit tests for a compiled contract.
• Manage private state with witnesses: declare witnesses in Compact, implement them in TypeScript, wire up private state, and avoid common pitfalls.
• Deploy and operate a contract: configure the Midnight.js providers, deploy a contract, observe its state, and keep it updatable.
• Security and best practices: authenticate callers, validate inputs, enforce deadlines, and prevent replay attacks.

Connect a wallet to a frontend

• Create a React wallet connector: connect a React application to a Midnight wallet through the DApp Connector API.
• Create a Next.js wallet connector: connect a Next.js application to a Midnight wallet through the DApp Connector API.
• Build a browser DApp: build the Midnight.js providers from a connected wallet, then deploy a contract, call a circuit, and read private state.

Index contract state and build across chains

• Index contract state with EffectStream: watch a Midnight contract and serve its public state over HTTP.
• Build a cross-chain DApp with EffectStream: run a template whose state lives on Midnight and an EVM chain.