@buildaureon/sdk 0.1.1 → 0.1.7

package/examples/portfolio-watch/main.ts

@@ -0,0 +1,84 @@
+/**
+ * @fileoverview demo — portfolio watch while away (agent-in-host).
+ *
+ * Env:
+ *   AUREON_API_KEY  issued developer key (required)
+ *   AUREON_API_URL  optional (default https://api.aureonlabs.network)
+ *
+ *   pnpm example:portfolio-watch
+ */
+
+import {
+  createAureonClient,
+  DEFAULT_API_BASE_URL,
+  formatWeight,
+  isAureonError,
+  type PortfolioWatchFlow,
+} from "../../src/index.js";
+
+function printFlow(flow: PortfolioWatchFlow): void {
+  console.log("\n=== AUREON — Watch while away (Cursor / Claude + MCP) ===\n");
+
+  console.log(`User brief: "${flow.userBrief}"`);
+  console.log(`Agent host: ${flow.host}\n`);
+
+  console.log("1. Register watch — intent → Automatic objective");
+  console.log(`   Objective:  ${flow.phases.register.objectiveName}`);
+  console.log(`   Mode:       ${flow.phases.register.automationMode}`);
+  console.log(`   Policy:     ${flow.phases.register.policySummary}`);
+  console.log(
+    `   Health:     ${flow.phases.register.health.state} — ${formatWeight(flow.phases.register.health.currentMetric ?? 0)} vs ${formatWeight(flow.phases.register.health.targetMetric ?? 0.2)} target`
+  );
+
+  if (flow.phases.whileAway) {
+    console.log("\n2. While away — market moved, Automatic mode acted");
+    console.log(
+      `   Event:      ${flow.phases.whileAway.marketEventName} (${flow.phases.whileAway.symbol} ${(flow.phases.whileAway.priceChangeRatio * 100).toFixed(0)}%)`
+    );
+    console.log(
+      `   Health:     ${flow.phases.whileAway.healthBefore.state} → ${flow.phases.whileAway.healthAfter.state}`
+    );
+    console.log(
+      `   Auto restore: ${flow.phases.whileAway.autoRestored ? "yes" : "no"}`
+    );
+    if (flow.phases.whileAway.receipt) {
+      console.log(
+        `   Receipt:    ${flow.phases.whileAway.receipt.settlement} — ${flow.phases.whileAway.receipt.id}`
+      );
+    }
+  }
+
+  console.log("\n3. Return briefing — what to tell the user");
+  for (const line of flow.phases.briefing.summaryLines) {
+    console.log(`   • ${line}`);
+  }
+
+  console.log(`\n${flow.message}`);
+  console.log(
+    "\nYou don't hand the agent a blank check — you register a rule, then read the briefing when you're back.\n"
+  );
+}
+
+async function main(): Promise<void> {
+  const apiKey = process.env.AUREON_API_KEY?.trim();
+  if (!apiKey) {
+    throw new Error("Set AUREON_API_KEY to an issued developer key.");
+  }
+
+  const aureon = createAureonClient({
+    baseUrl: process.env.AUREON_API_URL?.trim() || DEFAULT_API_BASE_URL,
+    apiKey,
+  });
+
+  const flow = await aureon.runPortfolioWatchDemo({ host: "cursor" });
+  printFlow(flow);
+}
+
+main().catch((error) => {
+  if (isAureonError(error)) {
+    console.error(`${error.code}: ${error.message}`);
+  } else {
+    console.error(error);
+  }
+  process.exitCode = 1;
+});

package/examples/quickstart/main.ts

