Skip to content

Instantly share code, notes, and snippets.

@n8maninger

n8maninger/siac.md

Last active June 10, 2023 18:44
Show Gist options
  • Save n8maninger/9dbe071cebf3e3a39298ad2be8a8a057 to your computer and use it in GitHub Desktop.
Save n8maninger/9dbe071cebf3e3a39298ad2be8a8a057 to your computer and use it in GitHub Desktop.
Download ZIP
A dump of all siac commands
Raw
siac.md

siac v1.5.7

Usage:

siac [flags]
siac [command]

Flags:

  • -a, --addr string which host/port to communicate with (i.e. the host/port siad is listening on) (default "localhost:9980")
  • -s, --alert-suppress suppress siac alerts
  • --apipassword string the password for the API's http authentication
  • -h, --help help for siac
  • -d, --sia-directory string location of the sia directory
  • --useragent string the useragent used by siac to connect to the daemon's API (default "Sia-Agent")
  • -v, --verbose Display additional information

alerts

view daemon alerts

Usage:

siac alerts [flags]

Flags:

  • -h, --help help for alerts

consensus

Print the current state of consensus such as current block, block height, and target.

Usage:

siac consensus [flags]

Flags:

  • -h, --help help for consensus

gateway

View and manage the gateway's connected peers.

Usage:

siac gateway [flags]
siac gateway [command]

Flags:

  • -h, --help help for gateway

gateway address

Print the network address of the gateway.

Usage:

siac gateway address [flags]

Flags:

  • -h, --help help for address

gateway bandwidth

returns the total upload and download bandwidth usage for the gateway and the duration of the bandwidth tracking.

Usage:

siac gateway bandwidth [flags]

Flags:

  • -h, --help help for bandwidth

gateway blocklist

Display and manage the peers currently on the gateway blocklist.

Usage:

siac gateway blocklist [flags]
siac gateway blocklist [command]

Flags:

  • -h, --help help for blocklist

gateway blocklist append

Adds new ip address(es) to the gateway blocklist. Accepts a list of ip addresses or domain names as individual inputs.

Usage:

siac gateway blocklist append [ip] [ip] [ip] [ip]... [flags]

Flags:

  • -h, --help help for append

gateway blocklist clear

Clear the blocklisted peers list.

Usage:

siac gateway blocklist clear [flags]

Flags:

  • -h, --help help for clear

gateway blocklist remove

Remove ip address(es) from the gateway blocklist. Accepts a list of ip addresses or domain names as individual inputs.

Usage:

siac gateway blocklist remove [ip] [ip] [ip] [ip]... [flags]

Flags:

  • -h, --help help for remove

gateway blocklist set

Set the gateway's blocklist. Accepts a list of ip addresses or domain names as individual inputs.

Usage:

siac gateway blocklist set [ip] [ip] [ip] [ip]... [flags]

Flags:

  • -h, --help help for set

gateway connect

Connect to a peer and add it to the node list.

Usage:

siac gateway connect [address] [flags]

Flags:

  • -h, --help help for connect

gateway disconnect

Disconnect from a peer. Does not remove the peer from the node list.

Usage:

siac gateway disconnect [address] [flags]

Flags:

  • -h, --help help for disconnect

gateway list

View the current peer list.

Usage:

siac gateway list [flags]

Flags:

  • -h, --help help for list

gateway ratelimit

Set the maxdownloadspeed and maxuploadspeed in Bytes/second or bits/second. Set to 0 for no limit.

Units:

  • B/s
  • KB/s
  • MB/s
  • GB/s
  • TB/s
  • Kbps
  • Mbps
  • Gbps
  • Tbps

Usage:

siac gateway ratelimit [maxdownloadspeed] [maxuploadspeed] [flags]

Flags:

  • -h, --help help for ratelimit

help

Help provides help for any command in the application. Simply type siac help [path to command] for full details.

Usage:

siac help [command] [flags]

Flags:

  • -h, --help help for help

host

