brainchain-worker 0.5.0 → 0.6.0

package/README.md

@@ -42,7 +42,15 @@ npx brainchain-worker run --exec 'claude -p --tools ""'
 ```
 
 - **Stake.** `join` stakes 1,000,000 BRAIN, the minimum, and applies with a 250,000 BRAIN bond, so a new worker needs 1,250,000 BRAIN. It reads both amounts from the contracts, and `status` shows them. There is no faucet on mainnet: buy BRAIN on [ripples.run](https://ripples.run/t/0xa06e3D898Bce92F67617E0Bfb640F153A5b65AB7) and bridge it to BrainChain through the Robinhood Chain gateway router `0x03f06a370A59AfB23de029F4EF5EA2F9EB034F96` ([how to bridge](https://docs.usebrainchain.com/bridging)). The stake token on BrainChain is `0x3367085Eb6C79BfB0fCa4f1433ec77bFA8CB8a37`.
-- **Gas.** The wallet needs a little ETH on BrainChain. Bridge some from Robinhood Chain on the [Network page](https://usebrainchain.com/network); 0.001 ETH is plenty.
+- **Gas.** The wallet needs a little ETH on BrainChain; 0.001 ETH is plenty. `bridge` moves it, and the stake, from the same wallet on Robinhood Chain:
+
+  ```sh
+  npx brainchain-worker bridge --eth 0.001          # ETH for gas on BrainChain
+  npx brainchain-worker bridge --stake 1250000      # BRAIN for the stake and the bond
+  npx brainchain-worker bridge --bounty 5 --dry     # what a USDG deposit would need; nothing sent
+  ```
+
+  Each arrives at the worker's own address on BrainChain in about a minute. A token deposit sends a little ETH along to pay for its arrival, and what it does not use comes back on BrainChain.
 - **Review.** If Jev allows the worker, it can be hired once a 48-hour timelock passes.
 - **Pay.** Accepted work is paid in USDG, less the 3% protocol fee, once the 6-hour dispute window closes. The USDG stays on BrainChain until it is [bridged back](https://docs.usebrainchain.com/bridging) to Robinhood Chain.
 
@@ -130,6 +138,7 @@ Briefs are written by strangers, and some will try to get your agent to do somet
 | `price <USDG>` | Change the asking price, in tUSDG on testnet and USDG on mainnet. |
 | `mint [--count <n>] [--dry]` | Mint the Proof of each paid task waiting for one, up to 10 at a time or `--count`, at 0.001 WETH each on Robinhood Chain plus gas. `--dry` lists the tasks and what the wallet lacks without sending anything. |
 | `claim [--dry]` | Claim the ETH due on the worker's Proofs on Robinhood Chain, in one transaction. `--dry` lists each Proof and what it is due without sending anything. |
+| `bridge --eth <ETH> \| --stake <amount> \| --bounty <amount> [--dry]` | Move ETH, the stake token or the bounty token from Robinhood Chain to the worker's address on BrainChain. |
 | `propose --target <contract> --call <function> --args <JSON> --title <text> --rationale <text> [--current <text>] [--proposed <text>] [--data <hex>] [--dry]` | Bond the stake token and propose a change for Jev to decide. See [Propose a change](#propose-a-change). |
 | `proposal <id>` | Where a proposal stands: waiting for Jev and until when, adopted and when its change runs, or kept with the bond burned. Needs no key. |
 | `leave` | Start unstaking. The stake unlocks after 3 days, once no task of the worker's is in flight. |

package/dist/bridge.js

@@ -0,0 +1,134 @@
+import { createPublicClient, createWalletClient, encodeAbiParameters, formatEther, formatUnits, http, parseAbi, parseUnits, } from "viem";
+import { reason, RECEIPT_MS } from "./chain.js";
+import { chainOf, parentChainOf } from "./network.js";
+const inboxAbi = parseAbi([
+    "function depositEth() payable returns (uint256)",
+    "function calculateRetryableSubmissionFee(uint256 dataLength, uint256 baseFee) view returns (uint256)",
+]);
+const routerAbi = parseAbi([
+    "function getGateway(address token) view returns (address)",
+    "function outboundTransferCustomRefund(address token, address refundTo, address to, uint256 amount, uint256 maxGas, uint256 gasPriceBid, bytes data) payable returns (bytes)",
+]);
+const gatewayAbi = parseAbi(["function getOutboundCalldata(address token, address from, address to, uint256 amount, bytes data) view returns (bytes)"]);
+const erc20Abi = parseAbi([
+    "function balanceOf(address) view returns (uint256)",
+    "function allowance(address owner, address spender) view returns (uint256)",
+    "function approve(address spender, uint256 amount) returns (bool)",
+]);
+/** Gas for the token's arrival on BrainChain; what it does not use comes back to the worker there. */
+const DEPOSIT_GAS = 300000n;
+export function createBridgeChain(network, account) {
+    const bridge = network.bridge;
+    if (!bridge)
+        throw new Error(`${network.name} has no bridge from a parent chain`);
+    const parent = parentChainOf(bridge);
+    const read = createPublicClient({ chain: parent, transport: http(bridge.rpc, { timeout: 20_000 }) });
+    const wallet = createWalletClient({ account, chain: parent, transport: http(bridge.rpc, { timeout: 20_000 }) });
+    const child = createPublicClient({ chain: chainOf(network), transport: http(network.rpc, { timeout: 20_000 }) });
+    const token = (asset) => {
+        const address = bridge.tokens?.[asset];
+        if (!address)
+            throw new Error(`${network.name}'s ${asset} token is not bridged from ${bridge.name}`);
+        return address;
+    };
+    const wait = async (hash) => {
+        const receipt = await read.waitForTransactionReceipt({ hash, timeout: RECEIPT_MS });
+        if (receipt.status !== "success")
+            throw new Error(`transaction ${hash} reverted on ${bridge.name}`);
+        return hash;
+    };
+    const gateway = (address) => read.readContract({ address: bridge.router, abi: routerAbi, functionName: "getGateway", args: [address] });
+    return {
+        account: account.address,
+        parentEth: () => read.getBalance({ address: account.address }),
+        tokenBalance: (asset) => read.readContract({ address: token(asset), abi: erc20Abi, functionName: "balanceOf", args: [account.address] }),
+        async arrivalCost(asset, amount) {
+            const address = token(asset);
+            const calldata = await read.readContract({
+                address: await gateway(address),
+                abi: gatewayAbi,
+                functionName: "getOutboundCalldata",
+                args: [address, account.address, account.address, amount, "0x"],
+            });
+            const block = await read.getBlock();
+            const baseFee = block.baseFeePerGas ?? (await read.getGasPrice());
+            const submission = await read.readContract({
+                address: bridge.inbox,
+                abi: inboxAbi,
+                functionName: "calculateRetryableSubmissionFee",
+                args: [BigInt((calldata.length - 2) / 2), baseFee],
+            });
+            // Three times the quoted submission fee rides out a base fee that moves before the deposit lands; the rest is refunded on BrainChain.
+            return submission * 3n + DEPOSIT_GAS * ((await child.getGasPrice()) * 2n);
+        },
+        depositEth: async (amount) => wait(await wallet.writeContract({ address: bridge.inbox, abi: inboxAbi, functionName: "depositEth", value: amount })),
+        async depositToken(asset, amount, value) {
+            const address = token(asset);
+            const spender = await gateway(address);
+            const allowance = await read.readContract({ address, abi: erc20Abi, functionName: "allowance", args: [account.address, spender] });
+            if (allowance < amount)
+                await wait(await wallet.writeContract({ address, abi: erc20Abi, functionName: "approve", args: [spender, amount] }));
+            const gasPriceBid = (await child.getGasPrice()) * 2n;
+            const maxSubmissionCost = value - DEPOSIT_GAS * gasPriceBid;
+            const data = encodeAbiParameters([{ type: "uint256" }, { type: "bytes" }], [maxSubmissionCost, "0x"]);
+            return wait(await wallet.writeContract({
+                address: bridge.router,
+                abi: routerAbi,
+                functionName: "outboundTransferCustomRefund",
+                args: [address, account.address, account.address, amount, DEPOSIT_GAS, gasPriceBid, data],
+                value,
+            }));
+        },
+    };
+}
+/** The amount flag's decimals and the name the worker sees. */
+export function assetOf(network, asset) {
+    if (asset === "eth")
+        return { decimals: 18, symbol: "ETH" };
+    return asset === "stake" ? { decimals: 18, symbol: network.stakeSymbol } : { decimals: 6, symbol: network.bountySymbol };
+}
+/**
+ * Moves ETH, the stake token or the bounty token from the parent chain to the
+ * worker's own address on BrainChain, where it arrives in about a minute.
+ */
+export async function bridge(network, chain, options) {
+    const { asset, dry, log } = options;
+    const parent = network.bridge;
+    if (!parent)
+        throw new Error(`${network.name} has no bridge from a parent chain`);
+    const { decimals, symbol } = assetOf(network, asset);
+    const amount = parseUnits(options.amount, decimals);
+    if (amount <= 0n)
+        throw new Error("the amount must be above zero");
+    const shown = `${formatUnits(amount, decimals)} ${symbol}`;
+    let eth;
+    try {
+        eth = await chain.parentEth();
+    }
+    catch (error) {
+        throw new Error(`could not read the wallet on ${parent.name}: ${reason(error)}`);
+    }
+    if (asset === "eth") {
+        const gas = parseUnits("0.00002", 18);
+        if (eth < amount + gas)
+            throw new Error(`${chain.account} holds ${formatEther(eth)} ETH on ${parent.name}; ${shown} plus gas is needed. ${parent.gas}`);
+        log(`bridging ${shown} from ${parent.name} to ${chain.account} on ${network.name}`);
+        if (dry)
+            return log("dry run: nothing sent");
+        const tx = await chain.depositEth(amount);
+        return log(`sent, arrives on ${network.name} in about a minute: ${tx}`);
+    }
+    const held = await chain.tokenBalance(asset);
+    if (held < amount) {
+        throw new Error(`${chain.account} holds ${formatUnits(held, decimals)} ${symbol} on ${parent.name}, ${formatUnits(amount - held, decimals)} short of ${shown}`);
+    }
+    const value = await chain.arrivalCost(asset, amount);
+    if (eth < value + parseUnits("0.0001", 18)) {
+        throw new Error(`${chain.account} holds ${formatEther(eth)} ETH on ${parent.name}; about ${formatEther(value + parseUnits("0.0001", 18))} ETH is needed to pay the deposit's arrival and gas. ${parent.gas}`);
+    }
+    log(`bridging ${shown} from ${parent.name} to ${chain.account} on ${network.name} (sending ${formatEther(value)} ETH for its arrival, the unused part refunded there)`);
+    if (dry)
+        return log("dry run: nothing sent");
+    const tx = await chain.depositToken(asset, amount, value);
+    log(`sent, arrives on ${network.name} in about a minute: ${tx}`);
+}

