@dappql/react 1.0.1

package/dist/react/src/useTransactionUpdates.js

@@ -0,0 +1,112 @@
+import { useCallback, useEffect } from 'react';
+import { usePublicClient } from 'wagmi';
+// Store refs for watching state outside the effect
+const storageKey = 'pending-transactions';
+class TransactionWatcher {
+    constructor(client, onUpdate) {
+        this.watchingTransactions = new Set();
+        this.abortControllers = new Map();
+        this.handleStorageChange = (e) => {
+            if (e.key !== storageKey || !e.newValue)
+                return;
+            this.processTransactions(JSON.parse(e.newValue));
+        };
+        this.client = client;
+        this.onUpdate = onUpdate;
+        window.addEventListener('storage', this.handleStorageChange);
+        this.processExistingTransactions();
+    }
+    processExistingTransactions() {
+        const existingData = localStorage.getItem(storageKey);
+        if (existingData) {
+            this.processTransactions(JSON.parse(existingData));
+        }
+    }
+    async processTransaction(txInfo) {
+        const txHash = txInfo.txHash;
+        if (!txHash || this.watchingTransactions.has(txHash))
+            return;
+        this.watchingTransactions.add(txHash);
+        const controller = new AbortController();
+        this.abortControllers.set(txHash, controller);
+        try {
+            const receipt = await this.client.waitForTransactionReceipt({
+                hash: txHash,
+            });
+            if (this.watchingTransactions.has(txHash)) {
+                const mutationUpdate = {
+                    ...txInfo,
+                    status: receipt.status === 'success' ? 'success' : 'error',
+                    error: receipt.status === 'success' ? undefined : new Error('Transaction failed'),
+                    receipt,
+                };
+                handleMutationUpdate(mutationUpdate, this.onUpdate);
+            }
+        }
+        catch (error) {
+            if (!controller.signal.aborted) {
+                console.error(`Error watching transaction ${txHash}:`, error);
+            }
+        }
+    }
+    processTransactions(transactions) {
+        transactions.forEach((item) => {
+            const txInfo = JSON.parse(item);
+            this.processTransaction(txInfo);
+        });
+    }
+    watchTransaction(txInfo) {
+        this.processTransaction(txInfo);
+    }
+    cleanup() {
+        window.removeEventListener('storage', this.handleStorageChange);
+        this.abortControllers.forEach((controller) => controller.abort());
+    }
+}
+let globalWatcher = null;
+function handleMutationUpdate(mutation, onUpdate) {
+    onUpdate(mutation);
+    if (!mutation.txHash)
+        return;
+    const txInfo = JSON.stringify({
+        id: mutation.id,
+        txHash: mutation.txHash,
+        account: mutation.account,
+        address: mutation.address,
+        contractName: mutation.contractName,
+        functionName: mutation.functionName,
+        transactionName: mutation.transactionName,
+    });
+    const currentData = localStorage.getItem(storageKey);
+    const transactions = currentData ? JSON.parse(currentData) : [];
+    switch (mutation.status) {
+        case 'signed':
+            // Add to storage and start watching
+            const newTransactions = [...transactions, txInfo];
+            localStorage.setItem(storageKey, JSON.stringify(newTransactions));
+            globalWatcher?.watchTransaction(JSON.parse(txInfo));
+            break;
+        case 'success':
+        case 'error':
+            // Remove from storage
+            localStorage.setItem(storageKey, JSON.stringify(transactions.filter((t) => t !== txInfo)));
+            break;
+    }
+}
+export default function useTransactionUpdates(onUpdate) {
+    const client = usePublicClient();
+    useEffect(() => {
+        if (!client || !onUpdate)
+            return;
+        globalWatcher = new TransactionWatcher(client, onUpdate);
+        return () => {
+            globalWatcher?.cleanup();
+            globalWatcher = null;
+        };
+    }, [client, onUpdate]);
+    return useCallback((mutation) => {
+        if (!client || !onUpdate)
+            return;
+        handleMutationUpdate(mutation, onUpdate);
+    }, [client, onUpdate]);
+}

package/dist/shared/types.d.ts

