Merge pull request #54 from nervosnetwork/update-docs

docs: update ethers api constructor
nervosnetwork · Nov 1, 2021 · 6cab685 · 6cab685
2 parents 41b39aa + 281c241
commit 6cab685
Showing 1 changed file with 5 additions and 7 deletions.
diff --git a/docs/api.md b/docs/api.md
@@ -170,7 +170,8 @@ class Abi {
 class PolyjuiceJsonRpcProvider extends providers.JsonRpcProvider {
     abi: Abi;
     godwoker: Godwoker;
-    constructor(polyjuice_config: PolyjuiceConfig, url?: ConnectionInfo | string, network?: Networkish);
+    enableInstantFinalityForReceipt: boolean;
+    constructor(polyjuiceConfig: PolyjuiceConfig, url?: ConnectionInfo | string, network?: Networkish, enableInstantFinalityForReceipt?: boolean);
     setAbi(abiItems: AbiItems): void;
     setMultiAbi(abiItemsArray: AbiItems[]): void;
     addAbi(_abiItems: AbiItems): void;
@@ -179,14 +180,11 @@ class PolyjuiceJsonRpcProvider extends providers.JsonRpcProvider {
     prepareRequest(method: string, params: any): [string, Array<any>];
 }
 
-interface PolyjuiceWebsocketProvider extends providers.WebSocketProvider {
-    constructor(polyjuiceConfig: PolyjuiceConfig, url: string, network?: Networkish): any;
-}
-
-class PolyjuiceWebsocketProvider extends providers.WebSocketProvider {
+export declare class PolyjuiceWebsocketProvider extends providers.WebSocketProvider {
     abi: Abi;
     godwoker: Godwoker;
-    constructor(polyjuiceConfig: PolyjuiceConfig, url: string, network?: Networkish);
+    enableInstantFinalityForReceipt: boolean;
+    constructor(polyjuiceConfig: PolyjuiceConfig, url: string, network?: Networkish, enableInstantFinalityForReceipt?: boolean);
     setAbi(abiItems: AbiItems): void;
     setMultiAbi(abiItemsArray: AbiItems[]): void;
     addAbi(_abiItems: AbiItems): void;