diff --git a/README.md b/README.md index c77b611..e5b411a 100644 --- a/README.md +++ b/README.md @@ -87,7 +87,7 @@ The lockdrop simulation validates the Zenith Network's token distribution mechan ```bash # Example - ssh -A + ssh -A @ ``` - Set zenith-stack version to use: @@ -398,16 +398,6 @@ Now we can execute the reference Jupyter notebook to perform lockdrop allocation - Calculate allocation amounts for different lock periods - Generate artifacts (`lockdrop_allocations_notebook.json`) for comparison with the data from zenithd node -3. **View Notebook Results (Optional)** - - To view the analysis on generated data, open the notebook in your browser at : - - ```bash - jupyter notebook lockdrop-calculations-simulated.ipynb - ``` - - The notebook contains useful visualizations including allocation distributions, lock period analysis, and participant statistics. - ### Step 5: Run Simulation Tests Now we can run the comprehensive test suite to validate that the zenithd node's TGE allocations match notebook results and run-time accruals happen as expected. @@ -463,6 +453,26 @@ Now we can run the comprehensive test suite to validate that the zenithd node's - Any differences or mismatches - Validation of the lockdrop implementation +5. **View Lockdrop Distribution Notebook Results (Optional)** + + To view the analysis on generated data, open it using jupyter: + + ```bash + jupyter notebook lockdrop-calculations-simulated.ipynb + ``` + + This should automatically open the notebook in you browser. + + If jupyter is running on a remote host, you can tunnel the port `8888` to load the notebook in your local browser: + + ```bash + ssh @ -L localhost:8888:localhost:8888 -Nv + ``` + + Open the URL from server logs and load `lockdrop-calculations-simulated.ipynb`. + + The notebook contains useful visualizations including allocation distributions, lock period analysis, and participant statistics. + ## Cleanup ### Validator Deployment diff --git a/test-runs/README.md b/test-runs/README.md index 456c786..d8afcd6 100644 --- a/test-runs/README.md +++ b/test-runs/README.md @@ -54,7 +54,7 @@ To reproduce the results from any one of the test runs, follow these steps to ru ```bash # Example - ssh -A + ssh -A @ ``` - Set zenith-stack version to use: @@ -366,16 +366,6 @@ Now we can execute the reference Jupyter notebook to perform lockdrop allocation - Calculate allocation amounts for different lock periods - Generate artifacts (`lockdrop_allocations_notebook.json`) for comparison with the data from zenithd node -3. **View Notebook Results (Optional)** - - To view the analysis on participants data, open the notebook in your browser at : - - ```bash - jupyter notebook lockdrop-calculations-simulated.ipynb - ``` - - The notebook contains useful visualizations including allocation distributions, lock period analysis, and participant statistics. - ### Step 5: Run Simulation Tests Now we can run the comprehensive test suite to validate that the zenithd node's TGE allocations match notebook results and run-time accruals happen as expected. @@ -409,6 +399,26 @@ Now we can run the comprehensive test suite to validate that the zenithd node's - **Unlock Schedule Tests**: Validate unlock block calculations (considering each point's locking time) and initial unlock amounts - **Accrual State Tests**: Verify accrual state calculations at current block height +3. **View Lockdrop Distribution Notebook Results (Optional)** + + To view the analysis on generated data, open it using jupyter: + + ```bash + jupyter notebook lockdrop-calculations-simulated.ipynb + ``` + + This should automatically open the notebook in you browser. + + If jupyter is running on a remote host, you can tunnel the port `8888` to load the notebook in your local browser: + + ```bash + ssh @ -L localhost:8888:localhost:8888 -Nv + ``` + + Open the URL from server logs and load `lockdrop-calculations-simulated.ipynb`. + + The notebook contains useful visualizations including allocation distributions, lock period analysis, and participant statistics. + ## Compare Results After running the tests, compare your output from the tests above to output from the chosen test run (eg. `test-runs/run1/output.log`):