refactor(rpc): deprecate httpAgent and httpsAgent

ckb-js · Nov 27, 2023 · f275e8c · f275e8c
1 parent 6380e04
commit f275e8c
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 2 deletions.
diff --git a/packages/rpc/src/types/api.ts b/packages/rpc/src/types/api.ts
@@ -50,8 +50,6 @@ export namespace CKBComponents {
   export type Since = string;
   export interface Node {
     url: string;
-    httpAgent?: any;
-    httpsAgent?: any;
   }
   export interface Method {
     name: string;

diff --git a/website/docs/migrations/migrate-to-v0.21.md b/website/docs/migrations/migrate-to-v0.21.md
@@ -0,0 +1,15 @@
+# Migrate to Lumos v0.21
+
+### Deprecated the `httpAgent` and `httpsAgent` in `RPC.setNode`
+
+Please use the `fetch` option in `RPC` constructor instead.
+
+```diff
+-const rpc = new RPC(url)
++const rpc = new RPC(
++ url,
++ { fetch: (request, init) => originalFetch(request, { ...init, keepalive: true }) },
++)
+-rpc.setNode({ url, httpAgent, httpsAgent })
++rpc.setNode({ url })
+```