@vechain/dev-stack

Shared local development environment for VeChain projects.

Brings up one thor-solo node, one mongo, one vechain-indexer, and one block-explorer that multiple projects can share. Each project deploys its own contracts and registers their addresses with the shared stack; the indexer and explorer pick up the union.

Consumer contract

A project joins the stack by providing two things:

1. vechain-dev.config.mjs at the project root

export default {
  project: 'my-project',
  profiles: ['safe', 'accounts', 'transactions'],
  deploy:  'yarn contracts:deploy:solo',
  // optional:
  // overlay: 'docker/overlay.yaml',
}

2. A deploy step that registers addresses

After deploying contracts to thor-solo, the deploy script calls:

import { registerAddresses } from '@vechain/dev-stack'

await registerAddresses({
  project: 'my-project',
  profiles: ['safe', 'accounts', 'transactions'],
  addresses: {
    SAFE_EMITTER_CONTRACT:       '0x...',
    SAFE_PROXY_FACTORY_CONTRACT: '0x...',
  },
})

This writes ~/.vechain-dev/config/my-project.json.

Commands

Project lifecycle — requires vechain-dev.config.mjs:

vechain-dev up                  # ensure infra, deploy if needed. Exits when infra is ready.
vechain-dev up --redeploy       # force the deploy step even if contracts are on-chain
vechain-dev up --skip-deploy    # bring infra up without running the deploy step
vechain-dev deploy              # re-run deploy + recreate indexer (no thor/explorer restart)
                                # always runs — no on-chain check
vechain-dev down                # stop the full stack (thor state preserved; mongo is ephemeral)
vechain-dev clean               # nuke all shared infra, volumes, and ~/.vechain-dev/
vechain-dev status              # show registered projects and service health

up does not run a frontend dev server — start that in a separate terminal (e.g. yarn frontend:dev). This keeps the frontend's lifecycle decoupled from contract redeploys: run vechain-dev deploy whenever you need fresh contracts; the frontend keeps running.

Service control — no config required:

vechain-dev solo up             # start only thor-solo
vechain-dev solo down           # stop only thor-solo (chain state preserved)
vechain-dev solo logs [-f]      # tail thor-solo logs
vechain-dev solo clean          # remove the container and the chain-data volume

vechain-dev indexer up          # start mongo + vechain-indexer + vechain-indexer-api
vechain-dev indexer down        # stop these services (mongo state is wiped — tmpfs)
vechain-dev indexer logs [-f]   # tail indexer + indexer-api logs (skips mongo noise)
vechain-dev indexer recreate    # re-merge address book + force-recreate the indexer containers
vechain-dev indexer clean       # remove the containers

Typical package.json:

"scripts": {
  "dev:up":           "vechain-dev up",
  "dev:down":         "vechain-dev down",
  "dev:clean":        "vechain-dev clean",
  "dev:deploy":       "vechain-dev deploy",
  "solo:up":          "vechain-dev solo up",
  "solo:down":        "vechain-dev solo down",
  "solo:logs":        "vechain-dev solo logs -f",
  "solo:clean":       "vechain-dev solo clean",
  "indexer:up":       "vechain-dev indexer up",
  "indexer:down":     "vechain-dev indexer down",
  "indexer:logs":     "vechain-dev indexer logs -f",
  "indexer:recreate": "vechain-dev indexer recreate",
  "indexer:clean":    "vechain-dev indexer clean"
}

Two-terminal day-to-day: terminal 1 yarn dev:up, terminal 2 your frontend dev server. Redeploy with yarn dev:deploy without touching the frontend.

Customizing thor-solo

All optional, all read from the environment:

| env var | default | maps to | |---------------------------------------------|----------------------------------|-------------------------------| | VECHAIN_DEV_THOR_IMAGE | ghcr.io/vechain/thor:latest | docker image | | VECHAIN_DEV_THOR_GAS_LIMIT | 40000000 | --gas-limit | | VECHAIN_DEV_THOR_TXPOOL_LIMIT | 10000 | --txpool-limit | | VECHAIN_DEV_THOR_TXPOOL_LIMIT_PER_ACCOUNT | 256 | --txpool-limit-per-account | | VECHAIN_DEV_THOR_API_CORS | * | --api-cors | | VECHAIN_DEV_GENESIS | bundled solo.default.json | mounted genesis file | | VECHAIN_DEV_HOME | ~/.vechain-dev | state directory | | VECHAIN_DEV_INDEXER_IMAGE | ghcr.io/vechain/vechain-indexer/indexer:6.31.5 | indexer image | | VECHAIN_DEV_INDEXER_API_IMAGE | ghcr.io/vechain/vechain-indexer/api:6.31.5 | indexer-api image | | VECHAIN_DEV_EXPLORER_IMAGE | ghcr.io/vechain/block-explorer:2.41.0 | block-explorer image |

These work for both vechain-dev solo up and vechain-dev up.

Programmatic API

import { registerAddresses, isProjectDeployed } from '@vechain/dev-stack'

isProjectDeployed(project, opts?) returns { deployed: true } or one of:

• { deployed: false, reason: 'not-registered' } — no registration file yet
• { deployed: false, reason: 'missing-code', address } — registered address has no code on-chain
• { deployed: false, reason: 'address-mismatch', name, expected, actual } — only when expectedAddresses is supplied and a registered address differs

Pass expectedAddresses: { ENV_NAME: '0x…' } to detect stale registrations (e.g. cached deployment artifacts pointing at a different address than the chain). This replaces the per-project artifact-wipe scripts some consumers maintain.

Running multiple checkouts of the same app

vechain-dev.config.mjs is a per-checkout file, so two checkouts of the same repo can coexist by giving each its own project name locally. In the second checkout, edit the file to project: 'multisig-2' (don't commit) — the rest follows: separate registration file, separate isProjectDeployed answers, separate deploy lifecycle. thor-solo is shared.

The indexer still merges env vars across projects, so two checkouts that register the same env-var names (e.g. SAFE_EMITTER_CONTRACT) will collide there. Contracts deploy correctly and registrations are distinct — the indexer is the only loose end.

Endpoints

| service | URL | |----------------|---------------------------| | thor-solo | http://localhost:8669 | | indexer-api | http://localhost:8089 | | block-explorer | http://localhost:8088 | | mongo | mongodb://localhost:27017 |