@enclave-e3/sdk 0.1.5 → 0.1.6

package/README.md

@@ -1,20 +1,17 @@
 # Enclave TypeScript SDK
 
-A powerful, type-safe TypeScript SDK for interacting with Enclave smart
-contracts. This SDK provides real-time event listening, contract interaction
-methods, and comprehensive error handling.
+A powerful, type-safe TypeScript SDK for interacting with Enclave smart contracts. This SDK provides
+real-time event listening, contract interaction methods, and comprehensive error handling.
 
 ## Features
 
 - **Event-driven architecture**: Listen to smart contract events in real-time
 - **Type-safe**: Built with TypeScript and uses generated types from contracts
-- **Easy contract interactions**: Simple methods for reading from and writing to
-  contracts
+- **Easy contract interactions**: Simple methods for reading from and writing to contracts
 - **React integration**: Includes React hooks for easy frontend integration
 - **Error handling**: Comprehensive error handling with custom error types
 - **Gas estimation**: Built-in gas estimation for transactions
-- **Event polling**: Support for both WebSocket and polling-based event
-  listening
+- **Event polling**: Support for both WebSocket and polling-based event listening
 
 ## Installation
 
@@ -25,60 +22,57 @@ pnpm add @enclave-e3/sdk
 ## Quick Start
 
 ```typescript
-import {
-  EnclaveSDK,
-  EnclaveEventType,
-  RegistryEventType,
-} from "@enclave-e3/sdk";
-import { createPublicClient, createWalletClient, http, custom } from "viem";
+import { EnclaveSDK, EnclaveEventType, RegistryEventType } from '@enclave-e3/sdk'
+import { createPublicClient, createWalletClient, http, custom } from 'viem'
 
 // Initialize clients
 const publicClient = createPublicClient({
-  transport: http("YOUR_RPC_URL"),
-});
+  transport: http('YOUR_RPC_URL'),
+})
 
 const walletClient = createWalletClient({
   transport: custom(window.ethereum),
-});
+})
 
 // Create SDK instance
 const sdk = new EnclaveSDK({
   publicClient,
   walletClient,
   contracts: {
-    enclave: "0x...", // Your Enclave contract address
-    ciphernodeRegistry: "0x...", // Your CiphernodeRegistry contract address
+    enclave: '0x...', // Your Enclave contract address
+    ciphernodeRegistry: '0x...', // Your CiphernodeRegistry contract address
   },
   chainId: 1, // Optional
-});
+})
 
 // Initialize the SDK
-await sdk.initialize();
+await sdk.initialize()
 
 // Listen to events with the unified event system
 sdk.onEnclaveEvent(EnclaveEventType.E3_REQUESTED, (event) => {
-  console.log("E3 Requested:", event.data);
-});
+  console.log('E3 Requested:', event.data)
+})
 
 sdk.onEnclaveEvent(RegistryEventType.CIPHERNODE_ADDED, (event) => {
-  console.log("Ciphernode Added:", event.data);
-});
+  console.log('Ciphernode Added:', event.data)
+})
 
 // Interact with contracts
 const hash = await sdk.requestE3({
-  filter: "0x...",
   threshold: [1, 3],
   startWindow: [BigInt(0), BigInt(100)],
   duration: BigInt(3600),
-  e3Program: "0x...",
-  e3ProgramParams: "0x...",
-  computeProviderParams: "0x...",
-});
+  e3Program: '0x...',
+  e3ProgramParams: '0x...',
+  computeProviderParams: '0x...',
+  customParams: '0x...',
+})
 ```
 
 ## Usage within a browser
 
-Usage within a typescript project should work out of the box, however in order to use wasm related functionality of the SDK within the browser vite you must do the following:
+Usage within a typescript project should work out of the box, however in order to use wasm related
+functionality of the SDK within the browser vite you must do the following:
 
 - Use `vite`
 - Use the `vite-plugin-top-level-await` plugin
@@ -110,19 +104,19 @@ The SDK uses a unified event system with TypeScript enums for type safety:
 ```typescript
 enum EnclaveEventType {
   // E3 Lifecycle
-  E3_REQUESTED = "E3Requested",
-  E3_ACTIVATED = "E3Activated",
-  INPUT_PUBLISHED = "InputPublished",
-  CIPHERTEXT_OUTPUT_PUBLISHED = "CiphertextOutputPublished",
-  PLAINTEXT_OUTPUT_PUBLISHED = "PlaintextOutputPublished",
+  E3_REQUESTED = 'E3Requested',
+  E3_ACTIVATED = 'E3Activated',
+  INPUT_PUBLISHED = 'InputPublished',
+  CIPHERTEXT_OUTPUT_PUBLISHED = 'CiphertextOutputPublished',
+  PLAINTEXT_OUTPUT_PUBLISHED = 'PlaintextOutputPublished',
 
   // E3 Program Management
-  E3_PROGRAM_ENABLED = "E3ProgramEnabled",
-  E3_PROGRAM_DISABLED = "E3ProgramDisabled",
+  E3_PROGRAM_ENABLED = 'E3ProgramEnabled',
+  E3_PROGRAM_DISABLED = 'E3ProgramDisabled',
 
   // Configuration
-  CIPHERNODE_REGISTRY_SET = "CiphernodeRegistrySet",
-  MAX_DURATION_SET = "MaxDurationSet",
+  CIPHERNODE_REGISTRY_SET = 'CiphernodeRegistrySet',
+  MAX_DURATION_SET = 'MaxDurationSet',
   // ... more events
 }
 ```