View or modify host settings.

Usage:

siac host [flags]
siac host [command]

Flags:

  • -h, --help help for host

host announce

Announce yourself as a host on the network.

Announcing will also configure the host to start accepting contracts. You can revert this by running:

siac host config acceptingcontracts false

You may also supply a specific address to be announced, e.g.:

siac host announce my-host-domain.com:9001

Doing so will override the standard connectivity checks.

Usage:

siac host announce [address] [flags]

Flags:

  • -h, --help help for announce

host config

Modify host settings.

Setting Type Description
acceptingcontracts boolean whether the host should accept new contracts
maxduration blocks the maximuum duration of a contract. Defaults to 25920 blocks (6 months), should not be set lower than 12960 blocks.
netaddress string the netaddress of the host ex: host.ddns.net:9982
windowsize blocks the number of blocks the host has to submit a proof. Leave at the default of 144.
collateral currency / TB /mo the amount of collateral the host will risk per TB of used storage per month. Should be around 2 * storageprice
collateralbudget currency the total amount of collateral the host is willing to lock. Currently bugged and needs to be recalculated occasionally by restarting the host.
maxcollateral currency the max collateral the host is willing to lock into a single contract. Setting this too low will limit the total amount of data a renter can upload into a single contract.
mincontractprice currency the cost to form a contract with the host. This covers the host's transaction fees for submitting a proof and final revision. Since transaction fees on the network are low, 0.15 SC is more than enough.
mindownloadbandwidthprice currency / TB the cost to download 1 TB of data
minuploadbandwidthprice currency / TB the cost to upload 1 TB of data
minstorageprice currency / TB / Month the cost to storage 1 TB of data for 1 month
minbaserpcprice currency the amount of Siacoin charged for each interaction with the host. This should remain the default or 0, renters need to interact with the host many times to download data, charging for each interaction adds up very quickly and renters will refuse to interact with too expensive hosts. Added as DoS protection on top of sector access, bandwidth, and storage prices.
minsectoraccessprice currency the amount of Siacoin charged to download 1 sector of data. This should remain the default or 0, charging for each sectors and download bandwidth essentially double charges the renter and they will refuse to interact with too expensive hosts. Added as DoS protection on top of sector access, bandwidth, and storage prices.
ephemeralaccountexpiry seconds do not adjust
maxephemeralaccountbalance currency do not adjust
maxephemeralaccountrisk currency do not adjust
registrysize filesize the size of the Sia registry
customregistrypath string the path to the Sia registry on disk

Currency units can be specified, e.g. 10SC; run 'siac help wallet' for details.

Durations (maxduration and windowsize) must be specified in either blocks (b), hours (h), days (d), or weeks (w). A block is approximately 10 minutes, so one hour is six blocks, a day is 144 blocks, and a week is 1008 blocks.

Timeouts (ephemeralaccountexpiry) must be specified in either seconds (s), hours (h), days (d), or weeks (w). One hour is 3600 seconds, a day is 86400 seconds, and a week is 604800 seconds.

For a description of each parameter, see doc/API.md.

To configure the host to accept new contracts, set acceptingcontracts to true: siac host config acceptingcontracts true

Usage:

siac host config [setting] [value] [flags]

Flags:

  • -h, --help help for config

host contracts

Show host contracts sorted by expiration height.

Usage:

siac host contracts [flags]

Flags:

  • -h, --help help for contracts
  • -t, --type string Select output type (default "value")

host folder

Add, remove, or resize a storage folder.

Usage:

siac host folder [command]

Flags:

  • -h, --help help for folder

host folder add

Add a storage folder to the host specifying how much data it should store

Usage:

siac host folder add [path] [size] [flags]

Flags:

  • -h, --help help for add

host folder remove

Remove a storage folder from the host.

Note that this does not delete any data; it will instead be distributed across the remaining storage folders unless the force flag is used.

Usage:

siac host folder remove [path] [flags]

