@compass-labs/api-sdk 0.1.2 → 0.1.3

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.
Files changed (63) hide show
  1. package/FUNCTIONS.md +3 -4
  2. package/README.md +19 -25
  3. package/bin/mcp-server.js +13 -12
  4. package/bin/mcp-server.js.map +11 -11
  5. package/dist/commonjs/funcs/aaveV3AvgRate.d.ts +2 -2
  6. package/dist/commonjs/funcs/aaveV3AvgRate.js +2 -2
  7. package/dist/commonjs/funcs/aaveV3Rate.d.ts +1 -1
  8. package/dist/commonjs/funcs/aaveV3Rate.js +1 -1
  9. package/dist/commonjs/funcs/aaveV3StdRate.d.ts +3 -2
  10. package/dist/commonjs/funcs/aaveV3StdRate.d.ts.map +1 -1
  11. package/dist/commonjs/funcs/aaveV3StdRate.js +3 -2
  12. package/dist/commonjs/funcs/aaveV3StdRate.js.map +1 -1
  13. package/dist/commonjs/lib/config.d.ts +2 -2
  14. package/dist/commonjs/lib/config.js +2 -2
  15. package/dist/commonjs/mcp-server/mcp-server.js +1 -1
  16. package/dist/commonjs/mcp-server/server.js +3 -3
  17. package/dist/commonjs/mcp-server/server.js.map +1 -1
  18. package/dist/commonjs/mcp-server/tools/aaveV3AvgRate.js +2 -2
  19. package/dist/commonjs/mcp-server/tools/aaveV3AvgRate.js.map +1 -1
  20. package/dist/commonjs/mcp-server/tools/aaveV3Rate.js +1 -1
  21. package/dist/commonjs/mcp-server/tools/aaveV3StdRate.d.ts.map +1 -1
  22. package/dist/commonjs/mcp-server/tools/aaveV3StdRate.js +3 -2
  23. package/dist/commonjs/mcp-server/tools/aaveV3StdRate.js.map +1 -1
  24. package/dist/commonjs/sdk/aavev3.d.ts +26 -25
  25. package/dist/commonjs/sdk/aavev3.d.ts.map +1 -1
  26. package/dist/commonjs/sdk/aavev3.js +29 -28
  27. package/dist/commonjs/sdk/aavev3.js.map +1 -1
  28. package/dist/esm/funcs/aaveV3AvgRate.d.ts +2 -2
  29. package/dist/esm/funcs/aaveV3AvgRate.js +2 -2
  30. package/dist/esm/funcs/aaveV3Rate.d.ts +1 -1
  31. package/dist/esm/funcs/aaveV3Rate.js +1 -1
  32. package/dist/esm/funcs/aaveV3StdRate.d.ts +3 -2
  33. package/dist/esm/funcs/aaveV3StdRate.d.ts.map +1 -1
  34. package/dist/esm/funcs/aaveV3StdRate.js +3 -2
  35. package/dist/esm/funcs/aaveV3StdRate.js.map +1 -1
  36. package/dist/esm/lib/config.d.ts +2 -2
  37. package/dist/esm/lib/config.js +2 -2
  38. package/dist/esm/mcp-server/mcp-server.js +1 -1
  39. package/dist/esm/mcp-server/server.js +3 -3
  40. package/dist/esm/mcp-server/server.js.map +1 -1
  41. package/dist/esm/mcp-server/tools/aaveV3AvgRate.js +2 -2
  42. package/dist/esm/mcp-server/tools/aaveV3AvgRate.js.map +1 -1
  43. package/dist/esm/mcp-server/tools/aaveV3Rate.js +1 -1
  44. package/dist/esm/mcp-server/tools/aaveV3StdRate.d.ts.map +1 -1
  45. package/dist/esm/mcp-server/tools/aaveV3StdRate.js +3 -2
  46. package/dist/esm/mcp-server/tools/aaveV3StdRate.js.map +1 -1
  47. package/dist/esm/sdk/aavev3.d.ts +26 -25
  48. package/dist/esm/sdk/aavev3.d.ts.map +1 -1
  49. package/dist/esm/sdk/aavev3.js +29 -28
  50. package/dist/esm/sdk/aavev3.js.map +1 -1
  51. package/docs/sdks/aavev3/README.md +49 -48
  52. package/jsr.json +1 -1
  53. package/package.json +1 -1
  54. package/src/funcs/aaveV3AvgRate.ts +2 -2
  55. package/src/funcs/aaveV3Rate.ts +1 -1
  56. package/src/funcs/aaveV3StdRate.ts +3 -2
  57. package/src/lib/config.ts +2 -2
  58. package/src/mcp-server/mcp-server.ts +1 -1
  59. package/src/mcp-server/server.ts +3 -3
  60. package/src/mcp-server/tools/aaveV3AvgRate.ts +2 -2
  61. package/src/mcp-server/tools/aaveV3Rate.ts +1 -1
  62. package/src/mcp-server/tools/aaveV3StdRate.ts +3 -2
  63. package/src/sdk/aavev3.ts +38 -37
