-
Notifications
You must be signed in to change notification settings - Fork 2
CLI Commands Reference
This page should provide additional high-level documentation and explanation beyond just chinilla -h.
This is not meant to be comprehensive, because often the -h (help) text is clear enough. We recommend fully investigating with the -h switch before looking elsewhere.
If want to know what a command's options are, append -h at the end to see options and explanations.
Some examples:
chinilla -hchinilla plots -hchinilla plots check -hchinilla plotters madmax -hchinilla start -h
As with the rest of this project, this doc is a work-in-progress. Feel free to browse the source code or the Chinilla Proof of Space Construction Document for more insight in the meantime.
If you installed Chinilla.app in your /Applications directory, you can find the chinilla binary at /Applications/Chinilla.app/Contents/Resources/app.asar.unpacked/daemon/chinilla.
Do a sanity check in Terminal.app with
/Applications/Chinilla.app/Contents/Resources/app.asar.unpacked/daemon/chinilla -h
You can use that if you augment your PATH with
PATH=/Applications/Chinilla.app/Contents/Resources/app.asar.unpacked/daemon:$PATH
and then chinilla -h should work.
There is more than one chinilla.exe binary; the GUI is Chinilla.exe (two of these!) and the CLI is chinilla.exe. They are found in different places. Note the big C versus the little c.
The CLI one is the one referred to in this document, and for version 1.1.3 it can be found at
~\AppData\Local\chinilla-blockchain\app-1.1.3\resources\app.asar.unpacked\daemon\chinilla.exe
Command: chinilla init
First, init checks for old versions of chinilla installed in your ~/.chinilla directory.
If so, init migrates these old files to the new version:
- config (including old SSL files)
- db
- wallet
- Using config.yaml, updates wallet keys and ensures coinbase rewards go to the right wallet puzzlehash.
If no old version exists, init:
- Creates a default chinilla configuration
- Initializes a new SSL key and cert (for secure communication with the GUI)
Command: chinilla start {service}
- Service
nodewill start only the full node. - Service
farmerwill start the farmer, harvester, a full node, and the wallet. - positional arguments: {all,node,harvester,farmer,farmer-no-wallet,farmer-only,timelord,timelord-only,timelord-launcher-only,wallet,wallet-only,introducer,simulator}
Flags
-r, --restart: Restart of running processes
In 1.2.11 the option to use different plotters was introduced. The plotters supported include Bladebit, madMAx, and the original reference chiapos plotter. Each plotter has slightly different hardware requirements and may need slightly different options specified. Learn more about the alternative plotters here: Alternative Plotters
For details on settings and usage of madMAx please refer to the original madMAx Github repository, or run the help command chinilla plotters madmax -h.
usage: chinilla plotters madmax [-h] [-k SIZE] [-n COUNT] [-r THREADS] [-u BUCKETS] [-v BUCKETS3] [-t TMPDIR] [-2 TMPDIR2] [-d FINALDIR] [-w]
[-p POOL_KEY] [-f FARMERKEY] [-c CONTRACT] [-G] [-K RMULTI2]
Madmax Plotter
optional arguments:
-h, --help show this help message and exit
-k SIZE, --size SIZE K value.
-n COUNT, --count COUNT
Number of plots to create (default = 1)
-r THREADS, --threads THREADS
Num threads.
-u BUCKETS, --buckets BUCKETS
Number of buckets.
-v BUCKETS3, --buckets3 BUCKETS3
Number of buckets for phase 3+4 (default = 256)
-t TMPDIR, --tmp_dir TMPDIR
Temporary directory 1.
-2 TMPDIR2, --tmp_dir2 TMPDIR2
Temporary directory 2.
-d FINALDIR, --final_dir FINALDIR
Final directory.
-w, --waitforcopy Wait for copy to start next plot
-p POOL_KEY, --pool-key POOL_KEY
Pool Public Key (48 bytes)
-f FARMERKEY, --farmerkey FARMERKEY
Farmer Public Key (48 bytes)
-c CONTRACT, --contract CONTRACT
Pool Contract Address (64 chars)
-G, --tmptoggle Alternate tmpdir/tmpdir2 (default = false)
-K RMULTI2, --rmulti2 RMULTI2
Thread multiplier for P2 (default = 1)
chinilla plotters bladebit -h
usage: chinilla bladebit [-h] [-r THREADS] [-n COUNT] [-f FARMERKEY] [-p POOL_KEY] [-c CONTRACT] [-i ID] [-w] [-m] [-d FINALDIR] [-v]
Bladebit Plotter
optional arguments:
-h, --help show this help message and exit
-r THREADS, --threads THREADS
Num threads.
-n COUNT, --count COUNT
Number of plots to create (default = 1)
-f FARMERKEY, --farmerkey FARMERKEY
Farmer Public Key (48 bytes)
-p POOL_KEY, --pool-key POOL_KEY
Pool Public Key (48 bytes)
-c CONTRACT, --contract CONTRACT
Pool Contract Address (64 chars)
-i ID, --id ID Plot id
-w, --warmstart Warm start
-m, --nonuma Disable numa
-d FINALDIR, --final_dir FINALDIR
Final directory.
-v, --verbose Set verbose
Command: chinilla plots create [add flags and parameters]
Flags
-k [size]: Define the size of the plot(s). For a list of k-sizes and creation times on various systems check out: k-Sizes
-n [number of plots]: The number of plots that will be made, in sequence. Once a plot is finished, it will be moved to the final location -d, before starting the next plot in the sequence.
-b [memory buffer size MiB]: Define memory/RAM usage. Default is 4608 (4.6 GiB). More RAM will marginally increase speed of plot creation. Please bear in mind that this is what is allocated to the plotting algorithm alone. Code, container, libraries etc. will require additional RAM from your system.
-f [farmer pk]: This is your "Farmer Public Key". Utilise this when you want to create plots on other machines for which you do not want to give full chinilla account access. To find your Chinilla Farmer Public Key use the following command: chinilla keys show
-p [pool pk]: This is your "Pool Public Key". Utilise this when you want to create plots on other machines for which you do not want to give full chinilla account access. To find your Chinilla Pool Public Key use the following command: chinilla keys show
-c [pool contract address]: This is your "Pool Contract Address". This replaces your Pool Public Key used previously in OG plots. This is used to point a plot to a plotNFT, which allows you to switch plots from local farming to pooling. To find your PlotNFT Contract Addres use the following command: chinilla plotnft show
-a [fingerprint]: This is the key Fingerprint used to select both the Farmer and Pool Public Keys to use. Utilize this when you want to select one key out of several in your keychain. To find your Chinilla Key Fingerprint use the following command: chinilla keys show
-t [tmp dir]: Define the temporary directory for plot creation. This is where Plotting Phase 1 (Forward Propagation) and Phase 2 (Backpropagation) both occur. The -t dir requires the largest working space: normally about 2.5 times the size of the final plot.
-2 [tmp dir 2]: Define a secondary temporary directory for plot creation. This is where Plotting Phase 3 (Compression) and Phase 4 (Checkpoints) occur. Depending on your OS, -2 might default to either -t or -d. Therefore, if either -t or -d are running low on space, it's recommended to set -2 manually. The -2 dir requires an equal amount of working space as the final size of the plot.
-d [final dir]: Define the final location for plot(s). Of course, -d should have enough free space as the final size of the plot. This directory is automatically added to your ~/.chinilla/VERSION/config/config.yaml file. You can use chinilla plots remove -d to remove a final directory from the configuration.
-r [number of threads]: 2 is usually optimal. Multithreading is only in phase 1 currently.
-u [number of buckets]: More buckets require less RAM but more random seeks to disk. With spinning disks you want less buckets and with NVMe more buckets. There is no significant benefit from using smaller buckets - just use 128.
-e [bitfield plotting]: Using the -e flag will disable the bitfield plotting algorithm, and revert back to the older b17 plotting style. After 1.0.4 it’s better to use bitfield for most cases (not using -e). Before 1.0.4 (obsolete) using the -e flag (bitfield disabled) lowers memory requirement, but also writes about 12% more data during creation of the plot. For now, SSD temp space will likely plot faster with -e (bitfield back propagation disabled) and for slower spinning disks, i.e SATA 5400/7200 rpm, not using -e (bitfield enabled) is a better option.
-x [exclude final dir]: Skips adding [final dir] to harvester for farming.
Example below will create a k32 plot and use 4GB (note - not GiB) of memory.
chinilla plots create -k 32 -b 4000 -t /path/to/temporary/directory -d /path/to/final/directory
Example 2 below will create a k34 plot and use 8GB of memory, 2 threads and 64 buckets
chinilla plots create -k 34 -e -b 8000 -r 2 -u 64 -t /path/to/temporary/directory -d /path/to/final/directory
Example 3 below will create five k32 plots (-n 5) one at a time using 4GB -b 4000 (note - not GiB) of memory and uses a secondary temp directory (-2 /path/to/secondary/temp/directory).
chinilla plots create -k 32 -b 4000 -n 5 -t /path/to/temporary/directory -2 /path/to/secondary/temp/directory -d /path/to/final/directory
Additional Plotting Notes
-
During plotting, Phase 1 (Forward Propagation) and Phase 3 (Compression) tend to take the most time. Therefore, to maximize plotting speed,
-tand-2should be on your fastest drives, and-dcan be on a slow drive. -
There are 4 major phases to plotting. Phase 1 of plotting can utilize multi-threading. Phases 2-3 do not. You can better optimize your plotting by using the
-rflag in your command and setting it to greater than 2, e.g,.-r 2. Above 4 threads there are diminishing returns. Many Chinilla users have determined it's more efficient to plot in parallel, rather than series. You can do this by just having multiple plotting instances open but staggering when they start 30min or more. -
It's objectively faster to plot on SSD's instead of HDD's. However, SSD's have significantly more limited lifespans, and early Chinilla testing has seemed to indicate that plotting on SSD's wears them out pretty quickly. Therefore, many Chinilla users have decided it's more "green" to plot in parallel on many HDD's at once.
-
Plotting is designed to be as efficient as possible. However, to prevent grinding attacks, farmers should not be able to create a plot within the average block interval. That's why the minimum k-size is k32 on vanillanet.
Using the CLI, you can perform the same operations as with the GUI. There is a new command, called chinilla plotnft. Type chinilla plotnft -h to see all the available sub-commands:
» chinilla plotnft -h
Usage: chinilla plotnft [OPTIONS] COMMAND [ARGS]...
Options:
-h, --help Show this message and exit.
Commands:
claim Claim rewards from a plot NFT
create Create a plot NFT
get_login_link Create a login link for a pool. To get the launcher id, use
plotnft show.
inspect Get Detailed plotnft information as JSON
join Join a plot NFT to a Pool
leave Leave a pool and return to self-farming
show Show plotnft information
To create a Plot NFT, use chinilla plotnft create -u https://poolnamehere.com, entering the URL of the pool you want to use. To create a plot NFT in self-farming mode, do chinilla plotnft create -s local.
To switch pools, you can use chinilla plotnft join, and to leave a pool (switch to self farming), use chinilla plotnft leave.
The show command can be used to check your current points balance. CLI plotting with create_plots is the same as before, but the -p is replaced with -c, and the pool contract address from chinilla plotnft show should be used here.
Command: chinilla plots check -n [num checks] -l -g [substring]
First, this looks in all plot directories from your config.yaml. You can check those directories with chinilla plots show. This command will check whether plots are valid given the plot's associated keys and your machine's stored Chinilla keys, as well as test the plot with challenges to identify found plots vs. expected number of plots.
-g check only plots with directory or file name containing case-sensitive [substring].
If -g isn't specified all plots in every plot directory in your config.yaml will be checked.
Examples for using -g
- Check plots within a long directory name like
/mnt/chinilla/DriveAcan usechinilla plots check -g DriveA - Check only k33 plots can use
chinilla plots check -g k33 - Check plots created on October 31, 2020 can use
chinilla plots check -g 2020-10-31
-l allows you to find duplicate plots by ID. It checks all plot directories listed in config.yaml and lists out any plot filenames with the same filename ending; *-[64 char plot ID].plot. You should use -l -n 0 if you only want to check for duplicates.
-n represents the number of challenges given. If you don't include an -n integer, the default is 30. For instance, if -n is 30, then 30 challenges will be given to each plot. The challenges count from 5 (minimum) to -n, and are not random.
Each plot will take each challenge and:
- Get the quality for the challenge (Is there a proof of space? You should expect 1 proof per challenge, but there may be 0 or more than 1.)
- Get the full proof(s) for the challenge if a proof was present
- Validate that the # of full proofs matches the # of expected quality proofs.
Finally, you'll see a report the final true proofs vs. expected proofs.
Therefore, if -n is 20, you would expect 20 proofs, but your plot may have more or fewer.
Running the command with -n 10 or -n 20 is good for a very minor check, but won't actually give you much information about if the plots are actually high-quality or not.
Consider using -n 30 to get a statistically better idea.
For more detail, you can read about the DiskProver commands in chiapos
What does the ratio of full proofs vs expected proofs mean?
- If the ratio is >1, your plot was relatively lucky for this run of challenges.
- If the ratio is <1, your plot was relatively unlucky.
- This shouldn't really concern you unless your ratio is <0.70 # If so, do a more thorough
chinilla plots checkby increasing your-n
- This shouldn't really concern you unless your ratio is <0.70 # If so, do a more thorough
The plots check challenge is a static challenge. For example if you run a plots check 20 times, with 30 tries against the same file, it will produce the same result every time. So while you may see a plot ratio << 1 for a plot check with x number of tries, it does not mean that the plot itself is worthless. It just means that given these static challenges, the plot is producing however many proofs. As the number of tries (-n) increases, we would expect the ratio to not be << 1. Since Vanillanet is live, and given that the blockchain has new challenges with every signage point - just because a plot is having a bad time with one specific challenge, does not mean it has the same results versus another challenge. "Number of plots" and "k-size" are much more influential factors at winning blocks than "proofs produced per challenge".
In theory, a plot with a ratio >> 1 would be more likely to win challenges on the blockchain. Likewise, a plot with a ratio << 1 would be less likely to win. However, in practice, this isn't actually going to be noticeable. Therefore, don't worry if your plot check ratios are less than 1, unless they're significantly less than 1 for many -n.
Command: chinilla db upgrade [add flags and parameters]
Flags
--input [PATH]: (optional) Specify a database input file. Must be a v1 database.
--output [PATH]: (optional) Specify a database output file. Can be any name, but must not already exist.
--no-update-config Don't update the config file to point to your new database. When specifying a custom output file, the config will not be updated regardless.
Database upgrade notes
- This will upgrade your database from version 1 to version 2, which is around 45% smaller and slightly faster.
- The upgrade could take several hours to complete. Use at your own leisure.
- You do not need to stop your Chinilla node while performing the upgrade.
- The new database file will be written to the same folder as the original. As of early 2022, around 30 GB of free space is required to perform the upgrade. If you do not have sufficient space, use the
--outputand--no-update-configflags to create the new database elsewhere and to not use the new file yet. After the version 2 file has been created, you can stop Chinilla and move/delete your version 1 file, which will free up enough space to move your version 2 file to the original folder. Finally, update the references in config.yaml to point to your version 2 file. - After the upgrade has completed, run
chinilla start farmer -r. This will restart your farmer, and begin using your new database. Note that it will have the same peak as version 1 at the time you initiated the upgrade. Your node will still need to run a short sync to fetch the remaining blocks that had gotten added while the upgrade was being performed. - For more info, see our FAQ.
Command: chinilla keys derive [OPTIONS] COMMAND [ARGS]
Flags
-f, --fingerprint [INTEGER]: The fingerprint of the key you want to use.
--mnemonic-seed-filename [TEXT]: The filename containing the mnemonic seed of the master key to derive from.
Notes on deriving keys
- This command will display or search for derived keys or wallet-addresses.
- This command requires either a fingerprint or a mnemonic seed file.
- The valid values for
COMMANDarechild-key,search, andwallet-address. - See below for details and example commands.
Command: chinilla keys derive child-key [OPTIONS]
Flags
-t, --type [farmer|pool|wallet|local|backup|singleton|pool_auth]: Type of child key to derive.
-p, --derive-from-hd-path [TEXT]: Derive child keys rooted from a specific HD path. Indices ending in an 'n' indicate that non-observer derivation should used at that index.
Example HD path: m/12381n/8444n/2/
-i, --index [INTEGER]: Index of the first child key to derive. (Index 0 is the first child key.)
-n, --count [INTEGER]: Number of child keys to derive, starting at index.
-d, --non-observer-derivation: Derive keys using non-observer derivation. [default: False]
-s, --show-private-keys: Display derived private keys. [default: False]
--show-hd-path: Show the HD path of the derived wallet addresses. [default: False]
Examples
-
Show the first singleton pubkey:
chinilla keys derive -f <fingerprint> child-key -t singleton -
Show a pair of public and private keys derived from a mixed observer/non-observer HD path using an imported key's mnemonic seed:
chinilla keys derive --mnemonic-seed-filename <(chinilla keys generate_and_print | sed -n 2p) child-key --derive-from-hd-path 'm/12381n/8444n/2/' --show-private-keys --show-hd-path -
Generate a mnemonic seed and show the farmer pubkeys 10-14 derived from that seed:
chinilla keys derive --mnemonic-seed-filename <(chinilla keys generate_and_print | sed -n 2p) child-key -i 10 -n 5 -t farmer
Command: chinilla keys derive search [OPTIONS] [SEARCH_TERMS]...
Flags
-l, --limit [INTEGER]: Limit the number of derivations to search against. [default: 100]
-d, --non-observer-derivation: Search will be performed against keys derived using non-observer derivation. [default: False]
-P, --show-progress: Show search progress. [default: False]
-t, --search-type [public_key|private_key|address|all]: Limit the search to include just the specified types. [default: address, public_key]
-p, --derive-from-hd-path [TEXT]: Search for items derived from a specific HD path. Indices ending in an 'n' indicate that non-observer derivation should used at that index. Example HD path: m/12381n/8444n/2/
Examples
- Search for a wallet address:
chinilla keys derive search -t address -l 100 <hcx address>
Command: chinilla keys derive wallet-address [OPTIONS]
Flags
-i, --index [INTEGER]: Index of the first wallet address to derive. Index 0 is the first wallet address.
-n, --count [INTEGER]: Number of wallet addresses to derive, starting at index.
-x, --prefix [TEXT]: Address prefix (hcx for vanillanet, thcx for testnet).
-d, --non-observer-derivation: Derive wallet addresses using non-observer derivation. [default: False]
--show-hd-path: Show the HD path of the derived wallet addresses. If non-observer-derivation is specified, path indices will have an 'n' suffix. [default: False]
Examples
-
Show first 10 wallet addresses:
chinilla keys derive -f <fingerprint> wallet-address -i 0 -n 10 --show-hd-path
$ chinilla
Options:
--root-path PATH Config file root [default: /home/mariano/.chinilla/vanillanet]
-h, --help Show this message and exit.
Commands:
configure Modify configuration
farm Manage your farm
init Create or migrate the configuration
keys Manage your keys
netspace Estimate total farmed space on the network
plots Manage your plots
run_daemon Runs chinilla daemon
show Show node information
start Start service groups
stop Stop services
version Show chinilla version
wallet Manage your wallet
To see what you can do with each of these commands, use the help flag -h. For example, chinilla show -h.
To check your full node status, do chinilla show -s and you'll see something like this. To figure how close
you are look at your height. Once fully synced it'll say Full Node Synced at the top.
Current Blockchain Status: Full Node Synced
Peak: Hash: 34554a10aff6b52545623e18667c9487758fa93a3b2345974da0d263939189dc
Time: Tue Mar 23 2021 20:54:46 JST Height: 19882
Estimated network space: 136.225 PiB
Current difficulty: 9
Current VDF sub_slot_iters: 112197632
Total iterations since the start of the blockchain: 63291534050
Height: | Hash:
19882 | 34554a10aff6b52545623e18667c9487758fa93a3b2345974da0d263939189dc
19881 | f53c052cd7ac58539ff5c35cb9d515bc521308a49cec7566b23dba84f76009d8
19880 | 924d825a7fdbfd61e4582efbbe1d977bb554b368eea58c349a71e688e43fcc49
You can add and remove directories for your plots with chinilla plots add -d 'your_dir' or chinilla plots remove -d 'your_dir', help can be found for respective add/remove with chinilla plots add/remove -h
You can check contents of your wallet with: chinilla wallet, and status of your farmer with chinilla farm summary.
Check harvester and farmer logs: grep ~/.chinilla/vanillanet/log/debug.log -e harvester
Sample result:
17:08:03.191 harvester harvester_server : INFO <- harvester_handshake from peer 214b269a425b8223cb50fbd458dab056599348e255f07a018c13ea9efb509ee5 127.0.0.1
17:08:03.194 farmer farmer_server : INFO -> harvester_handshake to peer 127.0.0.1 65f3fa0b0407a07da8ccf04dfa0f64c28f714726312aa051d3a8529390db4d7a
17:08:03.218 harvester src.plotting.plot_tools : INFO Searching directories ['/home/user/slab1/plots']
17:08:03.227 harvester src.plotting.plot_tools : INFO Found plot /home/user/slab1/plots/plot-k32-2021-01-11-17-26-bf2363828e469a3417b89eb98cfa9d694809e1ce8bef0ffd1d12853d4227aa0a.plot of size 32
17:08:03.227 harvester src.plotting.plot_tools : INFO Loaded a total of 1 plots of size 0.09895819725716137 TiB
Maybe follow logs: tail -F ~/.chinilla/vanillanet/log/debug.log. Chinilla is nice enough to rotate logs for you.
Chinilla Network - Green money for a digital world.
- Home
- Beginners Guide
- Install instructions
- Quick Start Guide
- FAQ - Frequently Asked Questions
- Pooling FAQ
- Pooling User Guide
- Chinilla Project FAQ
- Plotting Basics
- Alternate Plotters
- Plot Sizes (k-sizes)
- CLI Commands Reference
- Windows Tips & Tricks
- How to Check if Everything is Working (or Not)
- SSD Endurance - Info on SSD's and plotting
- Reference Plotting Hardware
- Reference Farming Hardware
- Farming on Many Machines
- Good Security Practices on Many Machines
- Chinillalisp Documentation (Official)
- Chinillalisp Notes
- Timelords and Cluster Timelords
- Release Notes
- RPC Interfaces
- Resolve Sync Issues - Port 8444