Coordinator CLI

Installation

npm install -g @crunchdao/coordinator-cli

Usage

crunch-coordinator <command> [options] [arguments]
crunch-coordinator crunch <subcommand> [options] [arguments]

Coordinator Management Commands

`register`

crunch-coordinator register <name>

Arguments:

name - Unique name for the coordinator

Example:

crunch-coordinator register "AI Research Lab"

Description: Registers the wallet as a Coordinator with the given name. The Coordinator must later be approved by protocol admins before they can create competitions. Requirements:

Coordinator name must be unique
Wallet must have sufficient SOL for account creation
Name should be descriptive and professional

`get`

Get Coordinator details by owner address. Usage:

crunch-coordinator get [owner]

Arguments:

owner - Owner address of the Coordinator (optional, defaults to current wallet)

Examples:

# Get Coordinator details for a specific address
crunch-coordinator get "9WzDXwBbmkg8ZTbNMqUxvQRAyrZzDsGYdLVL9zYtAWWM"

# Get Coordinator details for current wallet
crunch-coordinator get

Description: Retrieves detailed information about a Coordinator including registration status and metadata.

`get-config`

Get Coordinator configuration from the protocol. Usage:

crunch-coordinator get-config

Example:

crunch-coordinator get-config

Description: Displays the current Coordinator configuration including protocol parameters and settings.

Competition Lifecycle Management

`create`

Create a new competition (crunch). Usage:

crunch-coordinator crunch create <name> [payoutAmount] [maxModelsPerCruncher]

Arguments:

name - Name of the crunch
payoutAmount - Payout amount in USDC (default: 10)
maxModelsPerCruncher - Maximum models per Cruncher (default: 2)

Example:

crunch-coordinator crunch create "iris_classifier" 10000 5

Description: Creates a new competition with the specified parameters. The creator must be an approved coordinator. Requirements:

Must be an approved coordinator
Competition name must be unique
Must have sufficient SOL for account creation

`start`

Start a competition. Usage:

crunch-coordinator crunch start <crunchName>

Arguments:

crunchName - Name of the crunch to start

Example:

crunch-coordinator crunch start "iris_classifier"

Description: Transitions a competition from created state to active state, allowing crunchers to register and submit models. Requirements:

Competition must be in created state
Must be the Coordinator who created the competition

`address`

Get the account address for a competition. Usage:

crunch-coordinator crunch address <crunchName>

Arguments:

crunchName - Name of the crunch

Example:

crunch-coordinator crunch address "iris_classifier"

Description: Returns the Solana public key address of the specified competition account.

`get`

Get detailed information about a competition. Usage:

crunch-coordinator crunch get <name>

Arguments:

name - Name of the crunch

Example:

crunch-coordinator crunch get "iris_classifier"

Description: Retrieves comprehensive information about a competition including its state, configuration, participants, and financial details.

`end`

End a competition. Usage:

crunch-coordinator crunch end <crunchName>

Arguments:

crunchName - Name of the crunch to end

Example:

crunch-coordinator crunch end "iris_classifier"

Description: Transitions a competition to ended state, preventing new registrations and model submissions. Requirements:

Competition must be in active state
Must be the Coordinator who created the competition

Reward and Financial Management

`deposit-reward`

Deposit reward USDC to a competition. Usage:

crunch-coordinator crunch deposit-reward <crunchName> <amount>

Arguments:

crunchName - Name of the crunch
amount - Amount in USDC to deposit

Example:

crunch-coordinator crunch deposit-reward "iris_classifier" 5000

Description: Deposits USDC tokens to fund the reward pool for the specified competition. Requirements:

Must have sufficient USDC balance
Competition must exist

`margin`

Execute margin payout for a competition. Usage:

crunch-coordinator crunch margin <crunchName>

Arguments:

crunchName - Name of the crunch

Example:

crunch-coordinator crunch margin "iris_classifier"

Description: Processes margin-based payouts for competition participants based on their performance.

`drain`

Drain USDC from a competition. Usage:

crunch-coordinator crunch drain <crunchName> [--show-solscan]

Arguments:

crunchName - Name of the crunch

Options:

--show-solscan - Show Solscan links for transactions

Example:

crunch-coordinator crunch drain "iris_classifier" --show-solscan

Description: Withdraws remaining USDC from a competition’s reward pool back to the coordinator.

Checkpoint Management

`checkpoint-create`

Creates a checkpoint for payout distribution. Usage:

crunch-coordinator crunch checkpoint-create <crunchName> <prizeFileName> [--dryrun]

Arguments:

crunchName - Name of the crunch
prizeFileName - Path to prize JSON file containing payout distribution

Options:

--dryrun - Perform a dry run without executing transactions

Example:

crunch-coordinator crunch checkpoint-create "iris_classifier" "./prizes.json"