@@ -89,7 +89,7 @@ export function createMCPServer(deps: {
89
89
  }) {
90
90
  const server = new McpServer({
91
91
  name: "CompassApiSDK",
92
- version: "0.1.2",
92
+ version: "0.1.3",
93
93
  });
94
94
 
95
95
  const client = new CompassApiSDKCore({
@@ -119,10 +119,10 @@ export function createMCPServer(deps: {
119
119
  const register = { tool, resource, resourceTemplate, prompt };
120
120
  void register; // suppress unused warnings
121
121
 
122
- tool(tool$aaveV3StdRate);
122
+ tool(tool$aaveV3Rate);
123
123
  tool(tool$aaveV3AvgRate);
124
+ tool(tool$aaveV3StdRate);
124
125
  tool(tool$aaveV3ReserveOverview);
125
- tool(tool$aaveV3Rate);
126
126
  tool(tool$aaveV3TokenPrice);
127
127
  tool(tool$aaveV3LiquidityChange);
128
128
  tool(tool$aaveV3UserPositionSummary);
@@ -12,9 +12,9 @@ const args = {
12
12
 
13
13
  export const tool$aaveV3AvgRate: ToolDefinition<typeof args> = {
14
14
  name: "aave-v3-avg-rate",
15
- description: `Average interest rates
15
+ description: `Interest Rates: time average
16
16
 
17
- Returns time averaged Interest Rates for Aave Reserves.`,
17
+ Provides time-weighted averages of deposit and borrow rates for Aave reserves.`,
18
18
  args,
19
19
  tool: async (client, args, ctx) => {
20
20
  const [result, apiCall] = await aaveV3AvgRate(
@@ -12,7 +12,7 @@ const args = {
12
12
 
13
13
  export const tool$aaveV3Rate: ToolDefinition<typeof args> = {
14
14
  name: "aave-v3-rate",
15
- description: `Interest rates
15
+ description: `Interest Rates: now
16
16
 
17
17
  Returns the latest APY and APR rates for a specified token on Aave, for both
18
18
  deposits and loans.
@@ -12,9 +12,10 @@ const args = {
12
12
 
13
13
  export const tool$aaveV3StdRate: ToolDefinition<typeof args> = {
14
14
  name: "aave-v3-std-rate",
15
- description: `Standard deviation of interest rates
15
+ description: `Interest Rates: standard deviation
16
16
 
17
- Returns the standard deviation of Interest Rates for Aave Reserves over time.`,
17
+ Returns the historical standard deviation of lending and borrowing rates for Aave
18
+ reserves, illustrating market volatility.`,
18
19
  args,
19
20
  tool: async (client, args, ctx) => {
20
21
  const [result, apiCall] = await aaveV3StdRate(
package/src/sdk/aavev3.ts CHANGED
@@ -22,16 +22,29 @@ import { unwrapAsync } from "../types/fp.js";
22
22
 
23
23
  export class AaveV3 extends ClientSDK {
24
24
  /**
25
- * Standard deviation of interest rates
25
+ * Interest Rates: now
26
26
  *
27
27
  * @remarks
28
- * Returns the standard deviation of Interest Rates for Aave Reserves over time.
28
+ * Returns the latest APY and APR rates for a specified token on Aave, for both
29
+ * deposits and loans.
30
+ *
31
+ * **Annual percentage yield (APY)** is the yearly return/cost after continuous
32
+ * compounding of the per-second rate stored on-chain. This value is the same value as
33
+ * seen the on [app.aave.com](
34
+ * https://app.aave.com/)
35
+ * but more up-to-date as it is taken directly from the
36
+ * blockchain every time this endpoint is called.
37
+ *
38
+ * **Annual percentage rate (APR)** is the yearly simple interest rate (no
39
+ * compounding).
40
+ *
41
+ * For APY/APR on loans Aave offers both stable and fixed rates on certain tokens.
29
42
  */
30
- async stdRate(
31
- request: operations.AaveStdRateRequest,
43
+ async rate(
44
+ request: operations.AaveRateRequest,
32
45
  options?: RequestOptions,
33
- ): Promise<components.AaveSTDRateResponse> {
34
- return unwrapAsync(aaveV3StdRate(
46
+ ): Promise<components.AaveRateResponse> {
47
+ return unwrapAsync(aaveV3Rate(
35
48
  this,
36
49
  request,
37
50
  options,
@@ -39,10 +52,10 @@ export class AaveV3 extends ClientSDK {
39
52
  }
40
53
 
41
54
  /**
42
- * Average interest rates
55
+ * Interest Rates: time average
43
56
  *
44
57
  * @remarks
45
- * Returns time averaged Interest Rates for Aave Reserves.
58
+ * Provides time-weighted averages of deposit and borrow rates for Aave reserves.
46
59
  */
47
60
  async avgRate(
48
61
  request: operations.AaveAvgRateRequest,
@@ -56,21 +69,17 @@ export class AaveV3 extends ClientSDK {
56
69
  }
57
70
 
58
71
  /**
59
- * Reserve overview
72
+ * Interest Rates: standard deviation
60
73
  *
61
74
  * @remarks
62
- * Returns key metrics for Aave Reserves:
63
- * - Total Supplied (TVL) in USD
64
- * - Total Borrowed in USD
65
- * - Utilization Ratio
66
- *
67
- * See below for more info:
75
+ * Returns the historical standard deviation of lending and borrowing rates for Aave
76
+ * reserves, illustrating market volatility.
68
77
  */
69
- async reserveOverview(
70
- request: operations.AaveReserveOverviewRequest,
78
+ async stdRate(
79
+ request: operations.AaveStdRateRequest,
71
80
  options?: RequestOptions,
72
- ): Promise<components.AaveReserveOverviewResponse> {
73
- return unwrapAsync(aaveV3ReserveOverview(
81
+ ): Promise<components.AaveSTDRateResponse> {
82
+ return unwrapAsync(aaveV3StdRate(
74
83
  this,
75
84
  request,
76
85
  options,
@@ -78,29 +87,21 @@ export class AaveV3 extends ClientSDK {
78
87
  }
79
88
 
80
89
  /**
81
- * Interest rates
90
+ * Reserve overview
82
91
  *
83
92
  * @remarks
84
- * Returns the latest APY and APR rates for a specified token on Aave, for both
85
- * deposits and loans.
86
- *
87
- * **Annual percentage yield (APY)** is the yearly return/cost after continuous
88
- * compounding of the per-second rate stored on-chain. This value is the same value as
89
- * seen the on [app.aave.com](
90
- * https://app.aave.com/)
91
- * but more up-to-date as it is taken directly from the
92
- * blockchain every time this endpoint is called.
93
- *
94
- * **Annual percentage rate (APR)** is the yearly simple interest rate (no
95
- * compounding).
93
+ * Returns key metrics for Aave Reserves:
94
+ * - Total Supplied (TVL) in USD
95
+ * - Total Borrowed in USD
96
+ * - Utilization Ratio
96
97
  *
97
- * For APY/APR on loans Aave offers both stable and fixed rates on certain tokens.
98
+ * See below for more info:
98
99
  */
99
- async rate(
100
- request: operations.AaveRateRequest,
100
+ async reserveOverview(
101
+ request: operations.AaveReserveOverviewRequest,
101
102
  options?: RequestOptions,
102
- ): Promise<components.AaveRateResponse> {
103
- return unwrapAsync(aaveV3Rate(
103
+ ): Promise<components.AaveReserveOverviewResponse> {
104
+ return unwrapAsync(aaveV3ReserveOverview(
104
105
  this,
105
106
  request,
106
107
  options,