54137ac43c
This commit introduces a metrics store that serves as entry point for managing metrics, providing an API for fetching, inserting, and resetting metric data backed by a Sled database. The store organizes data into separate trees, including main storage for gas metrics by a defined time interval, a tree containing metrics by height for handling reorgs, and a transaction-specific gas data tree. It uses an overlay pattern for write operations, enabling unified management of metrics by delegating tasks such as adding metrics and handling reorgs to the MetricsStoreOverlay. Additionally, the commit introduces the GasMetrics struct, which is used for managing gas metrics across all transactions in the metrics store. This struct maintains running totals, min/max extrema, and transaction counts, allowing efficient calculations of total gas, WASM gas, ZK circuit gas, and signature gas without needing to iterate through previous transactions. With O(1) performance for calculating averages and updating min/max values, GasMetrics builds a comprehensive view of gas metrics throughout the blockchain's history. It includes methods for creating new instances, calculating average gas usage, and adding new gas data in real-time. Furthermore, the GasMetricsKey struct is introduced to facilitate storing and retrieving metrics by time interval. The initial implementation stores metrics on an hourly basis, with flexibility for future adjustments to different intervals with minimal code changes. This struct provides methods for creating, serializing, and deserializing keys from various time representations, including [Timestamp], u64 timestamps, and &str timestamps. It also features conversion methods to ensure compatibility with the Sled database. Test coverage has been added to validate functionality across various scenarios. Tests include inserting gas metrics, searching metrics by hour, fetching metrics by timestamp string, transaction gas usage, and resetting metrics under different conditions. Additionally, functions were added to load test data, simulating random, fixed, and reset scenarios while generating varied gas data. Core Updates Summary: - Created the `MetricsStore` struct to manage metric storage, providing an API for fetching, inserting, and resetting metrics backed by a Sled database. - Developed `MetricsStoreOverlay` to facilitate write operations, including adding and reverting metrics for handling reorgs. - Introduced the `GasMetrics` struct to encapsulate gas metrics across transactions, with methods to efficiently add data and compute extrema and averages. - Implemented `GasMetricsKey` for storing and retrieving fee metrics based on hourly intervals. - Introduced the `GasMetricsKeySource` trait for unified key creation using various time representations: `[Timestamp]`, `u64` timestamps, or `&str` timestamps. Test Functions: - `test_insert_gas_metrics`: Verifies correctness of inserted gas metrics into the main tree. - `test_insert_by_height_gas_metrics`: Tests gas metrics insertion into the metrics by height tree. - `test_search_metrics_by_hour`: Validates searching gas metrics by hour. - `test_get_metrics_by_timestamp_str`: Ensures correct retrieval of metrics by timestamp string. - `test_tx_gas_data`: Verifies transaction gas data insertion and retrieval, including handling of non-existent transactions. - `test_reset_metrics_within_height_range`: Tests resetting metrics within a specified height range. - `test_reset_metrics_height_to_0`: Ensures graceful handling of resetting the metrics store to height 0. - `test_reset_metrics_beyond_height`: Validates behavior when resetting beyond available metrics. - `test_reset_metrics_at_height`: Tests resetting metrics at the last available height. - `test_reset_empty_store`: Confirms that resetting an empty store is handled without errors. Test Data Load Functions: - `load_random_metrics`: Simulates loading random gas metrics data at hourly intervals from height 0 as the genesis block. - `load_fixed_metrics`: Loads fixed test data with timestamps. - `load_reset_metrics`: Returns accumulated gas metrics at a specified reset height. - `load_tx_gas_data`: Loads test transaction gas data, returning pairs of transaction hashes and gas data. - `random_gas_data`: Generates varied gas data based on a provided seed value.
DarkFi - Anonymous, Uncensored, Sovereign
We aim to proliferate anonymous digital markets by means of strong cryptography and peer-to-peer networks. We are establishing an online zone of freedom that is resistant to the surveillance state.
Unfortunately, the law hasn’t kept pace with technology, and this disconnect has created a significant public safety problem. We call it "Going Dark".
James Comey, FBI director
So let there be dark.
About DarkFi
DarkFi is a new Layer 1 blockchain, designed with anonymity at the forefront. It offers flexible private primitives that can be wielded to create any kind of application. DarkFi aims to make anonymous engineering highly accessible to developers.
DarkFi uses advances in zero-knowledge cryptography and includes a contracting language and developer toolkits to create uncensorable code.
In the open air of a fully dark, anonymous system, cryptocurrency has the potential to birth new technological concepts centered around sovereignty. This can be a creative, regenerative space - the dawn of a Dark Renaissance.
Connect to DarkFi IRC
Follow the installation instructions for the P2P IRC daemon.
Build
This project requires the Rust compiler to be installed. Please visit Rustup for instructions.
You have to install a native toolchain, which is set up during Rust installation, nightly toolchain and wasm32 target. To install nightly toolchain, execute:
% rustup toolchain install nightly
To install wasm32 target, execute:
% rustup target add wasm32-unknown-unknown
% rustup target add wasm32-unknown-unknown --toolchain nightly
Minimum Rust version supported is 1.77.0 (nightly).
The following dependencies are also required:
| Dependency | Debian-based |
|---|---|
| git | git |
| cmake | cmake |
| make | make |
| gcc | gcc |
| g++ | g++ |
| pkg-config | pkg-config |
| alsa-lib | libasound2-dev |
| clang | libclang-dev |
| fontconfig | libfontconfig1-dev |
| lzma | liblzma-dev |
| openssl | libssl-dev |
| sqlcipher | libsqlcipher-dev |
| sqlite3 | libsqlite3-dev |
| wabt | wabt |
Users of Debian-based systems (e.g. Ubuntu) can simply run the following to install the required dependencies:
# apt-get update
# apt-get install -y git cmake make gcc g++ pkg-config libasound2-dev libclang-dev libfontconfig1-dev liblzma-dev libssl-dev libsqlcipher-dev libsqlite3-dev wabt
Alternatively, users can try using the automated script under contrib
folder by executing:
% sh contrib/dependency_setup.sh
The script will try to recognize which system you are running, and install dependencies accordingly. In case it does not find your package manager, please consider adding support for it into the script and sending a patch.
To build the necessary binaries, we can just clone the repo, and use the provided Makefile to build the project:
% git clone https://codeberg.org/darkrenaissance/darkfi
% cd darkfi
% make
Development
If you want to hack on the source code, make sure to read some introductory advice in the DarkFi book.
Living on the cutting edge
Since the project uses the nightly toolchain, breaking changes are bound to happen from time to time. As a workaround, we can configure an older nightly version, which was known to work:
% rustup toolchain install nightly-2024-12-05
% rustup target add wasm32-unknown-unknown --toolchain nightly-2024-12-05
Now we can use that toolchain in make directly:
% make CARGO="cargo +nightly-2024-12-05" {target}
Or, if we are lazy, we can modify the Makefile to always use that:
% sed -i Makefile -e "s|nightly|nightly-2024-12-05|g"
Under no circumstances commit or push the Makefile change.
When using cargo directly, you have to add the +nightly-2024-12-05 flag,
in order for it to use the older nightly version.
Install
This will install the binaries on your system (/usr/local by
default). The configuration files for the binaries are bundled with the
binaries and contain sane defaults. You'll have to run each daemon once
in order for them to spawn a config file, which you can then review.
# make install
Examples and usage
See the DarkFi book
Go Dark
Let's liberate people from the claws of big tech and create the democratic paradigm of technology.
Self-defense is integral to any organism's survival and growth.
Power to the minuteman.