@buildaureon/sdk 0.1.2 → 0.1.8

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2026 AUREON Contributors
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2026 AUREON Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -11,7 +11,7 @@ Financial Compass, capital health, and verified restore plans: one typed integra
 
 [![TypeScript](https://img.shields.io/badge/TypeScript-5.x-3178C6?style=flat-square&logo=typescript&logoColor=white)](https://www.typescriptlang.org/)
 [![ESM](https://img.shields.io/badge/Module-ESM-f7df1e?style=flat-square)](#requirements)
-[![Version](https://img.shields.io/badge/version-0.1.1-a8e00d?style=flat-square)](https://github.com/buildaureon)
+[![Version](https://img.shields.io/badge/version-0.1.8-a8e00d?style=flat-square)](https://github.com/buildaureon)
 [![License: MIT](https://img.shields.io/badge/license-MIT-0b0e0d?style=flat-square)](LICENSE)
 [![Node](https://img.shields.io/badge/node-%3E%3D20-339933?style=flat-square&logo=nodejs&logoColor=white)](#requirements)
 
@@ -114,6 +114,8 @@ flowchart LR
 | Prepare non-custodial vault deposit / withdraw steps | `prepareVaultDeposit`, related vault helpers |
 | Fetch and execute restore plans | `getRestorePlan`, `restoreObjective` |
 | Apply controlled market events for integration rehearsal | `applyMarketEvent` |
+| Register agent intent as objective + portfolio flow | `applyFinancialIntent`, `getObjectivePortfolioFlow` |
+| Compare objective vs actual allocation | `getAllocationVsTarget` |
 | Manage developer API keys | `createApiKey`, `listApiKeys`, `toggleApiKey`, `revokeApiKey` |
 
 **This package alone does not:**
@@ -331,9 +333,11 @@ import { createAureonClient } from "@buildaureon/sdk";
 
 async function run() {
   const aureon = createAureonClient({
-    baseUrl: "https://api.aureonlabs.network",
     apiKey: process.env.AUREON_API_KEY!, // issued key from Developers console
   });
+  // Default network is mainnet (4663 / http://127.0.0.1:8788).
+  // Opt in to testnet: createAureonClient({ network: "testnet", apiKey })
+  // Public api.aureonlabs.network is still chain 46630.
 
   const me = await aureon.me();
   console.log("wallet", me.walletAddress);
@@ -523,7 +527,8 @@ await aureon.revokeApiKey(newKey.id);
 
 | Parameter | Type | Default | Description |
 | --- | --- | --- | --- |
-| `baseUrl` | `string` | `"https://api.aureonlabs.network"` | API ingress |
+| `network` | `"mainnet" \| "testnet"` | `"mainnet"` | Bundles chain + API. Mainnet is 4663 / local 8788. Testnet is optional (public host, still 46630). |
+| `baseUrl` | `string` | mainnet `http://127.0.0.1:8788` | Explicit URL still wins. Must not disagree with `network`. |
 | `apiKey` | `string` | `undefined` | Sent as `X-Aureon-Api-Key` |
 | `authToken` | `string` | `undefined` | Static JWT bearer |
 | `getAccessToken` | `() => string \| null` | `undefined` | Dynamic bearer resolver |
@@ -598,6 +603,19 @@ pnpm --filter @buildaureon/sdk cli portfolio
 pnpm --filter @buildaureon/sdk cli objectives
 ```
 
+### Runnable examples (live API)
+
+Requires `AUREON_API_KEY`:
+
+```bash
+pnpm example:ai-to-objective-to-portfolio   
+pnpm example:drift-detect-restore          
+pnpm example:receipt-verification          
+pnpm example:portfolio-watch              
+pnpm example:full-aureon-loop             
+pnpm example:green-vs-plan                  
+```
+
 ---
 
 ## Design principles & settlement honesty

package/config/network.json

@@ -1,10 +1,20 @@
-{
-  "defaultBaseUrl": "https://api.aureonlabs.network",
-  "localBaseUrl": "http://127.0.0.1:8787",
-  "appUrl": "https://app.aureonlabs.network",
-  "product": "AUREON",
-  "chain": "Robinhood Chain Testnet",
-  "chainId": 46630,
-  "sdkPackage": "@buildaureon/sdk",
-  "sdkVersion": "0.1.0"
-}
+{
+  "defaultNetwork": "mainnet",
+  "note": "Omitted network is local mainnet 4663 / 8788. Public api.aureonlabs.network is still testnet 46630.",
+  "mainnet": {
+    "baseUrl": "http://127.0.0.1:8788",
+    "chainId": 4663,
+    "chain": "Robinhood Chain",
+    "explorer": "https://robinhoodchain.blockscout.com",
+    "rpcUrl": "https://rpc.mainnet.chain.robinhood.com"
+  },
+  "testnet": {
+    "baseUrl": "https://api.aureonlabs.network",
+    "localBaseUrl": "http://127.0.0.1:8787",
+    "appUrl": "https://app.aureonlabs.network",
+    "chainId": 46630,
+    "chain": "Robinhood Chain Testnet"
+  },
+  "sdkPackage": "@buildaureon/sdk",
+  "sdkVersion": "0.1.8"
+}