@enclave-e3/sdk 0.0.7-test

package/LICENSE.md

@@ -0,0 +1,165 @@
+GNU LESSER GENERAL PUBLIC LICENSE
+                      Version 3, 29 June 2007
+
+Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+Everyone is permitted to copy and distribute verbatim copies
+of this license document, but changing it is not allowed.
+
+
+ This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+ 0. Additional Definitions.
+
+ As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+ "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+ An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+ A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+ The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+ The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+ 1. Exception to Section 3 of the GNU GPL.
+
+ You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+ 2. Conveying Modified Versions.
+
+ If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+  a) under this License, provided that you make a good faith effort to
+  ensure that, in the event an Application does not supply the
+  function or data, the facility still operates, and performs
+  whatever part of its purpose remains meaningful, or
+
+  b) under the GNU GPL, with none of the additional permissions of
+  this License applicable to that copy.
+
+ 3. Object Code Incorporating Material from Library Header Files.
+
+ The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+  a) Give prominent notice with each copy of the object code that the
+  Library is used in it and that the Library and its use are
+  covered by this License.
+
+  b) Accompany the object code with a copy of the GNU GPL and this license
+  document.
+
+ 4. Combined Works.
+
+ You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+  a) Give prominent notice with each copy of the Combined Work that
+  the Library is used in it and that the Library and its use are
+  covered by this License.
+
+  b) Accompany the Combined Work with a copy of the GNU GPL and this license
+  document.
+
+  c) For a Combined Work that displays copyright notices during
+  execution, include the copyright notice for the Library among
+  these notices, as well as a reference directing the user to the
+  copies of the GNU GPL and this license document.
+
+  d) Do one of the following:
+
+      0) Convey the Minimal Corresponding Source under the terms of this
+      License, and the Corresponding Application Code in a form
+      suitable for, and under terms that permit, the user to
+      recombine or relink the Application with a modified version of
+      the Linked Version to produce a modified Combined Work, in the
+      manner specified by section 6 of the GNU GPL for conveying
+      Corresponding Source.
+
+      1) Use a suitable shared library mechanism for linking with the
+      Library.  A suitable mechanism is one that (a) uses at run time
+      a copy of the Library already present on the user's computer
+      system, and (b) will operate properly with a modified version
+      of the Library that is interface-compatible with the Linked
+      Version.
+
+  e) Provide Installation Information, but only if you would otherwise
+  be required to provide such information under section 6 of the
+  GNU GPL, and only to the extent that such information is
+  necessary to install and execute a modified version of the
+  Combined Work produced by recombining or relinking the
+  Application with a modified version of the Linked Version. (If
+  you use option 4d0, the Installation Information must accompany
+  the Minimal Corresponding Source and Corresponding Application
+  Code. If you use option 4d1, you must provide the Installation
+  Information in the manner specified by section 6 of the GNU GPL
+  for conveying Corresponding Source.)
+
+ 5. Combined Libraries.
+
+ You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+  a) Accompany the combined library with a copy of the same work based
+  on the Library, uncombined with any other library facilities,
+  conveyed under the terms of this License.
+
+  b) Give prominent notice with the combined library that part of it
+  is a work based on the Library, and explaining where to find the
+  accompanying uncombined form of the same work.
+
+ 6. Revised Versions of the GNU Lesser General Public License.
+
+ The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+ Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+ If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

package/README.md

