@carrot-protocol/boost-http-client 0.4.8 → 0.5.0-bank-token-apy-timeseries-dev-4a1c04c

package/dist/charting/bank/index.d.ts

@@ -1,9 +1,8 @@
 import { web3 } from "@coral-xyz/anchor";
-import { ApyResponse } from "./types";
-import { DateRangeOptions } from "../../types";
+import { ChartingOptions, GetBankApysResponse } from "../../types";
 import { ApiClient } from "../../api";
 export declare class BankChartingExtension extends ApiClient {
-    private readonly bank;
-    constructor(baseUrl: string, bank: web3.PublicKey);
-    getApy(options?: DateRangeOptions): Promise<ApyResponse[]>;
+    private readonly banks;
+    constructor(baseUrl: string, banks: web3.PublicKey[]);
+    getApy(options?: ChartingOptions): Promise<GetBankApysResponse>;
 }

package/dist/charting/bank/index.js

@@ -1,26 +1,36 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BankChartingExtension = void 0;
+const anchor_1 = require("@coral-xyz/anchor");
 const api_1 = require("../../api");
 class BankChartingExtension extends api_1.ApiClient {
-    constructor(baseUrl, bank) {
+    constructor(baseUrl, banks) {
         super(baseUrl);
-        this.bank = bank;
+        this.banks = banks;
     }
     async getApy(options = {}) {
-        const { fromTime, toTime } = options;
+        const { fromTime, toTime, aggregationMethod } = options;
         const body = await this.handleApiCall(() => this.http.get(`/bank/apys`, {
             params: {
-                bank: this.bank.toString(),
+                banks: this.banks.map((b) => b.toString()).join(","),
                 fromTime: fromTime?.toISOString(),
                 toTime: toTime?.toISOString(),
+                aggregationMethod,
             },
         }));
-        const response = JSON.parse(body).map((apy) => ({
-            time: new Date(apy.time),
-            assetApy: Number(apy.supply_apy),
-            liabilityApy: Number(apy.borrow_apy),
-        }));
+        const jsonResponse = JSON.parse(body);
+        const response = {
+            banks: jsonResponse.banks.map((bankData) => ({
+                bank: new anchor_1.web3.PublicKey(bankData.bank),
+                mint: new anchor_1.web3.PublicKey(bankData.mint),
+                timeseries: bankData.timeseries.map((ts) => ({
+                    time: new Date(ts.time),
+                    supplyApy: Number(ts.supplyApy),
+                    borrowApy: Number(ts.borrowApy),
+                    utilizationRate: Number(ts.utilizationRate),
+                })),
+            })),
+        };
         return response;
     }
 }

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { AnchorProvider, web3 } from "@coral-xyz/anchor";
-import { GetBankResponse, GetUserResponse, GetGroupResponse, GetUserRequest, GetGroupsResponse, GetAccountResponse, GetAccountRequest, GetWalletBalancesRequest, GetWalletBalancesResponse } from "./types";
+import { GetBankResponse, GetUserResponse, GetGroupResponse, GetUserRequest, GetGroupsResponse, GetAccountResponse, GetAccountRequest, GetWalletBalancesRequest, GetWalletBalancesResponse, GetTokenApysRequest, GetTokenApysResponse } from "./types";
 import { ApiClient } from "./api";
 import { PositionChartingExtension } from "./charting/position";
 import { BankChartingExtension } from "./charting/bank";
@@ -87,8 +87,12 @@ export declare class Client extends ApiClient {
      * @returns Wallet balances grouped by group with timeseries data
      */
     getWalletBalances(request?: GetWalletBalancesRequest): Promise<GetWalletBalancesResponse>;
+    /**
+     * Get token yield APY timeseries for one or more mints
+     */
+    getTokenApys(request: GetTokenApysRequest): Promise<GetTokenApysResponse>;
     getPerformanceChartingExtension(clendAccount: web3.PublicKey): Promise<PositionChartingExtension>;
     getGroupChartingExtension(group: web3.PublicKey): Promise<GroupChartingExtension>;
     getWalletChartingExtension(address?: web3.PublicKey): Promise<WalletChartingExtension>;
-    getBankChartingExtension(bank: web3.PublicKey): Promise<BankChartingExtension>;
+    getBankChartingExtension(banks: web3.PublicKey[]): Promise<BankChartingExtension>;
 }

package/dist/index.js

@@ -507,6 +507,31 @@ class Client extends api_1.ApiClient {
         };
         return response;
     }
