@buildaureon/sdk 0.1.9 → 0.1.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +10 -0
- package/README.md +10 -10
- package/config/network.json +3 -3
- package/dist/index.d.ts +9 -9
- package/dist/index.js +4 -4
- package/dist/index.js.map +1 -1
- package/docs/architecture.md +8 -8
- package/docs/auth.md +4 -4
- package/docs/client-api.md +5 -5
- package/docs/data-contracts.md +3 -1
- package/docs/integration-guide.md +1 -1
- package/docs/security.md +1 -1
- package/docs/transport.md +2 -2
- package/examples/ai-to-objective-to-portfolio/main.ts +1 -1
- package/examples/drift-detect-restore/main.ts +1 -1
- package/examples/e2e-policy-rebalance/main.ts +1 -1
- package/examples/e2e-policy-rebalance/underrun.ts +1 -1
- package/examples/e2e-policy-rebalance/verify-sizing.ts +1 -1
- package/examples/e2e-vault-flow/main.ts +1 -1
- package/examples/full-aureon-loop/main.ts +1 -1
- package/examples/green-vs-plan/main.ts +1 -1
- package/examples/market-event/main.ts +1 -1
- package/examples/portfolio-watch/main.ts +1 -1
- package/examples/quickstart/main.ts +1 -1
- package/examples/receipt-verification/main.ts +1 -1
- package/examples/sdk-demo-terminal/main.ts +1 -1
- package/package.json +1 -1
package/docs/architecture.md
CHANGED
|
@@ -186,18 +186,18 @@ flowchart TD
|
|
|
186
186
|
|
|
187
187
|
## 8. Network
|
|
188
188
|
|
|
189
|
-
Default omitted SDK/MCP options use the official API `https://api.aureonlabs.network` on **
|
|
189
|
+
Default omitted SDK/MCP options use the official API `https://api.aureonlabs.network` on **mainnet**. Pass `network: "testnet"` to stay on testnet on the same host. First use is the same on both networks: empty vault → restore 409 → unsigned `prepareVaultDeposit` → host wallet / MetaMask broadcasts. MCP agents never broadcast.
|
|
190
190
|
|
|
191
|
-
| Item |
|
|
191
|
+
| Item | Mainnet (default) | Testnet (`network: "testnet"`) |
|
|
192
192
|
| --- | --- | --- |
|
|
193
|
-
| Chain | Robinhood Chain
|
|
194
|
-
| Chain ID | `
|
|
193
|
+
| Chain | Robinhood Chain mainnet | Robinhood Chain testnet |
|
|
194
|
+
| Chain ID | `4663` | `46630` |
|
|
195
195
|
| API | `https://api.aureonlabs.network` | `https://api.aureonlabs.network` |
|
|
196
|
-
| Cash park | Testnet catalog (see API) |
|
|
197
|
-
| Explorer | `https://
|
|
198
|
-
| Utility |
|
|
196
|
+
| Cash park | USDG | Testnet catalog (see API) |
|
|
197
|
+
| Explorer | `https://robinhoodchain.blockscout.com` | `https://explorer.testnet.chain.robinhood.com` |
|
|
198
|
+
| Utility | Testnet console (Living Capital cutover next) | [app.aureonlabs.network](https://app.aureonlabs.network) |
|
|
199
199
|
|
|
200
|
-
|
|
200
|
+
Confirm live addresses from the API you actually call. Public Living Capital is still the testnet console.
|
|
201
201
|
|
|
202
202
|
---
|
|
203
203
|
|
package/docs/auth.md
CHANGED
|
@@ -41,8 +41,8 @@ import { createAureonClient } from "@buildaureon/sdk";
|
|
|
41
41
|
|
|
42
42
|
const aureon = createAureonClient({
|
|
43
43
|
apiKey: process.env.AUREON_API_KEY!, // issued key from Developers
|
|
44
|
-
// omit network → official API /
|
|
45
|
-
// network: "
|
|
44
|
+
// omit network → official API / mainnet
|
|
45
|
+
// network: "testnet" → stay on testnet on the same official host
|
|
46
46
|
});
|
|
47
47
|
|
|
48
48
|
const me = await aureon.me();
|
|
@@ -89,7 +89,7 @@ import { createAureonClient, createSessionTokenProvider } from "@buildaureon/sdk
|
|
|
89
89
|
|
|
90
90
|
const session = createSessionTokenProvider(null);
|
|
91
91
|
const aureon = createAureonClient({
|
|
92
|
-
network: "testnet", //
|
|
92
|
+
network: "testnet", // opt-in testnet, chain 46630
|
|
93
93
|
apiKey: process.env.AUREON_API_KEY,
|
|
94
94
|
getAccessToken: session.getAccessToken,
|
|
95
95
|
});
|
|
@@ -144,7 +144,7 @@ session.clear();
|
|
|
144
144
|
| Variable | Required | Description |
|
|
145
145
|
| --- | --- | --- |
|
|
146
146
|
| `AUREON_API_KEY` | Recommended | Issued developer key |
|
|
147
|
-
| `AUREON_NETWORK` | No | Omit for official API /
|
|
147
|
+
| `AUREON_NETWORK` | No | Omit for official API / mainnet. Set `testnet` to stay on testnet. |
|
|
148
148
|
| `AUREON_API_URL` | No | Optional override of `https://api.aureonlabs.network`. |
|
|
149
149
|
| `AUREON_TOKEN` | No | Optional Bearer for CLI / scripts |
|
|
150
150
|
|
package/docs/client-api.md
CHANGED
|
@@ -32,8 +32,8 @@ import {
|
|
|
32
32
|
} from "@buildaureon/sdk";
|
|
33
33
|
|
|
34
34
|
const aureon = createAureonClient({
|
|
35
|
-
// network defaults to official API /
|
|
36
|
-
// network: "
|
|
35
|
+
// network defaults to official API / mainnet
|
|
36
|
+
// network: "testnet" → stay on testnet on the same official host
|
|
37
37
|
apiKey: process.env.AUREON_API_KEY,
|
|
38
38
|
getAccessToken: () => sessionToken,
|
|
39
39
|
timeoutMs: 30_000,
|
|
@@ -45,7 +45,7 @@ const aureon = createAureonClient({
|
|
|
45
45
|
|
|
46
46
|
| Option | Required | Default | Description |
|
|
47
47
|
|--------|----------|---------|-------------|
|
|
48
|
-
| `network` | no | `
|
|
48
|
+
| `network` | no | `mainnet` | Omit for official API / mainnet. Pass `"testnet"` to stay on testnet. |
|
|
49
49
|
| `baseUrl` | no | `https://api.aureonlabs.network` | Leave unset. Override only if you must point at another host. |
|
|
50
50
|
| `apiKey` | SDK / CLI | N/A | Sent as `X-Aureon-Api-Key`. Issued developer keys also identify the bound wallet (no Bearer required). Env bootstrap keys are product-gate only. Utility uses wallet Bearer only. |
|
|
51
51
|
| `getAccessToken` | no | N/A | Optional Bearer getter. Wins over API-key identity when present. |
|
|
@@ -61,8 +61,8 @@ const aureon = createAureonClient({
|
|
|
61
61
|
|
|
62
62
|
| Rule | Behavior |
|
|
63
63
|
|------|----------|
|
|
64
|
-
| Omitted `network` and `baseUrl` | Official API `https://api.aureonlabs.network`, chain
|
|
65
|
-
| `network: "
|
|
64
|
+
| Omitted `network` and `baseUrl` | Official API `https://api.aureonlabs.network`, chain 4663 |
|
|
65
|
+
| `network: "testnet"` | Same official host, chain 46630 |
|
|
66
66
|
| Explicit `baseUrl` | Override; official host is allowed with either network |
|
|
67
67
|
| `network` + disagreeing non-official host | Throws |
|
|
68
68
|
| Invalid `baseUrl` scheme | Throws via `assertBaseUrl` |
|
package/docs/data-contracts.md
CHANGED
|
@@ -579,7 +579,9 @@ export interface VaultPrepareResult {
|
|
|
579
579
|
}
|
|
580
580
|
```
|
|
581
581
|
|
|
582
|
-
#### JSON Representation Example
|
|
582
|
+
#### JSON Representation Example (testnet sample)
|
|
583
|
+
|
|
584
|
+
Labeled testnet: `chainId` 46630. Confirm live addresses from the API you actually call.
|
|
583
585
|
```json
|
|
584
586
|
{
|
|
585
587
|
"chainId": 46630,
|
|
@@ -320,7 +320,7 @@ module.exports = {
|
|
|
320
320
|
env: {
|
|
321
321
|
NODE_ENV: "production",
|
|
322
322
|
// omit AUREON_API_URL for official API https://api.aureonlabs.network
|
|
323
|
-
// AUREON_NETWORK: "
|
|
323
|
+
// AUREON_NETWORK: "testnet" // stay on testnet on the same official host
|
|
324
324
|
// AUREON_API_KEY from secret store / PM2 ecosystem secrets
|
|
325
325
|
},
|
|
326
326
|
},
|
package/docs/security.md
CHANGED
|
@@ -82,7 +82,7 @@ Never collapse staged into “confirmed on Robinhood Chain.”
|
|
|
82
82
|
|
|
83
83
|
## 5. Transport and logging hygiene
|
|
84
84
|
|
|
85
|
-
- Default omitted client is the official API `https://api.aureonlabs.network`
|
|
85
|
+
- Default omitted client is the official API `https://api.aureonlabs.network` on mainnet. Use `network: "testnet"` to stay on testnet on the same host. Public Living Capital is still the testnet console.
|
|
86
86
|
- Do not log raw `Authorization` or `X-Aureon-Api-Key`.
|
|
87
87
|
- Redact prepare step calldata in public logs if it includes sensitive amounts in your threat model.
|
|
88
88
|
- Set `timeoutMs` / `maxRetries` deliberately for agent loops (see [transport.md](./transport.md)).
|
package/docs/transport.md
CHANGED
|
@@ -48,8 +48,8 @@ Issued developer keys in `X-Aureon-Api-Key` are enough for control-plane identit
|
|
|
48
48
|
|
|
49
49
|
```ts
|
|
50
50
|
createAureonClient({
|
|
51
|
-
// omit network → official API /
|
|
52
|
-
// network: "
|
|
51
|
+
// omit network → official API / mainnet
|
|
52
|
+
// network: "testnet" → stay on testnet on the same official host
|
|
53
53
|
apiKey: process.env.AUREON_API_KEY!,
|
|
54
54
|
timeoutMs: 30_000, // per attempt
|
|
55
55
|
maxRetries: 2, // extra attempts after first failure
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*
|
|
4
4
|
* Env:
|
|
5
5
|
* AUREON_API_KEY issued developer key (required)
|
|
6
|
-
* AUREON_NETWORK optional; omit for official API /
|
|
6
|
+
* AUREON_NETWORK optional; omit for official API / mainnet; set testnet to stay on testnet
|
|
7
7
|
* AUREON_API_URL optional override (must match network if both set)
|
|
8
8
|
*
|
|
9
9
|
* pnpm example:ai-to-objective-to-portfolio
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
*
|
|
6
6
|
* Env:
|
|
7
7
|
* AUREON_API_KEY issued developer key (required)
|
|
8
|
-
* AUREON_NETWORK optional; omit for official API /
|
|
8
|
+
* AUREON_NETWORK optional; omit for official API / mainnet; set testnet to stay on testnet
|
|
9
9
|
* AUREON_API_URL optional override (must match network if both set)
|
|
10
10
|
*
|
|
11
11
|
* pnpm example:drift-detect-restore
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Env:
|
|
5
5
|
* AUREON_API_KEY issued developer key (required)
|
|
6
6
|
* AUREON_WALLET_PRIVATE_KEY 0x… signing key (required)
|
|
7
|
-
* AUREON_NETWORK optional; omit for official API /
|
|
7
|
+
* AUREON_NETWORK optional; omit for official API / mainnet; testnet = stay on testnet
|
|
8
8
|
* AUREON_API_URL optional override
|
|
9
9
|
* AUREON_RPC_URL optional (defaults from resolved chain)
|
|
10
10
|
* AUREON_CHAIN_ID optional (defaults from resolved network)
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Env:
|
|
5
5
|
* AUREON_API_KEY issued developer key
|
|
6
6
|
* AUREON_WALLET_PRIVATE_KEY 0x… signing key
|
|
7
|
-
* AUREON_NETWORK optional; omit for official API /
|
|
7
|
+
* AUREON_NETWORK optional; omit for official API / mainnet; testnet = stay on testnet
|
|
8
8
|
* AUREON_API_URL optional override
|
|
9
9
|
* AUREON_RPC_URL optional (defaults from resolved chain)
|
|
10
10
|
* AUREON_CHAIN_ID optional (defaults from resolved network)
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Env:
|
|
5
5
|
* AUREON_API_KEY issued developer key
|
|
6
6
|
* AUREON_WALLET_PRIVATE_KEY 0x… signing key
|
|
7
|
-
* AUREON_NETWORK optional; omit for official API /
|
|
7
|
+
* AUREON_NETWORK optional; omit for official API / mainnet; testnet = stay on testnet
|
|
8
8
|
* AUREON_API_URL optional override
|
|
9
9
|
* AUREON_RPC_URL optional (defaults from resolved chain)
|
|
10
10
|
* AUREON_CHAIN_ID optional (defaults from resolved network)
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*
|
|
4
4
|
* Env (integrators only — no local repo files):
|
|
5
5
|
* AUREON_API_KEY issued developer key (required)
|
|
6
|
-
* AUREON_NETWORK optional; omit for official API /
|
|
6
|
+
* AUREON_NETWORK optional; omit for official API / mainnet; testnet = stay on testnet
|
|
7
7
|
* AUREON_API_URL optional override
|
|
8
8
|
* AUREON_WALLET_PRIVATE_KEY 0x… key used to sign auth + broadcast vault txs (required)
|
|
9
9
|
* AUREON_RPC_URL optional (defaults from resolved chain)
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*
|
|
4
4
|
* Env:
|
|
5
5
|
* AUREON_API_KEY issued developer key (required)
|
|
6
|
-
* AUREON_NETWORK optional; omit for official API /
|
|
6
|
+
* AUREON_NETWORK optional; omit for official API / mainnet; set testnet to stay on testnet
|
|
7
7
|
* AUREON_API_URL optional override (must match network if both set)
|
|
8
8
|
*
|
|
9
9
|
* pnpm example:full-aureon-loop
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
*
|
|
7
7
|
* Env:
|
|
8
8
|
* AUREON_API_KEY issued developer key (required)
|
|
9
|
-
* AUREON_NETWORK optional; omit for official API /
|
|
9
|
+
* AUREON_NETWORK optional; omit for official API / mainnet; set testnet to stay on testnet
|
|
10
10
|
* AUREON_API_URL optional override (must match network if both set)
|
|
11
11
|
*
|
|
12
12
|
* pnpm example:green-vs-plan
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*
|
|
4
4
|
* Env:
|
|
5
5
|
* AUREON_API_KEY issued developer key (required)
|
|
6
|
-
* AUREON_NETWORK optional; omit for official API /
|
|
6
|
+
* AUREON_NETWORK optional; omit for official API / mainnet; set testnet to stay on testnet
|
|
7
7
|
* AUREON_API_URL optional override (must match network if both set)
|
|
8
8
|
*
|
|
9
9
|
* pnpm --filter @buildaureon/sdk example:market
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*
|
|
4
4
|
* Env:
|
|
5
5
|
* AUREON_API_KEY issued developer key (required)
|
|
6
|
-
* AUREON_NETWORK optional; omit for official API /
|
|
6
|
+
* AUREON_NETWORK optional; omit for official API / mainnet; set testnet to stay on testnet
|
|
7
7
|
* AUREON_API_URL optional override (must match network if both set)
|
|
8
8
|
*
|
|
9
9
|
* pnpm example:portfolio-watch
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*
|
|
4
4
|
* Env (required for integrators — nothing else):
|
|
5
5
|
* AUREON_API_KEY issued key from Developers
|
|
6
|
-
* AUREON_NETWORK optional; omit for official API /
|
|
6
|
+
* AUREON_NETWORK optional; omit for official API / mainnet; set testnet to stay on testnet
|
|
7
7
|
* AUREON_API_URL optional override (must match network if both set)
|
|
8
8
|
*
|
|
9
9
|
* pnpm --filter @buildaureon/sdk example:quickstart
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
*
|
|
6
6
|
* Env:
|
|
7
7
|
* AUREON_API_KEY issued developer key (required)
|
|
8
|
-
* AUREON_NETWORK optional; omit for official API /
|
|
8
|
+
* AUREON_NETWORK optional; omit for official API / mainnet; set testnet to stay on testnet
|
|
9
9
|
* AUREON_API_URL optional override (must match network if both set)
|
|
10
10
|
*
|
|
11
11
|
* pnpm example:receipt-verification
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*
|
|
4
4
|
* Env:
|
|
5
5
|
* AUREON_API_KEY issued developer key (required)
|
|
6
|
-
* AUREON_NETWORK optional; omit for official API /
|
|
6
|
+
* AUREON_NETWORK optional; omit for official API / mainnet; set testnet to stay on testnet
|
|
7
7
|
* AUREON_API_URL optional override (must match network if both set)
|
|
8
8
|
*
|
|
9
9
|
* pnpm --filter @buildaureon/sdk example:sdk-demo-terminal
|