@buildaureon/sdk 0.1.0 → 0.1.1

package/examples/e2e-vault-flow/main.ts

@@ -1,20 +1,16 @@
 /**
- * @fileoverview Live SDK e2e against local AUREON API + Robinhood testnet vault.
+ * @fileoverview Live vault deposit/withdraw + Automatic objective against the AUREON API.
  *
- * Exercises: wallet auth → sync → vault prepare deposit/withdraw (signed) →
- * createObjective (Automatic) → restore plan.
+ * Env (integrators only — no local repo files):
+ *   AUREON_API_KEY            issued developer key (required)
+ *   AUREON_API_URL            optional (default https://api.aureonlabs.network)
+ *   AUREON_WALLET_PRIVATE_KEY 0x… key used to sign auth + broadcast vault txs (required)
+ *   AUREON_RPC_URL            optional (default Robinhood testnet RPC)
+ *   AUREON_CHAIN_ID           optional (default 46630)
  *
- * Env (loaded from backend/.env + .secrets automatically when unset):
- *   AUREON_API_URL   default http://127.0.0.1:8787
- *   AUREON_API_KEY   from backend/.env AUREON_API_KEYS (first key)
- *   AUREON_E2E_KEY   hex private key (defaults to vault-deployer.key)
- *
- *   pnpm --filter @buildaureon/sdk exec tsx examples/e2e-vault-flow/main.ts
+ *   pnpm --filter @buildaureon/sdk example:e2e
  */
 
