Make a folder called 'engine', consolidate engine stuff (#2569)

packages/node/src/protocol/index.ts → packages/node/src/engine/index.ts

@@ -1,15 +1,37 @@
-import { Protocol } from "../machine/enums";
-import { ProtocolExecutionFlow } from "../machine/types";
+import { appIdentityToHash } from "../ethereum/utils/app-identity";
 
+import { Opcode, Protocol } from "./enums";
 import { INSTALL_PROTOCOL } from "./install";
 import { INSTALL_VIRTUAL_APP_PROTOCOL } from "./install-virtual-app";
 import { PROPOSE_PROTOCOL } from "./propose";
+import { ProtocolRunner } from "./protocol-runner";
 import { SETUP_PROTOCOL } from "./setup";
 import { TAKE_ACTION_PROTOCOL } from "./take-action";
+import {
+  Context,
+  InstallParams,
+  InstallVirtualAppParams,
+  Instruction,
+  Middleware,
+  ProtocolExecutionFlow,
+  ProtocolMessage,
+  SetupParams,
+  TakeActionParams,
+  UninstallParams,
+  UninstallVirtualAppParams,
+  UpdateParams,
+  WithdrawParams
+} from "./types";
 import { UNINSTALL_PROTOCOL } from "./uninstall";
 import { UNINSTALL_VIRTUAL_APP_PROTOCOL } from "./uninstall-virtual-app";
 import { UPDATE_PROTOCOL } from "./update";
 import { WITHDRAW_PROTOCOL } from "./withdraw";
+import {
+  xkeyKthAddress,
+  xkeyKthHDNode,
+  xkeysToSortedKthAddresses,
+  xkeysToSortedKthSigningKeys
+} from "./xkeys";
 
 const protocolsByName = {
   [Protocol.Install]: INSTALL_PROTOCOL,
@@ -42,3 +64,27 @@ export {
   PROPOSE_PROTOCOL,
   WITHDRAW_PROTOCOL
 };
+
+export {
+  appIdentityToHash,
+  ProtocolRunner,
+  Context,
+  Instruction,
+  Middleware,
+  Opcode,
+  Protocol,
+  ProtocolExecutionFlow,
+  ProtocolMessage,
+  SetupParams,
+  InstallParams,
+  UpdateParams,
+  UninstallParams,
+  WithdrawParams,
+  TakeActionParams,
+  InstallVirtualAppParams,
+  UninstallVirtualAppParams,
+  xkeyKthAddress,
+  xkeyKthHDNode,
+  xkeysToSortedKthAddresses,
+  xkeysToSortedKthSigningKeys
+};

packages/node/src/protocol/install-virtual-app.ts → packages/node/src/engine/install-virtual-app.ts

@@ -19,18 +19,18 @@ import { BigNumber, bigNumberify, defaultAbiCoder } from "ethers/utils";
 
 import { UNASSIGNED_SEQ_NO } from "../constants";
 import { ConditionalTransaction, SetStateCommitment } from "../ethereum";
-import { Opcode, Protocol } from "../machine/enums";
+import { AppInstance, StateChannel, StateChannelJSON } from "../models";
+import { getCreate2MultisigAddress } from "../utils";
+
+import { Opcode, Protocol } from "./enums";
 import {
   Context,
   InstallVirtualAppParams,
   ProtocolExecutionFlow,
   ProtocolMessage
-} from "../machine/types";
-import { sortAddresses, xkeyKthAddress } from "../machine/xkeys";
-import { AppInstance, StateChannel, StateChannelJSON } from "../models";
-import { getCreate2MultisigAddress } from "../utils";
-
+} from "./types";
 import { assertIsValidSignature } from "./utils/signature-validator";
+import { sortAddresses, xkeyKthAddress } from "./xkeys";
 
 export const encodeSingleAssetTwoPartyIntermediaryAgreementParams = params =>
   defaultAbiCoder.encode([virtualAppAgreementEncoding], [params]);

packages/node/src/protocol/install.ts → packages/node/src/engine/install.ts

@@ -11,13 +11,13 @@ import { BigNumber } from "ethers/utils";
 import { UNASSIGNED_SEQ_NO } from "../constants";
 import { SetStateCommitment } from "../ethereum";
 import { ConditionalTransaction } from "../ethereum/conditional-transaction-commitment";
-import { ProtocolExecutionFlow } from "../machine";
-import { Opcode, Protocol } from "../machine/enums";
-import { Context, InstallParams, ProtocolMessage } from "../machine/types";
 import { TWO_PARTY_OUTCOME_DIFFERENT_ASSETS } from "../methods/errors";
 import { AppInstance, StateChannel } from "../models";
 import { TokenIndexedCoinTransferMap } from "../models/free-balance";
 
+import { ProtocolExecutionFlow } from ".";
+import { Opcode, Protocol } from "./enums";
+import { Context, InstallParams, ProtocolMessage } from "./types";
 import { assertIsValidSignature } from "./utils/signature-validator";
 
 const { OP_SIGN, IO_SEND, IO_SEND_AND_WAIT } = Opcode;

packages/node/src/protocol/propose.ts → packages/node/src/engine/propose.ts

@@ -5,20 +5,12 @@ import {
   UNASSIGNED_SEQ_NO
 } from "../constants";
 import { SetStateCommitment } from "../ethereum";
-import {
-  appIdentityToHash,
-  ProtocolExecutionFlow,
-  xkeyKthAddress
-} from "../machine";
-import { Opcode, Protocol } from "../machine/enums";
-import {
-  Context,
-  ProposeInstallParams,
-  ProtocolMessage
-} from "../machine/types";
 import { AppInstanceProposal, StateChannel } from "../models";
 import { getCreate2MultisigAddress } from "../utils";
 
+import { appIdentityToHash, ProtocolExecutionFlow, xkeyKthAddress } from ".";
+import { Opcode, Protocol } from "./enums";
+import { Context, ProposeInstallParams, ProtocolMessage } from "./types";
 import { assertIsValidSignature } from "./utils/signature-validator";
 
 const protocol = Protocol.Propose;

packages/node/src/machine/protocol-runner.ts → packages/node/src/engine/protocol-runner.ts

@@ -2,9 +2,9 @@ import { NetworkContext } from "@counterfactual/types";
 import { BaseProvider } from "ethers/providers";
 import uuid from "uuid";
 
-import { getProtocolFromName } from "../protocol";
 import { Store } from "../store";
 
+import { getProtocolFromName } from ".";
 import { Opcode, Protocol } from "./enums";
 import { MiddlewareContainer } from "./middleware";
 import {

packages/node/src/protocol/setup.ts → packages/node/src/engine/setup.ts

@@ -1,15 +1,15 @@
 import { UNASSIGNED_SEQ_NO } from "../constants";
 import { SetupCommitment } from "../ethereum";
-import { ProtocolExecutionFlow, xkeyKthAddress } from "../machine";
-import { Opcode, Protocol } from "../machine/enums";
+import { StateChannel } from "../models/state-channel";
+
+import { ProtocolExecutionFlow, xkeyKthAddress } from ".";
+import { Opcode, Protocol } from "./enums";
 import {
   Context,
   ProtocolMessage,
   ProtocolParameters,
   SetupParams
-} from "../machine/types";
-import { StateChannel } from "../models/state-channel";
-
+} from "./types";
 import { assertIsValidSignature } from "./utils/signature-validator";
 
 const protocol = Protocol.Setup;

packages/node/src/protocol/take-action.ts → packages/node/src/engine/take-action.ts

@@ -1,9 +1,10 @@
 import { UNASSIGNED_SEQ_NO } from "../constants";
 import { SetStateCommitment } from "../ethereum";
-import { ProtocolExecutionFlow, xkeyKthAddress } from "../machine";
-import { Opcode, Protocol } from "../machine/enums";
-import { Context, ProtocolMessage, TakeActionParams } from "../machine/types";
+import { StateChannel } from "../models";
 
+import { ProtocolExecutionFlow, xkeyKthAddress } from ".";
+import { Opcode, Protocol } from "./enums";
+import { Context, ProtocolMessage, TakeActionParams } from "./types";
 import { assertIsValidSignature } from "./utils/signature-validator";
 
 const protocol = Protocol.TakeAction;

packages/node/src/protocol/uninstall-virtual-app.ts → packages/node/src/engine/uninstall-virtual-app.ts

@@ -5,20 +5,20 @@ import { fromExtendedKey } from "ethers/utils/hdnode";
 
 import { UNASSIGNED_SEQ_NO } from "../constants";
 import { SetStateCommitment } from "../ethereum";
-import { ProtocolExecutionFlow } from "../machine";
-import { Opcode, Protocol } from "../machine/enums";
+import { AppInstance, StateChannel, StateChannelJSON } from "../models";
+import { getCreate2MultisigAddress } from "../utils";
+
+import { Opcode, Protocol } from "./enums";
 import {
   Context,
+  ProtocolExecutionFlow,
   ProtocolMessage,
   ProtocolParameters,
   UninstallVirtualAppParams
-} from "../machine/types";
-import { xkeyKthAddress } from "../machine/xkeys";
-import { AppInstance, StateChannel, StateChannelJSON } from "../models";
-import { getCreate2MultisigAddress } from "../utils";
-
+} from "./types";
 import { computeTokenIndexedFreeBalanceIncrements } from "./utils/get-outcome-increments";
 import { assertIsValidSignature } from "./utils/signature-validator";
