rewrite and publish cli (#78)

* rewrite and publish cli

* pkg

* fix ci

* fix task

* restore cargo workflow

.github/workflows/ci.yaml → .github/workflows/cargo.yml

@@ -1,4 +1,4 @@
-name: Tests
+name: Cargo
 
 on:
   workflow_dispatch:

.github/workflows/cli.yml

@@ -0,0 +1,10 @@
+name: CI
+on: [push]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+      - run: cd cli && npm ci
+      - run: cd cli && npm test

cli/README.md

@@ -2,15 +2,49 @@
 
 ## Authentication
 
-Get a token from https://auth.node.glif.io/, then  pass `GLIF_TOKEN=...` with
+Get a token from https://auth.node.glif.io/, then pass `GLIF_TOKEN=...` with
 every CLI invocation.
 
 ## Ledger
 
 Keep your HW ledger device connected and unlocked on the Ethereum app.
 
-## Example
+## Installation
 
 ```bash
-GLIF_TOKEN=abc node bin/current-round-index.js
+$ npm install --global @meridian-ie/cli
+```
+
+## API
+
+```bash
+$ meridian --help
+meridian <command>
+
+Commands:
+  meridian current-round-index              Get the current round index
+  meridian list-transfers                   List transfers from last 100 blocks
+  meridian                                  Watch the participant count
+  participant-count-scheduled-for-transfer  scheduled for transfer
+  meridian ready-for-transfer               List participants ready for transfer
+  meridian release-rewards                  Release rewards
+  meridian rewards-scheduled-for            Get rewards scheduled for a
+  <participant>                             participant
+  meridian round-reward                     Get the current round reward
+  meridian scheduled-for-transfer           Get all participants scheduled for
+                                            transfer
+  meridian set-min-balance-for-transfer     Set the minimum balance for transfer
+  <minBalance>
+  meridian set-next-round-length <blocks>   Set the next round length
+  meridian set-round-reward <reward>        Set the round reward
+  meridian tick                             Trigger a tick
+
+Options:
+  -a, --address     Contract address (or $MERIDIAN_ADDRESS)  [string] [required]
+  -g, --glif-token  GLIF token (or $MERIDIAN_GLIF_TOKEN)     [string] [required]
+  -v, --version     Show version number                                [boolean]
+  -h, --help        Show help                                          [boolean]
+
+Examples:
+  $ meridian current-round-index  Get the current round index
 ```

cli/bin/meridian.js

@@ -0,0 +1,130 @@
+#!/usr/bin/env node
+
+import yargs from 'yargs/yargs'
+import { hideBin } from 'yargs/helpers'
+import fs from 'node:fs/promises'
+import { fileURLToPath } from 'node:url'
+
+import { currentRoundIndex } from '../commands/current-round-index.js'
+import { listTransfers } from '../commands/list-transfers.js'
+import {
+  participantCountScheduledForTransfer
+} from '../commands/participant-count-scheduled-for-transfer.js'
+import { readyForTransfer } from '../commands/ready-for-transfer.js'
+import { releaseRewards } from '../commands/release-rewards.js'
+import { rewardsScheduledFor } from '../commands/rewards-scheduled-for.js'
+import { roundReward } from '../commands/round-reward.js'
+import { scheduledForTransfer } from '../commands/scheduled-for-transfer.js'
+import {
+  setMinBalanceForTransfer
+} from '../commands/set-min-balance-for-transfer.js'
+import { setNextRoundLength } from '../commands/set-next-round-length.js'
+import { setRoundReward } from '../commands/set-round-reward.js'
+import { tick } from '../commands/tick.js'
+
+const pkg = JSON.parse(
+  await fs.readFile(
+    fileURLToPath(new URL('../package.json', import.meta.url)),
+    'utf8'
+  )
+)
+
+yargs(hideBin(process.argv))
+  .env('MERIDIAN')
+  .option('address', {
+    alias: 'a',
+    type: 'string',
+    description: 'Contract address (or $MERIDIAN_ADDRESS)'
+  })
+  .option('glif-token', {
+    alias: 'g',
+    type: 'string',
+    description: 'GLIF token (or $MERIDIAN_GLIF_TOKEN)'
+  })
+  .demandOption('address')
+  .demandOption('glif-token')
+  .command(
+    'current-round-index',
+    'Get the current round index',
+    yargs => yargs,
+    currentRoundIndex
+  )
+  .command(
+    'list-transfers',
+    'List transfers from last 100 blocks',
+    yargs => yargs,
+    listTransfers
+  )
+  .command(
+    'participant-count-scheduled-for-transfer',
+    'Watch the participant count scheduled for transfer',
+    yargs => yargs.option('watch', {
+      alias: 'w',
+      type: 'boolean',
+      default: false
+    }),
+    participantCountScheduledForTransfer
+  )
+  .command(
+    'ready-for-transfer',
+    'List participants ready for transfer',
+    yargs => yargs,
+    readyForTransfer
+  )
+  .command(
+    'release-rewards',
+    'Release rewards',
+    yargs => yargs,
+    releaseRewards
+  )
+  .command(
+    'rewards-scheduled-for <participant>',
+    'Get rewards scheduled for a participant',
+    yargs => yargs.positional('participant', { type: 'string' }),
+    rewardsScheduledFor
+  )
+  .command(
+    'round-reward',
+    'Get the current round reward',
+    yargs => yargs,
+    roundReward
+  )
+  .command(
+    'scheduled-for-transfer',
+    'Get all participants scheduled for transfer',
+    yargs => yargs,
+    scheduledForTransfer
+  )
+  .command(
+    'set-min-balance-for-transfer <minBalance>',
+    'Set the minimum balance for transfer',
+    yargs => yargs.positional('minBalance', { type: 'string' }),
+    setMinBalanceForTransfer
+  )
+  .command(
+    'set-next-round-length <blocks>',
+    'Set the next round length',
+    yargs => yargs.positional('blocks', { type: 'number' }),
+    setNextRoundLength
+  )
+  .command(
+    'set-round-reward <reward>',
+    'Set the round reward',
+    yargs => yargs.positional('reward', { type: 'string' }),
+    setRoundReward
+  )
+  .command(
+    'tick',
+    'Trigger a tick',
+    yargs => yargs,
+    tick
+  )
+  .demandCommand()
+  .version(`${pkg.name}: ${pkg.version}`)
+  .alias('v', 'version')
+  .alias('h', 'help')
+  .example([
+    ['$ $0 current-round-index', 'Get the current round index']
+  ])
+  .help()
+  .parse()

cli/commands/current-round-index.js

@@ -0,0 +1,6 @@
+import { createContract } from '../index.js'
+
+export const currentRoundIndex = async opts => {
+  const { contract } = createContract(opts)
+  console.log((await contract.currentRoundIndex()).toString())
+}

cli/commands/list-transfers.js

@@ -0,0 +1,23 @@
+import { createContract } from '../index.js'
+import { formatEther } from 'ethers'
+
+export const listTransfers = async opts => {
+  const { contract } = await createContract(opts)
+  console.error('Warning: Only showing transfers from the last 100 blocks')
+  const events = await contract.queryFilter(contract.filters.Transfer, -100)
+  const keys = new Set()
+  let sum = 0n
+
+  for (const event of events) {
+    const [to, amount] = event.args
+    const { blockNumber } = event
+    const key = `${to}:${amount}:${blockNumber}`
+    if (!keys.has(key)) {
+      console.log(`- ${to}: ${formatEther(amount)}`)
+      keys.add(key)
+      sum += amount
+    }
+  }
+
+  console.log(`Total: ${formatEther(sum)} / ${sum} attoFIL`)
+}

cli/commands/participant-count-scheduled-for-transfer.js

@@ -0,0 +1,12 @@
+import { createContract } from '../index.js'
+import timers from 'node:timers/promises'
+
+export const participantCountScheduledForTransfer = async ({ watch, ...opts }) => {
+  const { contract } = await createContract(opts)
+  while (true) {
+    const transfersLeft = await contract.participantCountScheduledForTransfer()
+    console.log('Transfers left:', transfersLeft)
+    if (!watch) break
+    await timers.setTimeout(10_000)
+  }
+}

cli/commands/ready-for-transfer.js

@@ -0,0 +1,16 @@
+import { createContract } from '../index.js'
+import { formatEther } from 'ethers'
+
+export const readyForTransfer = async opts => {
+  const { contract } = await createContract(opts)
+  for (let i = 0; ; i++) {
+    try {
+      const address = await contract.readyForTransfer(i)
+      const amount = await contract.rewardsScheduledFor(address)
+      console.log(`${address} FIL ${formatEther(amount)}`)
+    } catch (err) {
+      break
+    }
+  }
+  process.exit()
+}