-import { readFileSync, existsSync } from "node:fs";
-import { dirname, join } from "node:path";
-import { fileURLToPath } from "node:url";
 import {
   createPublicClient,
   createWalletClient,
@@ -25,48 +21,22 @@ import { privateKeyToAccount } from "viem/accounts";
 import {
   createAureonClient,
   createSessionTokenProvider,
+  DEFAULT_API_BASE_URL,
   isAureonError,
-  LOCAL_API_BASE_URL,
 } from "../../src/index.js";
 
-const __dirname = dirname(fileURLToPath(import.meta.url));
-const ROOT = join(__dirname, "../../..");
-const BACKEND = join(ROOT, "backend");
-
-function loadDotEnv(path: string): Record<string, string> {
-  if (!existsSync(path)) return {};
-  const out: Record<string, string> = {};
-  for (const line of readFileSync(path, "utf8").split(/\r?\n/)) {
-    const trimmed = line.trim();
-    if (!trimmed || trimmed.startsWith("#")) continue;
-    const i = trimmed.indexOf("=");
-    if (i < 0) continue;
-    out[trimmed.slice(0, i)] = trimmed.slice(i + 1).trim();
-  }
-  return out;
-}
-
-function firstApiKey(raw: string | undefined): string | null {
-  if (!raw) return null;
-  const key = raw.split(",")[0]?.trim();
-  return key || null;
+function requireEnv(name: string): string {
+  const value = process.env[name]?.trim();
+  if (!value) throw new Error(`Set ${name}`);
+  return value;
 }
 
 function loadPrivateKey(): Hex {
-  if (process.env.AUREON_E2E_KEY?.startsWith("0x")) {
-    return process.env.AUREON_E2E_KEY as Hex;
+  const key = requireEnv("AUREON_WALLET_PRIVATE_KEY");
+  if (!/^0x[0-9a-fA-F]{64}$/.test(key)) {
+    throw new Error("AUREON_WALLET_PRIVATE_KEY must be a 0x-prefixed 32-byte hex key");
   }
-  const fromEnv = loadDotEnv(join(BACKEND, ".env")).AUREON_VAULT_DEPLOYER_KEY;
-  if (fromEnv?.startsWith("0x")) return fromEnv as Hex;
-  const keyPath = join(BACKEND, ".secrets/vault-deployer.key");
-  if (!existsSync(keyPath)) {
-    throw new Error("Missing AUREON_E2E_KEY / vault-deployer.key");
-  }
-  const hex = readFileSync(keyPath, "utf8").trim();
-  if (!/^0x[0-9a-fA-F]{64}$/.test(hex)) {
-    throw new Error("vault-deployer.key must be a 32-byte hex private key");
-  }
-  return hex as Hex;
+  return key as Hex;
 }
 
 function log(step: string, data?: unknown): void {
@@ -78,15 +48,12 @@ function log(step: string, data?: unknown): void {
 }
 
 async function main(): Promise<void> {
-  const env = loadDotEnv(join(BACKEND, ".env"));
-  const baseUrl =
-    process.env.AUREON_API_URL ?? env.AUREON_API_URL ?? LOCAL_API_BASE_URL;
-  const apiKey =
-    process.env.AUREON_API_KEY ?? firstApiKey(env.AUREON_API_KEYS);
-  const rpcUrl = env.AUREON_RPC_URL ?? "https://rpc.testnet.chain.robinhood.com";
-  const chainId = Number(env.AUREON_CHAIN_ID ?? 46630);
-
-  if (!apiKey) throw new Error("AUREON_API_KEY / AUREON_API_KEYS missing");
+  const baseUrl = process.env.AUREON_API_URL?.trim() || DEFAULT_API_BASE_URL;
+  const apiKey = requireEnv("AUREON_API_KEY");
+  const rpcUrl =
+    process.env.AUREON_RPC_URL?.trim() ||
+    "https://rpc.testnet.chain.robinhood.com";
+  const chainId = Number(process.env.AUREON_CHAIN_ID ?? 46630);
 
   const account = privateKeyToAccount(loadPrivateKey());
   const publicClient = createPublicClient({ transport: http(rpcUrl) });
@@ -94,6 +61,12 @@ async function main(): Promise<void> {
     account,
     transport: http(rpcUrl),
   });
+  const chain = {
+    id: chainId,
+    name: "Robinhood Chain Testnet",
+    nativeCurrency: { name: "Ether", symbol: "ETH", decimals: 18 },
+    rpcUrls: { default: { http: [rpcUrl] } },
+  } as const;
 
   const session = createSessionTokenProvider(null);
   const aureon = createAureonClient({
@@ -106,10 +79,7 @@ async function main(): Promise<void> {
   log("ping", ping);
 
   const { message } = await aureon.getAuthNonce(account.address);
-  const signature = await walletClient.signMessage({
-    account,
-    message,
-  });
+  const signature = await walletClient.signMessage({ account, message });
   const login = await aureon.verifyWallet({
     address: account.address,
     message,
@@ -118,11 +88,6 @@ async function main(): Promise<void> {
   session.setToken(login.token);
   log("auth", { wallet: login.walletAddress });
 
-  const me = await aureon.me();
-  if (me.walletAddress.toLowerCase() !== account.address.toLowerCase()) {
-    throw new Error("session wallet mismatch");
-  }
-
   const synced = await aureon.syncPortfolio();
   log("syncPortfolio", {
     chainId: synced.chainId,
@@ -162,12 +127,7 @@ async function main(): Promise<void> {
   for (const step of deposit.steps) {
     const hash = await walletClient.sendTransaction({
       account,
-      chain: {
-        id: chainId,
-        name: "Robinhood Chain Testnet",
-        nativeCurrency: { name: "Ether", symbol: "ETH", decimals: 18 },
-        rpcUrls: { default: { http: [rpcUrl] } },
-      },
+      chain,
       to: step.to as `0x${string}`,
       data: step.data as Hex,
       value: BigInt(step.value),
@@ -185,19 +145,11 @@ async function main(): Promise<void> {
     throw new Error("expected vault WETH to increase after depositETH");
   }
 
-  const withdrawAmount = "0.00005";
-  const withdraw = await aureon.prepareVaultWithdraw({
-    amount: withdrawAmount,
-  });
+  const withdraw = await aureon.prepareVaultWithdraw({ amount: "0.00005" });
   for (const step of withdraw.steps) {
     const hash = await walletClient.sendTransaction({
       account,
-      chain: {
-        id: chainId,
-        name: "Robinhood Chain Testnet",
-        nativeCurrency: { name: "Ether", symbol: "ETH", decimals: 18 },
-        rpcUrls: { default: { http: [rpcUrl] } },
-      },
+      chain,
       to: step.to as `0x${string}`,
       data: step.data as Hex,
       value: BigInt(step.value),
@@ -211,9 +163,6 @@ async function main(): Promise<void> {
     vaultAfterWithdraw.balances.find((b) => b.symbol.toUpperCase() === "WETH")
       ?.quantity ?? 0;
   log("vault after withdraw", { weth: wethAfterWithdraw });
-  if (!(wethAfterWithdraw < wethAfterDeposit)) {
-    throw new Error("expected vault WETH to decrease after withdraw");
-  }
 
   await aureon.syncPortfolio();
 
@@ -228,12 +177,9 @@ async function main(): Promise<void> {
   log("createObjective", {
     id: objective.id,
     automationMode: objective.automationMode,
-    summary: objective.policy.summary,
   });
   if (objective.automationMode !== "auto") {
-    throw new Error(
-      `SDK create must default to auto, got ${objective.automationMode}`
-    );
+    throw new Error(`expected automationMode auto, got ${objective.automationMode}`);
   }
 
   const health = await aureon.getHealth(objective.id);
@@ -248,7 +194,7 @@ async function main(): Promise<void> {
     });
   } catch (err) {
     if (isAureonError(err)) {
-      log("getRestorePlan (expected if already in band)", {
+      log("getRestorePlan (ok if already in band)", {
         code: err.code,
         message: err.message,
       });
@@ -257,7 +203,7 @@ async function main(): Promise<void> {
     }
   }
 
-  console.log("\nE2E OK : vault up/down + Automatic objective via SDK");
+  console.log("\nE2E OK — vault deposit/withdraw + Automatic objective");
 }
 
 main().catch((error) => {

package/examples/market-event/main.ts

@@ -1,28 +1,28 @@
 /**
- * @fileoverview Controlled market event example (simulation helper).
+ * @fileoverview Controlled market-event rehearsal against the live AUREON API.
  *
- * Env: AUREON_API_KEY, AUREON_TOKEN, optional AUREON_API_URL
+ * Env:
+ *   AUREON_API_KEY  issued developer key (required)
+ *   AUREON_API_URL  optional (default https://api.aureonlabs.network)
  *
  *   pnpm --filter @buildaureon/sdk example:market
  */
 
 import {
   createAureonClient,
-  createSessionTokenProvider,
   DEFAULT_API_BASE_URL,
   isAureonError,
 } from "../../src/index.js";
 
 async function main(): Promise<void> {
-  const session = createSessionTokenProvider(process.env.AUREON_TOKEN ?? null);
-  if (!session.getAccessToken()) {
-    throw new Error("Set AUREON_TOKEN from a wallet verify session.");
+  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 ?? DEFAULT_API_BASE_URL,
-    apiKey: process.env.AUREON_API_KEY ?? null,
-    getAccessToken: session.getAccessToken,
+    baseUrl: process.env.AUREON_API_URL?.trim() || DEFAULT_API_BASE_URL,
+    apiKey,
   });
 
   const objective = await aureon.createObjective({

package/examples/quickstart/main.ts

@@ -1,39 +1,36 @@
 /**
- * @fileoverview Quickstart example for @buildaureon/sdk against the AUREON API.
+ * @fileoverview Quickstart — control-plane calls with an issued developer API key.
  *
- * Env:
- *   AUREON_API_KEY  : product key (required on hosted API)
- *   AUREON_TOKEN    : wallet Bearer session
- *   AUREON_API_URL  : optional override (defaults to https://api.aureonlabs.network)
+ * 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,
-  createSessionTokenProvider,
   DEFAULT_API_BASE_URL,
   formatWeight,
   isAureonError,
 } from "../../src/index.js";
 
 async function main(): Promise<void> {
-  const session = createSessionTokenProvider(process.env.AUREON_TOKEN ?? null);
+  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 ?? DEFAULT_API_BASE_URL,
-    apiKey: process.env.AUREON_API_KEY ?? null,
-    getAccessToken: session.getAccessToken,
+    baseUrl: process.env.AUREON_API_URL?.trim() || DEFAULT_API_BASE_URL,
+    apiKey,
   });
 
   const ping = await aureon.ping();
   console.log("connected", ping);
 
-  if (!session.getAccessToken()) {
-    throw new Error(
-      "Set AUREON_TOKEN from a wallet verify session (nonce → sign → verifyWallet)."
-    );
-  }
-
   const me = await aureon.me();
   console.log("wallet", me.walletAddress);
 
@@ -59,6 +56,10 @@ async function main(): Promise<void> {
       automationMode: o.automationMode,
     }))
   );
+
+  console.log(
+    "hint: private key is only needed later to broadcast prepare-deposit / prepare-withdraw steps"
+  );
 }
 
 main().catch((error) => {

package/examples/sdk-demo-terminal/main.ts

@@ -0,0 +1,171 @@
+/**
+ * @fileoverview Console demo of an Automatic SDK loop against the live API.
+ *
+ * Env:
+ *   AUREON_API_KEY  issued developer key (required)
+ *   AUREON_API_URL  optional (default https://api.aureonlabs.network)
+ *
+ *   pnpm --filter @buildaureon/sdk example:sdk-demo-terminal
+ *   pnpm --filter @buildaureon/sdk example:sdk-demo-terminal -- --create-only
+ */
+
+import {
+  createAureonClient,
+  DEFAULT_API_BASE_URL,
+  formatWeight,
+  isAureonError,
+  type PortfolioPositionInput,
+} from "../../src/index.js";
+
+const CREATE_ONLY = process.argv.includes("--create-only");
+
+const DEMO_POSITIONS: PortfolioPositionInput[] = [
+  {
+    symbol: "USDG",
+    name: "Paxos USDG",
+    category: "stable",
+    quantity: 24_000,
+    markPriceUsd: 1,
+  },
+  {
+    symbol: "NVDA",
+    name: "NVIDIA Stock Token",
+    category: "stock_token",
+    quantity: 45,
+    markPriceUsd: 920,
+  },
+  {
+    symbol: "AAPL",
+    name: "Apple Stock Token",
+    category: "stock_token",
+    quantity: 80,
+    markPriceUsd: 210,
+  },
+  {
+    symbol: "GOOGL",
+    name: "Alphabet Stock Token",
+    category: "stock_token",
+    quantity: 60,
+    markPriceUsd: 175,
+  },
+  {
+    symbol: "ETH",
+    name: "Ether",
+    category: "gas",
+    quantity: 8.5,
+    markPriceUsd: 3400,
+  },
+];
+
+function shortHash(hash: string, head = 10, tail = 6): string {
+  if (hash.length <= head + tail + 1) return hash;
+  return `${hash.slice(0, head)}…${hash.slice(-tail)}`;
+}
+
+function line(kind: "cmd" | "out" | "err" | "meta", text: string): void {
+  const prefix =
+    kind === "cmd" ? "$ " : kind === "err" ? "! " : kind === "meta" ? "# " : "  ";
+  console.log(`${prefix}${text}`);
+}
+
+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 baseUrl = process.env.AUREON_API_URL?.trim() || DEFAULT_API_BASE_URL;
+  line(
+    "meta",
+    CREATE_ONLY
+      ? `@buildaureon/sdk · create-only · ${baseUrl}`
+      : `@buildaureon/sdk · Automatic demo loop · ${baseUrl}`
+  );
+
+  const aureon = createAureonClient({ baseUrl, apiKey });
+
+  line("cmd", "aureon.ping()");
+  const ping = await aureon.ping();
+  line(
+    "out",
+    `connected  ok=${String(ping.ok)}  service=${ping.service}  version=${ping.version}`
+  );
+
+  line("cmd", "aureon.me()");
+  const me = await aureon.me();
+  line("out", `me       wallet=${me.walletAddress}`);
+
+  line("cmd", "aureon.setPortfolio(/* rehearsal book */)");
+  const book = await aureon.setPortfolio(DEMO_POSITIONS);
+  line(
+    "out",
+    `portfolio  notional=${book.totalNotionalUsd.toFixed(0)}  stable=${formatWeight(book.stableWeight)}  positions=${book.positions.length}`
+  );
+
+  line(
+    "cmd",
+    'aureon.createObjective({ kind: "stable_allocation", targetWeight: 0.2, … })'
+  );
+  const objective = await aureon.createObjective({
+    name: "Maintain 20% Stable Assets",
+    kind: "stable_allocation",
+    targetWeight: 0.2,
+    tolerance: 0.02,
+    priority: "high",
+  });
+  line(
+    "out",
+    `objective  id=${objective.id}  status=${objective.status}  mode=${objective.automationMode}`
+  );
+
+  if (CREATE_ONLY) {
+    line("meta", "create-only complete");
+    return;
+  }
+
+  line(
+    "cmd",
+    'aureon.applyMarketEvent({ symbol: "NVDA", priceChangeRatio: 0.45, autoRestore: true })'
+  );
+  const market = await aureon.applyMarketEvent({
+    name: "NVDA Stock Token Rally",
+    description: "Controlled mark appreciation on NVIDIA Stock Token",
+    symbol: "NVDA",
+    priceChangeRatio: 0.45,
+    autoRestore: true,
+  });
+  line(
+    "out",
+    `market     event=${market.event.id}  ${market.event.symbol} ${(market.event.priceChangeRatio * 100).toFixed(0)}%`
+  );
+
+  const executions =
+    market.executions.length > 0
+      ? market.executions
+      : await aureon.listExecutions(objective.id);
+  for (const receipt of executions) {
+    line(
+      "out",
+      `execution  id=${receipt.id}  status=${receipt.status}  settlement=${receipt.settlement ?? "n/a"}  hash=${shortHash(receipt.transactionHash)}`
+    );
+  }
+
+  const finalHealth = (await aureon.getHealth(objective.id))[0];
+  if (finalHealth) {
+    line(
+      "out",
+      `health     state=${finalHealth.state}  current=${formatWeight(finalHealth.currentMetric)}  target=${formatWeight(finalHealth.targetMetric)}`
+    );
+  }
+
+  line("meta", "done — check settlement field before claiming on-chain");
+}
+
+main().catch((error) => {
+  if (isAureonError(error)) {
+    line("err", `${error.code}: ${error.message}`);
+  } else {
+    line("err", error instanceof Error ? error.message : String(error));
+  }
+  process.exitCode = 1;
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@buildaureon/sdk",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Official TypeScript SDK for AUREON Financial Compass on Robinhood Chain",
   "type": "module",
   "main": "./dist/index.js",
@@ -29,6 +29,7 @@
     "bench": "tsx benchmarks/client-throughput.ts",
     "example:quickstart": "tsx examples/quickstart/main.ts",
     "example:market": "tsx examples/market-event/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",
     "cli": "tsx cli/aureon-cli.ts",
@@ -47,18 +48,14 @@
     "url": "https://github.com/buildaureon/aureon-sdk"
   },
   "license": "MIT",
-  "author": "AUREON Labs (https://github.com/buildaureon)",
-  "publishConfig": {
-    "access": "public"
-  },
   "engines": {
     "node": ">=20"
   },
   "devDependencies": {
     "@types/node": "^22.13.10",
-    "tsup": "^8.5.1",
-    "tsx": "^4.23.1",
-    "typescript": "^5.9.3",
+    "tsup": "^8.4.0",
+    "tsx": "^4.19.3",
+    "typescript": "^5.8.2",
     "viem": "^2.55.1"
   }
 }