diff --git a/contrib/ai-simulator/README.md b/contrib/ai-simulator/README.md index b15dda07680cfefe57f4d036d5fa20d188e42fd2..18953e7847b241583a911c4b6859b7b63dc904b5 100644 --- a/contrib/ai-simulator/README.md +++ b/contrib/ai-simulator/README.md @@ -1,7 +1,26 @@ Adaptive Issuance Simulator =========================== -This is work in progress. +This simulator aims to provide an approximation of the behavior of the new +adaptive issuance and an estimation of average baking rewards according to a +given delegate configuration. + +# Simulation Business Code Architecture + +The `Simulator` class is responsible for computing the issuance rate evolution +cycle by cycle for a given evolution of the total stake and total supply at each +cycle end. + +Given a `Simulator` object and a delegate configuration, the `Delegate` class +provides a simulation of the expected per-cycle rewards of the delegate. + +Detailed API of the classes can be found in the generated documentation. + +# Demo Visualization +The simulator comes with a visualization page meant to demonstrate its usage (see `site/index.html`). It +loads the Simulator with the stake and total supply data extracted from an +iteration of weekly-net. + # Build diff --git a/contrib/ai-simulator/package.json b/contrib/ai-simulator/package.json index 84dd7ea594cb4210cd521364347b4ba0410026c8..841e17b09ec35930eab1d977076b9f6a47102bc9 100644 --- a/contrib/ai-simulator/package.json +++ b/contrib/ai-simulator/package.json @@ -6,7 +6,7 @@ "scripts": { "watch": "watch 'npm run build' ./src/ ./site/", "build": "esbuild src/source.js --bundle --outfile=site/app.js --format=esm", - "css": "npx tailwindcss -i ./src/source.css -o ./site/app.css --watch", + "css": "npx tailwindcss -i ./src/source.css -o ./site/app.css", "server": "npx http-server site/ -p 8080" }, "keywords": [],