Skip to content

README.md

Latest commit

 

History

History
65 lines (44 loc) · 2.39 KB

README.md

File metadata and controls

65 lines (44 loc) · 2.39 KB

create-protocol/token-simulator

Create-Protocol-specific scenarios and presets for token-economy simulation.

What this repo is

A scenario catalog. Every file under scenarios/ is a YAML config that describes a Create Protocol token model (supply schedule, demand curves, burn/fee mechanics, revenue streams) in a format the engine can consume.

What this repo is NOT

This repo does not contain a simulation engine. The engine lives at kcolbchain/token-simulator — a general-purpose token/cashflow Monte Carlo simulator. This repo just holds the Create-Protocol-specific inputs that get fed into it.

Think of it as:

kcolbchain/token-simulator   →   the engine (code, math, solvers)
create-protocol/token-simulator  →   the data (CR8 scenarios, presets)

Keeping them separate means scenario authors can iterate on model assumptions without touching engine code, and engine authors can ship improvements without needing the CR8 numbers.

Scenarios

File Phase Description
scenarios/cr8-v4-relaunch-simple.yaml Phase 1 Simplified relaunch — 1 revenue stream (agent payments), no burn toll, USDC settlement.
scenarios/cr8-v4-burn-toll.yaml Phase 3 (full V4) 11.1B fixed supply, 1% burn toll (0.5%/0.5%), 5 revenue streams. Flagship long-horizon scenario.

Running a scenario

Until the engine publishes a stable CLI, run from a sibling checkout:

# clone both repos side-by-side
git clone https://github.com/kcolbchain/token-simulator.git
git clone https://github.com/create-protocol/token-simulator.git create-protocol-sim

# from the engine repo, point at a scenario here
cd token-simulator
python -m sim.run --scenario ../create-protocol-sim/scenarios/cr8-v4-burn-toll.yaml

The exact invocation may change as the engine stabilises — see the engine repo's README for the canonical command.

Contributing

See CONTRIBUTING.md.

Related

— kcolbchain / Abhishek Krishna