+import { xkeyKthAddress } from "./xkeys";
 
 function xkeyTo0thAddress(xpub: string) {
   return fromExtendedKey(xpub).derivePath("0").address;

packages/node/src/protocol/uninstall.ts → packages/node/src/engine/uninstall.ts

@@ -2,16 +2,16 @@ import { BaseProvider } from "ethers/providers";
 
 import { UNASSIGNED_SEQ_NO } from "../constants";
 import { SetStateCommitment } from "../ethereum";
-import { xkeyKthAddress } from "../machine";
-import { Opcode, Protocol } from "../machine/enums";
+import { StateChannel, StateChannelJSON } from "../models";
+
+import { xkeyKthAddress } from ".";
+import { Opcode, Protocol } from "./enums";
 import {
   Context,
   ProtocolExecutionFlow,
   ProtocolMessage,
   UninstallParams
-} from "../machine/types";
-import { StateChannel, StateChannelJSON } from "../models";
-
+} from "./types";
 import { computeTokenIndexedFreeBalanceIncrements } from "./utils/get-outcome-increments";
 import { assertIsValidSignature } from "./utils/signature-validator";
 

packages/node/src/protocol/update.ts → packages/node/src/engine/update.ts

@@ -1,10 +1,10 @@
 import { UNASSIGNED_SEQ_NO } from "../constants";
 import { SetStateCommitment } from "../ethereum";