Flags:

  • -f, --force Force the removal of the folder and its data
  • -h, --help help for remove

host folder resize

Change how much data a storage folder should store. If the new size is less than what the folder is currently storing, data will be distributed across the other storage folders.

Usage:

siac host folder resize [path] [size] [flags]

Flags:

  • -h, --help help for resize

host sector

Add or delete a sector. Adding is not currently supported. Note that deleting a sector may impact host revenue.

Usage:

siac host sector [command]

Flags:

  • -h, --help help for sector

host sector delete

Delete a sector, identified by its Merkle root. Note that deleting a sector may impact host revenue.

Usage:

siac host sector delete [root] [flags]

Flags:

  • -h, --help help for delete

hostdb

View the list of active hosts, the list of all hosts, or query specific hosts. If the '-v' flag is set, a list of recent scans will be provided, with the most recent scan on the right. a '0' indicates that the host was offline, and a '1' indicates that the host was online.

Usage:

siac hostdb [flags]
siac hostdb [command]

Flags:

  • -h, --help help for hostdb
  • -n, --numhosts int Number of hosts to display from the hostdb

hostdb filtermode

View the hostDB filtermode and the filtered hosts

Usage:

siac hostdb filtermode [flags]

Flags:

  • -h, --help help for filtermode

hostdb setfiltermode

Set the hostdb filtermode and specify hosts. [filtermode] can be whitelist, blacklist, or disable. [host] is the host public key.

Usage:

siac hostdb setfiltermode [filtermode] [host] [host] [host]... [flags]

Flags:

  • -h, --help help for setfiltermode

hostdb view

View detailed information about a host, including things like a score breakdown.

Usage:

siac hostdb view [pubkey] [flags]

Flags:

  • -h, --help help for view

json

queries a large number of endpoints in the siad api and produces a json dump with all of the information

Usage:

siac json [flags]

Flags:

  • -h, --help help for json

miner

Perform miner actions and view miner status.

Usage:

siac miner [flags]
siac miner [command]

Flags:

  • -h, --help help for miner

miner start

Start cpu mining, if the miner is already running, this command does nothing

Usage:

siac miner start [flags]

Flags:

  • -h, --help help for start

miner stop

Stop mining (this may take a few moments).

Usage:

siac miner stop [flags]

Flags:

  • -h, --help help for stop

profile

Start and stop CPU, memory, and/or trace profiles for the daemon

Usage:

siac profile [flags]
siac profile [command]

Flags:

  • -h, --help help for profile

profile start

Start a CPU, memory, and/or trace profile for the daemon by using the corresponding flag.

Provide a profileDir to save the profiles to.

If no profileDir is provided the profiles will be saved in the default profile directory in the siad data directory.

Usage:

siac profile start [flags]

Flags:

  • -c, --cpu Start the CPU profile
  • -h, --help help for start
  • -m, --memory Start the Memory profile
  • --profileDir string Specify the directory where the profile logs are to be saved
  • -t, --trace Start the Trace profile

profile stop

Stop profiles for the daemon

Usage:

siac profile stop [flags]

Flags:

  • -h, --help help for stop

ratelimit

Set the global maxdownloadspeed and maxuploadspeed in Bytes/second or bits/second. Set to 0 for no limit

  • B/s
  • KB/s
  • MB/s
  • GB/s
  • TB/s
  • Bps
  • Kbps
  • Mbps
  • Gbps
  • Tbps

Usage:

siac ratelimit [maxdownloadspeed] [maxuploadspeed] [flags]

Flags:

  • -h, --help help for ratelimit

renter

Upload, download, rename, delete, load, or share files.

Usage:

siac renter [flags]
siac renter [command]

Flags:

  • -h, --help help for renter

renter allowance

View the current allowance, which controls how much money is spent on file contracts.

Usage:

siac renter allowance [flags]
siac renter allowance [command]

Flags:

  • -h, --help help for allowance

renter allowance cancel

Cancel the current allowance, which controls how much money is spent on file contracts.

