Configuration

Every key of rocketh/config.ts. The file exports config (and, by convention, the extensions your scripts use); @rocketh/node reads rocketh.ts or rocketh/config.ts from the current directory (or a .js one), and refuses to start when it finds both a TypeScript and a JavaScript configuration. The types are UserConfig, ChainUserConfig and DeploymentEnvironmentConfig in packages/rocketh-core/src/types.ts, which this page mirrors.

import type {UserConfig} from 'rocketh/types';

export const config = {
	accounts: {deployer: {default: 0}},
	environments: {sepolia: {chain: 11155111}},
	chains: {11155111: {confirmationsRequired: 2}},
	data: {},
} as const satisfies UserConfig;

as const satisfies UserConfig keeps the literal types, which is what types env.namedAccounts and env.data in your scripts. Under hardhat-deploy, the Hardhat side (networks, compilers, typed artifacts) is in hardhat.config.ts, see Get started with hardhat-deploy.

Top level (UserConfig)

Environments (environments.<name>)

An environment is never invented from a chain name: a name the config does not declare has no chain id, and the run stops unless the node can be asked (a provider, or a fork).

Chains (chains.<id>, and overrides / whenForked)

Run parameters

What a command line sets for one run, the programmatic entry points (loadAndExecuteDeploymentsFromFiles, loadEnvironmentFromFiles, @rocketh/web's loaders) take as ExecutionParams:

@rocketh/node adds writeTransactions (a file path), the programmatic form of --write-transactions.