@@ -131,11 +125,12 @@ enum EnclaveEventType {
 
 ```typescript
 enum RegistryEventType {
-  CIPHERNODE_ADDED = "CiphernodeAdded",
-  CIPHERNODE_REMOVED = "CiphernodeRemoved",
-  COMMITTEE_REQUESTED = "CommitteeRequested",
-  COMMITTEE_PUBLISHED = "CommitteePublished",
-  ENCLAVE_SET = "EnclaveSet",
+  CIPHERNODE_ADDED = 'CiphernodeAdded',
+  CIPHERNODE_REMOVED = 'CiphernodeRemoved',
+  COMMITTEE_REQUESTED = 'CommitteeRequested',
+  COMMITTEE_PUBLISHED = 'CommitteePublished',
+  COMMITTEE_FINALIZED = 'CommitteeFinalized',
+  ENCLAVE_SET = 'EnclaveSet',
   // ... more events
 }
 ```
@@ -146,12 +141,12 @@ Each event follows a consistent structure:
 
 ```typescript
 interface EnclaveEvent<T extends AllEventTypes> {
-  type: T;
-  data: EventData[T]; // Typed based on event type
-  log: Log; // Raw viem log
-  timestamp: Date;
-  blockNumber: bigint;
-  transactionHash: string;
+  type: T
+  data: EventData[T] // Typed based on event type
+  log: Log // Raw viem log
+  timestamp: Date
+  blockNumber: bigint
+  transactionHash: string
 }
 ```
 
@@ -160,7 +155,7 @@ interface EnclaveEvent<T extends AllEventTypes> {
 The SDK includes a React hook for easy integration:
 
 ```typescript
-import { useEnclaveSDK } from '@enclave-e3/contracts/sdk';
+import { useEnclaveSDK } from "@enclave-e3/contracts/sdk";
 
 function MyComponent() {
   const {
@@ -171,20 +166,20 @@ function MyComponent() {
     connectWallet,
     requestE3,
     onEnclaveEvent,
-    EnclaveEventType
+    EnclaveEventType,
   } = useEnclaveSDK({
     contracts: {
-      enclave: '0x...',
-      ciphernodeRegistry: '0x...'
+      enclave: "0x...",
+      ciphernodeRegistry: "0x...",
     },
-    rpcUrl: 'YOUR_RPC_URL',
-    autoConnect: true
+    rpcUrl: "YOUR_RPC_URL",
+    autoConnect: true,
   });
 
   useEffect(() => {
     if (isInitialized) {
       onEnclaveEvent(EnclaveEventType.E3_REQUESTED, (event) => {
-        console.log('New E3 request:', event);
+        console.log("New E3 request:", event);
       });
     }
   }, [isInitialized]);
@@ -193,7 +188,7 @@ function MyComponent() {
     <div>
       {!isInitialized && (
         <button onClick={connectWallet} disabled={isConnecting}>
-          {isConnecting ? 'Connecting...' : 'Connect Wallet'}
+          {isConnecting ? "Connecting..." : "Connect Wallet"}
         </button>
       )}
       {/* Your UI */}
@@ -211,14 +206,13 @@ function MyComponent() {
 ```typescript
 // Request a new E3 computation
 await sdk.requestE3({
-  filter: `0x${string}`,
   threshold: [number, number],
   startWindow: [bigint, bigint],
   duration: bigint,
   e3Program: `0x${string}`,
   e3ProgramParams: `0x${string}`,
   computeProviderParams: `0x${string}`,
-  value?: bigint,
+  customParams?: `0x${string}`,
   gasLimit?: bigint
 });
 
@@ -270,13 +264,13 @@ sdk.cleanup();
 
 ```typescript
 interface SDKConfig {
-  publicClient: PublicClient;
-  walletClient?: WalletClient;
+  publicClient: PublicClient
+  walletClient?: WalletClient
   contracts: {
-    enclave: `0x${string}`;
-    ciphernodeRegistry: `0x${string}`;
-  };
-  chainId?: number;
+    enclave: `0x${string}`
+    ciphernodeRegistry: `0x${string}`
+  }
+  chainId?: number
 }
 ```
 
@@ -285,15 +279,15 @@ interface SDKConfig {
 The SDK includes comprehensive error handling:
 
 ```typescript
-import { SDKError } from "@enclave-e3/sdk";
+import { SDKError } from '@enclave-e3/sdk'
 
 try {
-  await sdk.requestE3(params);
+  await sdk.requestE3(params)
 } catch (error) {
   if (error instanceof SDKError) {
-    console.error(`SDK Error (${error.code}): ${error.message}`);
+    console.error(`SDK Error (${error.code}): ${error.message}`)
   } else {
-    console.error("Unexpected error:", error);
+    console.error('Unexpected error:', error)
   }
 }
 ```
@@ -315,8 +309,7 @@ pnpm install
 pnpm dev
 ```
 
-The demo showcases all SDK features including real-time event listening and
-contract interactions.
+The demo showcases all SDK features including real-time event listening and contract interactions.
 
 ### Testing