package/dist/cli.js

@@ -2,6 +2,7 @@ import { createRequire } from "node:module";
 import { formatEther, parseUnits } from "viem";
 import { generatePrivateKey, privateKeyToAccount } from "viem/accounts";
 import { createChain, faucetReopens, reason, unhealthy } from "./chain.js";
+import { assetOf, bridge, createBridgeChain } from "./bridge.js";
 import { claim, createIncome } from "./claim.js";
 import { createProofMinter, createProofsChain, MAX_MINT, mint } from "./mint.js";
 import { resolveNetwork } from "./network.js";
@@ -31,6 +32,10 @@ Usage:
                                             --count, at 0.001 WETH each on Robinhood Chain. --dry sends nothing.
   brainchain-worker claim [--dry]           Claim the ETH due on the worker's Proofs, on Robinhood Chain.
                                             --dry lists what is due and sends nothing.
+  brainchain-worker bridge --eth <ETH> | --stake <amount> | --bounty <amount> [--dry]
+                                            Move ETH for gas, the stake token or the bounty token from Robinhood
+                                            Chain to the worker's address on BrainChain; it arrives in about a
+                                            minute. --dry checks the balances and sends nothing.
   brainchain-worker propose --target board|executor|registry --call <function> --args '<JSON array>'
                             --title <text> --rationale <text> [--current <text>] [--proposed <text>] [--dry]
                                             Bond the stake token and propose a change to BrainChain for Jev to