Usage:

siac renter allowance cancel [flags]

Flags:

  • -h, --help help for cancel

renter bubble

Call bubble on a directory to manually force an update of the directories metadata. To bubble the root directory pass in '.' as the directory.

Usage:

siac renter bubble [directory] [flags]

Flags:

  • -A, --all Bubble the entire directory tree
  • -h, --help help for bubble

renter canceldownload

Cancels an ongoing async download.

Usage:

siac renter canceldownload [cancelID] [flags]

Flags:

  • -h, --help help for canceldownload

renter clean

WARNING: This action will permanently delete any files associated with the renter that do not have a local copy on disk and have a redundancy of < 1.

You will be asked if you want to see these lost files. Additionally you can use the command 'siac renter lost' to see the renter's lost files.

Usage:

siac renter clean [flags]

Flags:

  • -h, --help help for clean

renter contracts

View the contracts that the Renter has formed with hosts.

Usage:

siac renter contracts [flags]
siac renter contracts [command]

Flags:

  • -A, --all Show all expired contracts in addition to active contracts
  • -h, --help help for contracts

renter contracts view

View all details available of the specified contract.

Usage:

siac renter contracts view [contract-id] [flags]

Flags:

  • -h, --help help for view

renter createbackup

Create a backup of the renter's siafiles, using the specified name.

Usage:

siac renter createbackup [name] [flags]

Flags:

  • -h, --help help for createbackup

renter delete

Delete a file or folder. Does not delete the file/folder on disk. Multiple files may be deleted with space separation.

Usage:

siac renter delete [path] [flags]

Flags:

  • -h, --help help for delete
  • --root Delete files and folders from root instead of from the user home directory

renter download

Download a previously-uploaded file or folder to a specified destination.

Usage:

siac renter download [path] [destination] [flags]

Flags:

  • -A, --async Download file asynchronously
  • -h, --help help for download
  • -R, --recursive Download folder recursively
  • --root Download files and folders from root instead of from the user home directory

renter downloads

View the list of files currently downloading.

Usage:

siac renter downloads [flags]

Flags:

  • -h, --help help for downloads
  • -H, --history Show download history in addition to the download queue

renter export

Export renter data in various formats.

Usage:

siac renter export [command]

Flags:

  • -h, --help help for export

renter export contract-txns

Export the renter's current contract set in JSON format to the specified file. Intended for upload to the now deprecated https://rankings.sia.tech/.

Usage:

siac renter export contract-txns [destination] [flags]

Flags:

  • -h, --help help for contract-txns

renter fuse

List the set of fuse directories that are mounted

Usage:

siac renter fuse [flags]
siac renter fuse [command]

Flags:

  • -h, --help help for fuse

renter fuse mount

Mount a Sia folder to your disk. Applications will be able to see this folder as though it is a normal part of your filesystem. Currently experimental, and read-only. When Sia is ready to support read-write fuse mounting, siac will be updated to mount in read-write mode as the default. If you must guarantee that read-only mode is used, you must use the API.

Usage:

siac renter fuse mount [path] [siapath] [flags]

Flags:

  • --allow-other Allow users other than the user that mounted the fuse directory to access and use the fuse directory
  • -h, --help help for mount

renter fuse unmount

Unmount a Sia folder that has previously been mounted. Unmount by specifying the local path where the Sia folder is mounted.

Usage:

siac renter fuse unmount [path] [flags]

Flags:

  • -h, --help help for unmount

renter health

Display a health summary of uploaded files

Usage:

siac renter health [flags]

Flags:

  • -h, --help help for health

renter listbackups

List backups stored on hosts

Usage:

siac renter listbackups [flags]

Flags:

  • -h, --help help for listbackups

renter lost

Display the renter's lost files

Usage:

siac renter lost [flags]

Flags:

  • -h, --help help for lost

renter ls

List the status of a specific file or all files known to the renter within the specified folder on the Sia network. To query the root dir either '""', '/' or '.' can be supplied

