@gzeoneth/gov-tracker 0.4.0-beta.18db0de → 0.4.0-beta.1f24cf7

package/README.md

@@ -15,26 +15,22 @@ yarn add @gzeoneth/gov-tracker ethers@^5.8.0
 ## Quick Start
 
 ```typescript
-import { ethers } from "ethers";
-import { createTracker, findExecutableStage, ADDRESSES } from "@gzeoneth/gov-tracker";
+import { createTracker, findExecutableStage } from "@gzeoneth/gov-tracker";
 
-// Use StaticJsonRpcProvider for better performance
+// Accepts RPC URLs directly (or ethers Provider objects)
 const tracker = createTracker({
-  l2Provider: new ethers.providers.StaticJsonRpcProvider(process.env.ARB1_RPC),
-  l1Provider: new ethers.providers.StaticJsonRpcProvider(process.env.ETH_RPC),
-  novaProvider: new ethers.providers.StaticJsonRpcProvider(process.env.NOVA_RPC),
+  l2Provider: process.env.ARB1_RPC,  // URL string or Provider
+  l1Provider: process.env.ETH_RPC,
+  novaProvider: process.env.NOVA_RPC,
   cachePath: "./gov-tracker-cache.json",
 });
 
-// Track from transaction hash
+// Track from transaction hash (auto-detects proposal type)
 const results = await tracker.trackByTxHash("0x...");
 for (const stage of results[0].stages) {
   console.log(`${stage.type}: ${stage.status}`);
 }
 
-// Or track from governor
-const result = await tracker.trackFromGovernor(ADDRESSES.CONSTITUTIONAL_GOVERNOR, proposalId);
-
 // Execute ready stages
 const readyStage = findExecutableStage(results[0].stages);
 if (readyStage) {
@@ -177,6 +173,18 @@ PRIVATE_KEY=0x...  # For execution
 
 The CLI warns when using default public RPCs. For production, set these environment variables.
 
+### RPC Provider Recommendations
+
+For reliable operation, especially during election tracking which makes many RPC calls:
+
+| Chain | Recommended Providers |
+|-------|----------------------|
+| Ethereum | [Alchemy](https://www.alchemy.com/), [Infura](https://infura.io/), [ethereum.publicnode.com](https://ethereum.publicnode.com/) |
+| Arbitrum One | [Alchemy](https://www.alchemy.com/), [arb1.arbitrum.io/rpc](https://arb1.arbitrum.io/rpc), [arbitrum.publicnode.com](https://arbitrum.publicnode.com/) |
+| Arbitrum Nova | [nova.arbitrum.io/rpc](https://nova.arbitrum.io/rpc) |
+
+**Note:** Some public RPCs like `cloudflare-eth.com` may return `-32603` internal errors during high load. If you experience intermittent failures, try switching to a dedicated provider.
+
 ## Security & Privacy
 
 **External API Lookups**: When decoding calldata, unknown function selectors are looked up via [4byte.directory](https://www.4byte.directory/). To disable: