🔀 Merge branch '1038-integrate-watcher' into staging

.github/workflows/cd-staging.yml

@@ -147,5 +147,5 @@ jobs:
             export INDRA_DOMAINNAME="$STAGING_DOMAINNAME";
             make restart-prod;
             docker container prune -f;
-            docker image ls -q | xargs docker image rm || true;
+            docker image ls -q | xargs docker image rm -f || true;
           '

Makefile

@@ -159,7 +159,10 @@ test-watcher: watcher
 	bash ops/test/watcher.sh
 
 test-node: node
-	bash ops/test/node.sh
+	bash ops/test/node.sh test
+
+watch-node:
+	bash ops/test/node.sh watch
 
 test-tps: bot
 	bash ops/test/tps.sh 5 0 10

docs/src/reference/watcher.md

@@ -110,7 +110,7 @@ type WatcherInitOptions = {
   signer: IChannelSigner | string; // wallet or pk
   provider: providers.JsonRpcProvider | string;
   context: ContractAddresses;
-  store: IWatcherStoreService;
+  store: IStoreService;
   logger?: ILoggerService | ILogger;
   logLevel?: number;
 };
@@ -130,7 +130,7 @@ The options object contains the following fields:
   A json containing all the addresses across the relevant network (should be derived from your `address-book.json`). This will be shared with an internal instance of the ChainListener class.
 
 - `store`:
-  `IWatcherStoreService` is an interface containing all the store methods for saving challenge records. You can use any connext store, or implement your own. See [challenge storage](#challengestorage) for more detail.
+  `IStoreService` is an interface containing all the store methods for saving challenge records. You can use any connext store, or implement your own. See [challenge storage](#challengestorage) for more detail.
 
 - `logger (optional)`:
   Optional logger, can use the exported logger from the `@connext/utils` package

modules/cf-core/src/methods/state-channel/deploy-state-deposit-holder.ts

@@ -5,7 +5,12 @@ import {
   MinimalTransaction,
   TransactionReceipt,
 } from "@connext/types";
-import { delay, getGasPrice, getSignerAddressFromPublicIdentifier, stringify } from "@connext/utils";
+import {
+  delay,
+  getGasPrice,
+  getSignerAddressFromPublicIdentifier,
+  stringify,
+} from "@connext/utils";
 import { Contract, Signer, utils, constants, providers } from "ethers";
 
 import {
@@ -150,7 +155,12 @@ export class DeployStateDepositController extends MethodController {
     let error: any;
     if (transactionService) {
       log.info("Sending multisig deployment transaction using transaction service");
-      receipt = await transactionService.sendTransaction(minTx, preProtocolStateChannel.toJson());
+      const response = await transactionService.sendTransaction(
+        minTx,
+        preProtocolStateChannel.chainId,
+        preProtocolStateChannel.multisigAddress,
+      );
+      receipt = await response.wait();
     } else {
       // try with nonce retry logic
       for (let tryCount = 1; tryCount <= retryCount; tryCount += 1) {

modules/cf-core/src/rpc-router.ts

@@ -53,6 +53,7 @@ export class RpcRouter {
   }
 
   unsubscribeAll() {
+    this.requestHandler.incoming.removeAllListeners();
     this.requestHandler.outgoing.removeAllListeners();
   }
 

modules/client/package.json

@@ -15,15 +15,16 @@
     "lint": "../../node_modules/.bin/eslint -c '../../.eslintrc.js' --fix 'src/**/*'"
   },
   "dependencies": {
-    "axios": "0.19.2",
     "@connext/apps": "7.3.8",
     "@connext/cf-core": "7.3.8",
     "@connext/channel-provider": "7.3.8",
-    "@connext/utils": "7.3.8",
     "@connext/contracts": "3.5.0",
     "@connext/messaging": "7.3.8",
     "@connext/store": "7.3.8",
     "@connext/types": "7.3.8",
+    "@connext/utils": "7.3.8",
+    "@connext/watcher": "7.3.8",
+    "axios": "0.19.2",
     "core-js": "3.6.5",
     "ethers": "5.0.8",
     "evt": "1.8.4",

modules/client/src/channelProvider.ts

@@ -29,10 +29,6 @@ import {
   ValidationMiddleware,
   ProtocolName,
   MiddlewareContext,
-  ProtocolNames,
-  ProposeMiddlewareContext,
-  UninstallMiddlewareContext,
-  InstallMiddlewareContext,
 } from "@connext/types";
 import {
   deBigNumberifyJson,
@@ -224,8 +220,7 @@ export class CFCoreRpcConnection extends ConnextEventEmitter implements IRpcConn
   };
 
   public removeAllListeners = (): any => {
-    this.cfCore.removeAllListeners();
-    return this.cfCore;
+    return this.cfCore.removeAllListeners();
   };
 
   public once = (

modules/client/src/connect.ts

@@ -18,6 +18,7 @@ import {
   delay,
   getChainId,
 } from "@connext/utils";
+import { Watcher } from "@connext/watcher";
 
 import { Contract, providers } from "ethers";
 
@@ -45,6 +46,7 @@ export const connect = async (
     nodeUrl,
     middlewareMap,
     skipInitStore,
+    watcherEnabled,
     skipSync,
   } = opts;
   let { ethProvider, messaging } = opts;
@@ -142,6 +144,17 @@ export const connect = async (
     throw new Error("Must provide channelProvider or signer");
   }
 
+  // create watcher, which is enabled by default
+  const watcher = await Watcher.init({
+    signer,
+    providers: {},
+    context: node.config.contractAddresses,
+    store,
+  });
+  if (!watcherEnabled) {
+    await watcher.disable();
+  }
+
   // create a token contract based on the provided token
   const token = new Contract(config.contractAddresses[chainId].Token, ERC20.abi, ethProvider);
 
@@ -162,6 +175,7 @@ export const connect = async (
     store,
     token,
     chainId,
+    watcher,
   });
 
   logger.info(`Done creating connext client`);

modules/client/src/connext.ts

@@ -35,13 +35,16 @@ import {
   SupportedApplicationNames,
   WithdrawalMonitorObject,
   WithdrawAppName,
+  IWatcher,
+  StoredAppChallengeStatus,
 } from "@connext/types";
 import {
   delay,
   getRandomBytes32,
   getAddressFromAssetId,
   getSignerAddressFromPublicIdentifier,
   stringify,
+  computeCancelDisputeHash,
 } from "@connext/utils";
 import { BigNumber, Contract, providers, constants, utils } from "ethers";
 
@@ -78,6 +81,7 @@ export class ConnextClient implements IConnextClient {
   public signerAddress: string;
   public store: IStoreService;
   public token: Contract;
+  public watcher: IWatcher;
 
   private opts: InternalClientOptions;
 
@@ -101,6 +105,7 @@ export class ConnextClient implements IConnextClient {
     this.node = opts.node;
     this.store = opts.store;
     this.token = opts.token;
+    this.watcher = opts.watcher;
 
     this.signerAddress = this.channelProvider.config.signerAddress;
     this.publicIdentifier = this.channelProvider.config.userIdentifier;
@@ -274,22 +279,48 @@ export class ConnextClient implements IConnextClient {
     return this.node.getTransferHistory();
   };
 
+  ///////////////////////////////////
+  // DISPUTE METHODS
+  public initiateChallenge = (
+    params: PublicParams.InitiateChallenge,
+  ): Promise<PublicResults.InitiateChallenge> => {
+    return this.watcher.initiate(params.appIdentityHash);
+  };
+
+  public cancelChallenge = async (
+    params: PublicParams.CancelChallenge,
+  ): Promise<PublicResults.CancelChallenge> => {
+    const { appInstance } = (await this.getAppInstance(params.appIdentityHash)) || {};
+    if (!appInstance) {
+      throw new Error(`Could not find record of app with hash ${params.appIdentityHash}`);
+    }
+    const cancelHash = computeCancelDisputeHash(
+      appInstance.identityHash,
+      appInstance.latestVersionNumber,
+    );
+    const signature = await this.channelProvider.signMessage(cancelHash);
+    return this.node.cancelChallenge(params.appIdentityHash, signature);
+  };
+
   ///////////////////////////////////
   // CORE CHANNEL METHODS
 
   public deposit = async (params: PublicParams.Deposit): Promise<PublicResults.Deposit> => {
+    await this.assertFreeBalanceNotDisputed();
     return this.depositController.deposit(params);
   };
 
   public requestDepositRights = async (
     params: PublicParams.RequestDepositRights,
   ): Promise<MethodResults.RequestDepositRights> => {
+    await this.assertFreeBalanceNotDisputed();
     return this.depositController.requestDepositRights(params);
   };
 
   public rescindDepositRights = async (
     params: PublicParams.RescindDepositRights,
   ): Promise<PublicResults.RescindDepositRights> => {
+    await this.assertFreeBalanceNotDisputed();
     return this.depositController.rescindDepositRights(params);
   };
 
@@ -304,8 +335,8 @@ export class ConnextClient implements IConnextClient {
   };
 
   public swap = async (params: PublicParams.Swap): Promise<PublicResults.Swap> => {
-    const res = await this.swapController.swap(params);
-    return res;
+    await this.assertFreeBalanceNotDisputed();
+    return this.swapController.swap(params);
   };
 
   /**
@@ -315,6 +346,7 @@ export class ConnextClient implements IConnextClient {
   public transfer = async (
     params: PublicParams.Transfer,
   ): Promise<PublicResults.ConditionalTransfer> => {
+    await this.assertFreeBalanceNotDisputed();
     return this.createTransferController.createTransfer({
       amount: params.amount,
       assetId: params.assetId || CONVENTION_FOR_ETH_ASSET_ID,
@@ -326,11 +358,13 @@ export class ConnextClient implements IConnextClient {
     }) as Promise<PublicResults.ConditionalTransfer>;
   };
 
-  public withdraw = (params: PublicParams.Withdraw): Promise<PublicResults.Withdraw> => {
+  public withdraw = async (params: PublicParams.Withdraw): Promise<PublicResults.Withdraw> => {
+    await this.assertFreeBalanceNotDisputed();
     return this.withdrawalController.withdraw(params);
   };
 
-  public respondToNodeWithdraw = (appInstance: AppInstanceJson): Promise<void> => {
+  public respondToNodeWithdraw = async (appInstance: AppInstanceJson): Promise<void> => {
+    await this.assertFreeBalanceNotDisputed();
     return this.withdrawalController.respondToNodeWithdraw(appInstance);
   };
 
@@ -346,6 +380,7 @@ export class ConnextClient implements IConnextClient {
     params: PublicParams.ResolveCondition,
   ): Promise<PublicResults.ResolveCondition> => {
     // paymentId is generated for hashlock transfer
+    await this.assertFreeBalanceNotDisputed();
     if (params.conditionType === ConditionalTransferTypes.HashLockTransfer && !params.paymentId) {
       const lockHash = soliditySha256(["bytes32"], [params.preImage]);
       const paymentId = soliditySha256(["address", "bytes32"], [params.assetId, lockHash]);
@@ -357,6 +392,7 @@ export class ConnextClient implements IConnextClient {
   public conditionalTransfer = async (
     params: PublicParams.ConditionalTransfer,
   ): Promise<PublicResults.ConditionalTransfer> => {
+    await this.assertFreeBalanceNotDisputed();
     params.assetId = params.assetId || CONVENTION_FOR_ETH_ASSET_ID;
     return this.createTransferController.createTransfer(params);
   };
@@ -468,12 +504,11 @@ export class ConnextClient implements IConnextClient {
     return this.listener.waitFor(event, timeout, filter);
   }
 
-  // TODO: allow for removing listeners attached via a specific event
-  // by manipulating the context of the events
-
-  public off = () => {
-    this.listener.detach();
-    this.channelProvider.removeAllListeners();
+  public off = async () => {
+    await this.messaging.disconnect();
+    await this.listener.detach();
+    await this.channelProvider.removeAllListeners();
+    await delay(500); // give messaging a bit more time to finish disconnecting
   };
 
   public emit = <T extends EventName>(event: T, payload: EventPayload[T]): boolean => {
@@ -572,6 +607,7 @@ export class ConnextClient implements IConnextClient {
     action: AppAction,
     stateTimeout?: BigNumber,
   ): Promise<MethodResults.TakeAction> => {
+    await this.assertFreeBalanceNotDisputed();
     // check the app is actually installed
     const err = await this.appNotInstalled(appIdentityHash);
     if (err) {
@@ -602,6 +638,7 @@ export class ConnextClient implements IConnextClient {
   };
 
   public installApp = async (appIdentityHash: string): Promise<MethodResults.Install> => {
+    await this.assertFreeBalanceNotDisputed();
     // check the app isnt actually installed
     const alreadyInstalled = await this.appInstalled(appIdentityHash);
     if (alreadyInstalled) {
@@ -617,6 +654,7 @@ export class ConnextClient implements IConnextClient {
     appIdentityHash: string,
     action?: AppAction,
   ): Promise<MethodResults.Uninstall> => {
+    await this.assertFreeBalanceNotDisputed();
     // check the app is actually installed
     const err = await this.appNotInstalled(appIdentityHash);
     if (err) {
@@ -946,4 +984,20 @@ export class ConnextClient implements IConnextClient {
     }
     return undefined;
   };
+
+  private assertFreeBalanceNotDisputed = async () => {
+    const channel = await this.store.getStateChannel(this.multisigAddress);
+    if (!channel || !channel.freeBalanceAppInstance) {
+      return;
+    }
+    const freeBalanceChallenge = await this.store.getAppChallenge(
+      channel.freeBalanceAppInstance.identityHash,
+    );
+    if (
+      freeBalanceChallenge &&
+      freeBalanceChallenge.status !== StoredAppChallengeStatus.NO_CHALLENGE
+    ) {
+      throw new Error(`Free balance app has been disputed, cannot use channel.`);
+    }
+  };
 }