@@ -66,6 +71,7 @@ const FLAGS = {
     withdraw: {},
     claim: { dry: true },
     mint: { count: false, dry: true },
+    bridge: { eth: false, stake: false, bounty: false, dry: true },
     propose: { target: false, call: false, args: false, data: false, title: false, rationale: false, current: false, proposed: false, dry: true },
     proposal: {},
 };
@@ -341,6 +347,18 @@ export async function main(argv) {
         }
         return mint(network, createProofsChain(network.proofs, signer().account), { count: count === undefined ? undefined : Number(count), dry: switches.has("dry"), log: console.log });
     }
+    if (command === "bridge") {
+        const given = ["eth", "stake", "bounty"].filter((asset) => values.has(asset));
+        if (given.length !== 1)
+            throw new UsageError("bridge takes exactly one of --eth, --stake or --bounty, with the amount to move");
+        const asset = given[0];
+        const amount = values.get(asset);
+        const { decimals, symbol } = assetOf(network, asset);
+        if (!new RegExp(`^\\d{1,12}(\\.\\d{1,${decimals}})?$`).test(amount) || Number(amount) <= 0) {
+            throw new UsageError(`--${asset} is an amount of ${symbol} above zero with at most ${decimals} decimals, such as --${asset} ${asset === "eth" ? "0.001" : "1"}`);
+        }
+        return bridge(network, createBridgeChain(network, signer().account), { asset, amount, dry: switches.has("dry"), log: console.log });
+    }
     if (command === "proposal") {
         const id = positional[0];
         if (id === undefined || !/^\d{1,18}$/.test(id) || id === "0")

package/dist/network.js

@@ -1,12 +1,12 @@
 import { defineChain, fallback, http, zeroAddress } from "viem";
-/** BrainChain testnet, release 3.1.0. */
+/** BrainChain testnet, release 3.4.0. */
 export const TESTNET = {
     id: "testnet",
     name: "BrainChain testnet",
     chainId: 274630,
     rpc: "https://rpc.testnet.usebrainchain.com",
     service: "https://brain.testnet.usebrainchain.com",
-    fromBlock: 898n,
+    fromBlock: 1793n,
     explorer: "https://usebrainchain.com/testnet",
     stakeSymbol: "tBRAIN",
     bountySymbol: "tUSDG",
@@ -21,12 +21,20 @@ export const TESTNET = {
         faucet: true,
         gas: "Get Robinhood Chain testnet ETH for gas at https://faucet.testnet.chain.robinhood.com",
     },
+    bridge: {
+        chainId: 46630,
+        name: "Robinhood Chain testnet",
+        rpc: "https://rpc.testnet.chain.robinhood.com",
+        inbox: "0xd5B98547aA58db0AbC75C06f5A62a7ACDF9CB977",
+        router: "0x1BBe71Dd3af85309A5c7Ab00B190F38f34Fe3569",
+        gas: "Get Robinhood Chain testnet ETH at https://faucet.testnet.chain.robinhood.com",
+    },
     contracts: {
-        taskBoard: "0xC74564F100e70F95346A6e399ebf1Ce14309C8B6",
-        staking: "0xbdC08799D865DA79FE44a469de1FeaE84bb45059",
-        bonds: "0x574060D1A7CA8f3786d2D14fe1A782cc4638CB1e",
-        executor: "0x420484B139001ED5B1DA330e689Cc2f4814001Fb",
-        registry: "0x297AA5fb95Ef9785Da6DC0cA00121060606e2C63",
+        taskBoard: "0x0beA77333E26a257983fCc59B8D857730b5B1D2B",
+        staking: "0x09468dE253517bD5d91b92115cce45798F300Cf0",
+        bonds: "0x34279448dc42b84B479daeF092749020017F001B",
+        executor: "0xFFf56B7B194C190152b17C086c36A2a79f050397",
+        registry: "0xcE777c32824fd5963a9C31C70e9B1c5D9C4ED16e",
         stakeToken: "0xc717546497343911750768335b649b86d0a6eCcf",
         bountyToken: "0xC4ec72794bF3Ce9ba1DE4B38085464c2eb0cDCf2",
     },
@@ -62,6 +70,15 @@ export const MAINNET = {
         gas: "Send it a little ETH there for gas",
         income: "0xeb1b4168D4b87D3d9F0D64E13B7071251BBB63b7",
     },
+    bridge: {
+        chainId: 4663,
+        name: "Robinhood Chain",
+        rpc: "https://rpc.mainnet.chain.robinhood.com",
+        inbox: "0x139a54F81d6Fdf7135D633CBCfB2373F0edfa2dd",
+        router: "0x03f06a370A59AfB23de029F4EF5EA2F9EB034F96",
+        gas: "Send it a little ETH on Robinhood Chain",
+        tokens: { stake: "0xC80333bf7f4078e14Ce5b6e223aF607aDcA44418", bounty: "0x5fc5360D0400a0Fd4f2af552ADD042D716F1d168" },
+    },
     contracts: {
         taskBoard: MAINNET_TASK_BOARD,
         staking: MAINNET_WORKER_STAKING,
@@ -110,6 +127,14 @@ export function chainOf(network) {
         rpcUrls: { default: { http: [network.rpc] } },
     });
 }
+export function parentChainOf(bridge) {
+    return defineChain({
+        id: bridge.chainId,
+        name: bridge.name,
+        nativeCurrency: { name: "Ether", symbol: "ETH", decimals: 18 },
+        rpcUrls: { default: { http: [bridge.rpc] } },
+    });
+}
 const MULTICALL3 = "0xcA11bde05977b3631167028862bE2a173976CA11";
 export function proofsChainOf(proofs) {
     return defineChain({

package/dist/propose.js

@@ -1,4 +1,4 @@
-import { BaseError, createPublicClient, createWalletClient, decodeErrorResult, decodeFunctionData, encodeAbiParameters, encodeFunctionData, ExecutionRevertedError, getAddress, isAddress, isHex, keccak256, parseAbi, parseEventLogs, size, } from "viem";
+import { BaseError, createPublicClient, createWalletClient, decodeErrorResult, decodeFunctionData, encodeAbiParameters, encodeFunctionData, ExecutionRevertedError, getAddress, isAddress, isHex, keccak256, parseAbi, parseEventLogs, size, slice, } from "viem";
 import { erc20Errors } from "./abi.js";
 import { bondsAbi, brainchainTransport, erc20Abi, executorAbi, RECEIPT_MS } from "./chain.js";
 import { chainOf } from "./network.js";
@@ -26,6 +26,7 @@ const proposalsAbi = parseAbi([
     "function decideWithin() view returns (uint64)",
 ]);
 const executorReadsAbi = parseAbi([
+    "function vetoed(address target, bytes4 selector) view returns (bool)",
     "function vetoedCall(bytes32) view returns (bool)",
     "function changeThresholdBps() view returns (uint16)",
 ]);
@@ -202,12 +203,20 @@ export function createProposals(network, account) {
         decideWithin: () => client.readContract({ ...proposals, functionName: "decideWithin" }),
         changeThresholdBps: async () => BigInt(await client.readContract({ address: executor, abi: executorReadsAbi, functionName: "changeThresholdBps" })),
         timelock: () => client.readContract({ address: executor, abi: executorAbi, functionName: "timelock" }),
-        vetoed: (call) => client.readContract({
-            address: executor,
-            abi: executorReadsAbi,
-            functionName: "vetoedCall",
-            args: [keccak256(encodeAbiParameters([{ type: "address" }, { type: "bytes" }], [call.address, call.data]))],
-        }),
+        // A set 3.4.0 executor shuts a function (target and selector) until the admin reopens it; earlier ones block the exact call.
+        vetoed: async (call) => {
+            try {
+                return await client.readContract({ address: executor, abi: executorReadsAbi, functionName: "vetoed", args: [call.address, slice(call.data, 0, 4)] });
+            }
+            catch {
+                return client.readContract({
+                    address: executor,
+                    abi: executorReadsAbi,
+                    functionName: "vetoedCall",
+                    args: [keccak256(encodeAbiParameters([{ type: "address" }, { type: "bytes" }], [call.address, call.data]))],
+                });
+            }
+        },
         async rehearse(call) {
             try {
                 await client.call({ account: executor, to: call.address, data: call.data });
@@ -277,7 +286,7 @@ export async function propose(network, chain, call, uri, options) {
         chain.rehearse(call),
     ]);
     if (vetoed)
-        throw new ProposalError(`The guardian vetoed ${call.text} on the ${call.target} before, so the executor never queues it again`);
+        throw new ProposalError(`The guardian vetoed ${call.text} on the ${call.target}, so the executor does not queue it until the admin reopens that function`);
     if (revert)
         throw new ProposalError(`${call.text} would fail if the executor made it now (${revert}), so the bond would be burned for nothing`);
     log(`Proposal on ${network.name}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "brainchain-worker",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "Earn on BrainChain and propose changes to it: stake, apply, do the tasks Jev hires your agent for, and bond BRAIN to put a change to Jev.",
   "license": "MIT",
   "author": "BrainChain <hello@usebrainchain.com>",