mycomesh-consumer 0.6.0 → 0.7.0

package/networks/mycomesh-v11-sepolia.json

@@ -7,6 +7,9 @@
   "registry": "0x0ff3210e8e8abf5f5bfa73a39e60db7416b6c8c7",
   "relay_directory": "0xa0aaad9393f51cb5786c69f152133a174588bdab",
   "probe_ledger": "0x30055eae6645cce8754f834a17689d20a3795ca3",
+  "emission": "0x85ee0e8f63400041f0c76010c590c330bc135a8d",
+  "token": "0x620d026ad854fb17c7b16534a0f28ef5499e2d4a",
+  "emission_block": 11815544,
   "tiers": {
     "1": {
       "name": "OpenAI frontier",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mycomesh-consumer",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "MycoMesh V11 Consumer: a custodied deposit, relay-blind encrypted requests to any Provider, and a local OpenAI-compatible endpoint.",
   "repository": {
     "type": "git",

package/src/cli.mjs

@@ -11,6 +11,7 @@ import { completeWithdrawal, dispute, faucet, requestWithdrawal, setup, walletSt
 import { Consumer, loadNetwork, serveConsumer } from "./consumer.mjs";
 import { createWallet, ownerAddress, ownerKey, walletAddress } from "./wallet.mjs";
 import { loadRequest } from "./disputes.mjs";
+import { claimRewards, formatMyco, rewardsSummary } from "./rewards.mjs";
 import { addTenant, loadTenants, revokeTenant, setBudget, tenantKey, tenantStatus } from "./tenants.mjs";
 import { spawn } from "node:child_process";
 import { statSync } from "node:fs";
@@ -27,6 +28,8 @@ const USAGE = `Usage: mycomesh-consumer <command> [options]
                            deposit into the settlement contract and authorize the payment key
                            (on testnets, tops the wallet up from the faucet first)
   balance [--owner ADDR]   show the custodied deposit
+  rewards [claim]          MYCO earned by the owner wallet (80% of each hour's emission goes to the
+                           Consumers who paid that hour's fees); \`claim\` mints it to the wallet
   withdraw [UNITS]         request a withdrawal of the deposit; run again after the delay to receive it
   request "prompt" [--stream]
                            send one request and print the verified answer
@@ -136,6 +139,18 @@ export async function main(argv = process.argv.slice(2), { stdout = process.stdo
     stdout.write(`${await availableBalance(network, owner)}\n`);
     return 0;
   }
+  if (command === "rewards") {
+    if (rest[0] === "claim") {
+      const owner = await ownerKey(values["owner-key-file"], dir);
+      stdout.write(`claimed ${JSON.stringify(await claimRewards(network, owner, addressOf(owner)))}\n`);
+    }
+    const account = values.owner || ownerAddress(values["owner-key-file"], dir);
+    if (!account) throw new Error("--owner, --owner-key-file or a local wallet (`init`) is required");
+    const summary = await rewardsSummary(network, account);
+    if (!summary) throw new Error("this network has no MYCO emission");
+    stdout.write(`${JSON.stringify(summary, null, 2)}\nMYCO balance ${formatMyco(summary.myco_balance_wei ?? 0)}\n`);
+    return 0;
+  }
   if (command === "dispute") {
     const owner = await ownerKey(values["owner-key-file"], dir);
     const result = await dispute(network, owner, loadRequest(dir, rest[0] || "last"),

package/src/console.mjs

@@ -8,6 +8,7 @@ import { outputText } from "./protocol.mjs";
 import { createWallet, ownerAddress, unlockWallet, walletAddress } from "./wallet.mjs";
 import { addTenant, loadTenants, revokeTenant, setBudget, tenantStatus } from "./tenants.mjs";
 import { networkPrices } from "./pricing.mjs";
+import { claimRewards, rewardsSummary } from "./rewards.mjs";
 
 const PAGE = new URL("./web/console.html", import.meta.url);
 
@@ -61,6 +62,14 @@ export function consoleRoutes({ consumer, dataDir }) {
       }));
       return { entries };
     },
+    "GET /api/rewards": async () => {
+      const address = owner();
+      return { rewards: address ? await rewardsSummary(network, address) : null };
+    },
+    "POST /api/rewards/claim": async (body) => {
+      const ownerPrivate = withWallet(body);
+      return { claimed: await claimRewards(network, ownerPrivate, addressOf(ownerPrivate)) };
+    },
     "POST /api/wallet": async (body) => ({ owner: walletAddress(await createWallet(dataDir, body.password)) }),
     "POST /api/faucet": async () => {
       const address = owner();

package/src/rewards.mjs

@@ -0,0 +1,84 @@
+// MYCO rewards: every hour's fees mint MYCO for the Consumers who paid them (80%), their Providers (10%,
+// 48 hours later, by success rate), Relays (7%) and keepers (3%). Find, show and claim an account's share.
+import { encodeCall, encodeWords, hex, keccak } from "./eip712.mjs";
+import { rpcCall, sendTransaction } from "./chain.mjs";
+
+export const ROLES = ["consumer", "provider", "relay", "bridge"];
+const POINTS = hex(keccak(new TextEncoder().encode("Points(uint64,uint8,address,uint256)")));
+const LOG_CHUNK = 10_000;
+const CLAIM_BATCH = 100;
+
+async function word(network, to, signature, pairs = []) {
+  return BigInt(await rpcCall(network.rpc_urls, "eth_call", [{ to, data: encodeCall(signature, pairs) }, "latest"]));
+}
+
+/** role index -> emission blocks in which the account earned points. */
+export async function earnedBlocks(network, account) {
+  const head = Number(BigInt(await rpcCall(network.rpc_urls, "eth_blockNumber", [])));
+  const topic = `0x${account.toLowerCase().replace(/^0x/, "").padStart(64, "0")}`;
+  const found = new Map();
+  for (let start = Number(network.emission_block || 0); start <= head; start += LOG_CHUNK) {
+    const logs = await rpcCall(network.rpc_urls, "eth_getLogs", [{ address: network.emission, topics: [POINTS, null, null, topic],
+      fromBlock: `0x${start.toString(16)}`, toBlock: `0x${Math.min(head, start + LOG_CHUNK - 1).toString(16)}` }]);
+    for (const log of logs) {
+      const role = Number(BigInt(log.topics[2]));
+      if (!found.has(role)) found.set(role, new Set());
+      found.get(role).add(Number(BigInt(log.topics[1])));
+    }
+  }
+  return found;
+}
+
+const claimableAt = (network, block, role, account) => word(network, network.emission, "claimable(uint64,uint8,address)",
+  [["uint", block], ["uint", role], ["address", account]]);
+
+/** MYCO claimable per role (wei strings), blocks still waiting (the current hour, or a Provider's 48 hours) and the balance. */
+export async function rewardsSummary(network, account) {
+  if (!network.emission) return null;
+  const roles = {};
+  for (const [role, blocks] of await earnedBlocks(network, account)) {
+    let claimable = 0n; let waiting = 0;
+    for (const block of blocks) {
+      const amount = await claimableAt(network, block, role, account);
+      if (amount > 0n) claimable += amount;
+      else if (await word(network, network.emission, "points(uint64,uint8,address)",
+        [["uint", block], ["uint", role], ["address", account]]) > 0n) waiting += 1;
+    }
+    roles[ROLES[role]] = { claimable_wei: claimable.toString(), blocks_waiting: waiting, blocks: blocks.size };
+  }
+  return {
+    account, roles,
+    myco_balance_wei: network.token ? (await word(network, network.token, "balanceOf(address)", [["address", account]])).toString() : null,
+  };
+}
+
+function encodeClaim(blocks, role) {
+  const selector = encodeCall("claim(uint64[],uint8)", []);
+  return selector + encodeWords([["uint", 64], ["uint", role], ["uint", blocks.length], ...blocks.map((b) => ["uint", b])]).toString("hex");
+}
+
+/** Close the finished hour if nobody has yet, then claim every claimable block in every role. */
+export async function claimRewards(network, ownerPrivate, account) {
+  if (!network.emission) throw new Error("this network has no MYCO emission");
+  const [open, hasOpen, current] = await Promise.all(["openBlock()", "hasOpen()", "currentBlock()"]
+    .map((signature) => word(network, network.emission, signature)));
+  if (hasOpen && open < current) await sendTransaction(network.rpc_urls, ownerPrivate, { to: network.emission, data: encodeCall("poke()", []) });
+  const claimed = {};
+  for (const [role, blocks] of await earnedBlocks(network, account)) {
+    const ready = [];
+    for (const block of [...blocks].sort((a, b) => a - b)) if (await claimableAt(network, block, role, account) > 0n) ready.push(block);
+    for (let i = 0; i < ready.length; i += CLAIM_BATCH) {
+      await sendTransaction(network.rpc_urls, ownerPrivate, { to: network.emission, data: encodeClaim(ready.slice(i, i + CLAIM_BATCH), role) });
+    }
+    if (ready.length) claimed[ROLES[role]] = ready.length;
+  }
+  return claimed;
+}
+
+/** 18-decimal wei as a short MYCO figure. */
+export function formatMyco(wei) {
+  const value = BigInt(wei);
+  const whole = value / 10n ** 18n;
+  const fraction = (value % 10n ** 18n).toString().padStart(18, "0").slice(0, 2);
+  return `${whole.toLocaleString("en-US")}.${fraction}`;
+}

package/src/web/console.html

@@ -97,6 +97,14 @@
         <input id="dep-limit" placeholder="单次上限（tUSDC）" value="2" size="12">
         <button class="primary" id="deposit-btn">存入</button>
         <button class="ghost" id="faucet-btn">领取测试币</button></div>
+      <h2>MYCO 奖励</h2>
+      <p class="muted">MYCO 总量 10 亿，无预挖，按小时出块、像比特币一样减半产出（首个周期 1 周，之后 2 周、4 周……最长 4 年）。每小时产出的 80% 按当小时实际支付的费用分给 Consumer，花得越多分得越多；这一小时结束后即可领取。</p>
+      <div class="cards">
+        <div class="card"><div class="label">可领取 MYCO</div><div class="value" id="myco-claimable">—</div></div>
+        <div class="card"><div class="label">钱包里的 MYCO</div><div class="value" id="myco-balance">—</div></div>
+        <div class="card"><div class="label">等待中的小时</div><div class="value" id="myco-waiting">—</div></div>
+      </div>
+      <div class="row"><button class="primary" id="myco-claim">领取 MYCO</button></div>
       <h2>取回押金</h2>
       <p class="muted" id="withdraw-hint">先申请，等待期结束后再次点击即可到账。</p>
       <div class="row"><input id="wd-amount" placeholder="金额（留空为全部）" size="16"><button class="ghost" id="withdraw-btn">取回</button></div>
@@ -188,8 +196,18 @@ async function refreshWallet() {
   $("withdraw-hint").textContent = pending > 0n
     ? (w.withdrawal.available_at * 1000 > Date.now() ? `已申请取回 ${fmt(w.withdrawal.amount)}，${new Date(w.withdrawal.available_at * 1000).toLocaleString()} 之后可到账。`
       : `已申请的 ${fmt(w.withdrawal.amount)} 可以到账了，点击“取回”。`) : "先申请，等待期结束后再次点击即可到账。";
+  refreshRewards().catch(() => {});
   $("chat-hint").textContent = BigInt(w.deposit) === 0n || !w.grant?.active ? "还没有押金。" : `押金 ${fmt(w.deposit)} tUSDC`;
 }
+const myco = (wei) => (Number(BigInt(wei) / 10n ** 14n) / 1e4).toLocaleString(undefined, { maximumFractionDigits: 4 });
+async function refreshRewards() {
+  const { rewards } = await api("/api/rewards");
+  if (!rewards) return;
+  const roles = Object.values(rewards.roles);
+  $("myco-claimable").textContent = myco(roles.reduce((sum, r) => sum + BigInt(r.claimable_wei), 0n));
+  $("myco-balance").textContent = myco(rewards.myco_balance_wei ?? 0);
+  $("myco-waiting").textContent = roles.reduce((sum, r) => sum + r.blocks_waiting, 0);
+}
 function renderWelcome() {
   const ready = status?.wallet && BigInt(status.wallet.deposit) > 0n && status.wallet.grant?.active;
   $("welcome").style.display = ready ? "none" : "block";
@@ -257,6 +275,14 @@ $("deposit-btn").onclick = async () => {
     toast("押金已存入"); await refreshWallet();
   });
 };
+$("myco-claim").onclick = async () => {
+  const answer = await ask("领取 MYCO"); if (!answer) return;
+  await busy($("myco-claim"), async () => {
+    const { claimed } = await api("/api/rewards/claim", { password: answer.password });
+    const hours = Object.values(claimed).reduce((a, b) => a + b, 0);
+    toast(hours ? `已领取 ${hours} 个小时的 MYCO` : "暂时没有可领取的 MYCO"); await refreshRewards();
+  });
+};
 $("withdraw-btn").onclick = async () => {
   const answer = await ask("取回押金"); if (!answer) return;
   await busy($("withdraw-btn"), async () => {