Skip to content

Our Packages

We use a toolbox pattern: one main package bundles several focused plugins.

graph TD
    User[User Project] --> Toolbox[hardhat-arbitrum-stylus]
    Toolbox --> Node[hardhat-arb-node]
    Toolbox --> Compile[hardhat-arb-compile]
    Toolbox --> Deploy[hardhat-arb-deploy]
    Toolbox --> Test[hardhat-arb-test]
    Node --> Utils[hardhat-arb-utils]
    Compile --> Utils
    Deploy --> Utils
    Test --> Utils

Package Overview

Package Purpose
hardhat-arbitrum-stylus Toolbox - users install this one
hardhat-arb-node Local node management
hardhat-arb-compile Contract compilation
hardhat-arb-deploy Deployment
hardhat-arb-test Test runner
hardhat-arb-utils Shared utilities

Source Layout Convention

For plugin packages, we standardize source layout like this:

  • src/index.ts - stable public entrypoint
  • src/plugin/ - Hardhat plugin wiring (index.ts, type-extensions.ts, hooks/, tasks/)
  • src/config/ - config types/defaults/resolution
  • src/state/ - module-scoped runtime state
  • src/services/ - operational logic (compile/deploy/node services)
  • src/constants/ - static constants and bytecode
  • src/utils/ - compatibility/public utility barrels only

This keeps lifecycle wiring separate from domain logic and makes file placement predictable across packages.

The Toolbox

hardhat-arbitrum-stylus just bundles the others:

const hardhatArbitrumStylusPlugin: HardhatPlugin = {
  id: 'hardhat-arbitrum-stylus',
  dependencies: () => [
    import('@cobuilders/hardhat-arb-node'),
    import('@cobuilders/hardhat-arb-compile'),
    import('@cobuilders/hardhat-arb-deploy'),
    import('@cobuilders/hardhat-arb-test'),
  ],
  npmPackage: '@cobuilders/hardhat-arbitrum-stylus',
};

Users install one package, get everything.

Shared Utilities

hardhat-arb-utils provides common code:

  • Container - Docker client and lifecycle management
  • Errors - Standardized HardhatPluginError creation
  • Web3 - RPC helpers and viem client