README.md

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, which is the execution environment used by checker nodes to run checker modules. Follow the installation instructions in the Zinnia CLI documentation.

Running Spot Checks

Once Zinnia is installed, you can execute Spark Spot Check with a simple command:

zinnia run main.js

Development

Make sure you have installed Zinnia runtime.

$ # 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