From 5033926fd1889b389eec1b5420e69acdba44d359 Mon Sep 17 00:00:00 2001
From: Gonzalo D'Elia <gonzalo@bloq.com>
Date: Thu, 9 May 2024 11:36:59 -0300
Subject: [PATCH 1/3] Add readme file

---
 packages/eth-rpc-cache/README.md | 89 ++++++++++++++++++++++++++++++++
 1 file changed, 89 insertions(+)
 create mode 100644 packages/eth-rpc-cache/README.md

diff --git a/packages/eth-rpc-cache/README.md b/packages/eth-rpc-cache/README.md
new file mode 100644
index 0000000..86b4cd3
--- /dev/null
+++ b/packages/eth-rpc-cache/README.md
@@ -0,0 +1,89 @@
+# eth-rpc-cache
+
+![NPM Version](https://img.shields.io/npm/v/eth-rpc-cache)
+
+A simple cache for Ethereum RPC requests extensible with different caching strategies.
+
+## Install
+
+```sh
+npm i eth-rpc-cache
+```
+
+## Usage
+
+```ts
+import { createEthRpcCache } from 'eth-rpc-cache'
+import { providers } from 'ethers'
+
+const provider = new providers.JsonRpcProvider('https://rpc.url.org')
+const cache = new Map()
+const cachedProvider = {
+  ...provider,
+  send: createEthRpcCache((method, params) => provider.send(method, params), {
+    cache
+  })
+}
+Object.setPrototypeOf(cachedProvider, Object.getPrototypeOf(cachedProvider))
+
+// Will call the RPC endpoint and retrieve the chainId
+await provider.send('eth_chainId', [])
+// Will retrieve the value from the cache, and while the instance is alive, it will permanently be cached
+await provider.send('eth_chainId', [])
+// Will call the RPC endpoint and retrieve the current number
+await provider.send('eth_blockNumber', [])
+// This value will be cached for ~half block, so if requested again before that time passes, it will come from the cache
+await provider.send('eth_blockNumber', [])
+```
+
+## API
+
+### createEthRpcCache(rpc, options)
+
+Returns a function
+
+#### Parameters
+
+##### rpc
+
+Type: `Function`
+
+A function that follows the [JSON-RPC specification](https://www.jsonrpc.org/specification). Its parameters are:
+
+- `method` (string): The method to call
+- `params` (Array): The parameters to pass to the method
+
+and returns a Promise which resolves to an object with the following structure
+
+- `jsonrpc` (string): Version of the protocol
+- `id` (number): The request identifier
+- `result` (any): The result of the request
+
+##### options
+
+Type: `object`  
+Default: `{}`
+
+An optional configuration object
+
+###### options.allowOthers (optional)
+
+Type: `boolean`  
+Default: `true`
+
+Whether the strategy should allow to run the RPC call to unknown methods. Throws if `false`
+
+###### options.cache (optional)
+
+Type: `object`  
+Default: `new Map()`
+
+The cache storage.
+Must implement these methods: `has(key)`, `set(key, value)`, `get(key)` and `delete(key)`
+
+###### options.strategy (optional)
+
+Type: `object[]`
+Default: `[perBlockStrategy, permanentStrategy]`
+
+Array of strategies to use to cache methods. If methods are repeated, the latter will take precedence over the former.

From 5899f015c1894519e8a732a3a6e410f434412f5f Mon Sep 17 00:00:00 2001
From: Gonzalo D'Elia <gonzalo@bloq.com>
Date: Thu, 9 May 2024 11:37:34 -0300
Subject: [PATCH 2/3] Switch to version 1.0.0

---
 package-lock.json                   | 2 +-
 packages/eth-rpc-cache/package.json | 4 ++--
 2 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/package-lock.json b/package-lock.json
index 72a92ed..59c0e8e 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -12358,7 +12358,7 @@
       }
     },
     "packages/eth-rpc-cache": {
-      "version": "0.0.1",
+      "version": "1.0.0",
       "license": "MIT",
       "dependencies": {
         "debug": "4.3.4",
diff --git a/packages/eth-rpc-cache/package.json b/packages/eth-rpc-cache/package.json
index e00e7d9..28038a0 100644
--- a/packages/eth-rpc-cache/package.json
+++ b/packages/eth-rpc-cache/package.json
@@ -1,7 +1,7 @@
 {
   "name": "eth-rpc-cache",
-  "version": "0.0.2",
-  "description": "A simple cache for Ethereum RPC requests",
+  "version": "1.0.0",
+  "description": "A simple cache for Ethereum RPC requests extensible with different caching strategies",
   "keywords": [
     "cache",
     "eth",

From da1240137903f0b7090d51dc6580864daf322446 Mon Sep 17 00:00:00 2001
From: Gonzalo D'Elia <gonzalo@bloq.com>
Date: Thu, 9 May 2024 11:39:23 -0300
Subject: [PATCH 3/3] Fix bad example on readme

---
 packages/eth-rpc-cache/README.md | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/packages/eth-rpc-cache/README.md b/packages/eth-rpc-cache/README.md
index 86b4cd3..360d116 100644
--- a/packages/eth-rpc-cache/README.md
+++ b/packages/eth-rpc-cache/README.md
@@ -27,13 +27,13 @@ const cachedProvider = {
 Object.setPrototypeOf(cachedProvider, Object.getPrototypeOf(cachedProvider))
 
 // Will call the RPC endpoint and retrieve the chainId
-await provider.send('eth_chainId', [])
+await cachedProvider.send('eth_chainId', [])
 // Will retrieve the value from the cache, and while the instance is alive, it will permanently be cached
-await provider.send('eth_chainId', [])
+await cachedProvider.send('eth_chainId', [])
 // Will call the RPC endpoint and retrieve the current number
-await provider.send('eth_blockNumber', [])
+await cachedProvider.send('eth_blockNumber', [])
 // This value will be cached for ~half block, so if requested again before that time passes, it will come from the cache
-await provider.send('eth_blockNumber', [])
+await cachedProvider.send('eth_blockNumber', [])
 ```
 
 ## API