@vaultsfyi/sdk 1.0.0

package/.turbo/turbo-lint$colon$fix.log

@@ -0,0 +1,5 @@
+
+> @vaultsfyi/sdk@0.0.1 lint:fix /Users/pawel/Documents/code/vaultsfyi/packages/sdk
+> biome check . --write
+
+Checked 8 files in 22ms. No fixes applied.

package/.turbo/turbo-lint.log

@@ -0,0 +1,9 @@
+
+> @vaultsfyi/sdk@0.0.1 lint /Users/pawel/Documents/code/vaultsfyi/packages/sdk
+> pnpm typecheck && biome check .
+
+
+> @vaultsfyi/sdk@0.0.1 typecheck /Users/pawel/Documents/code/vaultsfyi/packages/sdk
+> tsc --noEmit
+
+Checked 8 files in 24ms. No fixes applied.

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "@vaultsfyi/sdk",
+  "version": "1.0.0",
+  "description": "An SDK for interacting with the Vaults.fyi API",
+  "exports": {
+    ".": "./src/client.ts"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "1.9.4",
+    "openapi-typescript": "^7.4.1",
+    "vitest": "2.1.1",
+    "typescript": "5.5.4"
+  },
+  "scripts": {
+    "updateOpenApiSchema": "openapi-typescript http://localhost:3001/v1/documentation/json -o ./src/types/openapi.ts && biome check ./src/types/openapi.ts --write",
+    "typecheck": "tsc --noEmit",
+    "lint": "pnpm typecheck && biome check .",
+    "lint:fix": "biome check . --write"
+  }
+}

package/src/client.ts

