w3pk 0.5.2 → 0.7.0

package/README.md

@@ -5,7 +5,7 @@
 
 Passwordless Web3 authentication SDK with encrypted wallets and privacy features.
 
-**Demo:** https://d2u.w3hc.org/voting
+**Demo: [w3pk.w3hc.org](https://w3pk.w3hc.org)**
 
 ## Install
 ```bash
@@ -16,35 +16,38 @@ npm install w3pk ethers
 ```typescript
 import { createWeb3Passkey } from 'w3pk'
 
-const w3pk = createWeb3Passkey({
-  apiBaseUrl: 'https://webauthn.w3hc.org'
-})
+const w3pk = createWeb3Passkey()
 
-// Register
-await w3pk.register({
-  username: 'alice',
-  ethereumAddress: '0x...'
-})
+// Register (auto-generates wallet and stores it securely)
+const { mnemonic } = await w3pk.register({ username: 'alice' })
+console.log('⚠️  Save this recovery phrase:', mnemonic)
 
-// Login
+// Login (for subsequent sessions)
 await w3pk.login()
 
 // Sign message
 const signature = await w3pk.signMessage('Hello World')
 
 // Derive addresses
-const wallet = await w3pk.deriveWallet(0) // First address
-const wallet2 = await w3pk.deriveWallet(1) // Second address
+const wallet0 = await w3pk.deriveWallet(0)
+const wallet1 = await w3pk.deriveWallet(1)
+
+// Get RPC endpoints for any chain
+const endpoints = await w3pk.getEndpoints(1) // Ethereum
+const rpcUrl = endpoints[0]
 ```
 
 ## Features
 
 **Core (Included)**
 - 🔐 Passwordless authentication (WebAuthn/FIDO2)
-- 💰 Encrypted wallet management (AES-GCM-256)
+- 🔒 Client-only biometric-gated wallet encryption (AES-GCM-256)
+- ⏱️ Session management (configurable duration, prevents repeated prompts)
 - 🌱 HD wallet generation (BIP39/BIP44)
 - 🔢 Multi-address derivation
-- 🥷 Stealth addresses (privacy-preserving transactions)
+- 🥷 ERC-5564 stealth addresses (privacy-preserving transactions with view tags)
+- 🔗 Chainlist support (2390+ networks, auto-filtered RPC endpoints)
+- ⚡ EIP-7702 network detection (329+ supported networks)
 
 **Optional: Zero-Knowledge Proofs**
 
@@ -53,39 +56,41 @@ Requires additional dependencies (~70MB):
 npm install snarkjs circomlibjs
 ```
 
-See [ZK Integration Guide](./docs/ZK_INTEGRATION_GUIDE.md) for:
-- Anonymous membership proofs
-- Private balance verification
-- Range proofs without revealing values
-- NFT ownership proofs
-
-[Bundle size comparison →](./docs/BUNDLE_SIZES.md)
+See [ZK Integration Guide](./docs/ZK_INTEGRATION_GUIDE.md) to get started.
 
 ## API
 
-### Authentication
+### Authentication Flow
+
 ```typescript
-// Register new user
-await w3pk.register({ username, ethereumAddress })
+// Register (auto-stores wallet)
+const { mnemonic } = await w3pk.register({ username: 'alice' })
+// Returns: { mnemonic } - SAVE THIS!
 
-// Login (usernameless)
+// Subsequent sessions: just login
 await w3pk.login()
 
 // Logout
 await w3pk.logout()
 
-// Check status
+// Status
 w3pk.isAuthenticated
 w3pk.user
 ```
 
-### Wallet
+**Advanced: Pre-generate wallet (optional)**
 ```typescript
-// Generate wallet
-const wallet = await w3pk.generateWallet()
+// If you want to see the wallet before registering:
+const { mnemonic } = await w3pk.generateWallet()
+const { mnemonic } = await w3pk.register({ username: 'alice' })
+// register() will use the pre-generated wallet
+```
+
+### Wallet Operations
 
-// Derive HD wallet addresses
-const derived = await w3pk.deriveWallet(index)
+```typescript
+// Derive addresses
+const wallet0 = await w3pk.deriveWallet(0)
 // Returns: { address, privateKey }
 
 // Export mnemonic
@@ -95,35 +100,146 @@ const mnemonic = await w3pk.exportMnemonic()
 const signature = await w3pk.signMessage(message)
 ```
 
-### Stealth Addresses
+### Session Management
+
+By default, after authentication, operations work for 1 hour without repeated biometric prompts:
+
+```typescript
+// Configure session duration
+const w3pk = createWeb3Passkey({
+  sessionDuration: 2 // 2 hours (default: 1)
+})
+
+// After login, mnemonic is cached in memory
+await w3pk.login()
+
+// These operations use the cached session
+await w3pk.deriveWallet(0)
+await w3pk.exportMnemonic()
+await w3pk.signMessage('Hello')
+await w3pk.stealth.getKeys()
+
+// Check session status
+w3pk.hasActiveSession() // true
+w3pk.getSessionRemainingTime() // 3540 seconds
+
+// Extend session
+w3pk.extendSession() // Adds 2 more hours
+
+// Clear session manually (force re-authentication)
+w3pk.clearSession()
+
+// Disable sessions (most secure - prompt every time)
+const w3pk = createWeb3Passkey({ sessionDuration: 0 })
+```
+
+#### Force Authentication for Sensitive Operations
+
+Even with an active session, you can require fresh biometric authentication for specific operations:
+
+```typescript
+// Session is active, but force authentication anyway
+await w3pk.exportMnemonic({ requireAuth: true })
+await w3pk.signMessage('Transfer $1000', { requireAuth: true })
+await w3pk.deriveWallet(5, { requireAuth: true })
+await w3pk.stealth.getKeys({ requireAuth: true })
+
+// Example: Require auth for high-value transactions
+async function transferFunds(amount: number, recipient: string) {
+  // For transfers above $100, require fresh authentication
+  const requireAuth = amount > 100
+
+  const signature = await w3pk.signMessage(
+    `Transfer ${amount} to ${recipient}`,
+    { requireAuth }
+  )
+
+  // ... submit transaction
+}
+```
+
+### RPC Endpoints
+```typescript
+// Get public RPC endpoints
+const endpoints = await w3pk.getEndpoints(1) // Ethereum
+const rpcUrl = endpoints[0]
+
+// Other chains
+await w3pk.getEndpoints(10)    // Optimism
+await w3pk.getEndpoints(42161) // Arbitrum
+await w3pk.getEndpoints(8453)  // Base
+
+// Use with ethers.js
+import { ethers } from 'ethers'
+
+const endpoints = await w3pk.getEndpoints(137)
+const provider = new ethers.JsonRpcProvider(endpoints[0])
+const blockNumber = await provider.getBlockNumber()
+```
+
+### EIP-7702 Support
+```typescript
+// Check network support
+const supported = await w3pk.supportsEIP7702(1) // true
+
+// Configure RPC testing
+await w3pk.supportsEIP7702(999, {
+  maxEndpoints: 5,
+  timeout: 5000
+})
+```
+
+### ERC-5564 Stealth Addresses
+
 ```typescript
 const w3pk = createWeb3Passkey({
-  apiBaseUrl: 'https://webauthn.w3hc.org',
   stealthAddresses: {}
 })
 
-// Generate unlinkable address
-const stealth = await w3pk.stealth?.generateStealthAddress()
-// Returns: { stealthAddress, stealthPrivateKey, ephemeralPublicKey }
+// Get stealth meta-address
+const metaAddress = await w3pk.stealth?.getStealthMetaAddress()
+
+// Generate stealth address
+const announcement = await w3pk.stealth?.generateStealthAddress()
+
+// Parse announcement
+const result = await w3pk.stealth?.parseAnnouncement({
+  stealthAddress: announcement.stealthAddress,
+  ephemeralPublicKey: announcement.ephemeralPublicKey,
+  viewTag: announcement.viewTag
+})
+
+if (result.isForUser) {
+  // Use private key to spend funds
+  console.log('Private key:', result.stealthPrivateKey)
+}
 
-// Get master keys
-const keys = await w3pk.stealth?.getKeys()
-// Returns: { metaAddress, viewingKey, spendingKey }
+// Scan announcements
+const myPayments = await w3pk.stealth?.scanAnnouncements(announcements)
 ```
 
-## Documentation
+## Browser Compatibility
+
+**Supported (95%+ of users):**
+- Chrome 67+ (May 2018), Edge 18+ (Nov 2018), Firefox 60+ (May 2018), Safari 14+ (Sep 2020)
+- iOS 14.5+ (April 2021), Android 9+ (August 2018)
+- Windows Hello, Touch ID, Face ID, platform authenticators
 
-- [Quick Start Guide](./docs/QUICK_START.md)
-- [ZK Integration Guide](./docs/ZK_INTEGRATION_GUIDE.md)
-- [Bundle Size Comparison](./docs/BUNDLE_SIZES.md)
+**Not Supported:**
+- Safari < 14, Chrome/Firefox < 2018, IE11, Android < 9, iOS < 14.5
+- Private/Incognito mode (credentials don't persist)
+- WebView/embedded browsers (often disabled)
 
-## Examples
+## Documentation
 
-- [Basic Authentication](./examples/basic-auth.ts)
-- [Wallet Management](./examples/wallet-demo.ts)
-- [Stealth Addresses](./examples/stealth-demo.ts)
-- [ZK Proofs](./examples/zk-proof-demo.ts) (requires ZK deps)
-- [NFT Ownership](./examples/nft-ownership-proof.ts) (requires ZK deps)
+- [Quick Start Guide](./docs/QUICK_START.md) - Get started in 5 minutes
+- [Browser Compatibility](./docs/BROWSER_COMPATIBILITY.md) - Supported browsers, devices, and OS versions
+- [Security Architecture](./docs/SECURITY.md) - Integration best practices
+- [ERC-5564 Stealth Addresses](./docs/ERC5564_STEALTH_ADDRESSES.md) - Complete guide with examples
+- [ERC-5564 Flow Diagrams](./docs/ERC5564_FLOW_DIAGRAM.md) - Visual explanations of how stealth addresses work
+- [RPC Endpoints](./docs/CHAINLIST.md) - Chainlist integration guide
+- [ZK Integration Guide](./docs/ZK_INTEGRATION_GUIDE.md) - Zero-knowledge proofs (optional)
+- [Bundle Size Comparison](./docs/BUNDLE_SIZES.md) - Core vs ZK bundle sizes
 
 ## Contributing
 

package/dist/chainlist/index.d.mts

@@ -0,0 +1,96 @@
+/**
+ * Chainlist types
+ */
+interface Chain {
+    name: string;
+    chain: string;
+    icon?: string;
+    rpc: string[];
+    features?: Array<{
+        name: string;
+    }>;
+    faucets: string[];
+    nativeCurrency: {
+        name: string;
+        symbol: string;
+        decimals: number;
+    };
+    infoURL: string;
+    shortName: string;
+    chainId: number;
+    networkId: number;
+    slip44?: number;
+    ens?: {
+        registry: string;
+    };
+    explorers?: Array<{
+        name: string;
+        url: string;
+        icon?: string;
+        standard: string;
+    }>;
+    title?: string;
+    status?: string;
+    redFlags?: string[];
+}
+interface ChainlistOptions {
+    /**
+     * Custom URL for chains.json data
+     * @default 'https://chainid.network/chains.json'
+     */
+    chainsJsonUrl?: string;
+    /**
+     * Cache duration in milliseconds
+     * @default 3600000 (1 hour)
+     */
+    cacheDuration?: number;
+}
+
+/**
+ * Chainlist module for fetching RPC endpoints
+ */
+
+/**
+ * Get RPC endpoints for a specific chain ID, excluding those that require API keys
+ *
+ * @param chainId - The chain ID to get endpoints for
+ * @param options - Optional configuration
+ * @returns Array of RPC URLs that don't require API keys
+ *
+ * @example
+ * ```typescript
+ * import { getEndpoints } from 'w3pk/chainlist'
+ *
+ * // Get Ethereum mainnet RPCs
+ * const endpoints = await getEndpoints(1)
+ * console.log(endpoints)
+ * // [
+ * //   "https://api.mycryptoapi.com/eth",
+ * //   "https://cloudflare-eth.com",
+ * //   "https://ethereum-rpc.publicnode.com",
+ * //   ...
+ * // ]
+ * ```
+ */
+declare function getEndpoints(chainId: number, options?: ChainlistOptions): Promise<string[]>;
+/**
+ * Get all available chains
+ *
+ * @param options - Optional configuration
+ * @returns Array of all chains
+ */
+declare function getAllChains(options?: ChainlistOptions): Promise<Chain[]>;
+/**
+ * Get chain information by chain ID
+ *
+ * @param chainId - The chain ID to get information for
+ * @param options - Optional configuration
+ * @returns Chain information or undefined if not found
+ */
+declare function getChainById(chainId: number, options?: ChainlistOptions): Promise<Chain | undefined>;
+/**
+ * Clear the chains data cache
+ */
+declare function clearCache(): void;
+
+export { type Chain, type ChainlistOptions, clearCache, getAllChains, getChainById, getEndpoints };

package/dist/chainlist/index.d.ts

@@ -0,0 +1,96 @@
+/**
+ * Chainlist types
+ */
+interface Chain {
+    name: string;
+    chain: string;
+    icon?: string;
+    rpc: string[];
+    features?: Array<{
+        name: string;
+    }>;
+    faucets: string[];
+    nativeCurrency: {
+        name: string;
+        symbol: string;
+        decimals: number;
+    };
+    infoURL: string;
+    shortName: string;
+    chainId: number;
+    networkId: number;
+    slip44?: number;
+    ens?: {
+        registry: string;
+    };
+    explorers?: Array<{
+        name: string;
+        url: string;
+        icon?: string;
+        standard: string;
+    }>;
+    title?: string;
+    status?: string;
+    redFlags?: string[];
+}
+interface ChainlistOptions {
+    /**
+     * Custom URL for chains.json data
+     * @default 'https://chainid.network/chains.json'
+     */
+    chainsJsonUrl?: string;
+    /**
+     * Cache duration in milliseconds
+     * @default 3600000 (1 hour)
+     */
+    cacheDuration?: number;
+}
+
+/**
+ * Chainlist module for fetching RPC endpoints
+ */
+
+/**
+ * Get RPC endpoints for a specific chain ID, excluding those that require API keys
+ *
+ * @param chainId - The chain ID to get endpoints for
+ * @param options - Optional configuration
+ * @returns Array of RPC URLs that don't require API keys
+ *
+ * @example
+ * ```typescript
+ * import { getEndpoints } from 'w3pk/chainlist'
+ *
+ * // Get Ethereum mainnet RPCs
+ * const endpoints = await getEndpoints(1)
+ * console.log(endpoints)
+ * // [
+ * //   "https://api.mycryptoapi.com/eth",
+ * //   "https://cloudflare-eth.com",
+ * //   "https://ethereum-rpc.publicnode.com",
+ * //   ...
+ * // ]
+ * ```
+ */
+declare function getEndpoints(chainId: number, options?: ChainlistOptions): Promise<string[]>;
+/**
+ * Get all available chains
+ *
+ * @param options - Optional configuration
+ * @returns Array of all chains
+ */
+declare function getAllChains(options?: ChainlistOptions): Promise<Chain[]>;
+/**
+ * Get chain information by chain ID
+ *
+ * @param chainId - The chain ID to get information for
+ * @param options - Optional configuration
+ * @returns Chain information or undefined if not found
+ */
+declare function getChainById(chainId: number, options?: ChainlistOptions): Promise<Chain | undefined>;
+/**
+ * Clear the chains data cache
+ */
+declare function clearCache(): void;
+
+export { type Chain, type ChainlistOptions, clearCache, getAllChains, getChainById, getEndpoints };

package/dist/chainlist/index.js

@@ -0,0 +1,2 @@
+"use strict";var o=Object.defineProperty;var h=Object.getOwnPropertyDescriptor;var u=Object.getOwnPropertyNames;var C=Object.prototype.hasOwnProperty;var p=(t,n)=>{for(var s in n)o(t,s,{get:n[s],enumerable:!0})},f=(t,n,s,a)=>{if(n&&typeof n=="object"||typeof n=="function")for(let i of u(n))!C.call(t,i)&&i!==s&&o(t,i,{get:()=>n[i],enumerable:!(a=h(n,i))||a.enumerable});return t};var l=t=>f(o({},"__esModule",{value:!0}),t);var I={};p(I,{clearCache:()=>y,getAllChains:()=>w,getChainById:()=>A,getEndpoints:()=>d});module.exports=l(I);var c="https://chainid.network/chains.json";var e=null,m=[/\$\{[\w_]+\}/i,/\{[\w_]+\}/i,/<[\w_]+>/i,/YOUR[-_]?API[-_]?KEY/i,/INSERT[-_]?API[-_]?KEY/i,/API[-_]?KEY[-_]?HERE/i];function E(t){return m.some(n=>n.test(t))}async function _(t=c){let n=await fetch(t);if(!n.ok)throw new Error(`Failed to fetch chains data: ${n.status} ${n.statusText}`);return await n.json()}async function r(t){let n=t?.chainsJsonUrl??c,s=t?.cacheDuration??36e5,a=Date.now();if(e&&a-e.timestamp<s)return e.data;let i=await _(n);return e={data:i,timestamp:a},i}async function d(t,n){let a=(await r(n)).find(i=>i.chainId===t);return a?a.rpc.filter(i=>!E(i)&&!i.startsWith("wss://")&&!i.startsWith("ws://")):[]}async function w(t){return r(t)}async function A(t,n){return(await r(n)).find(a=>a.chainId===t)}function y(){e=null}
+//# sourceMappingURL=index.js.map

package/dist/chainlist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/chainlist/index.ts"],"sourcesContent":["/**\n * Chainlist module for fetching RPC endpoints\n */\n\nimport type { Chain, ChainlistOptions } from \"./types\";\n\nconst DEFAULT_CHAINS_URL = \"https://chainid.network/chains.json\";\nconst DEFAULT_CACHE_DURATION = 3600000; // 1 hour\n\ninterface CacheEntry {\n  data: Chain[];\n  timestamp: number;\n}\n\nlet cache: CacheEntry | null = null;\n\n/**\n * Patterns that indicate an RPC URL requires an API key\n */\nconst API_KEY_PATTERNS = [\n  /\\$\\{[\\w_]+\\}/i, // ${INFURA_API_KEY}, ${API_KEY}, etc.\n  /\\{[\\w_]+\\}/i, // {API_KEY}, {INFURA_API_KEY}, etc.\n  /<[\\w_]+>/i, // <API_KEY>, <INFURA_API_KEY>, etc.\n  /YOUR[-_]?API[-_]?KEY/i,\n  /INSERT[-_]?API[-_]?KEY/i,\n  /API[-_]?KEY[-_]?HERE/i,\n];\n\n/**\n * Check if an RPC URL requires an API key\n */\nfunction requiresApiKey(rpcUrl: string): boolean {\n  return API_KEY_PATTERNS.some((pattern) => pattern.test(rpcUrl));\n}\n\n/**\n * Fetch all chains data from chainid.network\n */\nasync function fetchChains(\n  chainsJsonUrl: string = DEFAULT_CHAINS_URL\n): Promise<Chain[]> {\n  const response = await fetch(chainsJsonUrl);\n\n  if (!response.ok) {\n    throw new Error(\n      `Failed to fetch chains data: ${response.status} ${response.statusText}`\n    );\n  }\n\n  return await response.json();\n}\n\n/**\n * Get all chains data with caching\n */\nasync function getChainsData(options?: ChainlistOptions): Promise<Chain[]> {\n  const chainsJsonUrl = options?.chainsJsonUrl ?? DEFAULT_CHAINS_URL;\n  const cacheDuration = options?.cacheDuration ?? DEFAULT_CACHE_DURATION;\n  const now = Date.now();\n\n  // Check if cache is valid\n  if (cache && now - cache.timestamp < cacheDuration) {\n    return cache.data;\n  }\n\n  // Fetch fresh data\n  const data = await fetchChains(chainsJsonUrl);\n  cache = { data, timestamp: now };\n\n  return data;\n}\n\n/**\n * Get RPC endpoints for a specific chain ID, excluding those that require API keys\n *\n * @param chainId - The chain ID to get endpoints for\n * @param options - Optional configuration\n * @returns Array of RPC URLs that don't require API keys\n *\n * @example\n * ```typescript\n * import { getEndpoints } from 'w3pk/chainlist'\n *\n * // Get Ethereum mainnet RPCs\n * const endpoints = await getEndpoints(1)\n * console.log(endpoints)\n * // [\n * //   \"https://api.mycryptoapi.com/eth\",\n * //   \"https://cloudflare-eth.com\",\n * //   \"https://ethereum-rpc.publicnode.com\",\n * //   ...\n * // ]\n * ```\n */\nexport async function getEndpoints(\n  chainId: number,\n  options?: ChainlistOptions\n): Promise<string[]> {\n  const chains = await getChainsData(options);\n  const chain = chains.find((c) => c.chainId === chainId);\n\n  if (!chain) {\n    return [];\n  }\n\n  // Filter out RPC URLs that require API keys and websocket URLs\n  return chain.rpc.filter(\n    (rpcUrl) =>\n      !requiresApiKey(rpcUrl) &&\n      !rpcUrl.startsWith(\"wss://\") &&\n      !rpcUrl.startsWith(\"ws://\")\n  );\n}\n\n/**\n * Get all available chains\n *\n * @param options - Optional configuration\n * @returns Array of all chains\n */\nexport async function getAllChains(\n  options?: ChainlistOptions\n): Promise<Chain[]> {\n  return getChainsData(options);\n}\n\n/**\n * Get chain information by chain ID\n *\n * @param chainId - The chain ID to get information for\n * @param options - Optional configuration\n * @returns Chain information or undefined if not found\n */\nexport async function getChainById(\n  chainId: number,\n  options?: ChainlistOptions\n): Promise<Chain | undefined> {\n  const chains = await getChainsData(options);\n  return chains.find((c) => c.chainId === chainId);\n}\n\n/**\n * Clear the chains data cache\n */\nexport function clearCache(): void {\n  cache = null;\n}\n\n// Export types\nexport type { Chain, ChainlistOptions } from \"./types\";\n"],"mappings":"yaAAA,IAAAA,EAAA,GAAAC,EAAAD,EAAA,gBAAAE,EAAA,iBAAAC,EAAA,iBAAAC,EAAA,iBAAAC,IAAA,eAAAC,EAAAN,GAMA,IAAMO,EAAqB,sCAQ3B,IAAIC,EAA2B,KAKzBC,EAAmB,CACvB,gBACA,cACA,YACA,wBACA,0BACA,uBACF,EAKA,SAASC,EAAeC,EAAyB,CAC/C,OAAOF,EAAiB,KAAMG,GAAYA,EAAQ,KAAKD,CAAM,CAAC,CAChE,CAKA,eAAeE,EACbC,EAAwBC,EACN,CAClB,IAAMC,EAAW,MAAM,MAAMF,CAAa,EAE1C,GAAI,CAACE,EAAS,GACZ,MAAM,IAAI,MACR,gCAAgCA,EAAS,MAAM,IAAIA,EAAS,UAAU,EACxE,EAGF,OAAO,MAAMA,EAAS,KAAK,CAC7B,CAKA,eAAeC,EAAcC,EAA8C,CACzE,IAAMJ,EAAgBI,GAAS,eAAiBH,EAC1CI,EAAgBD,GAAS,eAAiB,KAC1CE,EAAM,KAAK,IAAI,EAGrB,GAAIZ,GAASY,EAAMZ,EAAM,UAAYW,EACnC,OAAOX,EAAM,KAIf,IAAMa,EAAO,MAAMR,EAAYC,CAAa,EAC5C,OAAAN,EAAQ,CAAE,KAAAa,EAAM,UAAWD,CAAI,EAExBC,CACT,CAwBA,eAAsBC,EACpBC,EACAL,EACmB,CAEnB,IAAMM,GADS,MAAMP,EAAcC,CAAO,GACrB,KAAMO,GAAMA,EAAE,UAAYF,CAAO,EAEtD,OAAKC,EAKEA,EAAM,IAAI,OACdb,GACC,CAACD,EAAeC,CAAM,GACtB,CAACA,EAAO,WAAW,QAAQ,GAC3B,CAACA,EAAO,WAAW,OAAO,CAC9B,EATS,CAAC,CAUZ,CAQA,eAAsBe,EACpBR,EACkB,CAClB,OAAOD,EAAcC,CAAO,CAC9B,CASA,eAAsBS,EACpBJ,EACAL,EAC4B,CAE5B,OADe,MAAMD,EAAcC,CAAO,GAC5B,KAAMO,GAAMA,EAAE,UAAYF,CAAO,CACjD,CAKO,SAASK,GAAmB,CACjCpB,EAAQ,IACV","names":["chainlist_exports","__export","clearCache","getAllChains","getChainById","getEndpoints","__toCommonJS","DEFAULT_CHAINS_URL","cache","API_KEY_PATTERNS","requiresApiKey","rpcUrl","pattern","fetchChains","chainsJsonUrl","DEFAULT_CHAINS_URL","response","getChainsData","options","cacheDuration","now","data","getEndpoints","chainId","chain","c","getAllChains","getChainById","clearCache"]}

