Docker Flow

Run the full builder-scaffold flow inside a Docker container — no Sui CLI or Node.js required on your host. The same steps work for any extension example (smart_gate_extension, storage_unit_extension, or your own); this guide uses smart_gate_extension for the publish and scripts steps.

1. Prerequisites

• Docker installed

2. Clone the Repo

If you haven’t already:

mkdir -p workspace && cd workspace
git clone https://github.com/evefrontier/builder-scaffold.git
cd builder-scaffold

3. Start the Container

cd docker
docker compose run --rm --service-ports sui-dev

On first run the container creates three funded accounts (ADMIN, PLAYER_A, PLAYER_B). Keys persist across container restarts via a Docker volume. Every start spins up a fresh local Sui node and funds the accounts from the faucet.

Inside the container you get:

/workspace/
├── builder-scaffold/    # full repo (syncs with host)
└── world-contracts/     # bind mount — clone here (syncs with host)

For full container details (workspace layout, testnet switching, cleanup) see the Docker Environment page.

4. Switch to Testnet (Optional)

You can switch to testnet from inside the container the same way you would on your host:

sui client switch --env testnet
sui keytool import <your-private-key> ed25519
sui client faucet

5. Deploy World and Create Test Resources

cd /workspace/world-contracts
git clone -b v0.0.18 https://github.com/evefrontier/world-contracts.git .
/workspace/scripts/generate-world-env.sh   # creates .env from docker/.env.sui keys
pnpm install
pnpm deploy-world localnet       # or testnet
pnpm configure-world localnet    # or testnet
pnpm create-test-resources localnet   # or testnet

6. Copy World Artifacts into Builder Scaffold

NETWORK=localnet   # or testnet
mkdir -p /workspace/builder-scaffold/deployments/$NETWORK/
cp -r deployments/* /workspace/builder-scaffold/deployments/
cp test-resources.json /workspace/builder-scaffold/test-resources.json
cp "contracts/world/Pub.localnet.toml" "/workspace/builder-scaffold/deployments/localnet/Pub.localnet.toml"

7. Configure .env

cd /workspace/builder-scaffold
cp .env.example .env

Set the following in .env:

• Same keys/addresses used during world deployment
• SUI_NETWORK=testnet (or localnet)
• WORLD_PACKAGE_ID — from deployments/<network>/extracted-object-ids.json (world.packageId)

8. Publish a Custom Contract

Pick an example (e.g. smart_gate_extension or storage_unit_extension); use its folder in move-contracts/:

cd /workspace/builder-scaffold/move-contracts/smart_gate_extension   # or storage_unit_extension, or your package

Localnet — use ephemeral publication:

sui client test-publish --build-env testnet --pubfile-path ../../deployments/localnet/Pub.localnet.toml

Testnet — publish directly:

sui client publish -e testnet

Set BUILDER_PACKAGE_ID and EXTENSION_CONFIG_ID in /workspace/builder-scaffold/.env from the publish output.

For more details see the Move Contracts page.

9. Run Scripts

For the smart_gate_extension example (scripts are in the repo root):

cd /workspace/builder-scaffold
pnpm install
pnpm configure-rules
pnpm authorise-gate-extension
pnpm authorise-storage-unit-extension
pnpm issue-tribe-jump-permit
pnpm jump-with-permit
pnpm collect-corpse-bounty

Useful Commands

See Docker Environment for container rebuild, cleanup, and troubleshooting details.