Prerequisites
What you need before scaffolding — Node, pnpm, the operator key, and a vault id.
Three things, then you scaffold. None of them takes more than a minute.
Toolchain
- Node.js: version 20 or newer. Check with
node --version. - A package manager: npm ships with Node and just works. The examples use pnpm shorthand (
pnpm dry-run …); with npm the same scripts arenpm run dry-run ….
The operator key
A vault names exactly one address allowed to act for it: its operator_address. The operator key is the Ed25519 keypair behind that address — a suiprivkey1… string. You generate it and you hold it. Nothing issues it to you; there is no console handing out keys.
Whatever signs with that key is the vault's operator. The runner reads it from OPERATOR_PRIVATE_KEY and signs every action with it. Keep it secret, and keep one operator per vault: don't drive the same vault by hand while the runner runs.
For why a vault binds to a single operator, see What is a vault.
A vault id
The runner operates one vault, addressed by its on-chain object id (0x…). You get one by creating a vault in Studio. When you create it, you set its operator_address to the address of the key above, so the two are linked from the start.
That's it. With Node, pnpm, your suiprivkey1…, and a 0x… vault id in hand, you're ready to scaffold.
Next: Scaffold →