@toon-protocol/rig 4.7.0 → 5.0.1

package/README.md

@@ -9,7 +9,7 @@ lives in NIP-34 Nostr events and the objects live on Arweave.
 - **Writes are paid** — pushing objects and publishing events spends from a
   payment channel funded by your wallet. Writes are permanent and non-refundable.
 - **One node URL is the whole network configuration** — `rig` embeds its own
-  payment client (`@toon-protocol/client` 3.x) built from your seed phrase and
+  payment client (`@toon-protocol/client` 4.x) built from your seed phrase and
   pays the TOON connector you name with `rig entry <url>`. The node describes
   itself on `GET /ilp`; there is nothing to discover (see
   [Pointing at a node](#pointing-at-a-node)).
@@ -238,20 +238,27 @@ estimate — nothing is executed or paid).
 
 ## Money: fund, balance, channels
 
-Paid commands spend from a **payment channel** — an on-chain-collateralized channel
-between your wallet and a payment peer, from which each write draws an off-chain
-claim. You rarely touch this directly:
+Paid commands spend from a **payment channel**: an x402 `batch-settlement`
+channel between your wallet and the node, collateralized on chain, on which each
+write signs an off-chain voucher naming the running total (connector ADR 0075;
+there is no nonce). You rarely touch this directly:
 
 - **`rig fund`** tops up your wallet (devnet faucet, or prints addresses to fund
   externally). Both the native coin (gas) and USDC (collateral) are needed.
 - **`rig balance`** shows what your wallet holds across chains.
 - **Channels open lazily.** The first paid write opens a channel from your funded
-  wallet and records it under `~/.toon-client` (`rig-channels.json`); later writes
-  resume the same channel instead of opening a new one.
-- **`rig channel list`** (free) shows current holdings and nonce watermarks.
-  **`rig channel open`** pre-opens one (or `--deposit`s more collateral) using the
-  exact lazy-open path; **`rig channel close`** starts the settlement challenge
-  window; **`rig channel settle`** releases collateral once the window elapses.
+  wallet (on Solana the node sponsors the open: USDC for the deposit, no SOL) and
+  records it under `~/.toon-client` (`rig-channels-x402.json`); later writes
+  resume the same channel, and a write it can no longer cover opens a fresh one.
+- **`rig channel list`** (free) shows current holdings and the running totals
+  signed. **`rig channel open`** pre-opens one (or `--deposit`s more collateral,
+  Base only) using the exact lazy-open path; **`rig channel close`** starts the
+  exit window; **`rig channel settle`** releases collateral once the window
+  elapses.
+- **Upgrading from a client 3.x rig** (4.7.x and earlier): its toon-channel
+  files (`rig-channels.json`, `channels.json`) are never read or written, only
+  named. A current connector refuses those claims; take their deposits back
+  with the rig that opened them.
 
 The `open`/`close`/`settle` lifecycle commands are on-chain wallet operations (gas +
 collateral movement), so they follow the same confirm idiom as `push`: they print
@@ -637,7 +644,7 @@ network — there is no announce to discover (kind:10032 was removed by connecto
 ADR 0046) and no topology to negotiate.
 
 ```sh
-curl -s https://proxy.relay.devnet.toonprotocol.dev/ilp | jq '{ilpAddresses, routes, settlements: [.settlements[].chain]}'
+curl -s https://proxy.relay.devnet.toonprotocol.dev/ilp | jq '{ilpAddresses, routes, batchSettlements: [.batchSettlements[].network]}'
 ```
 
 What rig derives from it, and the knob that overrides each:
@@ -648,16 +655,17 @@ What rig derives from it, and the knob that overrides each:
 | where events go | the node's first own address it also prices | `TOON_CLIENT_PUBLISH_DESTINATION` / `publishDestination` |
 | where git objects go | the node's first priced `*.store` route, else `*.ario` | `TOON_CLIENT_STORE_DESTINATION` / `storeDestination`; `rig name --via` per invocation |
 | a store on another node | — | `storeConnectorUrl` (that node holds its own channel: uploads ride a second client and watermark) or `storeSealTo` (same channel, sealed to that node) |
-| settlement chain | the first chain in `settlements[]` your identity holds a key for | `TOON_CLIENT_CHAIN` / `chain` — `evm` or `solana` (`evm:8453` is read by its family) |
+| settlement chain | the first chain in `batchSettlements[]` your identity holds a key for (a phrase holds both: name one) | `TOON_CLIENT_CHAIN` / `chain`: `evm` or `solana` (`evm:8453` is read by its family) |
 | chain RPC | the client's devnet preset | `TOON_CLIENT_RPC_URL` / `rpcUrl` / `chainRpcUrls[<chain>]` — **set this for a mainnet node** |
 | who pays | the phrase's key on that chain | `RIG_SOLANA_KEY_FILE` / `solanaKeyFile` (a `solana-keygen` JSON), `RIG_EVM_PRIVATE_KEY` / `evmPrivateKey` |
-| claim watermark file | `<TOON_CLIENT_HOME>/channels.json` | `TOON_CLIENT_CHANNEL_STORE` / `channelStorePath` — one file per channel writer, or two processes replay each other's nonces |
-| first-open collateral | the client default | `TOON_CLIENT_DEPOSIT` / `deposit` (base units) |
+| x402 channel store | `<TOON_CLIENT_HOME>/channels-x402.json` (+ `.peers.json`, each channel's config: keep both) | `TOON_CLIENT_CHANNEL_STORE` / `channelStorePath`: one file per channel writer, or two processes race each other's running totals. A client 3.x store is refused |
+| channel collateral | the client default (Solana: at least the node's `minDeposit`) | `TOON_CLIENT_DEPOSIT` / `deposit` (base units) |
+| Base deposit facilitator | none on Solana; the client's own on EVM | `TOON_CLIENT_FACILITATOR_URL` / `facilitatorUrl` |
 | carriage | `auto` (HTTP unless the node requires BTP) | `TOON_CLIENT_TRANSPORT` / `transport` |
 
 **Prices are schedules.** A route publishes a base price and, when it meters by
 size, a `pricePerKib` (connector ADR 0065). `rig push`'s fee table prices every
-object by its sealed size with the same rule the client puts on the claim, so
+object by its sealed size with the same rule the client puts on the voucher, so
 the estimate equals what is paid.
 
 **Who pays and who signs are independent.** The repo owner is the phrase's
@@ -666,13 +674,11 @@ Its EVM wallet is that same key (the client's `keyDerivation: 'legacy'`, rig's
 default, so channels an existing identity funded are still its own); set
 `TOON_CLIENT_KEY_DERIVATION=standard` for a fresh identity you want to import
 into MetaMask. The payer key may be a different key entirely: the connector
-attributes payment from the claim, never from the event.
+attributes payment from the voucher, never from the event.
 
 ### Devnet
 
-The shared devnet's nodes and the faucet (authoritative:
-[toon-meta `docs/deployment.md`](https://github.com/toon-protocol/toon-meta/blob/main/docs/deployment.md);
-the node URLs are also `@toon-protocol/client`'s `DEVNET` preset):
+The shared devnet's nodes and the faucet (the node URLs are also `@toon-protocol/client`'s `DEVNET` preset):
 
 | What | URL |
 |---|---|
@@ -746,13 +752,13 @@ phrase itself is never printed and never written to git config or any repo file.
 ## What a paid command does first
 
 Every standalone paid command bootstraps the same way: resolve the identity,
-read the connector's `GET /ilp`, open or adopt the payment channel with that
-node, then sign one claim per packet. Adoption is free — a channel's id derives
-from its participants, so a node you have paid before is found again without a
-transaction. Money state (the claim watermark, the channel map) lives under
-`TOON_CLIENT_HOME` and is never cached away.
+read the connector's `GET /ilp`, open or resume the x402 channel with that
+node, then sign one voucher per packet. Resuming is free: the client keeps each
+channel's config in its store, so a node you have paid before is found again
+without a transaction. Money state (the voucher watermark, the channel configs,
+the channel map) lives under `TOON_CLIENT_HOME` and is never cached away.
 
-Two rig processes on one identity race the claim nonce, so a per-identity lock
+Two rig processes on one identity race the running total, so a per-identity lock
 refuses the second (`RIG_STANDALONE=1` skips only the check for a same-identity
 `toon-clientd`; the lock stays). The `rig` bin exits as soon as a command
 finishes and stdio is flushed.

package/dist/{chunk-J6Y3U645.js → chunk-2TG4YHEC.js}

@@ -52,13 +52,13 @@ import {
   updateRef,
   writeGitObjects,
   writeToonConfig
-} from "./chunk-3IVO2MSZ.js";
+} from "./chunk-4WVH2ITA.js";
 import {
   PREFERRED_GATEWAY,
   mirrorGatewaysFor,
   readGateways,
   shaResolverFor
-} from "./chunk-XQ2AWNHQ.js";
+} from "./chunk-CHVOXCDV.js";
 import {
   COMMENT_KIND,
   DEFAULT_KEYSTORE_PASSWORD,
@@ -82,18 +82,19 @@ import {
   readClientConfigFile,
   resolveAccountIndex,
   resolveIdentity
-} from "./chunk-S3KKQ4IC.js";
+} from "./chunk-QKL53YZS.js";
 import {
   ChannelMapStore,
   channelStatus,
+  legacyChannelFiles,
   resolveChannelPaths,
   resolveConflictingPath
-} from "./chunk-XCLUB2CY.js";
+} from "./chunk-LMZSAFAB.js";
 import {
   RIG_STANDALONE_ENV,
   deriveNostrKeyFromMnemonic,
   uploadChargeFor
-} from "./chunk-U5A7MHBP.js";
+} from "./chunk-7VIVQHRG.js";
 
 // src/cli/render.ts
 function describeAnnouncementDiff(diff) {
@@ -310,7 +311,7 @@ function loadPaidSession(deps, relayUrl) {
   });
 }
 var defaultLoadStandalone = async (options) => {
-  const mod = await import("./standalone-mode-FY3XVQQK.js");
+  const mod = await import("./standalone-mode-AT4S5EZG.js");
   return mod.createStandaloneContext(options);
 };
 function identityReport(ctx) {
@@ -1027,7 +1028,10 @@ async function readWalletBounded(read, timeoutMs) {
   if (timeoutMs <= 0) return settled;
   let timer;
   const guard = new Promise((_resolve, reject) => {
-    timer = setTimeout(() => reject(new WalletReadTimeoutError(timeoutMs)), timeoutMs);
+    timer = setTimeout(
+      () => reject(new WalletReadTimeoutError(timeoutMs)),
+      timeoutMs
+    );
   });
   settled.catch(() => void 0);
   try {
@@ -1087,7 +1091,6 @@ async function runBalance(args, deps) {
         status: channelStatus(watermark),
         depositTotal: deposited ?? null,
         cumulativeClaimed: claimed ?? null,
-        nonce: watermark?.nonce ?? null,
         available,
         overdrawn
       };
@@ -1423,39 +1426,44 @@ async function runChain(args, deps) {
 
 // src/cli/channel.ts
 import { parseArgs as parseArgs4 } from "util";
+import { dirname as dirname2 } from "path";
 var CHANNEL_USAGE = `Usage: rig channel <subcommand>
 
-Manage the payment channels paid rig commands hold with relay/store peers.
-Paid commands open a channel lazily on first use and record it under
-TOON_CLIENT_HOME (default ~/.toon-client, rig-channels.json), so later
-invocations resume the same channel instead of opening a new one per run.
+Manage the x402 payment channels paid rig commands pay a node from. Every
+paid packet carries a voucher naming the channel's running total (client 4.x).
+Paid commands open a channel on first use and resume it from the client's
+store (TOON_CLIENT_HOME, default ~/.toon-client, channels-x402.json);
+\`rig channel open\` also records it in rig-channels-x402.json there.
 
 Subcommands:
   list [--json]    show recorded channels \u2014 peer, chain, channel id, deposit,
-                   cumulative claimed, status. Free: reads local state only.
+                   cumulative signed, status. Free: reads local state only.
 
   open [--peer <ilp-destination>] [--deposit <base-units>]
-                   explicitly open the payment channel for a peer \u2014 the SAME
-                   path paid commands use lazily: resumes the recorded live
-                   channel if one exists (no on-chain spend), else opens and
-                   records a fresh one (locks the peer-negotiated initial
-                   deposit on-chain). --peer is the ILP destination to anchor
-                   to (default: the configured destination, e.g. the devnet
-                   apex); --deposit adds that much extra collateral after the
-                   open/resume. On-chain: asks for confirmation (--yes skips).
+                   explicitly open the channel paid commands draw on: resumes
+                   the client's open channel if there is one (no on-chain
+                   spend), else opens and records a fresh one, locking the
+                   configured deposit (TOON_CLIENT_DEPOSIT) from your wallet.
+                   On Solana the node sponsors the open (USDC, no SOL).
+                   --peer is the ILP destination to record it under (default:
+                   the configured publish destination); --deposit adds that
+                   much extra collateral after the open/resume (Base only: a
+                   Solana channel is replaced when it runs out, never topped
+                   up). Asks for confirmation (--yes skips).
 
   close <channelId>
-                   close a recorded channel \u2014 an on-chain tx that starts the
-                   settlement challenge window (the peer's settlementTimeout).
-                   The channel stops paying immediately; the remaining
+                   close a recorded channel: an on-chain tx (Solana
+                   request_close, Base timed withdrawal) that starts its exit
+                   window, and that of every other channel still open with the
+                   node. The channel stops paying immediately; the remaining
                    collateral stays locked until \`rig channel settle\` after
                    the window elapses. Asks for confirmation (--yes skips).
 
   settle <channelId>
-                   settle a closed channel once its challenge window elapsed \u2014
-                   an on-chain tx that releases the remaining collateral back
-                   to your wallet. Refused (without spending gas) while the
-                   window is still open. Asks for confirmation (--yes skips).
+                   settle a closed channel once its exit window elapsed: an
+                   on-chain tx that releases the remaining collateral back to
+                   your wallet. Nothing is sent while the window is still
+                   open. Asks for confirmation (--yes skips).
 
 Common options: --json (machine-readable envelopes; without --yes lifecycle
 commands emit a pure plan and execute nothing), --yes, -h/--help.`;
@@ -1511,10 +1519,17 @@ function runChannelList(args, deps) {
     const store = new ChannelMapStore(paths);
     const records = store.list();
     const rows = records.map((record) => describeChannel(record, store));
+    const legacy = legacyChannelFiles(dirname2(paths.mapPath));
+    const legacyNote = `client 3.x toon-channel state not shown: ${legacy.join(", ")} (its deposits are left to the rig that opened them: \`npm i -g @toon-protocol/rig@4.7.0\`, then \`rig channel close\`)`;
     if (json) {
-      io.emitJson({ command: "channel list", channels: rows });
+      io.emitJson({
+        command: "channel list",
+        channels: rows,
+        ...legacy.length > 0 ? { legacyStateFiles: legacy } : {}
+      });
       return 0;
     }
+    if (legacy.length > 0) io.err(`rig: ${legacyNote}`);
     if (rows.length === 0) {
       io.out(
         "No payment channels recorded \u2014 paid rig commands (push, issue, comment, pr) record the channel they open on first use, and `rig channel open` records an explicit one."
@@ -1546,14 +1561,13 @@ function describeChannel(record, store) {
     tokenNetwork: record.tokenNetwork,
     depositTotal: record.depositTotal ?? null,
     cumulativeClaimed: watermark?.cumulativeAmount ?? null,
-    nonce: watermark?.nonce ?? null,
     status: channelStatus(watermark),
     openedAt: record.openedAt,
     lastUsedAt: record.lastUsedAt
   };
 }
 function renderChannel(row) {
-  const claimed = row.cumulativeClaimed === null ? "unknown (no local claim state)" : `${row.cumulativeClaimed} base units (nonce ${row.nonce})`;
+  const claimed = row.cumulativeClaimed === null ? "unknown (no local voucher state)" : `${row.cumulativeClaimed} base units signed`;
   return [
     `channel ${row.channelId} [${row.status}]`,
     `  peer        ${row.destination} (${row.peerId})`,
@@ -1701,7 +1715,9 @@ async function runChannelOpen(args, deps) {
     io.out(
       outcome.resumed ? `Resumed recorded channel ${outcome.channelId} \u2014 no on-chain open was needed.` : `Opened channel ${outcome.channelId}${outcome.chain ? ` on ${outcome.chain}` : ""} and recorded it for reuse.`
     );
-    io.out(`  peer        ${outcome.destination}${outcome.peerId ? ` (${outcome.peerId})` : ""}`);
+    io.out(
+      `  peer        ${outcome.destination}${outcome.peerId ? ` (${outcome.peerId})` : ""}`
+    );
     if (outcome.depositAdded) {
       io.out(
         `  deposited   +${outcome.depositAdded} base units` + (outcome.depositTxHash ? `  (tx ${outcome.depositTxHash})` : "")
@@ -1795,7 +1811,9 @@ async function runChannelWithdrawStep(args, deps, step) {
     if (!json) {
       const claimed = watermark?.cumulativeAmount;
       io.out(`Channel ${step} plan:`);
-      io.out(`  channel     ${channelId} [${channelStatus(watermark, nowSec)}]`);
+      io.out(
+        `  channel     ${channelId} [${channelStatus(watermark, nowSec)}]`
+      );
       io.out(`  peer        ${record.destination} (${record.peerId})`);
       io.out(`  chain       ${record.chain}`);
       io.out(
@@ -2475,7 +2493,7 @@ async function runCi(args, deps) {
     case "status":
       return runCiStatus(rest, deps);
     case "serve":
-      return (await import("./ci-serve-T33FCQVT.js")).runCiServe(rest, deps);
+      return (await import("./ci-serve-BU7NDT7O.js")).runCiServe(rest, deps);
     case "--help":
     case "-h":
     case "help":
@@ -2494,7 +2512,7 @@ async function runCi(args, deps) {
 
 // src/cli/clone.ts
 import { mkdtemp, mkdir, readdir, rename, rm, rmdir } from "fs/promises";
-import { basename, dirname as dirname2, join as join3, resolve } from "path";
+import { basename, dirname as dirname3, join as join3, resolve } from "path";
 import { parseArgs as parseArgs6 } from "util";
 var CLONE_USAGE = `Usage: rig clone <relay-url> <owner>/<repo-id> [dir] [options]
 
@@ -2674,7 +2692,7 @@ async function runClone(args, deps) {
         `warning: unreachable object ${sha} (tx ${txId}) could not be downloaded \u2014 not needed by any ref, continuing`
       );
     }
-    const parent = dirname2(dest);
+    const parent = dirname3(dest);
     await mkdir(parent, { recursive: true });
     tempDir = await mkdtemp(join3(parent, `.${basename(dest)}.rig-clone-`));
     await runGit(tempDir, [
@@ -4021,7 +4039,7 @@ async function warnIfNotMaintainer(deps, args) {
 // src/cli/entry.ts
 import { mkdirSync as mkdirSync3, readFileSync as readFileSync3, writeFileSync as writeFileSync3 } from "fs";
 import { homedir as homedir3 } from "os";
-import { dirname as dirname3, join as join4 } from "path";
+import { dirname as dirname4, join as join4 } from "path";
 import { parseArgs as parseArgs9 } from "util";
 var ENTRY_USAGE = `Usage: rig entry [<connector-url> | clear] [options]
 
@@ -4060,7 +4078,7 @@ function readEntryConfig(configPath) {
   }
 }
 function writeEntryConfig(configPath, file) {
-  mkdirSync3(dirname3(configPath), { recursive: true });
+  mkdirSync3(dirname4(configPath), { recursive: true });
   writeFileSync3(configPath, `${JSON.stringify(file, null, 2)}
 `, "utf8");
 }
@@ -4850,7 +4868,7 @@ var runGitPassthrough = (argv, options = {}) => {
 
 // src/cli/identity-cmd.ts
 import { existsSync, mkdirSync as mkdirSync4 } from "fs";
-import { dirname as dirname4 } from "path";
+import { dirname as dirname5 } from "path";
 import { createInterface } from "readline/promises";
 import { parseArgs as parseArgs12 } from "util";
 async function loadKeyOps() {
@@ -4902,7 +4920,7 @@ async function prepareKeystoreTarget(input) {
   const envPassword = input.env["TOON_CLIENT_KEYSTORE_PASSWORD"]?.trim() || void 0;
   const autoPassword = envPassword === void 0;
   const password = envPassword ?? DEFAULT_KEYSTORE_PASSWORD;
-  mkdirSync4(dirname4(keystorePath), { recursive: true });
+  mkdirSync4(dirname5(keystorePath), { recursive: true });
   return { keystorePath, password, autoPassword, existing, keyOps };
 }
 function readAccountIndex(env) {
@@ -7988,4 +8006,4 @@ export {
   rigVersion,
   dispatch
 };
-//# sourceMappingURL=chunk-J6Y3U645.js.map
+//# sourceMappingURL=chunk-2TG4YHEC.js.map