clockwork-press 0.2.1 → 0.2.2

package/dist/env.js

@@ -34,7 +34,7 @@ export const cfg = {
     // a native launch is quoted in eth: the pair address is the zero address and the escrow keeps it on its native ledger.
     gme: c.pair.address, pair: c.pair.address, pairSymbol: pairNative ? 'ETH' : c.pair.symbol, pairDecimals: pairNative ? 18 : c.pair.decimals ?? 18, pairNative,
     token: c.token.address, tokenSymbol: c.token.symbol, tokenName: c.token.name, totalSupply: c.token.supply ?? 1_000_000_000,
-    escrow: (c.launch.feeEscrow || ''), locker: (c.launch.locker || ''), claimMode: c.claim.mode, claimFloor: Number(c.claim.floor ?? 5), claimEveryHours: Number(c.claim.atLeastEveryHours ?? 24),
+    escrow: (c.launch.feeEscrow || ''), locker: (c.launch.locker || ''), claimMode: c.claim.mode, claimFloor: Number(c.claim.floor ?? 5), lowGasEth: Number(c.alerts?.lowGasEth ?? 0.005), claimEveryHours: Number(c.claim.atLeastEveryHours ?? 24),
     hook: (c.launch.hook || '0xE5e702641Ea86F4ae6cC3cDaeD2B886f976Be044'), vault: (c.launch.vault || '0x42df2a798f82289E177311362e8f5ccC45c1219c'),
     vestMode: c.buyback?.vest ?? 'burn', paceWord: pace,
     // ops is '' when the client has no ops wallet; the ops leg then holds (and validate() refuses opsBps > 0 without one)

package/dist/jobs/init.js

@@ -56,10 +56,10 @@ export async function runInit() {
         split: house ? { burnBps: 5000, treasuryBps: 5000, opsBps: 0, serviceBps: 0 } : { burnBps: 4500, treasuryBps: 4500, opsBps: 0, serviceBps: 1000 },
         schedule: { cadenceMin: 15, weekends: true, napUntil: null },
         slices: { rule: { kind: 'pace', pace: 'steady' }, dip: { on: false, bandBps: 1000, multiplier: 2 }, quoteSanityBps: 1500, maxSlippageBps: 300 },
-        burn: { method: 'burn' }, buyback: { vest: 'burn' }, claim: { mode: 'auto', floor: pair.symbol === 'ETH' || pair.symbol === 'WETH' ? 0.05 : 5, atLeastEveryHours: 24 },
-        telegram: { mode: 'shared', cards: { claim: true, slice: true, percent: true, buys: false }, buyFloorUsd: 50 },
+        burn: { method: 'burn' }, buyback: { vest: 'burn' }, claim: { mode: 'auto', floor: ['ETH', 'WETH'].includes(String(pair.symbol)) ? 0.05 : ['USDG', 'USDC', 'USDT', 'DAI', 'USD1'].includes(String(pair.symbol).toUpperCase()) ? 100 : 5, atLeastEveryHours: 24 },
+        telegram: { mode: 'own', chatId: '', cards: { claim: true, slice: true, percent: true, buys: false }, buyFloorUsd: 50 }, // own bot until the shared clockwork bot exists; chatId from `clockwork tgcheck`
         site: { enabled: true, modules: ['treasury', 'burns', 'holders', 'seats', 'wallet', 'rank', 'ledger'], seatThreshold: 250000 },
-        brand: { name: tName, treasuryWord: 'treasury', burnWord: 'burn', accent: '#3DFF8E' },
+        brand: { name: tName, treasuryWord: 'treasury', burnWord: 'burn', accent: '#0B6E4F', avatar: '' },
     };
     writeFileSync(out, JSON.stringify(cfg, null, 1) + '\n');
     console.log(`wrote ${out}: ${tName} (${tSym}) paired with ${pair.symbol}${native ? ' (native)' : ` at ${pair.address}`}, ${PHASES[Number(lt.phase)] ?? `phase ${lt.phase}`}, buybacks ${lt.buybackEnabled ? 'on' : 'off'}.`);

package/dist/press.js

@@ -108,6 +108,31 @@ async function scanStash(fairUsd) {
         await postCard(ART.press, [`${cfg.emoji} ${W.claim} #${entry.k}`, `${W.treasury}: +${gme.toFixed(2)} ${cfg.pairSymbol}. never sold, never distributed.`, fedNote ? fedNote.trim() : null, `the ${W.treasury}: ${Math.round(totals().stashedGme).toLocaleString('en-US')} ${cfg.pairSymbol}`]);
         added++;
     }
+    // the treasury-outflow watch: the treasury only grows; any transfer out of it is news, posted once per hash
+    try {
+        const outs = await pub.getLogs({
+            address: cfg.gme, event: parseAbiItem('event Transfer(address indexed from, address indexed to, uint256 value)'),
+            args: { from: cfg.stash }, fromBlock: from, toBlock: latest,
+        });
+        for (const log of outs) {
+            const amt = log.args.value;
+            if (amt === 0n)
+                continue;
+            const l = readLedger();
+            l.meta = { ...(l.meta ?? {}) };
+            const seen = l.meta.treasuryOutflows ?? [];
+            if (seen.some((o) => o.tx === log.transactionHash))
+                continue;
+            const rec = { tx: log.transactionHash, amount: Number(formatUnits(amt, cfg.pairDecimals)).toFixed(4), to: String(log.args.to), at: new Date().toISOString() };
+            l.meta.treasuryOutflows = [...seen, rec].slice(-20);
+            writeLedger(l);
+            console.log(`[press] the ${W.treasury} moved: ${rec.amount} ${cfg.pairSymbol} left it to ${rec.to.slice(0, 6)}…${rec.to.slice(-4)} (${rec.tx})`);
+            await postCard('', [`${cfg.emoji} the ${W.treasury} moved`, `${rec.amount} ${cfg.pairSymbol} left the ${W.treasury} to ${rec.to.slice(0, 6)}…${rec.to.slice(-4)}.`, `if this was the founder, nothing to do. if not, look now.`]);
+        }
+    }
+    catch (e) {
+        console.log(`[press] outflow watch skipped: ${e.shortMessage || e.message}`);
+    }
     const l2 = readLedger();
     l2.stashScanBlock = latest.toString();
     writeLedger(l2);
@@ -303,8 +328,12 @@ async function pressOnce(runAt, commit) {
     // what every stats write carries this run; the recipient watch and unswept are filled in once known.
     // the recipient row is red whenever an auto-mode machine is not where the fees point, key or no key.
     // lastRunAt is whatever the file holds: markRun sets it when a run commits to work, never a napping tick.
+    // supply locked at graduation sits in the pons locker and never comes out: out of circulation, like a burn
+    const lockedTokens = cfg.locker ? await tryRead('locker', () => pub.readContract({ address: token, abi: erc20Abi, functionName: 'balanceOf', args: [cfg.locker] }), 0n) : 0n;
+    const locked = lockedTokens > 0n ? { tokens: formatUnits(lockedTokens, 18), pctOfMint: ((Number(lockedTokens) / Number(TOTAL_SUPPLY)) * 100).toFixed(2) } : null;
     const common = () => ({
         presses: countKind('press'), snacks: countKind('snack'), checkedAt: new Date().toISOString(), peg: pegOut,
+        locked, treasuryOutflow: readLedger().meta?.treasuryOutflows?.at(-1) ?? null,
         cadenceMin: cfg.cadenceMin, days: dailyRollup(), holders, lastRunAt: prevStats().lastRunAt,
         phase: s.phaseWord, graduationPct: s.graduationPct,
         feeRecipient: { address: s.recipient, ok: cfg.claimMode !== 'auto' || same(s.recipient, cfg.pressWallet) }, pendingRecipient: null,
@@ -327,6 +356,26 @@ async function pressOnce(runAt, commit) {
     }
     const me = account().address;
     const w = wallet();
+    // one card a day when the machine wallet runs low on gas; the number rides in stats for the status page
+    let gasEth = '0', gasLow = false;
+    try {
+        const gas = await pub.getBalance({ address: me });
+        gasEth = Number(formatUnits(gas, 18)).toFixed(4);
+        gasLow = gas < parseUnits(String(cfg.lowGasEth), 18);
+        if (gasLow) {
+            const l = readLedger();
+            const last = l.meta?.lowGasAlertAt ? new Date(l.meta.lowGasAlertAt).getTime() : 0;
+            console.log(`[press] gas low: ${gasEth} eth in the machine wallet (floor ${cfg.lowGasEth})`);
+            if (Date.now() - last > 86_400_000 && !cfg.dry) {
+                l.meta = { ...(l.meta ?? {}), lowGasAlertAt: new Date().toISOString() };
+                writeLedger(l);
+                await postCard('', [`${cfg.emoji} gas is low`, `the machine wallet holds ${gasEth} eth. a few more ticks and it cannot burn.`, `send a little eth to ${me.slice(0, 6)}…${me.slice(-4)}.`]);
+            }
+        }
+    }
+    catch (e) {
+        console.log(`[press] gas check skipped: ${e.shortMessage || e.message}`);
+    }
     // 0b. The recipient watch, then the claim block.
     const watch = await watchRecipient(s, me);
     const mine = same(s.recipient, me);
@@ -425,7 +474,7 @@ async function pressOnce(runAt, commit) {
             }
         }
     }
-    const watched = () => ({ ...common(), feeRecipient: watch.feeRecipient, pendingRecipient: watch.pendingRecipient, unswept: unsweptOut, escrowOwed: escrowOut, claimFloor: cfg.claimFloor });
+    const watched = () => ({ ...common(), feeRecipient: watch.feeRecipient, pendingRecipient: watch.pendingRecipient, unswept: unsweptOut, escrowOwed: escrowOut, claimFloor: cfg.claimFloor, gasEth, gasLow });
     // 2. The float. Everything the wallet holds is pressed; held-back ops
     //    slices from earlier presses roll in naturally. A native pair keeps its gas money.
     let floatBal = await pairBal(me);

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "clockwork-press",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "private": false,
   "type": "module",
-  "description": "your fees, on a clock, with receipts. the fee machine for tokens on robinhood chain.",
+  "description": "your fees, on a clock, with receipts. ClockWorks, the fee machine for tokens on robinhood chain.",
   "license": "SEE LICENSE IN LICENSE",
   "repository": {
     "type": "git",

package/skills/clockwork/SKILL.md

@@ -1,11 +1,11 @@
 ---
 name: clockwork
-description: Set up and run a Clockwork machine for a pons v2 token on Robinhood Chain. Use when a founder asks to automate their creator fees, buy back and burn, build a treasury, or "run Clockwork" for their token. Walks the human through the machine wallet, the config, the repository, the secrets, the dry run, pointing fees at the machine, and going live. Never touches a private key.
+description: Set up and run a ClockWorks machine for a pons v2 token on Robinhood Chain. Use when a founder asks to automate their creator fees, buy back and burn, build a treasury, or "run ClockWorks" for their token. Walks the human through the machine wallet, the config, the repository, the secrets, the dry run, pointing fees at the machine, and going live. Never touches a private key.
 ---
 
-# Clockwork, with an assistant next to you
+# ClockWorks, with an assistant next to you
 
-Clockwork runs a token's creator fees on a clock: claims from the pons fee escrow, splits by percentages the
+ClockWorks runs a token's creator fees on a clock: claims from the pons fee escrow, splits by percentages the
 founder sets once, buys the token back and burns it in slices, sends the treasury share to a wallet that only
 grows, and prints every hash. It runs in the founder's own GitHub repository on a wallet the founder created.
 Docs: https://gmerald.xyz/clockwork/docs/
@@ -23,15 +23,16 @@ Docs: https://gmerald.xyz/clockwork/docs/
 1. The token address (a pons v2 launch on Robinhood Chain, chain id 4663).
 2. A fresh machine wallet address, created on their device, with about 0.02 ETH on Robinhood Chain.
 3. A treasury wallet address (a cold wallet is best).
-4. The split they want. Default: 45 burn / 45 treasury / 0 ops / 10 Clockwork. The Clockwork share is at
+4. The split they want. Default: 45 burn / 45 treasury / 0 ops / 10 ClockWorks. The ClockWorks share is at
    least 10 and is what pays for the software.
 5. The pace: gentle (a claim over a day), steady (over six hours, the default), or once (one slice).
-6. Telegram: their own bot token set as a secret (they create the bot in @BotFather), or off for now.
-7. How often to claim: `claim.floor` is how much of the pairing asset must be waiting in the escrow before the machine claims (default 5), and `claim.atLeastEveryHours` claims whatever waits at least that often (default 24). A claim costs gas and posts a card; most machines keep the defaults.
+6. Telegram: their own bot token set as a secret (they create the bot in @BotFather) and the group's chat id from `clockwork tgcheck`, or `telegram.mode` set to `off` for now. The config defaults to `own`; with no token set, the machine logs and posts nothing.
+7. The brand: `brand.name`, the words for treasury and burn (`brand.treasuryWord`, `brand.burnWord`, `brand.claimWord`), `brand.avatar` (an image URL the status page and the wallet card use), and `brand.art` (one image or short mp4 URL per Telegram card).
+8. How often to claim: `claim.floor` is how much of the pairing asset must be waiting in the escrow before the machine claims (default 5), and `claim.atLeastEveryHours` claims whatever waits at least that often (default 24). A claim costs gas and posts a card; most machines keep the defaults.
 
 ## The steps
 1. **Write the config.** In a terminal with Node 20 or newer, in an empty folder:
-   `npx --yes clockwork-press@0.2.0 init <token address>`
+   `npx --yes clockwork-press@0.2.1 init <token address>`
    It reads the launch from the pons factory and writes `clockwork.json`. Fill `wallets.machine`,
    `wallets.treasury`, the `split`, and `slices.rule` (`{ "kind": "pace", "pace": "steady" }`). If they want
    Telegram, set `telegram.mode` to `own` and `telegram.chatId` to their group id. Do not put a key or a token
@@ -47,7 +48,7 @@ Docs: https://gmerald.xyz/clockwork/docs/
    the float, and `dry: would swap …`. The machine refuses to run if the key belongs to a different wallet
    than `wallets.machine`; that is the guard working, not a bug.
 5. **Point the fees at the machine.** First claim what is already owed to the current recipient
-   (`npx --yes clockwork-press@0.2.0 claimcheck` from the folder with `clockwork.json` prints it), because a
+   (`npx --yes clockwork-press@0.2.1 claimcheck` from the folder with `clockwork.json` prints it), because a
    recipient change does not move credited balances. Then the current recipient signs
    `transferCreatorFeeRecipient(token, machineWallet)` on the pons factory
    `0x7eD598BcEf8bd9Edd8C97A195C6d13f40801EC7e`. Prepare the calldata for them (function selector
@@ -76,6 +77,6 @@ Docs: https://gmerald.xyz/clockwork/docs/
 `claimcheck` what the escrow holds and what is unswept · `doctor` RPC, wallet, gas, recipient, Telegram ·
 `handback <address>` claim what is credited, then move the fee recipient · `holders` the holder count.
 
-## What Clockwork costs
-Ten percent of every claim, sent on chain by the machine, slice by slice, to the Clockwork wallet pinned in
+## What ClockWorks costs
+Ten percent of every claim, sent on chain by the machine, slice by slice, to the ClockWorks wallet pinned in
 the package (`0x6EA62Bd07FE08C7491543d495B42F6dA7ad298D0`). No setup fee. The chain is the invoice.