https://github.com/checkernetwork/spark-spot-check
Perform spot checks on Spark rounds
https://github.com/checkernetwork/spark-spot-check
Last synced: about 1 year ago
JSON representation
Perform spot checks on Spark rounds
- Host: GitHub
- URL: https://github.com/checkernetwork/spark-spot-check
- Owner: CheckerNetwork
- License: other
- Created: 2025-02-05T16:43:40.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-01T20:58:27.000Z (about 1 year ago)
- Last Synced: 2025-04-01T21:43:41.187Z (about 1 year ago)
- Language: JavaScript
- Size: 269 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Spark Spot Check
## Overview
Spark Spot Check is a testing module designed to verify full data retrievals from Storage Providers, enabling better identification and assessment of honest network participants.
## Prerequisites
Before running Spark Spot Check, you must install the [Zinnia runtime](https://github.com/CheckerNetwork/zinnia), which is the execution environment used by checker nodes to run checker modules. Follow the installation instructions in the [Zinnia CLI documentation](https://github.com/CheckerNetwork/zinnia/blob/main/cli/README.md#installation).
## Running Spot Checks
Once Zinnia is installed, you can execute Spark Spot Check with a simple command:
```sh
zinnia run main.js
```
## Development
Make sure you have installed [Zinnia runtime](https://github.com/CheckerNetwork/zinnia).
```
$ # Lint
$ npx standard
$ # Run module
$ zinnia run main.js
$ # Test module
$ zinnia run test.js
```
## Configuration
All configuration options are managed through the `config.js` file. The following parameters can be customized:
| Parameter | Description | Default |
|-----------|-------------|---------|
| `roundId` | Specifies which round to test retrievals from. When undefined, tests the current round. | `undefined` |
| `maxTasks` | Limits the number of tasks to check. When undefined, tests all available tasks. | `undefined` |
| `minerId` | Filters spot checks to a specific Storage Provider. Only processes tasks for the specified provider if found in the round. When undefined tests tasks for all Storage Providers. | `undefined` |
| `maxByteLength` | Limits the number of bytes to retrieve per file. When undefined, retrieves complete files. | `undefined` |
| `retrievalTasks` | Restricts spot checks to specific tasks. When undefined, processes all available tasks based on other configuration parameters. | `undefined` |