@tuwaio/pulsar-evm 0.0.18 → 0.0.20

package/README.md

@@ -31,43 +31,58 @@ While its main export is the `evmAdapter`, it also includes a suite of standalon
 
 ## 💾 Installation
 
-This package is designed to be used as part of the Pulsar stack and requires `wagmi` and `viem`. Install all necessary packages together:
+This package is designed to be used as part of the Pulsar stack and requires `@wagmi/core` and `viem`. Install all necessary packages together:
 
 ```bash
 # Using pnpm
-pnpm add @tuwaio/pulsar-evm @tuwaio/pulsar-core wagmi viem zustand immer
+pnpm add @tuwaio/pulsar-evm @tuwaio/pulsar-core @wagmi/core viem zustand immer dayjs
 
 # Using npm
-npm install @tuwaio/pulsar-evm @tuwaio/pulsar-core wagmi viem zustand immer
+npm install @tuwaio/pulsar-evm @tuwaio/pulsar-core @wagmi/core viem zustand immer dayjs
 
 # Using yarn
-yarn add @tuwaio/pulsar-evm @tuwaio/pulsar-core wagmi viem zustand immer
+yarn add @tuwaio/pulsar-evm @tuwaio/pulsar-core @wagmi/core viem zustand immer dayjs
 ```
 
 ---
 
 ## 🚀 Usage
 
-### 1\. Primary Usage: The `evmAdapter`
+### 1. Primary Usage: The `evmAdapter`
 
 For most applications, you'll only need to import the `evmAdapter` and pass it to your `createPulsarStore` configuration.
 
 ```ts
-// src/store/pulsarStore.ts
-import { createPulsarStore } from '@tuwaio/pulsar-core';
+// src/hooks/txTrackingHooks.ts
+import { createBoundedUseStore, createPulsarStore, Transaction } from '@tuwaio/pulsar-core';
 import { evmAdapter } from '@tuwaio/pulsar-evm';
-import { wagmiConfig, chains } from '../configs/wagmi'; // Your wagmi config
-
-// Create the Pulsar store and plug in the EVM adapter
-export const pulsarStore = createPulsarStore({
-  // A unique name for localStorage persistence
-  name: 'my-dapp-transactions',
-  // Provide the evmAdapter with your wagmi config and supported chains
-  adapter: evmAdapter(wagmiConfig, chains),
-});
+
+import { appChains, config } from '@/configs/wagmiConfig';
+
+const storageName = 'transactions-tracking-storage';
+
+export enum TxType {
+  example = 'example',
+}
+
+type ExampleTx = Transaction & {
+  type: TxType.example;
+  payload: {
+    value: number;
+  };
+};
+
+export type TransactionUnion = ExampleTx;
+
+export const usePulsarStore = createBoundedUseStore(
+  createPulsarStore<TransactionUnion>({
+    name: storageName,
+    adapter: evmAdapter(config, appChains),
+  }),
+);
 ```
 
-### 2\. Using Standalone Actions
+### 2. Using Standalone Actions
 
 This package also exports utility actions that you can wire up to your UI for features like speeding up or canceling transactions.
 
@@ -76,11 +91,11 @@ This package also exports utility actions that you can wire up to your UI for fe
 ```tsx
 // src/components/SpeedUpButton.tsx
 import { speedUpTxAction } from '@tuwaio/pulsar-evm';
-import { usePulsar } from '@tuwaio/pulsar-react'; // Or your custom hook
+import { usePulsarStore } from '../hooks/txTrackingHooks'; // Or your custom hook
 import { wagmiConfig } from '../configs/wagmi'; // Your wagmi config
 
 function SpeedUpButton({ txKey }) {
-  const { transactionsPool } = usePulsar();
+  const transactionsPool = usePulsarStore((state) => state.transactionsPool);
   const stuckTransaction = transactionsPool[txKey];
 
   // Only show the button if the transaction is pending and is a standard EVM tx
@@ -106,7 +121,7 @@ function SpeedUpButton({ txKey }) {
 }
 ```
 
-### 3\. Using Standalone Utilities
+### 3. Using Standalone Utilities
 
 You can use exported utilities, like selectors, to get derived data for your UI.
 
@@ -115,7 +130,6 @@ You can use exported utilities, like selectors, to get derived data for your UI.
 ```tsx
 // src/components/ExplorerLink.tsx
 import { selectEvmTxExplorerLink } from '@tuwaio/pulsar-evm';
-import { usePulsar } from '@tuwaio/pulsar-react';
 import { chains } from '../configs/wagmi'; // Your wagmi config
 
 function ExplorerLink({ tx }) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tuwaio/pulsar-evm",
-  "version": "0.0.18",
+  "version": "0.0.20",
   "private": false,
   "author": "Oleksandr Tkach",
   "license": "Apache-2.0",
@@ -57,7 +57,7 @@
     "viem": "^2.37.4",
     "vitest": "^3.2.4",
     "zustand": "^5.0.8",
-    "@tuwaio/pulsar-core": "^0.1.6"
+    "@tuwaio/pulsar-core": "^0.1.10"
   },
   "scripts": {
     "start": "tsup src/index.ts --watch",