@@ -0,0 +1,155 @@
+import { HttpResponseError } from './errors'
+import type { paths } from './types/openapi'
+import { generateQueryParams } from './utils/generateQueryParams'
+
+export interface ConstructorOptions {
+  apiKey: string
+}
+
+export interface InternalOptions {
+  apiBaseUrl: string
+}
+
+type Endpoint = keyof paths
+
+type ExtractResponse<T> = T extends { responses: { 200: { content: { 'application/json': infer R } } } } ? R : never
+type Response<T extends Endpoint> = ExtractResponse<paths[T]['get' | 'post']>
+
+type ExtractParams<T> = T extends { parameters: infer P extends { path?: any; query?: any } }
+  ? Pick<P, 'path' | 'query'>
+  : never
+type Body<T extends Endpoint> = paths[T]['post'] extends {
+  requestBody: { content: { 'application/json': infer R } }
+}
+  ? { body: R }
+  : paths[T]['post'] extends {
+        requestBody?: { content: { 'application/json': infer R } }
+      }
+    ? { body?: R }
+    : undefined
+
+type Params<T extends Endpoint> = Body<T> extends undefined
+  ? ExtractParams<paths[T]['get' | 'post']>
+  : ExtractParams<paths[T]['get' | 'post']> & Body<T>
+
+type ActionEndpoint =
+  | '/v1/transactions/vaults/deposit'
+  | '/v1/transactions/vaults/redeem'
+  | '/v1/transactions/vaults/request-redeem'
+  | '/v1/transactions/vaults/claim-redeem'
+
+export class VaultsSdk {
+  private apiBaseUrl: string
+  private apiKey: string
+
+  constructor(options: ConstructorOptions)
+  constructor(options: ConstructorOptions, internalOptions: InternalOptions)
+  constructor(options: ConstructorOptions, internalOptions?: InternalOptions) {
+    this.apiKey = options.apiKey
+    this.apiBaseUrl = internalOptions?.apiBaseUrl ?? 'https://api.vaults.fyi'
+  }
+
+  private async fetchData<T extends Endpoint>(
+    endpoint: string,
+    params?: Params<T>,
+    method: 'POST' | 'GET' = 'GET'
+  ): Promise<Response<T>> {
+    const queryParams = generateQueryParams(params?.query)
+
+    const body = (params as Body<T>)?.body
+    const stringifiedBody = body ? JSON.stringify(body) : undefined
+
+    const response = await fetch(`${this.apiBaseUrl}${endpoint}${queryParams}`, {
+      method,
+      headers: {
+        'Content-Type': 'application/json',
+        'x-api-key': this.apiKey,
+      },
+      body: stringifiedBody,
+    })
+
+    if (!response.ok) {
+      const error = await response.json()
+      throw new HttpResponseError(error.message)
+    }
+
+    return response.json()
+  }
+
+  async bestDepositOption(params: Params<'/v1/portfolio/best-deposit-options/{userAddress}'>) {
+    const { userAddress } = params.path
+    return await this.fetchData<'/v1/portfolio/best-deposit-options/{userAddress}'>(
+      `/v1/portfolio/best-deposit-options/${userAddress}`,
+      params,
+      'POST'
+    )
+  }
+
+  async getVault(params: Params<'/v1/vaults/{network}/{vaultAddress}/'>) {
+    const { network, vaultAddress } = params.path
+    return await this.fetchData<'/v1/vaults/{network}/{vaultAddress}/'>(
+      `/v1/vaults/${network}/${vaultAddress}/`,
+      params
+    )
+  }
+
+  async getVaultHolderEvents(params: Params<'/v1/vaults/{network}/{vaultAddress}/holder-events/{holder}'>) {
+    const { network, vaultAddress, holder } = params.path
+    return await this.fetchData<'/v1/vaults/{network}/{vaultAddress}/holder-events/{holder}'>(
+      `/v1/vaults/${network}/${vaultAddress}/holder-events/${holder}`,
+      params
+    )
+  }
+
+  async getVaultTotalReturns(params: Params<'/v1/vaults/{network}/{vaultAddress}/holder-total-returns/{holder}'>) {
+    const { network, vaultAddress, holder } = params.path
+    return await this.fetchData<'/v1/vaults/{network}/{vaultAddress}/holder-total-returns/{holder}'>(
+      `/v1/vaults/${network}/${vaultAddress}/holder-total-returns/${holder}`,
+      params
+    )
+  }
+
+  async getAllVaults(params?: Params<'/v1/detailed/vaults'>) {
+    return await this.fetchData<'/v1/detailed/vaults'>('/v1/detailed/vaults', params)
+  }
+
+  async getVaultApy(params: Params<'/v1/vaults/{network}/{vaultAddress}/apy'>) {
+    const { network, vaultAddress } = params.path
+    return await this.fetchData<'/v1/vaults/{network}/{vaultAddress}/apy'>(
+      `/v1/vaults/${network}/${vaultAddress}/apy`,
+      params
+    )
+  }
+
+  async getHistoricalData(params: Params<'/v1/vaults/{network}/{vaultAddress}/historical-data'>) {
+    const { network, vaultAddress } = params.path
+    return await this.fetchData<'/v1/vaults/{network}/{vaultAddress}/historical-data'>(
+      `/v1/vaults/${network}/${vaultAddress}/historical-data`,
+      params
+    )
+  }
+
+  async getActionsDetails(params: Params<'/v1/transactions/vaults/actions/details'>) {
+    return await this.fetchData<'/v1/transactions/vaults/actions/details'>(
+      '/v1/transactions/vaults/actions/details',
+      params
+    )
+  }
+
+  async getWalletBalances(params: Params<'/v1/portfolio/wallet-balances'>) {
+    return await this.fetchData<'/v1/portfolio/wallet-balances'>('/v1/transactions/wallet-balances', params)
+  }
+
+  async getAllPositions(params: Params<'/v1/portfolio/positions/{userAddress}'>) {
+    const { userAddress } = params.path
+    return await this.fetchData<'/v1/portfolio/positions/{userAddress}'>(`/v1/transactions/positions/${userAddress}`)
+  }
+
+  async getActions(endpoint: (ActionEndpoint | string) & {}, params: Params<ActionEndpoint>) {
+    return await this.fetchData<ActionEndpoint>(endpoint, params)
+  }
+
+  async getBenchmarks() {
+    return await this.fetchData<'/v1/benchmarks'>('/v1/benchmarks')
+  }
+}

package/src/errors.ts

@@ -0,0 +1 @@
+export class HttpResponseError extends Error {}