@curator-studio/sdk 0.1.0

package/dist/strategy.d.ts

@@ -0,0 +1,81 @@
+import { type Address, type WalletClient, type PublicClient } from "viem";
+export type Allocation = {
+    recipient: Address;
+    weight: bigint;
+    label?: string;
+};
+/**
+ * Strategy configuration for creation
+ * Note: Fee is handled as the first allocation by convention
+ */
+export type StrategyConfig = {
+    owner: Address;
+    sourceStrategy: Address;
+    allocations: Allocation[];
+    metadataURI: string;
+    ensLabel: string;
+};
+/**
+ * Strategy data returned from contract
+ * Note: Fee is calculated from first allocation
+ */
+export type StrategyData = {
+    owner: Address;
+    sourceStrategy: Address;
+    allocations: Allocation[];
+    totalWeight: bigint;
+    metadataURI: string;
+};
+type ChainDeployments = {
+    Strategy: {
+        abi: unknown;
+    };
+    StrategyFactory: {
+        abi: unknown;
+        address: string;
+    };
+};
+export declare function createStrategyMethods(wallet: WalletClient | undefined, publicClient: PublicClient, deployments: ChainDeployments): {
+    /**
+     * Create a new strategy with optional ENS subdomain
+     * @param config Strategy configuration
+     * @param label ENS subdomain label (e.g., "mystrategy") - pass "" or omit to skip ENS
+     */
+    create: (config: StrategyConfig) => Promise<{
+        strategy: Address;
+        config: StrategyConfig;
+    }>;
+    /**
+     * Get strategy data including owner, allocations, and metadata
+     * Note: Fee is the first allocation by convention
+     */
+    getData: (strategyAddress: Address) => Promise<StrategyData>;
+    /**
+     * Get the balance of a token held by the strategy
+     */
+    balanceOf: (strategyAddress: Address, token: Address) => Promise<bigint>;
+    /**
+     * Update the allocation configuration and metadata (owner only)
+     */
+    rebalance: (strategyAddress: Address, allocations: Allocation[], metadataURI: string) => Promise<{
+        hash: `0x${string}`;
+    }>;
+    /**
+     * Distribute the strategy's token balance to recipients according to allocations
+     */
+    distribute: (strategyAddress: Address, token: Address) => Promise<{
+        hash: `0x${string}`;
+    }>;
+    /**
+     * Set ENS subdomain name for an existing strategy
+     * @param strategyAddress The strategy address to set ENS name for
+     * @param label ENS subdomain label (e.g., "mystrategy")
+     * @dev Automatically handles two cases:
+     *   1. If factory doesn't own the name: registers it via ENS registrar
+     *   2. If factory owns the name: connects pre-registered name
+     */
+    setENSName: (strategyAddress: Address, label: string) => Promise<{
+        hash: `0x${string}`;
+    }>;
+};
+export {};

package/dist/tokens.d.ts

@@ -0,0 +1,34 @@
+import { type Address } from "viem";
+export type TokenConfig = {
+    address: Address;
+    symbol: string;
+    name: string;
+    decimals: number;
+    logoURI?: string;
+};
+/**
+ * Native ETH address per ERC-7528 standard
+ * Used throughout the system to represent native ETH
+ */
+export declare const NATIVE_TOKEN = "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE";
+export declare const isNativeToken: (token?: string) => boolean;
+/**
+ * Native ETH token config
+ */
+export declare const ETH_TOKEN: TokenConfig;
+/**
+ * Get all available tokens for a chain
+ */
+export declare function getTokens(chainId: number): TokenConfig[];
+/**
+ * Get a token by symbol for a chain
+ */
+export declare function getToken(chainId: number, symbol: string): TokenConfig | undefined;
+/**
+ * Get a token by address for a chain
+ */
+export declare function getTokenByAddress(chainId: number, address: Address): TokenConfig | undefined;
+/**
+ * Get token addresses for a chain (useful for indexer)
+ */
+export declare function getTokenAddresses(chainId: number): Address[];

package/dist/vaults.d.ts

@@ -0,0 +1,19 @@
+import { type Address } from "viem";
+export type VaultConfig = {
+    address: Address;
+    name: string;
+    symbol: string;
+    asset: Address;
+};
+/**
+ * Get all available vaults for a chain
+ */
+export declare function getVaults(chainId: number): VaultConfig[];
+/**
+ * Get a vault by address for a chain
+ */
+export declare function getVaultByAddress(chainId: number, address: Address): VaultConfig | undefined;
+/**
+ * Get vault addresses for a chain
+ */
+export declare function getVaultAddresses(chainId: number): Address[];

package/dist/warehouse.d.ts

