Token Unlocks API SDK w/ examples (#13)

* Added token unlocks APIs to SDK w/ examples

* Removed unnecessary impoprt

* Removed unused types

Author: mmnavarr

packages/api/src/client/base.ts

@@ -45,6 +45,16 @@ import type {
   Investors,
   getAcquisitionDealsParameters,
   AcquisitionDeal,
+  getTokenUnlockSupportedAssetsParameters,
+  getTokenUnlockSupportedAssetsResponse,
+  getTokenUnlockAllocationsParameters,
+  getTokenUnlockAllocationsResponse,
+  getTokenUnlockVestingScheduleParameters,
+  getTokenUnlockVestingScheduleResponse,
+  getTokenUnlocksParameters,
+  getTokenUnlocksResponse,
+  getTokenUnlockEventsParameters,
+  getTokenUnlockEventsResponse,
 } from "@messari-kit/types";
 import { LogLevel, type Logger, makeConsoleLogger, createFilteredLogger, noOpLogger } from "../logging";
 import type { PaginatedResult, RequestOptions, ClientEventMap, ClientEventType, ClientEventHandler } from "./types";
@@ -279,6 +289,17 @@ export interface FundraisingAPIInterface {
   getAcquisitionDeals(params?: getAcquisitionDealsParameters): Promise<APIResponseWithMetadata<AcquisitionDeal[]>>;
 }
 
+/**
+ * Interface for the Token Unlocks API methods
+ */
+export interface TokenUnlocksInterface {
+  getSupportedAssets(params?: getTokenUnlockSupportedAssetsParameters, options?: RequestOptions): Promise<getTokenUnlockSupportedAssetsResponse>;
+  getAllocations(params?: getTokenUnlockAllocationsParameters, options?: RequestOptions): Promise<getTokenUnlockAllocationsResponse>;
+  getVestingSchedule(params: getTokenUnlockVestingScheduleParameters, options?: RequestOptions): Promise<getTokenUnlockVestingScheduleResponse>;
+  getUnlocks(params: getTokenUnlocksParameters, options?: RequestOptions): Promise<getTokenUnlocksResponse>;
+  getEvents(params: getTokenUnlockEventsParameters, options?: RequestOptions): Promise<getTokenUnlockEventsResponse>;
+}
+
 /**
  * Abstract base class for the Messari client
  * Defines the structure and common functionality that all client implementations must provide
@@ -314,6 +335,11 @@ export abstract class MessariClientBase {
    */
   public abstract readonly research: ResearchInterface;
 
+  /**
+   * Interface for Token Unlocks-related API methods
+   */
+  public abstract readonly tokenUnlocks: TokenUnlocksInterface;
+
   /**
    * Logger instance for the client
    */

packages/api/src/client/client.ts

@@ -24,6 +24,11 @@ import {
   getFundingRounds,
   getFundingRoundsInvestors,
   getAcquisitionDeals,
+  getTokenUnlockAllocations,
+  getTokenUnlockEvents,
+  getTokenUnlockSupportedAssets,
+  getTokenUnlocks,
+  getTokenUnlockVestingSchedule,
 } from "@messari-kit/types";
 import type {
   createChatCompletionParameters,
@@ -72,6 +77,16 @@ import type {
   getFundingRoundsInvestorsResponse,
   getAcquisitionDealsParameters,
   getAcquisitionDealsResponse,
+  getTokenUnlockAllocationsParameters,
+  getTokenUnlockAllocationsResponse,
+  getTokenUnlockEventsParameters,
+  getTokenUnlockEventsResponse,
+  getTokenUnlockSupportedAssetsParameters,
+  getTokenUnlockSupportedAssetsResponse,
+  getTokenUnlocksParameters,
+  getTokenUnlocksResponse,
+  getTokenUnlockVestingScheduleParameters,
+  getTokenUnlockVestingScheduleResponse,
 } from "@messari-kit/types";
 import type { Agent } from "node:http";
 import { pick } from "../utils";
@@ -98,6 +113,7 @@ import type {
   NewsInterface,
   RecapsAPIInterface,
   ResearchInterface,
+  TokenUnlocksInterface,
 } from "./base";
 import { MessariClientBase } from "./base";
 
@@ -810,4 +826,51 @@ export class MessariClient extends MessariClientBase {
       });
     },
   };
+
+  public readonly tokenUnlocks: TokenUnlocksInterface = {
+    getSupportedAssets: async (params: getTokenUnlockSupportedAssetsParameters = {}, options?: RequestOptions) => {
+      return this.request<getTokenUnlockSupportedAssetsResponse>({
+        method: getTokenUnlockSupportedAssets.method,
+        path: getTokenUnlockSupportedAssets.path(),
+        queryParams: pick(params, getTokenUnlockSupportedAssets.queryParams),
+        options,
+      });
+    },
+
+    getAllocations: async (params: getTokenUnlockAllocationsParameters = {}, options?: RequestOptions) => {
+      return this.request<getTokenUnlockAllocationsResponse>({
+        method: getTokenUnlockAllocations.method,
+        path: getTokenUnlockAllocations.path(),
+        queryParams: pick(params, getTokenUnlockAllocations.queryParams),
+        options,
+      });
+    },
+
+    getVestingSchedule: async (params: getTokenUnlockVestingScheduleParameters, options?: RequestOptions) => {
+      return this.request<getTokenUnlockVestingScheduleResponse>({
+        method: getTokenUnlockVestingSchedule.method,
+        path: getTokenUnlockVestingSchedule.path(params),
+        queryParams: pick(params, getTokenUnlockVestingSchedule.queryParams),
+        options,
+      });
+    },
+
+    getUnlocks: async (params: getTokenUnlocksParameters, options?: RequestOptions) => {
+      return this.request<getTokenUnlocksResponse>({
+        method: getTokenUnlocks.method,
+        path: getTokenUnlocks.path(params),
+        queryParams: pick(params, getTokenUnlocks.queryParams),
+        options,
+      });
+    },
+
+    getEvents: async (params: getTokenUnlockEventsParameters, options?: RequestOptions) => {
+      return this.request<getTokenUnlockEventsResponse>({
+        method: getTokenUnlockEvents.method,
+        path: getTokenUnlockEvents.path(params),
+        queryParams: pick(params, getTokenUnlockEvents.queryParams),
+        options,
+      });
+    },
+  };
 }

packages/examples/package.json

@@ -8,14 +8,15 @@
 		"clean": "rimraf dist",
 		"start": "tsx src/index.ts",
 		"start:asset": "tsx src/asset.ts",
-		"start:intel": "tsx src/intelEvents.ts",
-		"start:news": "tsx src/newsFeed.ts",
 		"start:chat": "tsx src/chatCompletion.ts",
+		"start:diligence": "tsx src/diligence.ts",
+		"start:fundraising": "tsx src/fundraising.ts",
+		"start:intel": "tsx src/intelEvents.ts",
 		"start:marketdata": "tsx src/marketData.ts",
+		"start:news": "tsx src/newsFeed.ts",
 		"start:recaps": "tsx src/recaps.ts",
-		"start:diligence": "tsx src/diligence.ts",
 		"start:research": "tsx src/research.ts",
-		"start:fundraising": "tsx src/fundraising.ts"
+		"start:token-unlocks": "tsx src/tokenUnlocks.ts"
 	},
 	"dependencies": {
 		"@messari-kit/api": "workspace:*",