Merge branch 'master' of github.com:plebbit/plebbit-js

plebbit · Dec 8, 2023 · f621b0c · f621b0c
2 parents 7421471 + 7d225ca
commit f621b0c
Showing 1 changed file with 37 additions and 3 deletions.
diff --git a/src/rpc/README.md b/src/rpc/README.md
@@ -102,8 +102,8 @@ new Subscription(subscriptionId).on('message', console.log)
 - `method: listSubplebbits, params: []`
 - `method: getDefaults, params: []`
 - `method: fetchCid, params: [cid: string]`
-- `method: getPlebbitOptions, params: []`
-- `method: setPlebbitOptions, params: [plebbitOptions]`
+- `method: getSettings, params: []`
+- `method: setSettings, params: [plebbitRpcSettings]`
 - `method: getPeers, params: []`
 - `method: getStats, params: []`
 
@@ -383,4 +383,38 @@ Unsubscribe from notifications
 
 ```json
 { "jsonrpc": "2.0", "result": true, "id": 1 }
-```
+```
+
+## getSettings
+
+Get the current plebbit rpc settings
+
+### Result:
+
+`<PlebbitRpcSettings>` - Current plebbit rpc settings
+
+### Code sample:
+
+```json
+{
+  "jsonrpc": "2.0",
+  "id": 1,
+  "method": "getSettings",
+  "params": []
+}
+```
+
+### Response:
+
+```json
+{
+  "jsonrpc": "2.0",
+  "id": 1,
+  "result": {
+    "plebbitOptions": {...},
+    "challenges": {
+      "challenge-name": {...}
+    }
+  }, 
+}
+```