fema-pf-calc 1.0.4 → 1.0.6

package/README.md

@@ -18,13 +18,13 @@ FEMA solves this by scanning recent blocks, building a real fee distribution, an
 
 ## How It Works
 
-1. FEMA connects to a Solana RPC and fetches data from the last 30 blocks
-2. For each transaction in those blocks it extracts the fee paid in microLamports per compute unit
+1. FEMA connects to Solana via a built-in Helius-backed RPC proxy — no API key or RPC setup required
+2. For each transaction in the last 30 blocks it extracts the fee paid in microLamports per compute unit
 3. It sorts these into a distribution and computes percentiles (p25, p50, p75)
 4. If you specify a protocol or pass your transaction, it filters the data to only transactions that used the same programs as yours
 5. It returns the fee at the percentile matching your chosen speed and strategy
 
-Results are cached for 30 seconds to avoid hammering the RPC on every call.
+Results are cached for 7 seconds to avoid hammering the RPC on every call.
 
 ---
 
@@ -43,10 +43,7 @@ import { init, estimateFee } from "fema-pf-calc";
 import { ComputeBudgetProgram } from "@solana/web3.js";
 
 // Configure once at app startup
-init({
-  cluster: "mainnet-beta", // or "devnet"
-  rpcUrl: "https://mainnet.helius-rpc.com/?api-key=YOUR_KEY", // optional override
-});
+init({ cluster: "mainnet-beta" }); // no RPC setup needed
 
 // Get the recommended fee
 const { fee } = await estimateFee({ speed: "fast", strategy: "balanced" });
@@ -57,7 +54,7 @@ const priorityIx = ComputeBudgetProgram.setComputeUnitPrice({
 });
 ```
 
-That is all a developer needs to do. No RPC calls, no math, no guessing.
+That is all a developer needs to do. No RPC key, no math, no guessing.
 
 ---
 
@@ -65,12 +62,12 @@ That is all a developer needs to do. No RPC calls, no math, no guessing.
 
 ```ts
 const result = await estimateFee({
-  speed: "fast", // "slow" | "medium" | "fast"
-  strategy: "balanced", // "cheap" | "balanced" | "aggressive"
-  protocol: "jupiter", // see supported protocols below
+  speed: "fast",            // "slow" | "medium" | "fast"
+  strategy: "balanced",     // "cheap" | "balanced" | "aggressive"
+  protocol: "jupiter",      // see supported protocols below
   transaction: myTransaction, // pass your actual tx for automatic protocol detection
-  maxFee: 500_000, // optional cap in microLamports
-  includeStats: true, // include full distribution in response
+  maxFee: 500_000,          // optional cap in microLamports
+  includeStats: true,       // include full distribution in response
 });
 ```
 
@@ -172,31 +169,23 @@ The `fee` value is in **microLamports per compute unit** — the exact unit that
 
 ```ts
 init({
-  cluster: "mainnet-beta", // "mainnet-beta" | "devnet" (default: "mainnet-beta")
-  rpcUrl: "https://your-rpc.com", // optional — overrides the cluster default
-  cacheDurationMs: 7000, // how long to cache results in ms (default: 7000)
+  cluster: "mainnet-beta",      // "mainnet-beta" | "devnet" (default: "mainnet-beta")
+  rpcUrl: "https://your-rpc.com", // optional — bring your own RPC to override the default
+  cacheDurationMs: 7000,        // how long to cache results in ms (default: 7000)
 });
 ```
 
-### Cluster RPC defaults
-
-| Cluster        | Default RPC                           |
-| -------------- | ------------------------------------- |
-| `mainnet-beta` | `https://api.mainnet-beta.solana.com` |
-| `devnet`       | `https://api.devnet.solana.com`       |
-
-Or configure via `.env`:
+You can also override the RPC via environment variables:
 
 ```env
-# Network: mainnet-beta (default) or devnet
-SOLANA_CLUSTER=mainnet-beta
+# Optional: use your own RPC provider (overrides the built-in default)
+SOLANA_RPC_URL=https://your-custom-rpc.com
 
-# Helius API key — get one free at https://helius.dev
-# The base URL is set in code; only your key goes here
+# Or use your own Helius API key
 HELIUS_API_KEY=your-api-key-here
 
-# Optional: use a different RPC provider entirely (overrides HELIUS_API_KEY)
-# SOLANA_RPC_URL=https://your-custom-rpc.com
+# Network: mainnet-beta (default) or devnet
+SOLANA_CLUSTER=mainnet-beta
 
 # How long to cache fee data in milliseconds (default: 7000)
 CACHE_DURATION_MS=7000
@@ -204,13 +193,38 @@ CACHE_DURATION_MS=7000
 
 ---
 
-## RPC Recommendations
+## Sample Code
 
-The public Solana RPC endpoints rate-limit aggressively. For reliable results use a private RPC:
+```ts
+import express from "express";
+import { init, estimateFee } from "fema-pf-calc";
+import { ComputeBudgetProgram } from "@solana/web3.js";
 
-- [Helius](https://helius.dev) — free tier available
-- [QuickNode](https://quicknode.com)
-- [Alchemy](https://alchemy.com)
+const app = express();
+
+init({ cluster: "mainnet-beta" }); // no RPC setup needed
+
+app.get("/fee", async (req, res) => {
+  try {
+    const { fee } = await estimateFee({ speed: "fast", strategy: "balanced" });
+
+    const priorityIx = ComputeBudgetProgram.setComputeUnitPrice({
+      microLamports: fee,
+    });
+
+    res.json({ fee, priorityIx });
+  } catch (err) {
+    console.error(err);
+    res.status(500).json({ error: err.message });
+  }
+});
+
+app.listen(8000, () => {
+  console.log("Server is running on port http://localhost:8000");
+});
+
+export default app;
+```
 
 ---
 
@@ -220,7 +234,7 @@ The public Solana RPC endpoints rate-limit aggressively. For reliable results us
 src/
 ├── index.ts              # SDK entry point — estimateFee() and init()
 ├── types.ts              # TypeScript types and interfaces
-├── config.ts             # Configuration and cluster RPC resolution
+├── config.ts             # Configuration and RPC resolution
 ├── protocols.ts          # Known protocol registry (Jupiter, Raydium, etc.)
 ├── engine/
 │   └── feeCalculator.ts  # Percentile math, strategy modifiers, outlier filtering

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fema-pf-calc",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "description": "Intelligent Solana priority fee estimation engine",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",