Scaffolding tooling that lets developers bootstrap a project, write and build Rust smart contracts, deploy to a local or DevNet environment, and interact with contracts via a wallet.
FURPS v0.1
Functionality
- One public DevNet vertical slice: generate wallet, fund wallet, deploy contract, execute one transaction type, verify result.
- Integrate wallet generation as part of the scaffold workflow for bootstrap and interaction flows.
- Support native token topup for wallet operations on local and DevNet environments.
Usability
- Single command bootstrap with no manual project wiring required.
- Generated layout clearly separates contract code, client code, config, and deploy scripts.
- Deterministic wallet generation and .env handling for repeatability.
- Clear happy-path docs, reproducible setup, discoverable commands.
- CLI prints underlying commands for each step so users can drop down to lower-level tooling.
Reliability
- The vertical slice must succeed 3 times in a row on a clean machine with deterministic wallets.
- Local network can be started and torn down in isolation without modifying host-global blockchain state.
Performance
- Each workshop step must complete within a demo-tolerable threshold (a few minutes).
Supportability
- Scaffold version and toolchain versions are explicit in generated output so projects remain buildable over time.
- Network configuration for local and DevNet deployment is .env based config.
- The scaffolded project includes command references for build, deploy, and interaction steps.
+ (Privacy, Anonymity, Censorship-Resistance)
- Local workflow does not require uploading source code, artifacts, or private keys to third-party services.
- CLI interaction flow works with locally controlled wallet keys and does not require custodial key management.
- Local development and testing can run fully offline from public networks.
- DevNet interaction uses explicit wallet and RPC configuration so developers can avoid accidental cross-network key reuse.
Architecture Decision Records
Project Structure (Single-Repo Template)
Developers need one bootstrap target that is immediately runnable and easy to modify. Use a single generated project containing contract, CLI client, configuration, and deployment scripts. Single-template onboarding is very simple.
CLI
The workflow should be discoverable for new developers. Expose one CLI surface with subcommands for init, build, deploy, and interact. One CLI improves onboarding but makes it hard to maintain backward-compatibility.
Local Runtime
Local development should work without requiring manually managed external node setup. Provide embedded localnet lifecycle commands as part of scaffold workflow. The scaffolded toolchain can start, stop, and reset a localnet environment that supports deploy and wallet-based interaction for the generated example contract.
Build Pipeline
Contract compilation should align with Rust ecosystem standards and avoid unnecessary abstraction. Use native Cargo-based build flow as the primary compilation path.
Network Configuration
Developers need explicit, editable environment targeting for local and DevNet workflows. Use environment-file based network configuration as the default model. Generated projects include env files for local and DevNet, wallet interaction settings used by deploy and interact commands. Env files are familiar and automation-friendly, but require strict handling to avoid credential leakage.
Dependencies
Internal Dependencies
- Logos Core DevEx for overall developer journey alignment and terminology.
- Logos Blockchain and Logos Execution Environment for functionality.
- Wallet Module for interactions with Logos Execution Environment.
Runtime Dependencies
- Local network runtime availability for local deploy and interaction workflows.
- DevNet RPC endpoint availability and stable chain configuration.
- Deterministic local/DevNet account and chain configuration via environment files.
Wallet Dependencies
- Wallet available for signing transactions initiated by CLI interaction commands.
- Network-aware wallet configuration to prevent cross-network key misuse.