DOME Docs

Getting Started

Install @dome/sdk-evm and run a balance check on Base Sepolia.

Prerequisites

  • Node.js 20+
  • Base Sepolia RPC URL (e.g. Alchemy)
  • Running Dome backend with indexed pool (or use https://api.getdome.app)

Install

git clone https://github.com/Dome-Foundation/dome-sdk-evm.git
cd dome-sdk-evm
npm install
npm run build

Environment

export DOME_EVM_INDEXER_URL=https://api.getdome.app
export DOME_BASE_RPC=https://base-sepolia.g.alchemy.com/v2/YOUR_KEY
export DOME_ETH_POOL_ADDRESS=0x...   # from base-sepolia-deploy.json
export DOME_FEE_RECIPIENT_ADDRESS=0x...
export DOME_CHAIN_ID=84532
export DOME_CIRCUIT_KEY_BASE_PATH=https://circuits.getdome.app/transaction
export PRIVATE_KEY=0x...             # funded test wallet

Smoke test

From the monorepo root with Sepolia configured:

node dome-sdk-evm/scripts/smoke-sepolia.mjs balance
node dome-sdk-evm/scripts/smoke-sepolia.mjs deposit 0.001
node dome-sdk-evm/scripts/smoke-sepolia.mjs withdraw 0.0006

Local Hardhat

bash scripts/dev/up.sh
cd dome-sdk-evm && npm run build
npm run test:integration   # in dome-backend

See Configuration for all env vars.

SDK Overview

TypeScript SDK for Dome shielded transactions on Base.

Configuration

Environment variables for @dome/sdk-evm and host apps.

On this page

PrerequisitesInstallEnvironmentSmoke testLocal Hardhat