Utility repository for building and deploying smart contracts.

Quick start

Prerequisites

We will use deno, a modern alternative to Node that can work with TypeScript out of the box. You can install it by running:

curl -fsSL https://deno.land/install.sh | sh

Setting up the Development Environment

For local development, you'll need to build the development node and Ethereum RPC proxy.

1. Clone the Polkadot SDK

First, clone the Polkadot SDK repository:

git clone https://github.com/paritytech/polkadot-sdk.git ~/polkadot-sdk

2. Source the Helper Scripts

Source the helper scripts to make the build commands available:

source scripts/node-env.sh

You can add this to your shell profile (.bashrc, .zshrc, etc.) to make these commands available in every session.

3. Build the Binaries

Build both the development node and the Ethereum RPC proxy:

# Build the development node
dev-node build

# Build the Ethereum RPC bridge
eth-rpc build

These commands will compile the binaries into ~/polkadot-sdk/target/debug/. The build process may take some time on the first run.

4. Running the Development Stack

Once built, you can run the complete development stack in tmux:

# Run both services in separate tmux panes
revive_dev_stack

# Or run with mitmproxy for traffic inspection
# Note: Requires mitmproxy setup first - https://github.com/pgherveou/mitmproxy
revive_dev_stack proxy

Alternatively, you can run each service individually:

# Run the development node
dev-node run

# In another terminal, run the Ethereum RPC bridge
eth-rpc run ws://localhost:9944

Building contracts

We can now compile the contracts located in the contracts/ directory:

deno task build [--filter <contract-name>] [--clean]

This does the following:

• Compile the bytecode for each contract into codgen/bytecode/*
• Generate the abi for each contract into codgen/abi/*.ts and the index codegen/abis.ts

Deploying contracts

Before you can deploy contracts, let's copy the .env.example file to .env and fill in the required environment variables.

cp .env.example .env

Update tools/deploy.ts to include new contracts you want to deploy. Make sure to specify the constructor arguments and the value, if needed.

Deploying to Testnet

To deploy to Westend Testnet, you will need to specify the TESTNET_PRIVATE_KEY. Check the instructions here to connect with your wallet and request funds.

Deploying to a local chain

Local deployments will use the account 0xf24FF3a9CF04c71Dbc94D0b566f7A27B94566cac already configured in your .env file, This account is pre-funded at genesis, so you can use it to deploy contracts.

Now that you have the environment variables setup, ensure that your chain is running and deploy the contracts by running:

deno task deploy [--filter <contract-name>]

This command will update the codegen/addresses.ts file with the deployed contract addresses, so that you can easily reference them in your apps.

Note: You can also test against geth, the deployment code, will detect the chain and deploy the right bytecode (evm or pvm).

Testing with Block Explorer

For testing and debugging, you can use an in-browser block explorer at https://polkadotevm-explorer.netlify.app/ to inspect transactions, contracts, and blockchain state.

Run cli

There is an example cli in the cli directory that you can run to interact with the deployed contracts.

./cli/playground.ts

Learn more

• Asset Hub documentation to learn more about building Smart Contracts on Asset Hub.
• viem documentation to learn more about the library used to interact with EVM contracts.