@hightop/sdk 0.1.4 → 0.1.5

package/README.md

@@ -43,6 +43,7 @@ const client = new HightopAgentClient({
 })
 
 const self = await client.self.get()
+const collateralOptions = await client.request('GET /v1/agent/borrow/collateral-options')
 const repay = await client.borrow.repay(
   { asset: 'GREEN', amount_usd: '10' },
   { idempotencyKey: createIdempotencyKey() },
@@ -62,6 +63,11 @@ const capabilities = await new HightopAgentClient({ baseUrl: 'https://api.highto
 Every catalogued `/v1/agent/*` endpoint is available through the generated typed request map:
 
 ```ts
+const collateralOptions = await client.request('GET /v1/agent/borrow/collateral-options')
+const usdcVault = collateralOptions.items.find(
+  (option) => option.source_type === 'earn_vault' && option.asset_symbol === 'USDC',
+)
+
 const oneOff = await client.request(
   'POST /v1/agent/one-off-payments',
   {
@@ -75,6 +81,8 @@ const oneOff = await client.request(
 )
 ```
 
+For `POST /v1/agent/borrow/collateral/add`, pass a collateral option `id` as `asset`. Vault-backed options use a vault contract address as the id, so callers should discover options instead of guessing from token symbols.
+
 The generated package artifact exports:
 
 ```ts

package/dist/generated/agent-api.d.ts

@@ -34,6 +34,12 @@ export type AgentErrorDetailsByCode = {
         period: 'rolling_30d' | 'active';
     } | {
         max_endpoints: number;
+    } | {
+        cap: number;
+        observed: number;
+        period: 'manager_period';
+        cap_kind: 'max_num_swaps_per_period';
+        quote_id: string;
     };
     ltv_too_high: {
         current_ltv: string;
@@ -592,6 +598,30 @@ export type AgentApiCollateralResponse = {
     next_cursor: string | null;
     has_more: boolean;
 };
+export type AgentApiCollateralOptionsResponse = {
+    ok: true;
+    items: Array<{
+        id: string;
+        asset_symbol: string;
+        asset_display_name: string;
+        asset_address: string;
+        source_type: 'cash' | 'earn_vault';
+        vault_id?: string;
+        vault_name?: string;
+        protocol_id?: string;
+        protocol_name?: string;
+        amount: string;
+        amount_usd: string;
+        ltv: string;
+        max_ltv: string;
+        borrow_power_usd: string;
+        increases_borrow_capacity: boolean;
+        apy?: string;
+        allowed: true;
+    }>;
+    next_cursor: string | null;
+    has_more: boolean;
+};
 export type AgentApiBorrowRepayRequest = {
     asset: 'GREEN' | '0xd1Eac76497D06Cf15475A5e3984D5bC03de7C707';
     repay_all?: boolean;
@@ -1554,6 +1584,21 @@ export declare const agentApiEndpoints: readonly [{
     readonly idempotencyRequired: false;
     readonly routeClass: "read";
     readonly description: "List collateral for the authenticated agent wallet.";
+}, {
+    readonly key: "GET /v1/agent/borrow/collateral-options";
+    readonly method: "GET";
+    readonly path: "/v1/agent/borrow/collateral-options";
+    readonly pathParams: readonly [];
+    readonly queryParams: readonly ["cursor", "limit"];
+    readonly bodyParams: readonly [];
+    readonly requestSchema: "agentApiResourceListQuery";
+    readonly bodySchema: null;
+    readonly responseSchema: "agentApiCollateralOptionsResponse";
+    readonly requestType: "AgentApiResourceListQuery";
+    readonly responseType: "AgentApiCollateralOptionsResponse";
+    readonly idempotencyRequired: false;
+    readonly routeClass: "read";
+    readonly description: "List addable collateral options for the authenticated agent wallet.";
 }, {
     readonly key: "POST /v1/agent/borrow/repay";
     readonly method: "POST";
@@ -2016,6 +2061,7 @@ export type AgentApiEndpointRequestMap = {
     readonly 'GET /v1/agent/borrow': undefined;
     readonly 'POST /v1/agent/borrow': AgentApiBorrowRequest;
     readonly 'GET /v1/agent/borrow/collateral': AgentApiResourceListQuery;
+    readonly 'GET /v1/agent/borrow/collateral-options': AgentApiResourceListQuery;
     readonly 'POST /v1/agent/borrow/repay': AgentApiBorrowRepayRequest;
     readonly 'POST /v1/agent/borrow/deleverage': AgentApiDeleverageRequest;
     readonly 'POST /v1/agent/borrow/collateral/add': AgentApiCollateralAddRequest;
@@ -2107,6 +2153,7 @@ export type AgentApiEndpointResponseMap = {
     readonly 'GET /v1/agent/borrow': AgentApiBorrowResponse;
     readonly 'POST /v1/agent/borrow': AgentApiWriteResponse;
     readonly 'GET /v1/agent/borrow/collateral': AgentApiCollateralResponse;
+    readonly 'GET /v1/agent/borrow/collateral-options': AgentApiCollateralOptionsResponse;
     readonly 'POST /v1/agent/borrow/repay': AgentApiWriteResponse;
     readonly 'POST /v1/agent/borrow/deleverage': AgentApiWriteResponse;
     readonly 'POST /v1/agent/borrow/collateral/add': AgentApiWriteResponse;

package/dist/generated/agent-api.js

@@ -30,7 +30,13 @@ export const agentErrorDetailsValidators = {
         typeof value['cap'] === 'number' &&
         typeof value['observed'] === 'number' &&
         ['rolling_30d', 'active'].includes(value['period'])) ||
-        (isAgentSdkRecord(value) && typeof value['max_endpoints'] === 'number'),
+        (isAgentSdkRecord(value) && typeof value['max_endpoints'] === 'number') ||
+        (isAgentSdkRecord(value) &&
+            typeof value['cap'] === 'number' &&
+            typeof value['observed'] === 'number' &&
+            ['manager_period'].includes(value['period']) &&
+            ['max_num_swaps_per_period'].includes(value['cap_kind']) &&
+            typeof value['quote_id'] === 'string'),
     ltv_too_high: (value) => isAgentSdkRecord(value) &&
         typeof value['current_ltv'] === 'string' &&
         typeof value['estimated_ltv_after'] === 'string' &&
@@ -705,6 +711,22 @@ export const agentApiEndpoints = [
         routeClass: 'read',
         description: 'List collateral for the authenticated agent wallet.',
     },
+    {
+        key: 'GET /v1/agent/borrow/collateral-options',
+        method: 'GET',
+        path: '/v1/agent/borrow/collateral-options',
+        pathParams: [],
+        queryParams: ['cursor', 'limit'],
+        bodyParams: [],
+        requestSchema: 'agentApiResourceListQuery',
+        bodySchema: null,
+        responseSchema: 'agentApiCollateralOptionsResponse',
+        requestType: 'AgentApiResourceListQuery',
+        responseType: 'AgentApiCollateralOptionsResponse',
+        idempotencyRequired: false,
+        routeClass: 'read',
+        description: 'List addable collateral options for the authenticated agent wallet.',
+    },
     {
         key: 'POST /v1/agent/borrow/repay',
         method: 'POST',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hightop/sdk",
-  "version": "0.1.4",
+  "version": "0.1.5",
   "license": "MIT",
   "type": "module",
   "main": "./dist/index.js",