Usage:

siac renter ls [path] [flags]

Flags:

  • -h, --help help for ls
  • -R, --recursive Recursively list files and folders
  • --root List files and folders from root instead of from the user home directory

renter prices

Display the estimated prices of storing files, retrieving files, and creating a set of contracts.

An allowance can be provided for a more accurate estimate, if no allowance is provided the current set allowance will be used, and if no allowance is set an allowance of 500SC, 12w period, 50 hosts, and 4w renew window will be used.

Usage:

siac renter prices [amount] [period] [hosts] [renew window] [flags]

Flags:

  • -h, --help help for prices

renter ratelimit

Set the maxdownloadspeed and maxuploadspeed in Bytes per second: B/s, KB/s, MB/s, GB/s, TB/s or Bits per second: Bps, Kbps, Mbps, Gbps, Tbps Set them to 0 for no limit.

Usage:

siac renter ratelimit [maxdownloadspeed] [maxuploadspeed] [flags]

Flags:

  • -h, --help help for ratelimit

renter recoveryscanprogress

Returns the progress of a potentially ongoing recovery scan.

Usage:

siac renter recoveryscanprogress [flags]

Flags:

  • -h, --help help for recoveryscanprogress

renter rename

Rename a file.

Usage:

siac renter rename [path] [newpath] [flags]

Flags:

  • -h, --help help for rename
  • --root Rename files relative to root instead of the user homedir

renter restorebackup

Restore the backup of the renter's siafiles with the given name.

Usage:

siac renter restorebackup [name] [flags]

Flags:

  • -h, --help help for restorebackup

renter setallowance

Set the amount of money that can be spent over a given period.

If no flags are set you will be walked through the interactive allowance setting. To update only certain fields, pass in those values with the corresponding field flag, for example '--amount 500SC'.

Allowance can be automatically renewed periodically. If the current blockheight + the renew window >= the end height the contract, then the contract is renewed automatically.

Note that setting the allowance will cause siad to immediately begin forming contracts! You should only set the allowance once you are fully synced and you have a reasonable number (>30) of hosts in your hostdb.

Usage:

siac renter setallowance [flags]

Flags:

  • --amount string amount of money in allowance, specified in currency units
  • --expected-download string expected download in period in bytes (B), kilobytes (KB), megabytes (MB) etc. up to yottabytes (YB)
  • --expected-redundancy string expected redundancy of most uploaded files
  • --expected-storage string expected storage in bytes (B), kilobytes (KB), megabytes (MB) etc. up to yottabytes (YB)
  • --expected-upload string expected upload in period in bytes (B), kilobytes (KB), megabytes (MB) etc. up to yottabytes (YB)
  • -h, --help help for setallowance
  • --hosts string number of hosts the renter will spread the uploaded data across
  • --max-contract-price string the maximum price that the renter will pay to form a contract with a host
  • --max-download-bandwidth-price string the maximum price that the renter will pay to download from a host
  • --max-rpc-price string the maximum RPC base price that is allowed for a host
  • --max-sector-access-price string the maximum price that the renter will pay to access a sector on a host
  • --max-storage-price string the maximum price that the renter will pay to store data on a host
  • --max-upload-bandwidth-price string the maximum price that the renter will pay to upload data to a host
  • --period string period of allowance in blocks (b), hours (h), days (d) or weeks (w)
  • --renew-window string renew window in blocks (b), hours (h), days (d) or weeks (w)

renter setlocalpath

Changes the local path of the file

Usage:

siac renter setlocalpath [siapath] [newlocalpath] [flags]

Flags:

  • -h, --help help for setlocalpath

renter triggerrecoveryscan

Triggers a scan of the whole blockchain to find recoverable contracts.

Usage:

siac renter triggerrecoveryscan [flags]

Flags:

  • -h, --help help for triggerrecoveryscan

renter unstuckall

Set the 'stuck' status of every chunk in every file uploaded to the renter to 'false'.

Usage:

