101: Update README for v2.1.0

aurora-is-near · Jul 21, 2023 · eeaf4f9 · eeaf4f9
1 parent 3408c75
commit eeaf4f9
Showing 1 changed file with 59 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -110,13 +110,17 @@ for detailed explanation and flags of each command see help
 | endpoint.eth.proxyEndpoints.url               | ENDPOINT_ETH_PROXYENDPOINTS_URL                         | `https://testnet.aurora.dev:443`             | ❌              |                                                                                                                                                     |
 | endpoint.eth.proxyEndpoints.endpoints         | ENDPOINT_ETH_PROXYENDPOINTS_ENDPOINTS                   | empty list                                   | ✅              | e.g.: eth_estimateGas, debug_traceTransaction                                                                                                       |
 | endpoint.eth.proxyEndpoints.disabledEndpoints | ENDPOINT_ETH_DISABLEDENDPOINTS                          | empty list                                   | ✅              | e.g.: debug_traceTransaction                                                                                                                        |
-| rpcNode.geth.HTTPHost                         | RPCNODE_GETH_HTTPHOST                                   | `localhost`                                  | ❌              |                                                                                                                                                     |
-| rpcNode.geth.HTTPPort                         | RPCNODE_GETH_HTTPPORT                                   | `8545`                                       | ❌              |                                                                                                                                                     |
-| rpcNode.geth.HTTPVirtualHosts                 | RPCNODE_GETH_HTTPVIRTUALHOSTS                           | `["localhost"]`                              | ❌              |                                                                                                                                                     |
-| rpcNode.geth.HTTPModules                      | RPCNODE_GETH_HTTPMODULES                                | `["net", "web3", "eth", "parity"]`           | ❌              |                                                                                                                                                     |
-| rpcNode.geth.WSHost                           | RPCNODE_GETH_WSHOST                                     | `localhost`                                  | ❌              |                                                                                                                                                     |
-| rpcNode.geth.WSPort                           | RPCNODE_GETH_WSPORT                                     | `8545`                                       | ❌              |                                                                                                                                                     |
-| rpcNode.geth.WSModules                        | RPCNODE_GETH_WSMODULES                                  | `["net", "web3", "eth", "parity"]`           | ❌              |                                                                                                                                                     |
+| rpcNode.httpHost                              | RPCNODE_HTTPHOST                                        | `localhost`                                  | ❌              |                                                                                                                                                     |
+| rpcNode.httpPort                              | RPCNODE_HTTPPORT                                        | `8545`                                       | ❌              |                                                                                                                                                     |
+| rpcNode.httpPathPrefix                        | RPCNODE_HTTPPATHPREFIX                                  | `"*"`                                        | ❌              | `"*"` allows any path, please provide specific prefix starting with `"/"` to limit request URL                                                      |
+| rpcNode.httpCors                              | RPCNODE_HTTPCORS                                        | `""`                                         | ❌              |                                                                                                                                                     |
+| rpcNode.httpCompress                          | RPCNODE_HTTPCOMPRESS                                    | `true`                                       | ❌              |                                                                                                                                                     |
+| rpcNode.httpTimeout                           | RPCNODE_HTTPTIMEOUT                                     | `300`                                        | ❌              | in seconds                                                                                                                                          |
+| rpcNode.wsHost                                | RPCNODE_WSHOST                                          | `localhost`                                  | ❌              |                                                                                                                                                     |
+| rpcNode.wsPort                                | RPCNODE_WSPORT                                          | `8545`                                       | ❌              |                                                                                                                                                     |
+| rpcNode.wsPathPrefix                          | RPCNODE_WSPATHPREFIX                                    | `"*"`                                        | ❌              | `"*"` allows any path, please provide specific prefix starting with `"/"` to limit request URL                                                      |
+| rpcNode.wsHandshakeTimeout                    | RPCNODE__WSHANDSHAKETIMEOUT                             | `10`                                         | ❌              | in seconds                                                                                                                                          |
+| rpcNode.maxBatchRequest                       | RPCNODE_MAXBATCHREQUEST                                 | `10000`                                      | ❌              |                                                                                                                                                     |
 | indexer.sourceFolder                          | INDEXER_SOURCE_FOLDER                                   | `/tmp/relayer/json/`                         | ❌              |                                                                                                                                                     |
 | indexer.subFolderBatchSize                    | INDEXER_SUBFOLDERBATCHSIZE                              | `10000`                                      | ❌              |                                                                                                                                                     |
 | indexer.keepFiles                             | INDEXER_KEEPFILES                                       | `true`                                       | ❌              | deletes the json files after indexing if set to false                                                                                               |
@@ -229,6 +233,54 @@ for detailed explanation and flags of each command see help
     * `PATCH` backward compatible and stable release for hot-fixes published out of planned release cycle
     * `PRERELEASE` does not guarantees stability, mostly used for QA cycles, e.g.: `alpha`, `beta` with optional build number
 
+## Migration
+### from v2.0.x to v2.1.x
+Relayer2-Public v2.1.0 introduces a new JSON-RPC server. Therefore, for those who already have a native Relayer2-Public with version 
+`v2.0.x` should update the configuration .yaml file accordingly.
+#### sample v2.0.x config.yaml
+```shell
+rpcNode:
+  geth:                    # -> deprecated
+    HTTPHost: localhost
+    HTTPPort: 8545
+    HTTPPathPrefix: ""
+    HTTPCors: 
+      - "*"
+    HTTPVirtualHosts:      # -> deprecated
+      - "*"
+    HTTPModules:           # -> deprecated
+      - "net"
+      - "web3"
+      - "eth"
+      - "parity"
+    WSHost: localhost
+    WSPort: 8545
+    WSPathPrefix: ""
+    WSModules:             # -> deprecated
+      - "net"
+      - "web3"
+      - "eth"
+      - "parity"
+```
+#### sample v2.1. config.yaml
+```shell
+rpcNode:
+  httpHost: localhost
+  httpPort: 8545
+  httpPathPrefix: "*"
+  httpCors: 
+    - "*"
+  httpCompress: true      # -> new subfield
+  httpTimeout: 300        # -> new subfield
+  wsHost: localhost
+  wsPort: 8545
+  wsPathPrefix: "*"
+  wsHandshakeTimeout: 10  # -> new subfield
+  maxBatchRequests: 1000  # -> new subfield
+```
+**IMPORTANT** Please note that configuration update step is automatically done if you are
+using distribution project [Standalone Aurora Relayer and Refiner].
+
 ## Contributing
 
 [Go]: https://go.dev/doc/install