@meshsdk/midnight-setup

Complete development setup for building Midnight Network dApps

Quick Start

Installation

yarn add @meshsdk/midnight-setup

Basic Usage

import { MidnightSetupAPI } from '@meshsdk/midnight-setup';

// Deploy a new contract
const api = await MidnightSetupAPI.deployContract(providers, contractInstance);

// Join an existing contract
const api = await MidnightSetupAPI.joinContract(providers, contractInstance, contractAddress);

// Get contract state
const state = await api.getContractState();

// Get ledger state
const ledgerState = await api.getLedgerState();

What's Included

This monorepo contains everything you need to build Midnight Network dApps:

• @meshsdk/midnight-setup - Main npm package with API and types
• packages/ui - Example React application
• packages/cli - Command-line tools
• packages/api - Core API implementation

Core API Methods

MidnightSetupAPI

Method	Description	Usage
deployContract(providers, contractInstance)	Deploy a new contract	Creates new contract instance
joinContract(providers, contractInstance, address)	Join existing contract	Connect to deployed contract
getContractState()	Read contract state	Get current contract data
getLedgerState()	Read ledger state	Get blockchain data

Provider Setup

import { setupProviders } from './lib/providers';

const providers = await setupProviders();
// Returns: MidnightSetupContractProviders

Lace Wallet Integration

This project includes a complete Lace Beta Wallet integration for Midnight Network:

Wallet Features

Feature	Description	Implementation
Connect Wallet	Connect to Lace Beta Wallet	wallet.enable()
Disconnect Wallet	Disconnect from wallet	wallet.disconnect()
Get Wallet State	Retrieve wallet address and keys	wallet.state()
Deploy Contract	Deploy contracts through wallet	wallet.submitTransaction()
Join Contract	Join existing contracts	wallet.balanceAndProveTransaction()
Balance Transactions	Balance and prove transactions	Wallet API integration

Wallet Provider Setup

// Connect to Lace Wallet
const wallet = window.midnight?.mnLace;
if (!wallet) {
  throw new Error('Please install Lace Beta Wallet for Midnight Network');
}

// Enable wallet and get state
const walletAPI = await wallet.enable();
const walletState = await walletAPI.state();
const uris = await wallet.serviceUriConfig();

React Wallet Hook

import { useMidnightWallet } from './hooks/useMidnightWallet';

function App() {
  const { 
    connectWallet, 
    disconnectWallet, 
    walletState, 
    isConnected 
  } = useMidnightWallet();
  
  return (
    <div>
      {isConnected ? (
        <button onClick={disconnectWallet}>Disconnect</button>
      ) : (
        <button onClick={connectWallet}>Connect Wallet</button>
      )}
    </div>
  );
}

Project Structure

├── packages/
│   ├── api/          # Core API implementation
│   ├── ui/           # React example app
│   └── cli/          # Command-line tools
├── compact/          # Smart contract source
└── README.md

Key Features

• Zero-knowledge privacy - Built for Midnight Network
• TypeScript support - Full type safety
• React hooks - Easy integration
• Wallet integration - Lace Beta Wallet support
• CLI tools - Development utilities

Integration Examples

React Hook

import { useMidnightContract } from './hooks/useMidnightContract';

function App() {
  const { api, deployContract, joinContract } = useMidnightContract();
  
  const handleDeploy = async () => {
    const newApi = await deployContract();
    console.log('Deployed:', newApi.deployedContractAddress);
  };
  
  return <button onClick={handleDeploy}>Deploy Contract</button>;
}

Try the Project

To test the complete setup locally, follow these steps strictly:

• 1. Clone the repository

• using https:

git clone https://github.com/MeshJS/midnight-setup.git

• using ssh:

git clone [email protected]:MeshJS/midnight-setup.git

• 2. Navigate to the folder

cd midnight-setup

• 3. Install dependencies

yarn install

• 3. Set environment variable

cd packages/ui && echo 'VITE_NETWORK_ID="TestNet"' > .env

• 5. Build all packages

cd ../../ && yarn build:all

• 6. Download fetch parameters

cd packages/cli && ./fetch-zk-params.sh

• 7. Start testnet with Docker

docker-compose -f testnet.yml up -d

• 8. Run the frontend

cd ../ui && yarn start

Resources

• Midnight Network Docs
• Mesh SDK Documentation
• Lace Beta Wallet

Community

• Discord Community
• Twitter

---

Powered by MeshJS Team

Built with ❤️ on Midnight Network