You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Coinshift is a BIP300-style sidechain node with a trustless L2 <-> L1 swap system. Exchange sidechain (L2) coins for parent-chain (L1) assets such as BTC, BCH, or LTC, and vice versa. The app includes a JSON-RPC server, CLI, and GUI.
# Start the RPC server (headless)
cargo run --bin coinshift_app -- --headless
# Start the GUI (includes an embedded RPC server)
cargo run --bin coinshift_app
# CLI for interacting with the JSON-RPC server
cargo run --bin coinshift_app_cli
Running multiple instances
Run two or more Coinshift instances on the same machine by giving each its own data directory, RPC address, and P2P (net) address.
# Talk to the second instance with the CLI
cargo run --bin coinshift_app_cli -- --rpc-url http://localhost:6256 balance
CLI commands
The CLI talks to the Coinshift RPC server (default http://localhost:6255). Use --rpc-url to override. Run cargo run --bin coinshift_app_cli <command> --help for per-command help.
Wallet / seed
Command
Description
backup-mnemonic
Output mnemonic for backup (new phrase, or from file with --from-file)
balance
Get balance in sats
generate-mnemonic
Generate a new 12-word mnemonic
get-new-address
Get a new address
get-wallet-addresses
List wallet addresses (sorted by base58)
get-wallet-utxos
List wallet UTXOs
recover-from-mnemonic
Set seed from mnemonic and show addresses + balance
set-seed-from-mnemonic
Set wallet seed from mnemonic (no extra output)
sidechain-wealth
Total sidechain wealth (sats)
Deposits / withdrawals / transfers
Command
Description
create-deposit
Deposit to address (--address, --value-sats, --fee-sats)
format-deposit-address
Format a deposit address
transfer
Transfer to L2 address (--dest, --value-sats, --fee-sats)
withdraw
Withdraw to mainchain (--mainchain-address, --amount-sats, --fee-sats, --mainchain-fee-sats)