siac renter unstuckall [flags]

Flags:

  • -h, --help help for unstuckall

renter upload

Upload a file or folder to [path] on the Sia network. The --data-pieces and --parity-pieces flags can be used to set a custom redundancy for the file.

Usage:

siac renter upload [source] [path] [flags]
siac renter upload [command]

Flags:

  • --data-pieces string the number of data pieces a files should be uploaded with
  • -h, --help help for upload
  • --parity-pieces string the number of parity pieces a files should be uploaded with

renter upload pause

Temporarily pause renter uploads for the duration specified. Available durations include "s" for seconds, "m" for minutes, and "h" for hours. For Example: 'siac renter upload pause 3h' would pause uploads for 3 hours.

Usage:

siac renter upload pause [duration] [flags]

Flags:

  • -h, --help help for pause

renter upload resume

Resume renter uploads that were previously paused.

Usage:

siac renter upload resume [flags]

Flags:

  • -h, --help help for resume

renter uploads

View the list of files currently uploading.

Usage:

siac renter uploads [flags]

Flags:

  • -h, --help help for uploads

renter workers

View the status of the Renter's workers

Usage:

siac renter workers [flags]
siac renter workers [command]

Flags:

  • -h, --help help for workers

renter workers dj

View detailed information of the workers' download jobs

Usage:

siac renter workers dj [flags]

Flags:

  • -h, --help help for dj

renter workers ea

View detailed information of the workers' ephemeral account

Usage:

siac renter workers ea [flags]

Flags:

  • -h, --help help for ea

renter workers hsj

View detailed information of the workers' has sector jobs

Usage:

siac renter workers hsj [flags]

Flags:

  • -h, --help help for hsj

renter workers pt

View detailed information of the workers' price table

Usage:

siac renter workers pt [flags]

Flags:

  • -h, --help help for pt

renter workers rj

View detailed information of the workers' read jobs

Usage:

siac renter workers rj [flags]

Flags:

  • -h, --help help for rj

renter workers rrj

View detailed information of the workers' read registry jobs

Usage:

siac renter workers rrj [flags]

Flags:

  • -h, --help help for rrj

renter workers uj

View detailed information of the workers' upload jobs

Usage:

siac renter workers uj [flags]

Flags:

  • -h, --help help for uj

renter workers urj

View detailed information of the workers' update registry jobs

Usage:

siac renter workers urj [flags]

Flags:

  • -h, --help help for urj

stack

Get current stack trace for the daemon

Usage:

siac stack [flags]

Flags:

  • -f, --filename string Specify the output file for the stack trace (default "stack.txt")
  • -h, --help help for stack

stop

Stop the Sia daemon.

Usage:

siac stop [flags]

Flags:

  • -h, --help help for stop

update

Check for (and/or download) available updates for Sia.

Usage:

siac update [flags]
siac update [command]

Flags:

  • -h, --help help for update

update check

Check for available updates.

Usage:

siac update check [flags]

Flags:

  • -h, --help help for check

utils

Various utilities for working with Sia's types. These commands do not require siad.

Usage:

siac utils [command]

Flags:

  • -h, --help help for utils

utils bash-completion

Creates a bash completion file at the specified location.

Note: Bash completions will only work with the prefix with which the script is created (e.g. ./siac or siac).

Once created, the file has to be moved to the bash completion script folder, usually /etc/bash_completion.d/

Usage:

siac utils bash-completion [path] [flags]

Flags:

  • -h, --help help for bash-completion

utils bruteforce-seed

Attempts to brute force a partial Sia seed. Accepts a 27 or 28 word seed and returns a valid 28 or 29 word seed

Usage:

siac utils bruteforce-seed [flags]

Flags:

  • -h, --help help for bruteforce-seed

utils checksig

Verify that a hash was signed by the specified key.

The signature should be base64-encoded, and the hash should be hex-encoded.

The pubkey should be either a JSON-encoded SiaPublicKey, or of the form: algorithm:hexkey. e.g. ed25519:d0e1a2d3b4e5e6f7...

