Expand description
§paralock-cli
The paralock binary: swap shielded ZEC for stablecoins on EVM chains (Tempo, Base, Ethereum, Arbitrum,
Robinhood Chain, HyperEVM) and run a Paralock market maker, without a Node process. It is
built on the paralock Rust SDK and speaks the same wire protocol as the TypeScript SDK and the npm CLI, so it
trades with TypeScript makers and serves TypeScript takers.
paralock doctor # check nodes, contracts, keys, balances, the maker, the price
paralock quote --zec 0.5 --chain base # a checked quote, nothing locked
paralock swap --zec 0.5 --chain base --private
paralock pay --usd 25 --to 0x… --chain tempo
paralock swaps | resume <id> | refund <id> # recovery from the swap store
paralock maker # serve a maker (HTTP API, settlement loops)
paralock --devnet swap --zec 0.1 # against the local devnet of `npx paralock dev`Configuration comes from a paralock.toml (config) whose keys are read from environment variables or key
files, or, with --devnet, from the devnet.json the npm CLI writes. --json prints one JSON document per
command for scripts. Exit codes are described on error::Exit.
The library is the binary’s implementation; it is not a stable API. Embed paralock instead.
Status: experimental and not audited. In both modes the Zcash leg is transparent on chain, and the devnet is not mainnet.
Modules§
- amount
- Exact decimal amounts: ZEC ↔ zatoshi and dollars ↔ token base units, without floating point.
- cli
- The command line (clap).
- commands
- The commands, and what they share: connecting to Zcash and the EVM chains, prices.
- config
paralock.tomland--devnet: everything a command needs, resolved and checked before anything connects.- devnet
- The local devnet started by the npm CLI (
npx paralock dev/paralock devnet up): itsdevnet.json, the keys this binary keeps for it, the ths faucet and block production. - error
- Errors and exit codes.
- output
- Human and
--jsonoutput. - state
- Where the local state lives (the rule of the TypeScript SDK’s
state-dir.ts), and the user’s home directory.
Constants§
- PROTOCOL_
VERSION - The protocol version this binary speaks.