@vaultsfyi/sdk 1.0.0 → 1.0.2

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @vaultsfyi/sdk
+
+## 1.0.1
+
+### Patch Changes
+
+- 48146a0: add README.md

package/README.md

@@ -0,0 +1,76 @@
+# `@vaultsfyi/sdk`
+An SDK for interacting with the VaultsFYI API.
+
+## Installation
+
+```bash
+npm install @vaultsfyi/sdk
+# or
+pnpm add @vaultsfyi/sdk
+# or
+yarn add @vaultsfyi/sdk
+```
+
+## Usage
+
+```javascript
+// Import the SDK
+import { VaultsSdk } from "@vaultsfyi/sdk";
+
+// Initialize the SDK with your API key
+const sdk = new VaultsSdk({ apiKey: "your-api-key" })
+
+// Example usage: get all vaults
+async function main() {
+  const vaults = await sdk.getAllVaults()
+  console.log(vaults)
+}
+
+main()
+```
+
+## Available Methods
+
+```typescript
+// Get information about all vaults
+getAllVaults(params?: Params<'/v1/detailed/vaults'>)
+
+// Get information about a specific vault
+getVault(params: { path: { network: string, vaultAddress: string } })
+
+// Get APY information for a vault
+getVaultApy(params: { path: { network: string, vaultAddress: string } })
+
+// Get historical data for a vault
+getHistoricalData(params: { path: { network: string, vaultAddress: string } })
+
+// Get holder events for a specific address
+getVaultHolderEvents(params: { path: { network: string, vaultAddress: string, holder: string } })
+
+// Get total returns for a specific holder
+getVaultTotalReturns(params: { path: { network: string, vaultAddress: string, holder: string } })
+
+// Get best deposit options for a user
+bestDepositOption(params: { path: { userAddress: string } })
+
+// Get wallet balances
+getWalletBalances(params)
+
+// Get all positions for a user
+getAllPositions(params: { path: { userAddress: string } })
+
+// Get benchmarks
+getBenchmarks()
+```
+
+## Configuration
+
+You can override the default API URL:
+
+```javascript
+const sdk = new VaultsSdk(
+  { apiKey: "your-api-key" }, 
+  { apiBaseUrl: "https://custom-api.example.com" }
+)
+```
+