@@ -1,72 +1,72 @@
-/**
- * @fileoverview Quickstart — control-plane calls with an issued developer API key.
- *
- * Env (required for integrators — nothing else):
- *   AUREON_API_KEY  issued key from https://app.aureonlabs.network → Developers
- *   AUREON_API_URL  optional (default https://api.aureonlabs.network)
- *
- *   pnpm --filter @buildaureon/sdk example:quickstart
- */
-
-import {
-  createAureonClient,
-  DEFAULT_API_BASE_URL,
-  formatWeight,
-  isAureonError,
-} from "../../src/index.js";
-
-async function main(): Promise<void> {
-  const apiKey = process.env.AUREON_API_KEY?.trim();
-  if (!apiKey) {
-    throw new Error(
-      "Set AUREON_API_KEY to an issued developer key from the AUREON Developers page."
-    );
-  }
-
-  const aureon = createAureonClient({
-    baseUrl: process.env.AUREON_API_URL?.trim() || DEFAULT_API_BASE_URL,
-    apiKey,
-  });
-
-  const ping = await aureon.ping();
-  console.log("connected", ping);
-
-  const me = await aureon.me();
-  console.log("wallet", me.walletAddress);
-
-  const synced = await aureon.syncPortfolio();
-  console.log("synced", {
-    chainId: synced.chainId,
-    positions: synced.portfolio.positions.length,
-    stableWeight: formatWeight(synced.portfolio.stableWeight),
-  });
-
-  const vault = await aureon.getVaultStatus();
-  console.log("vault", {
-    empty: vault.empty,
-    canRestore: vault.canRestore,
-    totalNotionalUsd: vault.totalNotionalUsd,
-  });
-
-  const objectives = await aureon.listObjectives();
-  console.log(
-    "objectives",
-    objectives.map((o) => ({
-      name: o.name,
-      automationMode: o.automationMode,
-    }))
-  );
-
-  console.log(
-    "hint: private key is only needed later to broadcast prepare-deposit / prepare-withdraw steps"
-  );
-}
-
-main().catch((error) => {
-  if (isAureonError(error)) {
-    console.error(`${error.code}: ${error.message}`);
-  } else {
-    console.error(error instanceof Error ? error.message : error);
-  }
-  process.exitCode = 1;
-});
+/**
+ * @fileoverview Quickstart — control-plane calls with an issued developer API key.
+ *
+ * Env (required for integrators — nothing else):
+ *   AUREON_API_KEY  issued key from https://app.aureonlabs.network → Developers
+ *   AUREON_API_URL  optional (default https://api.aureonlabs.network)
+ *
+ *   pnpm --filter @buildaureon/sdk example:quickstart
+ */
+
+import {
+  createAureonClient,
+  DEFAULT_API_BASE_URL,
+  formatWeight,
+  isAureonError,
+} from "../../src/index.js";
+
+async function main(): Promise<void> {
+  const apiKey = process.env.AUREON_API_KEY?.trim();
+  if (!apiKey) {
+    throw new Error(
+      "Set AUREON_API_KEY to an issued developer key from the AUREON Developers page."
+    );
+  }
+
+  const aureon = createAureonClient({
+    baseUrl: process.env.AUREON_API_URL?.trim() || DEFAULT_API_BASE_URL,
+    apiKey,
+  });
+
+  const ping = await aureon.ping();
+  console.log("connected", ping);
+
+  const me = await aureon.me();
+  console.log("wallet", me.walletAddress);
+
+  const synced = await aureon.syncPortfolio();
+  console.log("synced", {
+    chainId: synced.chainId,
+    positions: synced.portfolio.positions.length,
+    stableWeight: formatWeight(synced.portfolio.stableWeight),
+  });
+
+  const vault = await aureon.getVaultStatus();
+  console.log("vault", {
+    empty: vault.empty,
+    canRestore: vault.canRestore,
+    totalNotionalUsd: vault.totalNotionalUsd,
+  });
+
+  const objectives = await aureon.listObjectives();
+  console.log(
+    "objectives",
+    objectives.map((o) => ({
+      name: o.name,
+      automationMode: o.automationMode,
+    }))
+  );
+
+  console.log(
+    "hint: private key is only needed later to broadcast prepare-deposit / prepare-withdraw steps"
+  );
+}
+
+main().catch((error) => {
+  if (isAureonError(error)) {
+    console.error(`${error.code}: ${error.message}`);
+  } else {
+    console.error(error instanceof Error ? error.message : error);
+  }
+  process.exitCode = 1;
+});

package/examples/receipt-verification/main.ts

