@fidesbuild/sub 0.2.0 → 0.2.1

package/README.md

@@ -2,6 +2,18 @@
 
 FIDES is a Transaction Builder for autonomous agents. SUB-FIDES is scoped agent-to-agent delegation: an agent working under a FIDES hands part of its authority to another agent, and the contract makes sure the child can never exceed the parent.
 
+## Get started
+
+The fastest way to try it is the guided tour, which includes SUB-FIDES:
+
+```bash
+npm install @fidesbuild/sdk viem
+npx @fidesbuild/sdk init
+npm run delegate
+```
+
+`npx @fidesbuild/sub` prints this guide. In your own code:
+
 ```bash
 npm install @fidesbuild/sub @fidesbuild/sdk viem
 ```

package/dist/guide.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/guide.js

@@ -0,0 +1,34 @@
+#!/usr/bin/env node
+// npx @fidesbuild/sub — what SUB-FIDES is, and the fastest way to try it.
+const say = (s = '') => console.log(s);
+say(`
+SUB-FIDES: agents hiring agents, inside limits none of them can break.
+
+An agent working under a FIDES hands another agent a slice of it: its own budget, contracts and expiry.
+The child can never go past its slice, everything it spends also counts against the parent, and the
+owner or the parent agent can revoke it at any time.
+
+Try it, guided, in one folder:
+
+  npm install @fidesbuild/sdk viem
+  npx @fidesbuild/sdk init
+  npm start                     the tour: sign, fund, then every example, including
+  npm run delegate              this agent hands a second agent a slice, and it spends inside it
+
+In your own code:
+
+  import { createSubClient, SubFidesKit, SubAgent } from "@fidesbuild/sub"
+
+  const client = createSubClient({ chainId: 4663, rpc })                       // V2 accounts, which can delegate
+  const sub = await SubFidesKit.sign(
+    SubFidesKit.create(parentFides, { agent: childAddress, spend: [{ asset: USDG, amount }], expiry }),
+    parentAgent, client, parentFides)
+  await SubFidesKit.register("https://api.fidesbuilder.xyz", parentFides, sub)  // the child finds it by address
+
+  const child = new SubAgent({ client, parent: parentFides, sub, agent: childKey, api: "https://api.fidesbuilder.xyz" })
+  await child.execute(await child.plan(actions))                               // no gas: the relayer pays
+
+Also in the app (tick "Allow this agent to hand out SUB-FIDES") and in Claude ("give 0x… 0.1 USDG for 30 minutes").
+Docs: https://fidesbuilder.xyz/docs/#/sub
+`);
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fidesbuild/sub",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "FIDES SUB-FIDES: scoped agent-to-agent delegation. An agent hands part of its FIDES to another agent, who can never exceed it.",
   "keywords": [
     "fides",
@@ -20,6 +20,9 @@
       "default": "./dist/index.js"
     }
   },
+  "bin": {
+    "fides-sub": "./dist/guide.js"
+  },
   "files": [
     "dist",
     "!dist/*.tsbuildinfo",