Skip to main content

Installation

Learn how to set up Scaffold-DOT on your system.

Prerequisites​

Before installing Scaffold-DOT, make sure you have the following tools installed:

Platform Support

Scaffold-DOT currently supports Linux and macOS (x64 and ARM64). Windows is not supported at this time.

Install Scaffold-DOT​

1. Clone the Repository​

git clone https://github.com/scaffold-dot/scaffold-dot.git
cd scaffold-dot

2. Install Dependencies​

yarn install

This command will:

  • Install all Node.js dependencies
  • Download the correct prebuilt Asset Hub binaries for your system
  • Set up the monorepo structure

The installation script automatically detects your platform and downloads:

  • revive-dev-node: Local Substrate node with PolkaVM support
  • eth-rpc: Ethereum RPC compatibility layer

3. Verify Installation​

Check that all binaries were downloaded correctly:

ls packages/asset-hub-pvm/bin/

You should see:

  • revive-dev-node
  • eth-rpc

Project Structure​

After installation, your project will have this structure:

scaffold-dot/
├── packages/
│   ├── hardhat/          # Smart contract development
│   ├── nextjs/           # Frontend application
│   └── asset-hub-pvm/    # Polkadot binaries
├── package.json
└── yarn.lock

Troubleshooting​

Binary Download Issues​

If binaries fail to download during installation:

yarn setup:binaries

This manually runs the binary download script.

Permission Errors​

On Linux/macOS, ensure the binaries are executable:

chmod +x packages/asset-hub-pvm/bin/*

Platform Not Supported​

If you receive a "platform not supported" error, your OS/architecture combination may not have prebuilt binaries. Supported platforms:

  • linux-x64
  • darwin-x64 (macOS Intel)
  • darwin-arm64 (macOS Apple Silicon)

Node Version Issues​

Ensure you're using Node.js >= 20.18.3:

node --version

Use nvm to manage Node.js versions:

nvm install 20
nvm use 20

Next Steps​

Now that you have Scaffold-DOT installed, check out the Quick Start Guide to build your first dapp!