-import { ProtocolExecutionFlow, xkeyKthAddress } from "../machine";
-import { Opcode, Protocol } from "../machine/enums";
-import { Context, ProtocolMessage, UpdateParams } from "../machine/types";
 import { StateChannel } from "../models";
 
+import { ProtocolExecutionFlow, xkeyKthAddress } from ".";
+import { Opcode, Protocol } from "./enums";
+import { Context, ProtocolMessage, UpdateParams } from "./types";
 import { assertIsValidSignature } from "./utils/signature-validator";
 
 const protocol = Protocol.Update;

packages/node/src/protocol/withdraw.ts → packages/node/src/engine/withdraw.ts

@@ -17,11 +17,11 @@ import {
   WithdrawERC20Commitment,
   WithdrawETHCommitment
 } from "../ethereum";
-import { ProtocolExecutionFlow } from "../machine";
-import { Opcode, Protocol } from "../machine/enums";
-import { Context, ProtocolMessage, WithdrawParams } from "../machine/types";
 import { AppInstance, StateChannel } from "../models";
 
+import { ProtocolExecutionFlow } from ".";
+import { Opcode, Protocol } from "./enums";
+import { Context, ProtocolMessage, WithdrawParams } from "./types";
 import { assertIsValidSignature } from "./utils/signature-validator";
 
 const { IO_SEND, IO_SEND_AND_WAIT, OP_SIGN } = Opcode;

packages/node/src/message-handling/handle-protocol-message.ts

@@ -11,8 +11,8 @@ import {
   UninstallVirtualAppParams,
   UpdateParams,
   WithdrawParams
-} from "../machine";
-import { ProtocolParameters } from "../machine/types";
+} from "../engine";
+import { ProtocolParameters } from "../engine/types";
 import { NO_PROPOSED_APP_INSTANCE_FOR_APP_INSTANCE_ID } from "../methods/errors";
 import { StateChannel } from "../models";
 import { RequestHandler } from "../request-handler";