Use sighash to calculate the hash of a transaction.

Usage:

siac utils checksig [sig] [hash] [pubkey] [flags]

Flags:

  • -h, --help help for checksig

utils decoderawtxn

Convert a base64-encoded transaction to JSON.

Usage:

siac utils decoderawtxn [base64 txn] [flags]

Flags:

  • -h, --help help for decoderawtxn

utils display-api-password

Display the API password. The API password is required for some 3rd party integrations such as Duplicati

Usage:

siac utils display-api-password [flags]

Flags:

  • -h, --help help for display-api-password

utils encoderawtxn

Convert a JSON-encoded transaction to base64. The argument may be either a JSON literal or a file containing JSON.

Usage:

siac utils encoderawtxn [json txn] [flags]

Flags:

  • -h, --help help for encoderawtxn

utils hastings

Convert a currency amount to Hastings. See wallet --help for a list of units.

Usage:

siac utils hastings [amount] [flags]

Flags:

  • -h, --help help for hastings

utils man-generation

Creates unix style man pages at the specified directory.

Usage:

siac utils man-generation [path] [flags]

Flags:

  • -h, --help help for man-generation

utils sighash

Calculate the SigHash of a transaction.

The SigHash is the hash of the fields of the transaction specified in the CoveredFields of the specified signature.

The transaction may be JSON, base64, or a file containing either.

Usage:

siac utils sighash [sig index] [txn] [flags]

Flags:

  • -h, --help help for sighash

utils uploadedsize

Calculates a given folder size on Sia and the lost space caused by files are rounded up to the minimum chunks size.

Usage:

siac utils uploadedsize [path] [flags]

Flags:

  • -h, --help help for uploadedsize

utils verify-seed

Verify that a seed has correct number of words, no extra whitespace, and all words appear in the Sia dictionary. The language may be english (default), japanese, or german

Usage:

siac utils verify-seed [flags]

Flags:

  • -h, --help help for verify-seed
  • -l, --language string which dictionary you want to use (default "english")

version

Print version information.

Usage:

siac version [flags]

Flags:

  • -h, --help help for version

wallet

Generate a new address, send coins to another wallet, or view info about the wallet.

Units: The smallest unit of siacoins is the hasting. One siacoin is 10^24 hastings. Other supported units are:

  • pS (pico, 10^-12 SC)
  • nS (nano, 10^-9 SC)
  • uS (micro, 10^-6 SC)
  • mS (milli, 10^-3 SC)
  • SC
  • KS (kilo, 10^3 SC)
  • MS (mega, 10^6 SC)
  • GS (giga, 10^9 SC)
  • TS (tera, 10^12 SC)

Usage:

siac wallet [flags]
siac wallet [command]

Flags:

  • -h, --help help for wallet

wallet address

Generate a new wallet address from the wallet's primary seed.

Usage:

siac wallet address [flags]

Flags:

  • -h, --help help for address

wallet addresses

List all addresses that have been generated by the wallet.

Usage:

siac wallet addresses [flags]

Flags:

  • -h, --help help for addresses

wallet balance

View wallet balance, including confirmed and unconfirmed siacoins and siafunds.

Usage:

siac wallet balance [flags]

Flags:

  • -h, --help help for balance

wallet broadcast

Broadcast a JSON-encoded transaction to connected peers. The transaction must be valid. txn may be either JSON, base64, or a file containing either.

Usage:

siac wallet broadcast [txn] [flags]

Flags:

  • -h, --help help for broadcast
  • --raw Decode transaction as base64 instead of JSON

wallet change-password

Change the encryption password of the wallet, re-encrypting all keys + seeds kept by the wallet.

Usage:

siac wallet change-password [flags]

Flags:

  • -h, --help help for change-password

wallet init

Generate a new wallet from a randomly generated seed, and encrypt it. By default the wallet encryption / unlock password is the same as the generated seed.

Usage:

siac wallet init [flags]

Flags:

  • --force destroy the existing wallet and re-encrypt
  • -h, --help help for init
  • -p, --password Prompt for a custom password

wallet init-seed

Initialize and encrypt a new wallet using a pre-existing seed.

Usage:

siac wallet init-seed [flags]

Flags:

  • --force destroy the existing wallet
  • -h, --help help for init-seed

wallet load

Load a wallet seed, v0.3.3.x wallet, or siag keyset

Usage:

siac wallet load [command]

Flags:

  • -h, --help help for load

wallet load 033x

Load a v0.3.3.x wallet into the current wallet

Usage:

siac wallet load 033x [filepath] [flags]

Flags:

  • -h, --help help for 033x

wallet load seed

Loads an auxiliary seed into the wallet. Auxiliary seeds are not well supported and should be used with caution as they can mess up wallets.

Usage:

siac wallet load seed [flags]

Flags:

  • -h, --help help for seed

wallet load siag

Load siag key(s) into the wallet - typically used for siafunds.

Usage:

siac wallet load siag [filepath,...] [flags]

Flags:

  • -h, --help help for siag

wallet lock

Lock the wallet, preventing further use

Usage:

siac wallet lock [flags]

Flags:

  • -h, --help help for lock

wallet seeds

View your primary and auxiliary wallet seeds.

Usage:

siac wallet seeds [flags]

Flags:

  • -h, --help help for seeds

wallet send

Send either siacoins or siafunds to an address

Usage:

siac wallet send [command]

Flags:

  • -h, --help help for send

wallet send siacoins

Send siacoins to an address. 'dest' must be a 76-byte hexadecimal address.

'amount' can be specified in units, e.g. 1.23KS. Run 'wallet --help' for a list of units.

If no unit is supplied, hastings will be assumed.

A dynamic transaction fee is applied depending on the size of the transaction and how busy the network is.

Usage:

siac wallet send siacoins [amount] [dest] [flags]

Flags:

  • --fee-included Take the transaction fee out of the balance being submitted instead of the fee being additional
  • -h, --help help for siacoins

wallet send siafunds

Send siafunds to an address, and transfer the claim siacoins to your wallet.

Usage:

siac wallet send siafunds [amount] [dest] [flags]

Flags:

  • -h, --help help for siafunds

wallet sign

Sign a transaction. If siad is running with an unlocked wallet, the /wallet/sign API call will be used. Otherwise, sign will prompt for the wallet seed, and the signing key(s) will be regenerated.

txn may be either JSON, base64, or a file containing either.

tosign is an optional list of indices. Each index corresponds to a TransactionSignature in the txn that will be filled in. If no indices are provided, the wallet will fill in every TransactionSignature it has keys for.

Usage:

siac wallet sign [txn] [tosign] [flags]

Flags:

  • -h, --help help for sign
  • --raw Encode signed transaction as base64 instead of JSON

wallet sweep

Sweep siacoins and siafunds from a seed. The outputs belonging to the seed will be sent to your wallet.

Usage:

siac wallet sweep [flags]

Flags:

  • -h, --help help for sweep

wallet transactions

View transactions related to addresses spendable by the wallet, providing a net flow of siacoins and siafunds for each transaction

Usage:

siac wallet transactions [flags]

Flags:

  • --endheight uint Height of the block where transaction history should end. (default 18446744073709551615)
  • -h, --help help for transactions
  • --startheight uint Height of the block where transaction history should begin.

wallet unlock

Decrypt and load the wallet into memory. Automatic unlocking is also supported via environment variable: if the SIA_WALLET_PASSWORD environment variable is set, the unlock command will use it instead of displaying the typical interactive prompt.

Usage:

siac wallet unlock [flags]

Flags:

  • -h, --help help for unlock
  • --insecure-input Disable shoulder-surf protection (echoing passwords and seeds)
  • -p, --password Display interactive password prompt even if SIA_WALLET_PASSWORD is set
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment