@boostxyz/cli 1.1.0-alpha.34

package/README.md

@@ -0,0 +1,162 @@
+# `@boostxyz/cli`
+
+A command line interface simplifying Boost protocol deployment, and Boost creation.
+
+- [Features](#features)
+- [Installation](#installation)
+  - [Via Package Manager](#via-package-manager)
+  - [Manual Installation](#manual-installation)
+- [Usage](#usage)
+- [Options](#options)
+- [Contributing](#contributing)
+  - [Development Setup](#development-setup)
+
+## Features
+
+- Deploy Boost Protocol and register all valid base implementations
+- Deploy and fund basic ERC20's to use with Boost budgets and incentives
+- Generate Boost creation templates
+- Create Boosts given JSON templates, with option to automatically mint and allocate funds to new or existing budgets
+- Configurable, supports any Viem chain
+- Secure, keys do not leave your machine
+
+## Installation
+
+### Via Package Manager
+
+```bash
+# npm
+npm install -g @boostxyz/cli
+npx boost --help
+```
+
+### Manual Installation
+
+```bash
+git clone https://github.com/boostxyz/boost-protocol.git
+cd boost-protocol
+pnpm install
+turbo build --filter="./packages/cli"
+npx boost seed generate
+```
+
+## Usage
+
+Basic usage pattern:
+
+```bash
+# see the detailed help documentation
+boost --help
+
+# deploy the Boost Protocol to a local hardhat instance
+boost deploy --privateKey="0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80" --chain="hardhat"
+
+# generate a json template that can be used with `boost seed`
+# if privateKey or mnemonic is supplied, your 0 address will be slotted into the requisite owner locations
+boost seed generate --privateKey="0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80" --chain="hardhat"
+
+# create boosts
+boost seed PATH/TO/seed.json PATH/TO/another.json --privateKey="0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80" --chain="hardhat"
+
+# deploy new erc20's that can be used with boosts and budgets
+boost seed erc20 --privateKey="0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80" --chain="hardhat"
+```
+
+## Options
+
+| Option | Alias | Description | Default |
+|--------|-------|-------------|---------|
+| `--help` | `-h` | Show documentation | - |
+| `--version` | `-v` | Show the current version number | - |
+| `--chain` | - | Target a specific viem chain, ie hardhat, anvil, sepolia, base, etc. See https://github.com/wevm/viem/tree/main/src/chains/definitions for a list of valid names | - |
+| `--privateKey` | - | Private key to derive account from to use for contract operations, see https://viem.sh/docs/accounts/local/privateKeyToAccount#generating-private-keys for more information | - |
+| `--mnemonic` | - | Mnemonic to derive account from to use for contract operations, see https://viem.sh/docs/accounts/local/mnemonicToAccount#generating-private-keys for more information | - |
+| `--rpcUrl` | - | Optional URL to provide to Viem http transport, will typically be specific to targeted chain | - |
+| `--out` | - | Filepath to write result of command. Can be useful if used with `--format="env"` to write to a .env file | - |
+| `--format` | - | Specify command output format, either env or json | env |
+
+## Seeding
+
+Here is an example seed template.
+
+### Tips
+- By default the owner, will be `test...junk`'s 0 account unless `--privateKey` or `--mnemonic` is provided.
+- For `action` `signatures`, While you generally need to manually supply the byte selector, you have the option of supplying a plain english signature, which will be converted into the bytes selector for you when passed into the `seed` command.
+- If you supply a `"shouldMintAndAllocate": true` to an ERC20 incentive, the seed command will automatically call `mint` on the referenced asset with the total amount required to allocate and fund the Boosts's budget, so make sure the `privateKey` or `mnemonic` option is correctly supplied to make this call.
+
+```json
+{
+  "protocolFee": 0,
+  "maxParticipants": 10,
+  "budget": {
+    "type": "ManagedBudget",
+    "owner": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266",
+    "authorized": [
+      "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266"
+    ],
+    "roles": [
+      1
+    ]
+  },
+  "action": {
+    "type": "EventAction",
+    "actionClaimant": {
+      "signatureType": 1,
+      "signature": "function mint(address to, uint256 amount)", // This will be converted into a bytes selector for you
+      "fieldIndex": 0,
+      "targetContract": "0x0000000000000000000000000000000000000000",
+      "chainid": 31337
+    },
+    "actionSteps": [
+      {
+        "signature": "event Minted(address to, uint256 amount)",
+        "signatureType": 1,
+        "actionType": 0,
+        "targetContract": "0x0000000000000000000000000000000000000000",
+        "chainid": 31337,
+        "actionParameter": {
+          "filterType": 0,
+          "fieldType": 1,
+          "fieldIndex": 0,
+          "filterData": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266"
+        }
+      }
+    ]
+  },
+  "validator": {
+    "type": "SignerValidator",
+    "signers": [
+      "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266"
+    ],
+    "validatorCaller": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266"
+  },
+  "allowList": {
+    "type": "SimpleDenyList",
+    "owner": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266",
+    "denied": []
+  },
+  "incentives": [
+    {
+      "type": "ERC20Incentive",
+      "asset": "0xf3B2d0E4f2d8F453DBCc278b10e88b20d7f19f8D", // By default, this is STAGING https://sepolia.etherscan.io/token/0xf3B2d0E4f2d8F453DBCc278b10e88b20d7f19f8D
+      "shouldMintAndAllocate": true, // if set to true, will call `mint` on the referenced asset with the total amount required to fund this Boosts's budget.
+      "strategy": 0,
+      "reward": 1,
+      "limit": 1,
+      "manager": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266"
+    }
+  ]
+}
+```
+
+## Contributing
+
+Contributions are welcome! Please read our [Contributing Guide](../../.github/CONTRIBUTING.md) for details on our code of conduct and the process for submitting pull requests.
+
+### Development Setup
+
+```bash
+git clone https://github.com/boostxyz/boost-protocol.git
+cd boost-protocol
+pnpm install
+```

package/dist/cli.cjs

@@ -0,0 +1,27 @@
+#!/usr/bin/env node
+"use strict";const c=require("node:fs/promises"),s=require("node:path"),w=require("/home/runner/work/boost-protocol/boost-protocol/node_modules/.pnpm/arg@5.0.2/node_modules/arg/index.js"),d=require("./index.cjs"),a=require("./utils-DX4pZJ98.cjs"),b="2.0.0-alpha.33",S="1.1.0-alpha.34",h=`
+Deploy Boost Protocol V2, and retrieve base implementation addresses.
+
+Usage: boost <COMMAND>
+
+Commands:
+  deploy                  Deploy a new version of the protocol
+  seed generate           Generate a new basic Boost seed
+  seed erc20              Deploys a new ERC20
+  seed seed.json [...]    Create Boosts using JSON configuration files generable by \`seed generate\`. 
+                          You can pass as many file paths as needed, and each will be validated before any operations occur.
+                          Budgets can be automatically funded based on the incentives configuration, using accounts derived from a configured private key or mnemonic.
+
+Options:
+  -h, --help     Print help
+  -v, --version  Print version
+
+  --chain        Viem chain name, see https://github.com/wevm/viem/tree/main/src/chains/definitions for a list of valid names
+  --privateKey   Private key to derive account from to use for contract operations, see https://viem.sh/docs/accounts/local/privateKeyToAccount#generating-private-keys for more information
+  --mnemonic     Mnemonic to derive account from to use for contract operations, see https://viem.sh/docs/accounts/local/mnemonicToAccount#generating-private-keys for more information
+  --rpcUrl       Optional URL to provide to Viem http transport
+  --out          Path to file to output command results
+  --cacheDir     Path to artifact cache directory
+  --force        Bypass cache for given command and configuration, re-running any tasks and re-generating cache artifacts
+  --format       Specify command output format, either env or json
+`;BigInt.prototype.toJSON=function(){return Number(this)};const l=w({"--help":Boolean,"--version":Boolean,"--chain":String,"--privateKey":String,"--mnemonic":String,"--rpcUrl":String,"--out":String,"--cacheDir":String,"--force":Boolean,"--format":String,"--from":String,"-h":"--help","-v":"--version"});async function D(){var u,f,p;const{_:r,...o}=l,i=r.at(0);if(l["--version"])return console.log(S),0;if(l["--help"])return console.log(h),0;if(!i||!d.commands[i])return console.log(h),127;const e={help:o["--help"],version:o["--version"],chain:o["--chain"],privateKey:o["--privateKey"],mnemonic:o["--mnemonic"],rpcUrl:o["--rpcUrl"],out:o["--out"],cacheDir:o["--cacheDir"],force:o["--force"],format:o["--format"]};e.format||(e.format="env");const v=(u=e.cacheDir)!=null&&u.startsWith("./")?s.resolve(process.cwd(),e.cacheDir):e.cacheDir||s.resolve(process.cwd(),"./.boost"),g=`${r.join("-")}-v${b.split(".").slice(0,2).join("-")}-${e.chain}-${e!=null&&e.privateKey?(f=e.privateKey)==null?void 0:f.slice(e.privateKey.length-5):((p=e.mnemonic)==null?void 0:p.split(" ").at(-1))||""}`,y=s.resolve(v,g);async function m(){const n=await d.commands[i](r.slice(1),e);return i==="seed"&&r.includes("generate")&&(e.format="json"),e.format==="env"?a.objectToEnv(n):JSON.stringify(n,null,2)}let t;if(e.force)t=await m();else try{t=await c.readFile(y,{encoding:"utf-8"});const n=a.validateJson(t);e.format==="json"&&n===!1&&(t=JSON.stringify(a.envToObject(t),null,2)),e.format==="env"&&n!==!1&&(t=a.objectToEnv(n))}catch(n){if(n instanceof Error&&n.message.includes("ENOENT"))t=await m();else throw n}if(typeof t==null)throw new Error("No result found after cache and command operations. This shouldn't happen.");e.out?(await c.mkdir(e.out,{recursive:!0}),await c.writeFile(e.out,t,{encoding:"utf8"}),console.log(`Succesfully wrote result to ${e.out}`)):console.log(t)}D().then((r=0)=>process.exit(r)).catch(r=>{console.error(r),process.exit(1)});

package/dist/cli.js

@@ -0,0 +1,99 @@
+#!/usr/bin/env node
+import i from "node:fs/promises";
+import s from "node:path";
+import w from "/home/runner/work/boost-protocol/boost-protocol/node_modules/.pnpm/arg@5.0.2/node_modules/arg/index.js";
+import { commands as u } from "./index.js";
+import { v as b, e as S, o as h } from "./utils-D0bdHF2y.js";
+const D = "2.0.0-alpha.33", B = "1.1.0-alpha.34", d = `
+Deploy Boost Protocol V2, and retrieve base implementation addresses.
+
+Usage: boost <COMMAND>
+
+Commands:
+  deploy                  Deploy a new version of the protocol
+  seed generate           Generate a new basic Boost seed
+  seed erc20              Deploys a new ERC20
+  seed seed.json [...]    Create Boosts using JSON configuration files generable by \`seed generate\`. 
+                          You can pass as many file paths as needed, and each will be validated before any operations occur.
+                          Budgets can be automatically funded based on the incentives configuration, using accounts derived from a configured private key or mnemonic.
+
+Options:
+  -h, --help     Print help
+  -v, --version  Print version
+
+  --chain        Viem chain name, see https://github.com/wevm/viem/tree/main/src/chains/definitions for a list of valid names
+  --privateKey   Private key to derive account from to use for contract operations, see https://viem.sh/docs/accounts/local/privateKeyToAccount#generating-private-keys for more information
+  --mnemonic     Mnemonic to derive account from to use for contract operations, see https://viem.sh/docs/accounts/local/mnemonicToAccount#generating-private-keys for more information
+  --rpcUrl       Optional URL to provide to Viem http transport
+  --out          Path to file to output command results
+  --cacheDir     Path to artifact cache directory
+  --force        Bypass cache for given command and configuration, re-running any tasks and re-generating cache artifacts
+  --format       Specify command output format, either env or json
+`;
+BigInt.prototype.toJSON = function() {
+  return Number(this);
+};
+const c = w({
+  "--help": Boolean,
+  "--version": Boolean,
+  "--chain": String,
+  "--privateKey": String,
+  "--mnemonic": String,
+  "--rpcUrl": String,
+  "--out": String,
+  "--cacheDir": String,
+  "--force": Boolean,
+  "--format": String,
+  "--from": String,
+  "-h": "--help",
+  "-v": "--version"
+});
+async function K() {
+  var m, f, p;
+  const { _: r, ...o } = c, a = r.at(0);
+  if (c["--version"])
+    return console.log(B), 0;
+  if (c["--help"])
+    return console.log(d), 0;
+  if (!a || !u[a])
+    return console.log(d), 127;
+  const e = {
+    help: o["--help"],
+    version: o["--version"],
+    chain: o["--chain"],
+    privateKey: o["--privateKey"],
+    mnemonic: o["--mnemonic"],
+    rpcUrl: o["--rpcUrl"],
+    out: o["--out"],
+    cacheDir: o["--cacheDir"],
+    force: o["--force"],
+    format: o["--format"]
+  };
+  e.format || (e.format = "env");
+  const v = (m = e.cacheDir) != null && m.startsWith("./") ? s.resolve(process.cwd(), e.cacheDir) : e.cacheDir || s.resolve(process.cwd(), "./.boost"), g = `${r.join("-")}-v${D.split(".").slice(0, 2).join("-")}-${e.chain}-${e != null && e.privateKey ? (f = e.privateKey) == null ? void 0 : f.slice(e.privateKey.length - 5) : ((p = e.mnemonic) == null ? void 0 : p.split(" ").at(-1)) || ""}`, y = s.resolve(v, g);
+  async function l() {
+    const n = await u[a](r.slice(1), e);
+    return a === "seed" && r.includes("generate") && (e.format = "json"), e.format === "env" ? h(n) : JSON.stringify(n, null, 2);
+  }
+  let t;
+  if (e.force)
+    t = await l();
+  else
+    try {
+      t = await i.readFile(y, { encoding: "utf-8" });
+      const n = b(t);
+      e.format === "json" && n === !1 && (t = JSON.stringify(S(t), null, 2)), e.format === "env" && n !== !1 && (t = h(n));
+    } catch (n) {
+      if (n instanceof Error && n.message.includes("ENOENT"))
+        t = await l();
+      else throw n;
+    }
+  if (typeof t == null)
+    throw new Error(
+      "No result found after cache and command operations. This shouldn't happen."
+    );
+  e.out ? (await i.mkdir(e.out, { recursive: !0 }), await i.writeFile(e.out, t, { encoding: "utf8" }), console.log(`Succesfully wrote result to ${e.out}`)) : console.log(t);
+}
+K().then((r = 0) => process.exit(r)).catch((r) => {
+  console.error(r), process.exit(1);
+});