@@ -0,0 +1,24 @@
+import { type Address, type WalletClient, type PublicClient } from "viem";
+import { type SupportedChainId } from "./config";
+type ChainDeployments = {
+    SplitsWarehouse: {
+        abi: unknown;
+    };
+};
+export declare function createWarehouseMethods(wallet: WalletClient | undefined, publicClient: PublicClient, chainId: SupportedChainId, deployments: ChainDeployments): {
+    /**
+     * Withdraw tokens from the SplitsWarehouse
+     * @param owner Address to withdraw for (usually msg.sender)
+     * @param token Token address to withdraw
+     */
+    withdraw: (owner: Address, token: Address) => Promise<{
+        hash: `0x${string}`;
+    }>;
+    /**
+     * Get warehouse balance for a user/token
+     * @param owner Address to check balance for
+     * @param token Token address
+     */
+    balanceOf: (owner: Address, token: Address) => Promise<bigint>;
+};
+export {};

package/dist/yield-redirector.d.ts

@@ -0,0 +1,68 @@
+import { type Address, type WalletClient, type PublicClient } from "viem";
+type ChainDeployments = {
+    YieldRedirectorFactory: {
+        abi: unknown;
+        address: string;
+    };
+    YieldRedirector4626: {
+        abi: unknown;
+    };
+};
+export declare function createYieldRedirectorMethods(wallet: WalletClient | undefined, publicClient: PublicClient, deployments: ChainDeployments): {
+    /**
+     * Create a new yield redirector
+     * @param sourceVault ERC-4626 vault address that generates yield
+     * @param yieldRecipient Address to receive harvested yield (typically a Strategy)
+     * @param owner Address that can update yield recipient
+     */
+    create: (sourceVault: Address, yieldRecipient: Address, owner: Address) => Promise<{
+        redirector: Address;
+        sourceVault: Address;
+        yieldRecipient: Address;
+        owner: Address;
+    }>;
+    /**
+     * Create a new yield redirector with deterministic address
+     * @param sourceVault ERC-4626 vault address that generates yield
+     * @param yieldRecipient Address to receive harvested yield (typically a Strategy)
+     * @param owner Address that can update yield recipient
+     * @param salt Bytes32 salt for deterministic address generation
+     */
+    createDeterministic: (sourceVault: Address, yieldRecipient: Address, owner: Address, salt: `0x${string}`) => Promise<{
+        redirector: Address;
+        sourceVault: Address;
+        yieldRecipient: Address;
+        owner: Address;
+    }>;
+    /**
+     * Harvest yield from a redirector and send to recipient
+     * @param redirectorAddress The yield redirector contract address
+     */
+    harvest: (redirectorAddress: Address) => Promise<{
+        hash: `0x${string}`;
+    }>;
+    /**
+     * Get the current surplus (harvestable yield) from a redirector
+     * @param redirectorAddress The yield redirector contract address
+     */
+    surplus: (redirectorAddress: Address) => Promise<bigint>;
+    /**
+     * Get the principal deposited in a redirector
+     * @param redirectorAddress The yield redirector contract address
+     */
+    principal: (redirectorAddress: Address) => Promise<bigint>;
+    /**
+     * Get the total value in the source vault (principal + yield)
+     * @param redirectorAddress The yield redirector contract address
+     */
+    sourceVaultValue: (redirectorAddress: Address) => Promise<bigint>;
+    /**
+     * Update the yield recipient (owner only)
+     * @param redirectorAddress The yield redirector contract address
+     * @param newRecipient New address to receive harvested yield
+     */
+    setYieldRecipient: (redirectorAddress: Address, newRecipient: Address) => Promise<{
+        hash: `0x${string}`;
+    }>;
+};
+export {};

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@curator-studio/sdk",
+  "version": "0.1.0",
+  "type": "module",
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "types": "./dist/index.d.ts",
+  "dependencies": {
+    "@ensdomains/ensjs": "^4.2.2",
+    "@urql/core": "^6.0.1",
+    "@vercel/blob": "^2.2.0",
+    "@curator-studio/contracts": "1.0.0"
+  },
+  "peerDependencies": {
+    "@tanstack/react-query": ">=5.0.0",
+    "react": "^19.2.4",
+    "sonner": ">=1.0.0",
+    "typescript": ">=4.5.0",
+    "viem": "^2.45.1",
+    "wagmi": ">=2.0.0"
+  },
+  "devDependencies": {
+    "@types/react": "^19.2.13",
+    "@types/react-dom": "^19.2.3",
+    "tsup": "^8.5.1",
+    "vitest": "^4.0.18"
+  },
+  "scripts": {
+    "build": "tsup src/index.ts --format esm --dts",
+    "dev": "tsup src/index.ts --watch --format esm --dts",
+    "check-types": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  }
+}