@@ -0,0 +1,87 @@
+/**
+ * @fileoverview receipt → verification.
+ *
+ * Shows claim vs validation vs settlement proof after a restore.
+ *
+ * Env:
+ *   AUREON_API_KEY  issued developer key (required)
+ *   AUREON_API_URL  optional (default https://api.aureonlabs.network)
+ *
+ *   pnpm example:receipt-verification
+ */
+
+import {
+  createAureonClient,
+  DEFAULT_API_BASE_URL,
+  isAureonError,
+  type ReceiptVerificationFlow,
+} from "../../src/index.js";
+
+function printFlow(flow: ReceiptVerificationFlow): void {
+  console.log("\n=== AUREON — Receipt → verification ===\n");
+
+  console.log("1. Claim — what the API/agent would call 'success'");
+  console.log(`   Status:     ${flow.phases.claimed.status}`);
+  console.log(`   Result:     ${flow.phases.claimed.result}`);
+  console.log(`   Settlement: ${flow.phases.claimed.settlement}`);
+  console.log(`   Summary:    ${flow.phases.claimed.summary}\n`);
+
+  console.log("2. Validate — local honesty check (schema + settlement rules)");
+  console.log(`   Valid:      ${flow.phases.validation.valid}`);
+  if (!flow.phases.validation.valid) {
+    for (const issue of flow.phases.validation.issues) {
+      console.log(`   - ${issue.code}: ${issue.message}`);
+    }
+  }
+  console.log(`   Proof tier: ${flow.proofTier}\n`);
+
+  console.log("3. Verify — independent settlement lookup (vault only)");
+  const settlement = flow.phases.settlement;
+  if (settlement) {
+    console.log(`   On-chain:   ${settlement.verifiedOnChain ? "yes" : "no"}`);
+    if (settlement.settlement) {
+      console.log(`   Block:      ${settlement.settlement.blockNumber}`);
+      console.log(`   Explorer:   ${settlement.settlement.explorerUrl}`);
+    } else {
+      console.log("   Record:     (none yet — vault submitted but not observed)");
+    }
+  } else if (flow.receipt.settlement === "staged") {
+    console.log("   Staged receipt — schema-valid, not chain-verified by design.");
+  } else {
+    console.log("   Settlement lookup unavailable for this receipt.");
+  }
+
+  const timelineCount = flow.phases.timelineEvents?.length ?? 0;
+  if (timelineCount > 0) {
+    console.log(`\n   Timeline:   ${timelineCount} linked event(s)`);
+  }
+
+  console.log(`\n${flow.message}`);
+  console.log(
+    "\nSuccess text is a claim. Validation and settlement records are how you verify it.\n"
+  );
+}
+
+async function main(): Promise<void> {
+  const apiKey = process.env.AUREON_API_KEY?.trim();
+  if (!apiKey) {
+    throw new Error("Set AUREON_API_KEY to an issued developer key.");
+  }
+
+  const aureon = createAureonClient({
+    baseUrl: process.env.AUREON_API_URL?.trim() || DEFAULT_API_BASE_URL,
+    apiKey,
+  });
+
+  const flow = await aureon.runReceiptVerificationDemo();
+  printFlow(flow);
+}
+
+main().catch((error) => {
+  if (isAureonError(error)) {
+    console.error(`${error.code}: ${error.message}`);
+  } else {
+    console.error(error);
+  }
+  process.exitCode = 1;
+});

package/examples/registry-register/main.ts

@@ -0,0 +1,44 @@
+/**
+ * Phase 2 — prepare on-chain objective registration (wallet signs broadcast).
+ *
+ * Usage:
+ *   AUREON_API_KEY=aur_... npx tsx examples/registry-register/main.ts
+ */
+import { createAureonClient } from "../../src/client/factory.js";
+
+async function main() {
+  const apiKey = process.env.AUREON_API_KEY?.trim();
+  if (!apiKey) {
+    console.error("Set AUREON_API_KEY");
+    process.exit(1);
+  }
+
+  const client = createAureonClient({ apiKey });
+  const status = await client.getRegistryStatus();
+  console.log("registry status", status);
+
+  const { objectives } = await client.listObjectives();
+  const target = objectives[0];
+  if (!target) {
+    console.error("Create an objective first");
+    process.exit(1);
+  }
+
+  const lookup = await client.getObjectiveRegistry(target.id);
+  if (lookup.registered) {
+    console.log("already registered", lookup.record);
+    return;
+  }
+
+  const prepared = await client.prepareObjectiveRegistry(target.id);
+  console.log("Sign and broadcast this tx from your wallet:");
+  console.log(JSON.stringify(prepared, null, 2));
+  console.log(
+    "Then: client.confirmObjectiveRegistry(objectiveId, transactionHash)"
+  );
+}
+
+main().catch((err) => {
+  console.error(err);
+  process.exit(1);
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@buildaureon/sdk",
-  "version": "0.1.1",
+  "version": "0.1.7",
   "description": "Official TypeScript SDK for AUREON Financial Compass on Robinhood Chain",
   "type": "module",
   "main": "./dist/index.js",
@@ -29,6 +29,13 @@
     "bench": "tsx benchmarks/client-throughput.ts",
     "example:quickstart": "tsx examples/quickstart/main.ts",
     "example:market": "tsx examples/market-event/main.ts",
+    "example:green-vs-plan": "tsx examples/green-vs-plan/main.ts",
+    "example:ai-to-objective-to-portfolio": "tsx examples/ai-to-objective-to-portfolio/main.ts",
+    "example:drift-detect-restore": "tsx examples/drift-detect-restore/main.ts",
+    "example:receipt-verification": "tsx examples/receipt-verification/main.ts",
+    "example:portfolio-watch": "tsx examples/portfolio-watch/main.ts",
+    "example:full-aureon-loop": "tsx examples/full-aureon-loop/main.ts",
+    "example:audit-trail": "tsx examples/audit-trail/main.ts",
     "example:sdk-demo-terminal": "tsx examples/sdk-demo-terminal/main.ts",
     "example:e2e": "tsx examples/e2e-vault-flow/main.ts",
     "example:e2e-policy": "tsx examples/e2e-policy-rebalance/main.ts",