Prize File Format:

{"timestamp": 1840417288969, "model": "model_3", "prize": 130870000}

Prize File Fields:

timestamp - Unix timestamp in milliseconds (required)
model - Model identifier receiving the prize (required)
prize - Prize amount in micro USDC (amount to transfer * (10^6)) (required)
prizeId - Unique identifier for the prize (optional)

Description: Creates a new checkpoint with specified prize distribution, enabling participants to claim their rewards.

`checkpoint-get-current`

Get the current checkpoint information. Usage:

crunch-coordinator crunch checkpoint-get-current <crunchName>

Arguments:

crunchName - Name of the crunch

Example:

crunch-coordinator crunch checkpoint-get-current "iris_classifier"

Description: Retrieves information about the current active checkpoint including total amount and distribution details.

`checkpoint-get-address`

Get the address of a specific checkpoint. Usage:

crunch-coordinator crunch checkpoint-get-address <crunchName> <checkpointIndex>

Arguments:

crunchName - Name of the crunch
checkpointIndex - Index of the checkpoint

Example:

crunch-coordinator crunch checkpoint-get-address "iris_classifier" 1

Description: Returns the Solana public key address of the specified checkpoint account.

Configuration

The CLI uses a configuration system for managing settings. Use the config commands to manage your configuration:

# Set configuration values
crunch-coordinator config set <key> <value>

# Show current configuration
crunch-coordinator config show

# Use a specific profile
crunch-coordinator config use-profile <profile>

Configuration Options

network (string) - Solana network (localnet, devnet, mainnet)
wallet (string) - Path to wallet keypair file
loglevel (string) - Log level (debug, info, warn, error)

Default Configuration

{
  "network": "localnet",
  "wallet": "./accounts/coordinator.json",
  "loglevel": "info"
}

Command Reference Summary

Category	Command	Description
Coordinator Management	`register`	Register as a Coordinator
	`get`	Get Coordinator details
	`get-config`	Get Coordinator configuration
Competition Lifecycle	`crunch create`	Create a new competition
	`crunch start`	Start a competition
	`crunch address`	Get competition address
	`crunch get`	Get competition details
	`crunch end`	End a competition
Financial Management	`crunch deposit-reward`	Deposit USDC rewards
	`crunch margin`	Execute margin payout
	`crunch drain`	Withdraw remaining USDC
Checkpoint Management	`crunch checkpoint-create`	Create reward checkpoint
	`crunch checkpoint-get-current`	Get current checkpoint
	`crunch checkpoint-get-address`	Get checkpoint address
Configuration	`config`	Configuration management

Competition Workflow

Setup: Register as Coordinator using register
Create: Create competition using crunch create
Fund: Deposit rewards using crunch deposit-reward
Launch: Start competition using crunch start
Monitor: Check status using crunch get
Distribute: Create checkpoints using crunch checkpoint-create
Complete: End competition using crunch end
Cleanup: Drain remaining funds using crunch drain

@crunchdao/cruncher-cli - Participant operations (cruncher registration, claiming rewards)
See Global Options for shared configuration options

Best Practices

Secure Wallets: Keep Coordinator wallet keys secure
Documentation: Keep track of checkpoint indices and prize distributions

Overview

Introduction

Getting Started as Coordinator

Crunch Implementation Example

CLI

Appendix

Installation

Usage

Coordinator Management Commands

`register`

`get`

`get-config`

Competition Lifecycle Management

`create`

`start`

`address`

`get`

`end`

Reward and Financial Management

`deposit-reward`

`margin`

`drain`

Checkpoint Management

`checkpoint-create`

`checkpoint-get-current`

`checkpoint-get-address`

Configuration

Configuration Options

Default Configuration

Command Reference Summary

Competition Workflow

Best Practices

Overview

Introduction

Getting Started as Coordinator

Crunch Implementation Example

CLI

Appendix

​Installation

​Usage

​Coordinator Management Commands

​register

​get

​get-config

​Competition Lifecycle Management

​create

​start

​address

​get

​end

​Reward and Financial Management

​deposit-reward

​margin

​drain

​Checkpoint Management

​checkpoint-create

​checkpoint-get-current

​checkpoint-get-address

​Configuration

​Configuration Options

​Default Configuration

​Command Reference Summary

​Competition Workflow

​Related Packages

​Best Practices

Installation

Usage

Coordinator Management Commands

`register`

`get`

`get-config`

Competition Lifecycle Management

`create`

`start`

`address`

`get`

`end`

Reward and Financial Management

`deposit-reward`

`margin`

`drain`

Checkpoint Management

`checkpoint-create`

`checkpoint-get-current`

`checkpoint-get-address`

Configuration

Configuration Options

Default Configuration

Command Reference Summary

Competition Workflow

Related Packages

Best Practices