Call the tools.
Thirteen tools, Protocol 4. Amounts are decimal strings, memo_hash is hex.
The tool surface
Negotiate, settle, disclose
open_channel(operation_id, counterparty)Returns channel_handle.
propose_offer(operation_id, channel_handle, amount, token, deadline, memo_hash)The payee asks. The payer offers.
counter_offer(operation_id, channel_handle, reply_to, amount, token, deadline, memo_hash)Does not withdraw the offer it replies to.
wait_for_offers(channel_handle, expected_count, timeout_seconds=300)One call instead of a poll loop. A timeout is not an error.
read_channel_state(channel_handle)Every visible offer plus the settlement list.
accept_and_settle(operation_id, channel_handle, offer_id)Payer only. Settles one deal — the pair can start another.
get_note_balance()Payer must call before naming a price.
grant_viewing_key(operation_id, channel_handle, deal_id, grantee, expires_at, output_path)Writes a new mode-0600 file and returns no secret.
reveal(grant_path)Reconstructs the selected deal.
Recovery & ops
reconcile()Read-only. Classifies journaled operations, never submits.
resume_operation(operation_id)Resumes one safe operation, or names the operator action it needs first.
rebuild_state()Rebuilds missing channel records from the pool key and chain data.
doctor()Read-only. Always safe to call.
A full negotiation is open_channel, propose_offer, wait_for_offers, counter_offer, accept_and_settle, then grant_viewing_key and reveal.
Every write takes operation_id. Persist it and the intent before the call, and reuse both after a restart — see operation_id under core concepts.
This page documents CLI Protocol 4, published as v0.2.0, exposing the thirteen tools listed above. The older v0.1.0 speaks Protocol 2 and exposes ten. erebus-sdk refuses a mismatched CLI by protocol number rather than failing later on a changed shape.