Chapter 10

Builder Scaffold

Note

The builder-scaffold repository is under active development. Some workflows (e.g. world deployment) are being simplified into single-command operations. Check the repo for the latest changes.

Templates and tools for building on EVE Frontier. The builder-scaffold repository provides everything you need to deploy a world, write custom Move contracts (extensions), publish them, and interact with them via TypeScript scripts — all locally or on testnet.

What’s in the Repo

Directory Purpose
docker/ Dev container (Sui CLI + Node.js) — used by the Docker flow.
move-contracts/ Custom Smart Assembly extension examples (e.g. smart_gate_extension, storage_unit_extension); build & publish.
ts-scripts/ TypeScript scripts to call your contracts; run after publishing.
rust-scripts/ Same functionality as TypeScript scripts, implemented in Rust.
setup-world/ What “deploy world” does and what gets created.
dapps/ Reference dApp template (optional next step).
zklogin/ zkLogin CLI for OAuth-based signing (optional).

Prerequisites

Quick Start

Clone the repo:

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

Then choose a flow:

Flow When to Use
Docker Flow No Sui/Node on host; run everything in a container (local or testnet).
Host Flow Sui CLI + Node.js installed on your machine; target local or testnet.
Building on an existing world (coming soon) World already deployed (e.g. shared server, live game); you don’t deploy the world yourself.

By the end you’ll have a deployed world, a published custom contract (e.g. smart_gate_extension), and scripts that call it.

Tip

Use the menu on the left hand side to find the article you are looking for. You can also use search at the top to search for specific terms.