chore: release 1.1.0

Author: Cafe137

Dockerfile

@@ -0,0 +1,16 @@
+FROM node:alpine
+
+WORKDIR /usr/src/app
+
+COPY package*.json .
+COPY dist dist
+
+RUN npm install --ignore-scripts
+
+EXPOSE 9000
+
+ENV PORT=""
+ENV TARGET=""
+ENV EXPIRY=""
+
+CMD sh -c "node dist/index.js --port $PORT --target $TARGET --expiry $EXPIRY"

README.md

@@ -1,17 +1,44 @@
 # Etherproxy
 
-## Usage
+Etherproxy is a JSON-RPC reverse proxy tool designed for caching requests.
 
-To launch a JSON-RPC reverse proxy on port 9000 and forward all requests to GetBlock using your token and mainnet, run:
+## Usage
 
 ```
-npx etherproxy 9000 https://gno.getblock.io/YOUR_TOKEN/mainnet/
+npx etherproxy --port 9000 --target https://gno.getblock.io/YOUR_TOKEN/mainnet/ --expiry 2000
 ```
 
+The command above starts the JSON-RPC reverse proxy...
+
+-   on port 9000 (`--port`)
+-   forwarding all requests to GetBlock using your token and mainnet (`--target`)
+-   grouping requests together within 2 seconds (`--expiry`)
+
 Make sure to replace `YOUR_TOKEN` with your actual token.
 
+## Verify the tool is running
+
+Execute the `curl` command shown below repeatedly and inspect the logs of Etherproxy.
+
+```sh
+curl http://localhost:9000 -H "Content-Type: application/json" -X POST --data '{"jsonrpc":"2.0","method":"eth_blockNumber","params":[],"id":1}'
+```
+
+When the text `Cache hit` appears, it indicates that a request was saved and immediately returned:
+
+```txt
+[~] Key: {"jsonrpc":"2.0","method":"eth_blockNumber","params":[]}
+[~] Cache hit: {"jsonrpc":"2.0","method":"eth_blockNumber","params":[]}
+[~] Cache hit: {"jsonrpc":"2.0","method":"eth_blockNumber","params":[]}
+[~] Cache hit: {"jsonrpc":"2.0","method":"eth_blockNumber","params":[]}
+```
+
 ## Benefits
 
-The JSON-RPC reverse proxy provides several benefits, particularly in multi-node scenarios. For instance, requests such as `eth_blockNumber` and `eth_getLogs` are frequently called, and in such scenarios, it's easy to quickly exhaust your request quota.
+Etherproxy provides several benefits in multi-node scenarios. For instance, requests such as `eth_blockNumber` and `eth_getLogs` are frequently called, sometimes generating many unnecessary requests. By using a reverse proxy, the same requests made within a small time period are grouped together and sent to your JSON-RPC endpoint only once.
+
+As a result, all local nodes receive identical correct responses, and the number of actual requests sent is significantly reduced, which helps to **preserve your request quota** in case of a paid third-party, or **reduce the load** when you run your own Ethereum node.
+
+## Error handling
 
-However, by using the reverse proxy, the same requests made within 2 seconds are grouped together and sent to your third-party service only once. As a result, all local nodes receive the same response, which can significantly reduce the number of requests made and help preserve your quota.
+Whenever an error is thrown, Etherproxy responds with a `503 Service Unavailable` status.

package-lock.json

@@ -1,6 +1,6 @@
 {
     "name": "etherproxy",
-    "version": "1.0.0",
+    "version": "1.1.0",
     "description": "",
     "main": "dist/index.js",
     "bin": {
@@ -9,19 +9,18 @@
     "scripts": {
         "start": "ts-node src/index.ts",
         "prepare": "npm run build",
-        "build": "rimraf dist && tsc"
+        "build": "tsc"
     },
     "keywords": [],
     "author": "",
     "license": "MIT",
     "dependencies": {
-        "cafe-utility": "^9.0.1",
+        "cafe-utility": "^10.8.1",
         "node-fetch": "^2.6.9"
     },
     "devDependencies": {
         "@types/node": "^18.15.11",
         "@types/node-fetch": "^2.6.3",
-        "rimraf": "^4.4.1",
         "typescript": "^5.0.3"
     }
 }