@hyperbridge/sdk 1.0.0 → 1.2.0

package/README.md

@@ -17,9 +17,15 @@ pnpm add @hyperbridge/sdk
 ### Initialize Client
 
 ```ts
-import { IndexerClient } from "@hyperbridge/sdk"
+import { IndexerClient, createQueryClient } from "@hyperbridge/sdk"
+
+const queryClient = createQueryClient({
+	url: "http://localhost:3000", // URL of the Hyperbridge indexer API
+})
 
 const indexer = new IndexerClient({
+	queryClient: queryClient,
+	pollInterval: 1_000, // Every second
 	source: {
 		consensusStateId: "BSC0",
 		rpcUrl: "https://data-seed-prebsc-1-s1.binance.org:8545",
@@ -37,8 +43,6 @@ const indexer = new IndexerClient({
 		stateMachineId: "KUSAMA-4009",
 		wsUrl: "wss://gargantua.polytope.technology",
 	},
-	url: "http://localhost:3000", // URL of the Hyperbridge indexer API
-	pollInterval: 1_000, // Every second
 })
 ```
 
@@ -87,6 +91,22 @@ const request = await indexer.queryRequestWithStatus(commitment)
 console.log(request?.statuses)
 ```
 
+Alternatively. You can use the `queryPostRequest` utility
+
+```ts
+import { createQueryClient, queryPostRequest } from "@hyperbridge/sdk"
+
+const queryClient = createQueryClient({
+	url: "http://localhost:3000", // URL of the Hyperbridge indexer API
+})
+
+const commitmentHash = "0x...."
+
+// Get request statuses
+const request = await queryPostRequest({ commitmentHash, queryClient })
+console.log(request.statuses) // read transaction statuses
+```
+
 ### Chain Utilities
 
 ```ts
@@ -108,6 +128,28 @@ const hyperbridge = new SubstrateChain({
 const proof = await hyperbridge.queryStateProof(blockNumber, keys)
 ```
 
+## Vite Integration
+
+If you're using Vite in your project, Hyperbridge SDK includes a plugin to handle WebAssembly dependencies correctly.
+
+### Using the Vite Plugin
+
+```ts
+// vite.config.ts
+import { defineConfig } from "vite"
+import hyperbridge from "@hyperbridge/sdk/plugins/vite"
+
+export default defineConfig({
+	plugins: [
+		// ... other plugins
+		// Add the Hyperbridge WASM plugin
+		hyperbridge(),
+	],
+})
+```
+
+The plugin automatically copies the necessary WebAssembly files to the correct location in Vite's dependency cache during development. This ensures that any WASM dependencies required by Hyperbridge SDK are properly loaded when using Vite's dev server.
+
 ## API Reference
 
 ### Classes