@@ -0,0 +1,340 @@
+# 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.
+
+## 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
+- **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
+
+## Installation
+
+```bash
+pnpm add @enclave-e3/sdk
+```
+
+## Quick Start
+
+```typescript
+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"),
+});
+
+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
+  },
+  chainId: 1, // Optional
+});
+
+// Initialize the SDK
+await sdk.initialize();
+
+// Listen to events with the unified event system
+sdk.onEnclaveEvent(EnclaveEventType.E3_REQUESTED, (event) => {
+  console.log("E3 Requested:", event.data);
+});
+
+sdk.onEnclaveEvent(RegistryEventType.CIPHERNODE_ADDED, (event) => {
+  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...",
+});
+```
+
+## 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:
+
+- Use `vite`
+- Use the `vite-plugin-top-level-await` plugin
+- Use the `vite-plugin-wasm` plugin
+- Exclude the `@enclave-e3/wasm` package from bundling optimization.
+
+This will enable `vite` to correctly bundle and serve the wasm bundle we use effectively.
+
+```
+import { defineConfig } from 'vite'
+import wasm from 'vite-plugin-wasm'
+import topLevelAwait from 'vite-plugin-top-level-await'
+
+export default defineConfig({
+  // other config ...
+  optimizeDeps: {
+    exclude: ['@enclave-e3/wasm'],
+  },
+  plugins: [wasm(), topLevelAwait()],
+})
+```
+
+## Event System
+
+The SDK uses a unified event system with TypeScript enums for type safety:
+
+### Enclave Events
+
+```typescript
+enum EnclaveEventType {
+  // E3 Lifecycle
+  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",
+
+  // Configuration
+  CIPHERNODE_REGISTRY_SET = "CiphernodeRegistrySet",
+  MAX_DURATION_SET = "MaxDurationSet",
+  // ... more events
+}
+```
+
+### Registry Events
+
+```typescript
+enum RegistryEventType {
+  CIPHERNODE_ADDED = "CiphernodeAdded",
+  CIPHERNODE_REMOVED = "CiphernodeRemoved",
+  COMMITTEE_REQUESTED = "CommitteeRequested",
+  COMMITTEE_PUBLISHED = "CommitteePublished",
+  ENCLAVE_SET = "EnclaveSet",
+  // ... more events
+}
+```
+
+### Event Data Structure
+
+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;
+}
+```
+
+## React Integration
+
+The SDK includes a React hook for easy integration:
+
+```typescript
+import { useEnclaveSDK } from '@enclave-e3/contracts/sdk';
+
+function MyComponent() {
+  const {
+    sdk,
+    isInitialized,
+    isConnecting,
+    error,
+    connectWallet,
+    requestE3,
+    onEnclaveEvent,
+    EnclaveEventType
+  } = useEnclaveSDK({
+    contracts: {
+      enclave: '0x...',
+      ciphernodeRegistry: '0x...'
+    },
+    rpcUrl: 'YOUR_RPC_URL',
+    autoConnect: true
+  });
+
+  useEffect(() => {
+    if (isInitialized) {
+      onEnclaveEvent(EnclaveEventType.E3_REQUESTED, (event) => {
+        console.log('New E3 request:', event);
+      });
+    }
+  }, [isInitialized]);
+
+  return (
+    <div>
+      {!isInitialized && (
+        <button onClick={connectWallet} disabled={isConnecting}>
+          {isConnecting ? 'Connecting...' : 'Connect Wallet'}
+        </button>
+      )}
+      {/* Your UI */}
+    </div>
+  );
+}
+```
+
+## API Reference
+
+### Core Methods
+
+#### Contract Interactions
+
+```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,
+  gasLimit?: bigint
+});
+
+// Activate an E3 computation
+await sdk.activateE3(e3Id: bigint, publicKey: `0x${string}`, gasLimit?: bigint);
+
+// Publish input data
+await sdk.publishInput(e3Id: bigint, data: `0x${string}`, gasLimit?: bigint);
+
+// Read operations
+const e3Data = await sdk.getE3(e3Id: bigint);
+```
+
+#### Event Handling
+
+```typescript
+sdk.onEnclaveEvent(eventType: AllEventTypes, callback: EventCallback);
+
+sdk.off(eventType: AllEventTypes, callback: EventCallback);
+
+const logs = await sdk.getHistoricalEvents(
+  eventType: AllEventTypes,
+  fromBlock?: bigint,
+  toBlock?: bigint
+);
+
+// Event polling (if websockets unavailable)
+await sdk.startEventPolling();
+sdk.stopEventPolling();
+```
+
+#### Utilities
+
+```typescript
+// Gas estimation
+const gas = await sdk.estimateGas(functionName, args, contractAddress, abi, value?);
+
+// Transaction waiting
+const receipt = await sdk.waitForTransaction(hash);
+
+// Configuration updates
+sdk.updateConfig(newConfig: Partial<SDKConfig>);
+
+// Cleanup
+sdk.cleanup();
+```
+
+## Configuration
+
+```typescript
+interface SDKConfig {
+  publicClient: PublicClient;
+  walletClient?: WalletClient;
+  contracts: {
+    enclave: `0x${string}`;
+    ciphernodeRegistry: `0x${string}`;
+  };
+  chainId?: number;
+}
+```
+
+## Error Handling
+
+The SDK includes comprehensive error handling:
+
+```typescript
+import { SDKError } from "@enclave-e3/sdk";
+
+try {
+  await sdk.requestE3(params);
+} catch (error) {
+  if (error instanceof SDKError) {
+    console.error(`SDK Error (${error.code}): ${error.message}`);
+  } else {
+    console.error("Unexpected error:", error);
+  }
+}
+```
+
+## Development
+
+### Building the SDK
+
+```bash
+cd packages/enclave-contracts
+pnpm compile
+```
+
+### Running the Demo
+
+```bash
+cd examples/basic/client
+pnpm install
+pnpm dev
+```
+
+The demo showcases all SDK features including real-time event listening and
+contract interactions.
+
+### Testing
+
+```bash
+cd packages/enclave-contracts
+pnpm test
+```
+
+## Architecture
+
+The SDK consists of several key components:
+
+- **EnclaveSDK**: Main orchestrator class
+- **ContractClient**: Handles contract read/write operations
+- **EventListener**: Manages real-time event listening
+- **Types**: TypeScript definitions with full type safety
+- **Utils**: Helper functions and error classes
+
+## License
+
+This project is licensed under the MIT License.