+    /**
+     * Get token yield APY timeseries for one or more mints
+     */
+    async getTokenApys(request) {
+        const { mints, fromTime, toTime, aggregationMethod } = request;
+        const body = await this.handleApiCall(() => this.http.get(`/token/apys`, {
+            params: {
+                mints: mints.map((m) => m.toString()).join(","),
+                fromTime: fromTime?.toISOString(),
+                toTime: toTime?.toISOString(),
+                aggregationMethod,
+            },
+        }));
+        const jsonResponse = JSON.parse(body);
+        const response = {
+            tokens: jsonResponse.tokens.map((tokenData) => ({
+                mint: new anchor_1.web3.PublicKey(tokenData.mint),
+                timeseries: tokenData.timeseries.map((ts) => ({
+                    time: new Date(ts.time),
+                    apy: Number(ts.apy),
+                })),
+            })),
+        };
+        return response;
+    }
     async getPerformanceChartingExtension(clendAccount) {
         return new position_1.PositionChartingExtension(this.baseUrl, clendAccount);
     }
@@ -516,8 +541,8 @@ class Client extends api_1.ApiClient {
     async getWalletChartingExtension(address) {
         return new wallet_1.WalletChartingExtension(this.baseUrl, address ?? this.address());
     }
-    async getBankChartingExtension(bank) {
-        return new bank_1.BankChartingExtension(this.baseUrl, bank);
+    async getBankChartingExtension(banks) {
+        return new bank_1.BankChartingExtension(this.baseUrl, banks);
     }
 }
 exports.Client = Client;

package/dist/types.d.ts

@@ -321,3 +321,40 @@ export interface GroupWalletBalances {
 export interface GetWalletBalancesResponse {
     groups: GroupWalletBalances[];
 }
+export interface GetBankApysRequest {
+    banks: web3.PublicKey[];
+    fromTime?: Date;
+    toTime?: Date;
+    aggregationMethod?: AggregationMethod;
+}
+export interface BankApyTimeseries {
+    time: Date;
+    supplyApy: number;
+    borrowApy: number;
+    utilizationRate: number;
+}
+export interface BankApysEntry {
+    bank: web3.PublicKey;
+    mint: web3.PublicKey;
+    timeseries: BankApyTimeseries[];
+}
+export interface GetBankApysResponse {
+    banks: BankApysEntry[];
+}
+export interface GetTokenApysRequest {
+    mints: web3.PublicKey[];
+    fromTime?: Date;
+    toTime?: Date;
+    aggregationMethod?: AggregationMethod;
+}
+export interface TokenApyTimeseries {
+    time: Date;
+    apy: number;
+}
+export interface TokenApysEntry {
+    mint: web3.PublicKey;
+    timeseries: TokenApyTimeseries[];
+}
+export interface GetTokenApysResponse {
+    tokens: TokenApysEntry[];
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@carrot-protocol/boost-http-client",
-  "version": "0.4.8",
+  "version": "0.5.0-bank-token-apy-timeseries-dev-4a1c04c",
   "description": "HTTP client for Carrot Boost",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/charting/bank/index.ts

@@ -1,35 +1,54 @@
 import { web3 } from "@coral-xyz/anchor";
-import { ApyResponse } from "./types";
-import { DateRangeOptions } from "../../types";
+import {
+  ChartingOptions,
+  GetBankApysResponse,
+  BankApysEntry,
+  BankApyTimeseries,
+} from "../../types";
 import { ApiClient } from "../../api";
 
 export class BankChartingExtension extends ApiClient {
-  private readonly bank: web3.PublicKey;
+  private readonly banks: web3.PublicKey[];
 
-  constructor(baseUrl: string, bank: web3.PublicKey) {
+  constructor(baseUrl: string, banks: web3.PublicKey[]) {
     super(baseUrl);
-    this.bank = bank;
+    this.banks = banks;
   }
 
-  public async getApy(options: DateRangeOptions = {}): Promise<ApyResponse[]> {
-    const { fromTime, toTime } = options;
+  public async getApy(
+    options: ChartingOptions = {},
+  ): Promise<GetBankApysResponse> {
+    const { fromTime, toTime, aggregationMethod } = options;
     const body = await this.handleApiCall(() =>
       this.http.get(`/bank/apys`, {
         params: {
-          bank: this.bank.toString(),
+          banks: this.banks.map((b) => b.toString()).join(","),
           fromTime: fromTime?.toISOString(),
           toTime: toTime?.toISOString(),
+          aggregationMethod,
         },
       }),
     );
 
-    const response: ApyResponse[] = JSON.parse(body).map(
-      (apy: { time: string; supply_apy: string; borrow_apy: string }) => ({
-        time: new Date(apy.time),
-        assetApy: Number(apy.supply_apy),
-        liabilityApy: Number(apy.borrow_apy),
-      }),
-    );
+    const jsonResponse: any = JSON.parse(body);
+
+    const response: GetBankApysResponse = {
+      banks: jsonResponse.banks.map(
+        (bankData: any): BankApysEntry => ({
+          bank: new web3.PublicKey(bankData.bank),
+          mint: new web3.PublicKey(bankData.mint),
+          timeseries: bankData.timeseries.map(
+            (ts: any): BankApyTimeseries => ({
+              time: new Date(ts.time),
+              supplyApy: Number(ts.supplyApy),
+              borrowApy: Number(ts.borrowApy),
+              utilizationRate: Number(ts.utilizationRate),
+            }),
+          ),
+        }),
+      ),
+    };
+
     return response;
   }
 }

package/src/index.ts

@@ -41,6 +41,10 @@ import {
   GroupWalletBalances,
   WalletBalances,
   WalletBalancesTimeseries,
+  GetTokenApysRequest,
+  GetTokenApysResponse,
+  TokenApysEntry,
+  TokenApyTimeseries,
 } from "./types";
 import encode from "bs58";
 import { ApiClient } from "./api";
@@ -756,6 +760,44 @@ export class Client extends ApiClient {
     return response;
   }
 
+  /**
+   * Get token yield APY timeseries for one or more mints
+   */
+  async getTokenApys(
+    request: GetTokenApysRequest,
+  ): Promise<GetTokenApysResponse> {
+    const { mints, fromTime, toTime, aggregationMethod } = request;
+
+    const body = await this.handleApiCall(() =>
+      this.http.get(`/token/apys`, {
+        params: {
+          mints: mints.map((m) => m.toString()).join(","),
+          fromTime: fromTime?.toISOString(),
+          toTime: toTime?.toISOString(),
+          aggregationMethod,
+        },
+      }),
+    );
+
+    const jsonResponse: any = JSON.parse(body);
+
+    const response: GetTokenApysResponse = {
+      tokens: jsonResponse.tokens.map(
+        (tokenData: any): TokenApysEntry => ({
+          mint: new web3.PublicKey(tokenData.mint),
+          timeseries: tokenData.timeseries.map(
+            (ts: any): TokenApyTimeseries => ({
+              time: new Date(ts.time),
+              apy: Number(ts.apy),
+            }),
+          ),
+        }),
+      ),
+    };
+
+    return response;
+  }
+
   public async getPerformanceChartingExtension(
     clendAccount: web3.PublicKey,
   ): Promise<PositionChartingExtension> {
@@ -775,9 +817,9 @@ export class Client extends ApiClient {
   }
 
   public async getBankChartingExtension(
-    bank: web3.PublicKey,
+    banks: web3.PublicKey[],
   ): Promise<BankChartingExtension> {
-    return new BankChartingExtension(this.baseUrl, bank);
+    return new BankChartingExtension(this.baseUrl, banks);
   }
 }
 

package/src/types.ts

@@ -380,3 +380,50 @@ export interface GroupWalletBalances {
 export interface GetWalletBalancesResponse {
   groups: GroupWalletBalances[];
 }
+
+// Bank APY time-series
+export interface GetBankApysRequest {
+  banks: web3.PublicKey[];
+  fromTime?: Date;
+  toTime?: Date;
+  aggregationMethod?: AggregationMethod;
+}
+
+export interface BankApyTimeseries {
+  time: Date;
+  supplyApy: number;
+  borrowApy: number;
+  utilizationRate: number;
+}
+
+export interface BankApysEntry {
+  bank: web3.PublicKey;
+  mint: web3.PublicKey;
+  timeseries: BankApyTimeseries[];
+}
+
+export interface GetBankApysResponse {
+  banks: BankApysEntry[];
+}
+
+// Token yield APY time-series
+export interface GetTokenApysRequest {
+  mints: web3.PublicKey[];
+  fromTime?: Date;
+  toTime?: Date;
+  aggregationMethod?: AggregationMethod;
+}
+
+export interface TokenApyTimeseries {
+  time: Date;
+  apy: number;
+}
+
+export interface TokenApysEntry {
+  mint: web3.PublicKey;
+  timeseries: TokenApyTimeseries[];
+}
+
+export interface GetTokenApysResponse {
+  tokens: TokenApysEntry[];
+}

package/dist/charting/bank/types.d.ts

@@ -1,5 +0,0 @@
-export interface ApyResponse {
-    time: Date;
-    assetApy: number;
-    liabilityApy: number;
-}

package/dist/charting/bank/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/src/charting/bank/types.ts

@@ -1,5 +0,0 @@
-export interface ApyResponse {
-  time: Date;
-  assetApy: number;
-  liabilityApy: number;
-}