packages/node/src/methods/app-instance/install-virtual/operation.ts

@@ -1,7 +1,7 @@
 import { AppInstanceProposal, Node } from "@counterfactual/types";
 import { bigNumberify } from "ethers/utils";
 
-import { Protocol, ProtocolRunner } from "../../../machine";
+import { Protocol, ProtocolRunner } from "../../../engine";
 import { Store } from "../../../store";
 import {
   NO_APP_INSTANCE_ID_TO_INSTALL,

packages/node/src/methods/app-instance/install/operation.ts

@@ -1,7 +1,7 @@
 import { AppInstanceProposal, Node } from "@counterfactual/types";
 import { bigNumberify } from "ethers/utils";
 
-import { Protocol, ProtocolRunner } from "../../../machine";
+import { Protocol, ProtocolRunner } from "../../../engine";
 import { StateChannel } from "../../../models";
 import { Store } from "../../../store";
 import { NO_APP_INSTANCE_ID_TO_INSTALL } from "../../errors";

packages/node/src/methods/app-instance/propose-install/controller.ts

@@ -3,7 +3,7 @@ import { BigNumber } from "ethers/utils";
 import { jsonRpcMethod } from "rpc-server";
 
 import { CONVENTION_FOR_ETH_TOKEN_ADDRESS } from "../../../constants";
-import { Protocol, xkeyKthAddress } from "../../../machine";
+import { Protocol, xkeyKthAddress } from "../../../engine";
 import { StateChannel } from "../../../models";
 import { RequestHandler } from "../../../request-handler";
 import { getCreate2MultisigAddress } from "../../../utils";

packages/node/src/methods/app-instance/propose-install/operation.ts

@@ -1,7 +1,7 @@
 import { Node } from "@counterfactual/types";
 
 import { CONVENTION_FOR_ETH_TOKEN_ADDRESS } from "../../../constants";
-import { appIdentityToHash } from "../../../machine";
+import { appIdentityToHash } from "../../../engine";
 import { AppInstanceProposal } from "../../../models";
 import { Store } from "../../../store";
 import { getCreate2MultisigAddress } from "../../../utils";

packages/node/src/methods/app-instance/take-action/controller.ts

@@ -2,7 +2,7 @@ import { Node, SolidityValueType } from "@counterfactual/types";
 import { INVALID_ARGUMENT } from "ethers/errors";
 import { jsonRpcMethod } from "rpc-server";
 
-import { Protocol, ProtocolRunner } from "../../../machine";
+import { Protocol, ProtocolRunner } from "../../../engine";
 import { RequestHandler } from "../../../request-handler";
 import { Store } from "../../../store";
 import { NODE_EVENTS, UpdateStateMessage } from "../../../types";

packages/node/src/methods/app-instance/uninstall-virtual/operation.ts

@@ -1,6 +1,6 @@
 import { BaseProvider } from "ethers/providers";
 
-import { Protocol, ProtocolRunner } from "../../../machine";
+import { Protocol, ProtocolRunner } from "../../../engine";
 import { Store } from "../../../store";
 
 export async function uninstallVirtualAppInstanceFromChannel(

packages/node/src/methods/app-instance/uninstall/operation.ts

@@ -1,4 +1,4 @@
-import { Protocol, ProtocolRunner } from "../../../machine";
+import { Protocol, ProtocolRunner } from "../../../engine";
 import { Store } from "../../../store";
 
 export async function uninstallAppInstanceFromChannel(

packages/node/src/methods/app-instance/update-state/controller.ts

@@ -2,7 +2,7 @@ import { Node, SolidityValueType } from "@counterfactual/types";
 import { INVALID_ARGUMENT } from "ethers/errors";
 import { jsonRpcMethod } from "rpc-server";
 
-import { Protocol, ProtocolRunner } from "../../../machine";
+import { Protocol, ProtocolRunner } from "../../../engine";
 import { StateChannel } from "../../../models";
 import { RequestHandler } from "../../../request-handler";
 import { Store } from "../../../store";