package/dist/chainlist/index.mjs

@@ -0,0 +1,2 @@
+var r="https://chainid.network/chains.json";var s=null,c=[/\$\{[\w_]+\}/i,/\{[\w_]+\}/i,/<[\w_]+>/i,/YOUR[-_]?API[-_]?KEY/i,/INSERT[-_]?API[-_]?KEY/i,/API[-_]?KEY[-_]?HERE/i];function h(n){return c.some(t=>t.test(n))}async function u(n=r){let t=await fetch(n);if(!t.ok)throw new Error(`Failed to fetch chains data: ${t.status} ${t.statusText}`);return await t.json()}async function o(n){let t=n?.chainsJsonUrl??r,e=n?.cacheDuration??36e5,a=Date.now();if(s&&a-s.timestamp<e)return s.data;let i=await u(t);return s={data:i,timestamp:a},i}async function C(n,t){let a=(await o(t)).find(i=>i.chainId===n);return a?a.rpc.filter(i=>!h(i)&&!i.startsWith("wss://")&&!i.startsWith("ws://")):[]}async function p(n){return o(n)}async function f(n,t){return(await o(t)).find(a=>a.chainId===n)}function l(){s=null}export{l as clearCache,p as getAllChains,f as getChainById,C as getEndpoints};
+//# sourceMappingURL=index.mjs.map