@@ -0,0 +1,105 @@
+import type { Abi, AbiFunction, Address, TransactionReceipt } from 'viem';
+export type Request = {
+    contractName: string;
+    method: AbiFunction['name'];
+    args?: readonly any[];
+    address?: Address;
+    deployAddress?: Address;
+    defaultValue?: unknown;
+    chainId?: number;
+    getAbi: () => Abi;
+};
+export type RequestCollection = Record<string, Request>;
+export type MutationConfig<M extends string, Args extends readonly any[]> = {
+    contractName: string;
+    functionName: M;
+    deployAddress?: Address;
+    argsType?: Args;
+    chainId?: number;
+    getAbi: () => Abi;
+};
+export type MutationCollection<T extends Record<string, MutationConfig<any, any>>> = T;
+export type ExtractArgs<T> = T extends (...args: infer P) => any ? P : never;
+/**
+ * Configuration options for query operations
+ */
+export type QueryOptions = {
+    /**
+     * If true, the query will not automatically update when new blocks arrive.
+     * Use this for data that you know won't change, like historical events
+     * or immutable contract state.
+     */
+    isStatic?: boolean;
+    /** If true, the query will be refetched on new blocks */
+    watchBlocks?: boolean;
+    /** Optional block number to query at a specific block */
+    blockNumber?: bigint;
+    /** Optional interval (in ms) to refetch the data */
+    refetchInterval?: number;
+    /** Optional batch size for multicalls */
+    batchSize?: number;
+    /** If true, the query will be paused. */
+    paused?: boolean;
+    /** How many blocks to wait before refetching the query */
+    blocksRefetchInterval?: number;
+};
+export type MutationInfo = {
+    id: string;
+    status: 'submitted' | 'signed' | 'success' | 'error';
+    account?: Address;
+    address: Address;
+    contractName: string;
+    functionName: string;
+    transactionName?: string;
+    txHash?: Address;
+    args?: readonly any[];
+    error?: Error;
+    receipt?: TransactionReceipt;
+};
+/**
+ * Callback functions for different mutation states
+ */
+export type MutationCallbacks = {
+    /** Called when a mutation changes state */
+    onMutationUpdate?: (info: MutationInfo) => any;
+};
+/**
+ * Function type for resolving contract names to addresses
+ */
+export type AddressResolverFunction = (contractName: string) => Address;
+/**
+ * Props for the AddressResolver component
+ */
+export type AddressResolverProps = {
+    /** Callback when resolver is ready */
+    onResolved: (resolver: AddressResolverFunction) => any;
+};
+export type ReadContractsResult = {
+    isLoading?: boolean;
+    isError?: boolean;
+    error?: Error | null;
+    data?: ({
+        error?: undefined;
+        result: unknown;
+        status: 'success';
+    } | {
+        error: Error;
+        result?: undefined;
+        status: 'failure';
+    })[] | undefined;
+};
+/**
+ * Function type for generating item queries at specific indices
+ */
+export type GetItemCallFunction<T> = (index: bigint) => Request & {
+    defaultValue: T;
+};
+export type QueryContextProps = {
+    /** Whether to update queries on new blocks */
+    watchBlocks?: boolean;
+    /** How many blocks to wait before refecthing queries*/
+    blocksRefetchInterval?: number;
+    /** Default batch size for multicalls */
+    defaultBatchSize?: number;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/shared/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../shared/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,WAAW,EAAE,OAAO,EAAE,kBAAkB,EAAE,MAAM,MAAM,CAAA;AAEzE,MAAM,MAAM,OAAO,GAAG;IACpB,YAAY,EAAE,MAAM,CAAA;IACpB,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAC3B,IAAI,CAAC,EAAE,SAAS,GAAG,EAAE,CAAA;IACrB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,MAAM,GAAG,CAAA;CAClB,CAAA;AACD,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAEvD,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,MAAM,EAAE,IAAI,SAAS,SAAS,GAAG,EAAE,IAAI;IAC1E,YAAY,EAAE,MAAM,CAAA;IACpB,YAAY,EAAE,CAAC,CAAA;IACf,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB,QAAQ,CAAC,EAAE,IAAI,CAAA;IACf,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,MAAM,GAAG,CAAA;CAClB,CAAA;AACD,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC,CAAA;AAEtF,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,MAAM,CAAC,KAAK,GAAG,GAAG,CAAC,GAAG,KAAK,CAAA;AAE5E;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,yDAAyD;IACzD,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,yDAAyD;IACzD,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,oDAAoD;IACpD,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,yCAAyC;IACzC,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,yCAAyC;IACzC,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,0DAA0D;IAC1D,qBAAqB,CAAC,EAAE,MAAM,CAAA;CAC/B,CAAA;AAED,MAAM,MAAM,YAAY,GAAG;IACzB,EAAE,EAAE,MAAM,CAAA;IACV,MAAM,EAAE,WAAW,GAAG,QAAQ,GAAG,SAAS,GAAG,OAAO,CAAA;IACpD,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,OAAO,EAAE,OAAO,CAAA;IAChB,YAAY,EAAE,MAAM,CAAA;IACpB,YAAY,EAAE,MAAM,CAAA;IACpB,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,IAAI,CAAC,EAAE,SAAS,GAAG,EAAE,CAAA;IACrB,KAAK,CAAC,EAAE,KAAK,CAAA;IACb,OAAO,CAAC,EAAE,kBAAkB,CAAA;CAC7B,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,2CAA2C;IAC3C,gBAAgB,CAAC,EAAE,CAAC,IAAI,EAAE,YAAY,KAAK,GAAG,CAAA;CAC/C,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,CAAC,YAAY,EAAE,MAAM,KAAK,OAAO,CAAA;AAEvE;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,sCAAsC;IACtC,UAAU,EAAE,CAAC,QAAQ,EAAE,uBAAuB,KAAK,GAAG,CAAA;CACvD,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,KAAK,CAAC,EAAE,KAAK,GAAG,IAAI,CAAA;IACpB,IAAI,CAAC,EACD,CACI;QACE,KAAK,CAAC,EAAE,SAAS,CAAA;QACjB,MAAM,EAAE,OAAO,CAAA;QACf,MAAM,EAAE,SAAS,CAAA;KAClB,GACD;QACE,KAAK,EAAE,KAAK,CAAA;QACZ,MAAM,CAAC,EAAE,SAAS,CAAA;QAClB,MAAM,EAAE,SAAS,CAAA;KAClB,CACJ,EAAE,GACH,SAAS,CAAA;CACd,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,mBAAmB,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,GAAG;IAChE,YAAY,EAAE,CAAC,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,8CAA8C;IAC9C,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,uDAAuD;IACvD,qBAAqB,CAAC,EAAE,MAAM,CAAA;IAC9B,wCAAwC;IACxC,gBAAgB,CAAC,EAAE,MAAM,CAAA;CAC1B,CAAA"}

package/dist/shared/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -0,0 +1,74 @@
+{
+  "name": "@dappql/react",
+  "version": "1.0.1",
+  "description": "Streamlined smart contract data fetching library for React dApps with TypeScript support",
+  "author": "DappQL Team",
+  "type": "module",
+  "keywords": [
+    "wagmi",
+    "viem",
+    "typescript",
+    "blockchain",
+    "smart-contracts",
+    "dapp",
+    "hooks",
+    "react hooks",
+    "query"
+  ],
+  "main": "dist/react/src/index.js",
+  "types": "dist/react/src/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/react/src/index.d.ts",
+      "default": "./dist/react/src/index.js"
+    },
+    "./shared/*": {
+      "types": "./dist/shared/*.d.ts",
+      "default": "./dist/shared/*.js"
+    }
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/dappql/monorepo.git"
+  },
+  "bugs": {
+    "url": "https://github.com/dappql/monorepo/issues"
+  },
+  "homepage": "https://github.com/dappql/monorepo#readme",
+  "license": "MIT",
+  "peerDependencies": {
+    "@tanstack/react-query": ">=5.0.0",
+    "react": ">=18",
+    "typescript": ">=5.0.4",
+    "viem": "2.x",
+    "wagmi": "^2"
+  },
+  "devDependencies": {
+    "@testing-library/jest-dom": "^6.6.3",
+    "@testing-library/react": "^16.1.0",
+    "@types/react": "^18.3.12",
+    "@typescript-eslint/eslint-plugin": "^5.46.1",
+    "@typescript-eslint/parser": "^5.46.1",
+    "@vitejs/plugin-react": "^4.3.4",
+    "@vitest/coverage-v8": "2.1.8",
+    "eslint": "^8.29.0",
+    "eslint-config-universe": "^11.1.1",
+    "happy-dom": "^15.11.7",
+    "jsdom": "^25.0.1",
+    "typescript": "^5.6.3",
+    "vitest": "^2.1.8"
+  },
+  "scripts": {
+    "clean": "rm -rf ./node_modules && rm -rf ./dist && rm -rf ./.turbo",
+    "test": "vitest run --coverage",
+    "test:watch": "vitest --coverage",
+    "dev": "pnpm exec tsc -b -w",
+    "build": "del-cli dist && tsc",
+    "version:bump": "bump patch --commit --push",
+    "publish:npm": "pnpm publish --access public --no-workspace-root",
+    "ship": "pnpm run build && pnpm run version:bump && pnpm run publish:npm --no-git-checks --access public"
+  }
+}