tokenomics-simulator 0.1.6

Simulate trades, calculate various metrics, and predict user behaviour over different time intervals.
Documentation

Tokenomics Simulator

Tokenomics Simulator is a tool for simulating the tokenomics of a project.

It allows users to simulate trades, calculate various metrics, and predict user behaviour over different time intervals.

Reference implementation

test docs crate downloads GitHub codecov

Options

Option Description
duration Duration of the simulation, depending on the interval type.
total_users Number of users in the simulation.
market_volatility Volatility level. 0.0 is no volatility, 1.0 is maximum volatility.
interval_type Interval type for the simulation (daily or weekly).
transaction_fee Transaction fee for each trade.

Safety

This crate uses #![forbid(unsafe_code)] to ensure everything is implemented in 100% safe Rust.

Documentation

For more in-depth details, please refer to the full documentation.

If you encounter any issues or have questions that are not addressed in the documentation, feel free to submit an issue.

Contributing

Contributions from the community are always welcome! Here are some ways you can contribute:

Reporting Bugs

If you encounter any bugs, please submit an issue with detailed information about the problem and steps to reproduce it.

Feature Requests

If you have ideas for new features, feel free to submit an issue with a detailed description of the feature and its potential use cases.

Build

To build the project, run:

cargo build

Test

To run the tests, use:

cargo test

Lint

Run clippy to lint the code:

cargo clippy --all-targets --all-features --no-deps -- -D warnings

Format

Run rustfmt to format the code:

cargo fmt

Documentation

Generate documentation in HTML format:

cargo doc --open