package/dist/chainlist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/chainlist/index.ts"],"sourcesContent":["/**\n * Chainlist module for fetching RPC endpoints\n */\n\nimport type { Chain, ChainlistOptions } from \"./types\";\n\nconst DEFAULT_CHAINS_URL = \"https://chainid.network/chains.json\";\nconst DEFAULT_CACHE_DURATION = 3600000; // 1 hour\n\ninterface CacheEntry {\n  data: Chain[];\n  timestamp: number;\n}\n\nlet cache: CacheEntry | null = null;\n\n/**\n * Patterns that indicate an RPC URL requires an API key\n */\nconst API_KEY_PATTERNS = [\n  /\\$\\{[\\w_]+\\}/i, // ${INFURA_API_KEY}, ${API_KEY}, etc.\n  /\\{[\\w_]+\\}/i, // {API_KEY}, {INFURA_API_KEY}, etc.\n  /<[\\w_]+>/i, // <API_KEY>, <INFURA_API_KEY>, etc.\n  /YOUR[-_]?API[-_]?KEY/i,\n  /INSERT[-_]?API[-_]?KEY/i,\n  /API[-_]?KEY[-_]?HERE/i,\n];\n\n/**\n * Check if an RPC URL requires an API key\n */\nfunction requiresApiKey(rpcUrl: string): boolean {\n  return API_KEY_PATTERNS.some((pattern) => pattern.test(rpcUrl));\n}\n\n/**\n * Fetch all chains data from chainid.network\n */\nasync function fetchChains(\n  chainsJsonUrl: string = DEFAULT_CHAINS_URL\n): Promise<Chain[]> {\n  const response = await fetch(chainsJsonUrl);\n\n  if (!response.ok) {\n    throw new Error(\n      `Failed to fetch chains data: ${response.status} ${response.statusText}`\n    );\n  }\n\n  return await response.json();\n}\n\n/**\n * Get all chains data with caching\n */\nasync function getChainsData(options?: ChainlistOptions): Promise<Chain[]> {\n  const chainsJsonUrl = options?.chainsJsonUrl ?? DEFAULT_CHAINS_URL;\n  const cacheDuration = options?.cacheDuration ?? DEFAULT_CACHE_DURATION;\n  const now = Date.now();\n\n  // Check if cache is valid\n  if (cache && now - cache.timestamp < cacheDuration) {\n    return cache.data;\n  }\n\n  // Fetch fresh data\n  const data = await fetchChains(chainsJsonUrl);\n  cache = { data, timestamp: now };\n\n  return data;\n}\n\n/**\n * Get RPC endpoints for a specific chain ID, excluding those that require API keys\n *\n * @param chainId - The chain ID to get endpoints for\n * @param options - Optional configuration\n * @returns Array of RPC URLs that don't require API keys\n *\n * @example\n * ```typescript\n * import { getEndpoints } from 'w3pk/chainlist'\n *\n * // Get Ethereum mainnet RPCs\n * const endpoints = await getEndpoints(1)\n * console.log(endpoints)\n * // [\n * //   \"https://api.mycryptoapi.com/eth\",\n * //   \"https://cloudflare-eth.com\",\n * //   \"https://ethereum-rpc.publicnode.com\",\n * //   ...\n * // ]\n * ```\n */\nexport async function getEndpoints(\n  chainId: number,\n  options?: ChainlistOptions\n): Promise<string[]> {\n  const chains = await getChainsData(options);\n  const chain = chains.find((c) => c.chainId === chainId);\n\n  if (!chain) {\n    return [];\n  }\n\n  // Filter out RPC URLs that require API keys and websocket URLs\n  return chain.rpc.filter(\n    (rpcUrl) =>\n      !requiresApiKey(rpcUrl) &&\n      !rpcUrl.startsWith(\"wss://\") &&\n      !rpcUrl.startsWith(\"ws://\")\n  );\n}\n\n/**\n * Get all available chains\n *\n * @param options - Optional configuration\n * @returns Array of all chains\n */\nexport async function getAllChains(\n  options?: ChainlistOptions\n): Promise<Chain[]> {\n  return getChainsData(options);\n}\n\n/**\n * Get chain information by chain ID\n *\n * @param chainId - The chain ID to get information for\n * @param options - Optional configuration\n * @returns Chain information or undefined if not found\n */\nexport async function getChainById(\n  chainId: number,\n  options?: ChainlistOptions\n): Promise<Chain | undefined> {\n  const chains = await getChainsData(options);\n  return chains.find((c) => c.chainId === chainId);\n}\n\n/**\n * Clear the chains data cache\n */\nexport function clearCache(): void {\n  cache = null;\n}\n\n// Export types\nexport type { Chain, ChainlistOptions } from \"./types\";\n"],"mappings":"AAMA,IAAMA,EAAqB,sCAQ3B,IAAIC,EAA2B,KAKzBC,EAAmB,CACvB,gBACA,cACA,YACA,wBACA,0BACA,uBACF,EAKA,SAASC,EAAeC,EAAyB,CAC/C,OAAOF,EAAiB,KAAMG,GAAYA,EAAQ,KAAKD,CAAM,CAAC,CAChE,CAKA,eAAeE,EACbC,EAAwBC,EACN,CAClB,IAAMC,EAAW,MAAM,MAAMF,CAAa,EAE1C,GAAI,CAACE,EAAS,GACZ,MAAM,IAAI,MACR,gCAAgCA,EAAS,MAAM,IAAIA,EAAS,UAAU,EACxE,EAGF,OAAO,MAAMA,EAAS,KAAK,CAC7B,CAKA,eAAeC,EAAcC,EAA8C,CACzE,IAAMJ,EAAgBI,GAAS,eAAiBH,EAC1CI,EAAgBD,GAAS,eAAiB,KAC1CE,EAAM,KAAK,IAAI,EAGrB,GAAIZ,GAASY,EAAMZ,EAAM,UAAYW,EACnC,OAAOX,EAAM,KAIf,IAAMa,EAAO,MAAMR,EAAYC,CAAa,EAC5C,OAAAN,EAAQ,CAAE,KAAAa,EAAM,UAAWD,CAAI,EAExBC,CACT,CAwBA,eAAsBC,EACpBC,EACAL,EACmB,CAEnB,IAAMM,GADS,MAAMP,EAAcC,CAAO,GACrB,KAAMO,GAAMA,EAAE,UAAYF,CAAO,EAEtD,OAAKC,EAKEA,EAAM,IAAI,OACdb,GACC,CAACD,EAAeC,CAAM,GACtB,CAACA,EAAO,WAAW,QAAQ,GAC3B,CAACA,EAAO,WAAW,OAAO,CAC9B,EATS,CAAC,CAUZ,CAQA,eAAsBe,EACpBR,EACkB,CAClB,OAAOD,EAAcC,CAAO,CAC9B,CASA,eAAsBS,EACpBJ,EACAL,EAC4B,CAE5B,OADe,MAAMD,EAAcC,CAAO,GAC5B,KAAMO,GAAMA,EAAE,UAAYF,CAAO,CACjD,CAKO,SAASK,GAAmB,CACjCpB,EAAQ,IACV","names":["DEFAULT_CHAINS_URL","cache","API_KEY_PATTERNS","requiresApiKey","rpcUrl","pattern","fetchChains","chainsJsonUrl","DEFAULT_CHAINS_URL","response","getChainsData","options","cacheDuration","now","data","getEndpoints","chainId","chain","c","getAllChains","getChainById","clearCache"]}