Canton dAppBooster
    Preparing search index...

    Canton dAppBooster

    Canton dAppBooster

    Static Badge GitHub top language GitHub branch status GitHub License

    Local Canton development stack.

    • Node 24 (>=24.15.0)
    • pnpm
    • Docker
    • dpm (DAML SDK 3.4.11)

    Run the install script and follow the on-screen instructions.

    pnpm dlx dappbooster --canton
    

    A more detailed step-by-step installation guide is available below.

    Once Canton dAppBooster is installed, the easiest way to start the development stack is using the dev-stack script. It allows you to install, bring up and tear down everything you need in a simple way.

    ./scripts/dev-stack.sh
    

    • The demo app runs on http://localhost:3012/ by default.
    • Select Wallet Gateway from the picker when connecting and enter unsafe as the client secret.
    • Wallet Gateway runs on http://localhost:3030 by default. You'll need at least 2 parties in it to explore the demo's features in full. Create parties with wallet-kernel as the signing provider.
    • Technical documentation available at https://docs.dappbooster.cc

    git clone git@github.com:BootNodeDev/canton-dappbooster.git <project-name>
    
    pnpm i
    
    open -a Docker
    
    cp .env.example .env
    

    Default values should be enough, except for CANTON_BACKEND_TOKEN which must be generated.

    To generate it run this command and then add the token to .env

    pnpm run mint-token
    

    Create a folder for canton-barebones.

    mkdir -p .canton-localnet
    cd .canton-localnet

    Then run this command to scaffold it.

    pnpm exec canton-barebones init
    

    Edit canton-barebones.config.json: change validators.appUser.ui and sv.scanUI to true.

    Start canton-barebones from .canton-localnet

    pnpm exec canton-barebones start
    

    Notes:

    • The first run pulls ~10 GB. If start exits 1 during splice migrations, run it again.
    • Splice can take a few minutes to start.

    deploy-dar requires LocalNet up and running.

    pnpm run build-dar
    # use the appropriate version for amulet-vesting-*.dar
    pnpm run deploy-dar -- dapp/daml/.daml/dist/amulet-vesting-*.dar

    Note: The step is only needed the first time. Run again if the Daml source changes or if LocalNet is reset.

    Start the Wallet Gateway, which is the wallet the dApp connects to.

    pnpm run wallet-gateway
    

    Needs LocalNet up and running.

    pnpm run bootstrap
    

    Note: The step is only needed the first time. Run again if the Daml source changes or if LocalNet is reset.

    Start the Vesting demo app.

    # runs on http://localhost:3012 by default
    pnpm run app:dev