Spark

NAME

spark - Build, test, fuzz, debug and deploy Ylem contracts.

SYNOPSIS

spark [options] command [args]
spark [options] --version
spark [options] --help

DESCRIPTION

This program is a set of tools to build, test, fuzz, debug and deploy Ylem smart contracts.

COMMANDS

General Commands

spark help
Display help information about Spark.

spark completions
Generate shell autocompletions for Spark.

Project Commands

spark init
Create a new Spark project.

spark install
Install one or multiple dependencies.

spark update
Update one or multiple dependencies.

spark remove
Remove one or multiple dependencies.

spark config
Display the current config.

spark remappings
Get the automatically inferred remappings for this project.

spark tree
Display a tree visualization of the project's dependency graph.

spark geiger Detects usage of unsafe cheat codes in a foxar project and its dependencies.

Build Commands

spark build
Build the project's smart contracts.

spark clean
Remove the build artifacts and cache directories.

spark inspect
Get specialized information about a smart contract.

Test Commands

spark test
Run the project's tests.

spark snapshot
Create a snapshot of each test's gas usage.

spark coverage
Generate coverage reports.

Deploy Commands

spark create
Deploy a smart contract.

spark verify-check
Check verification status on Etherscan.

spark flatten
Flatten a source file and all of its imports into one file.

Utility Commands

spark debug
Debug a single smart contract as a script.

spark bind
Generate Rust bindings for smart contracts.

spark cache
Manage the Foxar cache.

spark cache clean
Cleans cached data from ~/.foxar.

spark cache ls
Shows cached data from ~/.foxar.

spark script
Run a smart contract as a script, building transactions that can be sent onchain.

spark upload-selectors
Uploads abi of given contract to https://sig.eth.samczsun.com function selector database.

spark doc
Generate documentation for Ylem source files.

OPTIONS

Special Options

-V
--version
Print version info and exit.

Common Options

-h
--help
Prints help information.

FILES

~/.foxar/
Default location for Foxar's "home" directory where it stores various files.

~/.foxar/bin/
Binaries installed using foxarup will be located here.

~/.foxar/cache/
Spark's cache directory, where it stores cached block data and more.

~/.foxar/foxar.toml
The global Foxar config.

~/.svm
The location of the Spark-managed solc binaries.

EXAMPLES

1. Create a new Spark project:

   spark init hello_foxar

2. Build a project:

   spark build

3. Run a project's tests:

   spark test

BUGS

See https://github.com/bchainhub/foxar/issues for issues.