@panoptic-eng/sdk 1.0.1 → 1.0.2

package/README.md

@@ -1,9 +1,139 @@
-# Panoptic SDK
+# @panoptic-eng/sdk
 
-## Installation
+TypeScript SDK for interacting with Panoptic v2 protocol.
 
-```bash
+## Prerequisites
+
+- **Node.js** `>=20.19.0 <23.0.0` (see `.nvmrc` in repo root)
+- **pnpm** package manager
+
+## Setup
+
+### 1. Install Node.js (via nvm)
+
+```sh
+# Install nvm if you don't have it
+curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.1/install.sh | bash
+
+# Restart terminal, then install the correct Node version
+nvm install
+nvm use
+```
+
+### 2. Install pnpm
+
+```sh
+# Option A: via corepack (recommended, built into Node 16.13+)
+corepack enable
+
+# Option B: via npm
+npm install -g pnpm
+```
+
+### 3. Install dependencies
+
+From the monorepo root:
+
+```sh
+pnpm install
 pnpm add @panoptic-eng/sdk react viem wagmi
 ```
 
-> The SDK requires `react`, `viem`, and `wagmi` as peer dependencies (you likely already have these).
+### 4. Generate types
+
+The SDK uses code generation for contract ABIs and GraphQL types:
+
+```sh
+cd packages/sdk
+pnpm codegen
+```
+
+This runs:
+- `codegen:graphql` - Generates TypeScript types from GraphQL schema
+- `codegen:wagmi` - Generates TypeScript types from contract ABIs
+
+### 5. Set up environment (for fork tests)
+
+```sh
+cp .env.template .env
+# Add your Alchemy API key to .env
+```
+
+## Development
+
+```sh
+# Build the SDK
+pnpm build
+
+# Watch mode (rebuilds on changes)
+pnpm dev
+
+# Type checking
+pnpm typecheck
+
+# Linting
+pnpm lint
+pnpm lint:fix
+```
+
+## Testing
+
+```sh
+# Run unit tests
+pnpm test
+
+# Run fork tests (requires ALCHEMY_API_KEY)
+pnpm test:fork
+
+# Watch mode for fork tests
+pnpm test:fork:watch
+
+# Run all tests (unit + fork)
+pnpm test:examples
+```
+
+## Project Structure
+
+```
+packages/sdk/
+├── src/
+│   ├── panoptic/
+│   │   └── v2/              # Panoptic v2 SDK
+│   │       ├── clients/     # Client utilities (getBlockMeta, etc.)
+│   │       ├── errors/      # Error types
+│   │       ├── simulations/ # Transaction simulations
+│   │       ├── sync/        # Position sync and tracking
+│   │       ├── types/       # TypeScript types
+│   │       ├── utils/       # Utility functions
+│   │       └── examples/    # Example implementations
+│   │           ├── basic/           # Basic read/write examples
+│   │           ├── liquidation-bot/ # Liquidation bot example
+│   │           └── oracle-poker/    # Oracle poker bot example
+│   └── generated/           # Auto-generated contract types
+├── contracts/               # Contract ABIs (synced from contracts repo)
+├── graphql/                 # GraphQL schema and queries
+└── scripts/                 # Build and sync scripts
+```
+
+## Contract ABIs
+
+Contract ABIs are synced from the main contracts repository. See [ABI_GENERATION.md](./ABI_GENERATION.md) for details.
+
+To sync ABIs:
+
+```sh
+pnpm sync-contracts
+```
+
+## Usage
+
+```typescript
+import {
+  simulateOpenPosition,
+  simulateClosePosition,
+  getBlockMeta,
+  TokenIdBuilder,
+} from '@panoptic-eng/sdk'
+```
+
+See the [examples](./src/panoptic/v2/examples/) directory for usage patterns.

package/dist/index.js

@@ -1,6 +1,6 @@
 import { BaseError, ContractFunctionRevertedError, encodeAbiParameters, encodeFunctionData, encodePacked, keccak256, maxUint256, parseAbi, zeroAddress } from "viem";
 import { readContract, simulateContract, writeContract } from "viem/actions";
-import { useCallback, useMemo } from "react";
+import { useCallback, useEffect, useMemo, useRef } from "react";
 import { useAccount, useReadContract, useSimulateContract, useWaitForTransactionReceipt, useWriteContract } from "wagmi";
 import { z } from "zod";
 import { GraphQLClient } from "graphql-request";
@@ -19916,11 +19916,22 @@ const useExecuteWithdrawal = ({ vaultAddress, desiredAssets, queuedWithdrawals,
 	const wait = useWaitForTransactionReceipt({
 		hash: write.data,
 		query: {
-			meta: { onSuccess: onWaitSuccess },
 			refetchOnWindowFocus: false,
 			refetchOnMount: false
 		}
 	});
+	const handledRequestHashRef = useRef(void 0);
+	useEffect(() => {
+		const requestHash = write.data;
+		if (!wait.isSuccess || requestHash == null) return;
+		if (handledRequestHashRef.current === requestHash) return;
+		handledRequestHashRef.current = requestHash;
+		onWaitSuccess?.();
+	}, [
+		onWaitSuccess,
+		wait.isSuccess,
+		write.data
+	]);
 	const act = useCallback(() => {
 		const request = simulate.data?.request;
 		return request != null ? write.writeContract(request) : void 0;
@@ -20426,7 +20437,6 @@ const useRequestDeposit = ({ vaultAddress, assets, tokenAddress, onWaitSuccess }
 	const approveWait = useWaitForTransactionReceipt({
 		hash: approveWrite.data,
 		query: {
-			meta: { onSuccess: refetchAllowance },
 			refetchOnWindowFocus: false,
 			refetchOnMount: false
 		}
@@ -20446,11 +20456,34 @@ const useRequestDeposit = ({ vaultAddress, assets, tokenAddress, onWaitSuccess }
 	const wait = useWaitForTransactionReceipt({
 		hash: write.data,
 		query: {
-			meta: { onSuccess: onWaitSuccess },
 			refetchOnWindowFocus: false,
 			refetchOnMount: false
 		}
 	});
+	const handledApproveHashRef = useRef(void 0);
+	const handledRequestHashRef = useRef(void 0);
+	useEffect(() => {
+		const approveHash = approveWrite.data;
+		if (!approveWait.isSuccess || approveHash == null) return;
+		if (handledApproveHashRef.current === approveHash) return;
+		handledApproveHashRef.current = approveHash;
+		refetchAllowance();
+	}, [
+		approveWait.isSuccess,
+		approveWrite.data,
+		refetchAllowance
+	]);
+	useEffect(() => {
+		const requestHash = write.data;
+		if (!wait.isSuccess || requestHash == null) return;
+		if (handledRequestHashRef.current === requestHash) return;
+		handledRequestHashRef.current = requestHash;
+		onWaitSuccess?.();
+	}, [
+		onWaitSuccess,
+		wait.isSuccess,
+		write.data
+	]);
 	const act = useCallback(() => {
 		if (tokenNeedsApproval) {
 			const request$1 = approveSimulate.data?.request;
@@ -20717,11 +20750,22 @@ const useRequestWithdrawal = ({ vaultAddress, desiredAssets, sharePrice, walletS
 	const wait = useWaitForTransactionReceipt({
 		hash: write.data,
 		query: {
-			meta: { onSuccess: onWaitSuccess },
 			refetchOnWindowFocus: false,
 			refetchOnMount: false
 		}
 	});
+	const handledRequestHashRef = useRef(void 0);
+	useEffect(() => {
+		const requestHash = write.data;
+		if (!wait.isSuccess || requestHash == null) return;
+		if (handledRequestHashRef.current === requestHash) return;
+		handledRequestHashRef.current = requestHash;
+		onWaitSuccess?.();
+	}, [
+		onWaitSuccess,
+		wait.isSuccess,
+		write.data
+	]);
 	const act = useCallback(() => {
 		const request = simulate.data?.request;
 		return request != null ? write.writeContract(request) : void 0;