Skip to content

Installation

Requirements

  • Node.js 18.0.0 or higher
  • A package manager (pnpm, npm, or yarn)

Install the Package

Terminal window
pnpm add @no-witness-labs/midday-sdk

Peer Dependencies

Midday SDK includes all necessary dependencies. However, if you’re using the Effect API, you may want to install Effect explicitly for better IDE support:

Terminal window
pnpm add effect

TypeScript Configuration

Midday SDK is written in TypeScript and ships with type definitions. For the best experience, ensure your tsconfig.json includes:

{
"compilerOptions": {
"moduleResolution": "bundler",
"target": "ES2022",
"module": "ESNext",
"strict": true
}
}

Browser vs Node.js

Midday SDK works in both environments, but there are some differences:

FeatureNode.jsBrowser
WalletSeed-based HD walletLace wallet extension
Private StateIn-memory or file-basedIndexedDB
ZK ConfigLocal or HTTP providerHTTP provider

Next Steps

Now that you have Midday SDK installed, head to the Quick Start guide to create your first client.