Remove proposals from Store DB

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

@@ -26,22 +26,19 @@ export async function handleReceivedProposalMessage(
     proposedByIdentifier
   );
 
-  await store.addAppInstanceProposal(
-    stateChannel,
-    new AppInstanceProposal(
-      {
-        ...params,
-        proposedByIdentifier,
-        initiatorDeposit: params.responderDeposit,
-        initiatorDepositTokenAddress: params.responderDepositTokenAddress!,
-        responderDeposit: params.initiatorDeposit!,
-        responderDepositTokenAddress: params.initiatorDepositTokenAddress!
-      },
-      stateChannel
-    )
+  const proposal = new AppInstanceProposal(
+    {
+      ...params,
+      proposedByIdentifier,
+      initiatorDeposit: params.responderDeposit,
+      initiatorDepositTokenAddress: params.responderDepositTokenAddress!,
+      responderDeposit: params.initiatorDeposit!,
+      responderDepositTokenAddress: params.initiatorDepositTokenAddress!
+    },
+    stateChannel
   );
 
-  await store.saveStateChannel(stateChannel.bumpProposedApps());
+  await store.saveStateChannel(stateChannel.addProposal(proposal));
 }
 
 export async function handleRejectProposalMessage(
@@ -52,5 +49,8 @@ export async function handleRejectProposalMessage(
   const {
     data: { appInstanceId }
   } = receivedRejectProposalMessage;
-  await store.removeAppInstanceProposal(appInstanceId);
+
+  const stateChannel = await store.getChannelFromAppInstanceID(appInstanceId);
+
+  await store.saveStateChannel(stateChannel.removeProposal(appInstanceId));
 }

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

@@ -79,7 +79,11 @@ export async function handleReceivedProtocolMessage(
         }
       }
       if (proposal) {
-        await store.saveRealizedProposedAppInstance(proposal);
+        await store.saveStateChannel(
+          (await store.getChannelFromAppInstanceID(
+            appInstanceId
+          )).removeProposal(appInstanceId)
+        );
       }
     }
   }

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

@@ -64,7 +64,11 @@ export async function installVirtual(
     );
   }
 
-  await store.saveRealizedProposedAppInstance(proposal);
+  await store.saveStateChannel(
+    (await store.getChannelFromAppInstanceID(appInstanceId)).removeProposal(
+      appInstanceId
+    )
+  );
 
   return proposal;
 }

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

@@ -32,7 +32,7 @@ export default class InstallController extends NodeController {
     requestHandler: RequestHandler,
     params: Node.InstallParams
   ): Promise<Node.InstallResult> {
-    const { store, protocolRunner, publicIdentifier } = requestHandler;
+    const { store, protocolRunner } = requestHandler;
 
     const appInstanceProposal = await install(store, protocolRunner, params);
 

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

@@ -49,7 +49,11 @@ export async function install(
     }
   );
 
-  await store.saveRealizedProposedAppInstance(proposal);
+  await store.saveStateChannel(
+    (await store.getChannelFromAppInstanceID(appInstanceId)).removeProposal(
+      appInstanceId
+    )
+  );
 
   return proposal;
 }

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

@@ -44,9 +44,7 @@ export async function createProposedAppInstance(
     stateChannel
   );
 
-  await store.addAppInstanceProposal(stateChannel, appInstanceProposal);
-
-  await store.saveStateChannel(stateChannel.bumpProposedApps());
+  await store.saveStateChannel(stateChannel.addProposal(appInstanceProposal));
 
   return appInstanceProposal.identityHash;
 }

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

@@ -13,7 +13,9 @@ export default async function rejectInstallVirtualController(
 
   const proposal = await store.getAppInstanceProposal(appInstanceId);
 
-  await store.removeAppInstanceProposal(appInstanceId);
+  const stateChannel = await store.getChannelFromAppInstanceID(appInstanceId);
+
+  await store.saveStateChannel(stateChannel.removeProposal(appInstanceId));
 
   const rejectInstallVirtualMsg: RejectInstallVirtualMessage = {
     from: publicIdentifier,

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

@@ -33,7 +33,9 @@ export default class RejectInstallController extends NodeController {
       return rejectInstallVirtualController(requestHandler, params);
     }
 
-    await store.removeAppInstanceProposal(appInstanceId);
+    const stateChannel = await store.getChannelFromAppInstanceID(appInstanceId);
+
+    await store.saveStateChannel(stateChannel.removeProposal(appInstanceId));
 
     const rejectProposalMsg: RejectProposalMessage = {
       from: publicIdentifier,

packages/node/src/models/state-channel.ts

@@ -9,6 +9,7 @@ import { xkeyKthAddress } from "../machine/xkeys";
 import { Store } from "../store";
 import { prettyPrintObject } from "../utils";
 
+import { AppInstanceProposal, AppInstanceProposalJSON } from ".";
 import { AppInstance } from "./app-instance";
 import {
   CoinTransferMap,
@@ -59,6 +60,7 @@ type SingleAssetTwoPartyIntermediaryAgreementJSON = {
 export type StateChannelJSON = {
   readonly multisigAddress: string;
   readonly userNeuteredExtendedKeys: string[];
+  readonly proposedAppInstances: [string, AppInstanceProposalJSON][];
   readonly appInstances: [string, AppInstanceJson][];
   readonly singleAssetTwoPartyIntermediaryAgreements: [
     string,
@@ -73,6 +75,10 @@ export class StateChannel {
   constructor(
     public readonly multisigAddress: string,
     public readonly userNeuteredExtendedKeys: string[],
+    readonly proposedAppInstances: ReadonlyMap<
+      string,
+      AppInstanceProposal
+    > = new Map<string, AppInstanceProposal>([]),
     readonly appInstances: ReadonlyMap<string, AppInstance> = new Map<
       string,
       AppInstance
@@ -168,10 +174,8 @@ export class StateChannel {
     return this.getSigningKeysFor(this.monotonicNumProposedApps);
   }
 
-  public bumpProposedApps(): StateChannel {
-    return this.build({
-      monotonicNumProposedApps: this.monotonicNumProposedApps + 1
-    });
+  public get hasFreeBalance(): boolean {
+    return !!this.freeBalanceAppInstance;
   }
 
   public get freeBalance(): AppInstance {
@@ -184,10 +188,6 @@ export class StateChannel {
     );
   }
 
-  public get hasFreeBalance(): boolean {
-    return !!this.freeBalanceAppInstance;
-  }
-
   public getMultisigOwnerAddrOf(xpub: string): string {
     const [alice, bob] = this.multisigOwners;
 
@@ -224,6 +224,7 @@ export class StateChannel {
     multisigAddress?: string;
     userNeuteredExtendedKeys?: string[];
     appInstances?: ReadonlyMap<string, AppInstance>;
+    proposedAppInstances?: ReadonlyMap<string, AppInstanceProposal>;
     singleAssetTwoPartyIntermediaryAgreements?: ReadonlyMap<
       string,
       SingleAssetTwoPartyIntermediaryAgreement
@@ -235,6 +236,7 @@ export class StateChannel {
     return new StateChannel(
       args.multisigAddress || this.multisigAddress,
       args.userNeuteredExtendedKeys || this.userNeuteredExtendedKeys,
+      args.proposedAppInstances || this.proposedAppInstances,
       args.appInstances || this.appInstances,
       args.singleAssetTwoPartyIntermediaryAgreements ||
         this.singleAssetTwoPartyIntermediaryAgreements,
@@ -303,6 +305,7 @@ export class StateChannel {
     return new StateChannel(
       multisigAddress,
       userNeuteredExtendedKeys,
+      new Map<string, AppInstanceProposal>([]),
       new Map<string, AppInstance>([]),
       new Map<string, SingleAssetTwoPartyIntermediaryAgreement>(),
       createFreeBalance(
@@ -321,6 +324,7 @@ export class StateChannel {
     return new StateChannel(
       multisigAddress,
       userNeuteredExtendedKeys,
+      new Map<string, AppInstanceProposal>([]),
       new Map<string, AppInstance>(),
       new Map<string, SingleAssetTwoPartyIntermediaryAgreement>(),
       // Note that this FreeBalance is undefined because a channel technically
@@ -330,6 +334,31 @@ export class StateChannel {
     );
   }
 
+  public addProposal(proposal: AppInstanceProposal) {
+    const proposedAppInstances = new Map<string, AppInstanceProposal>(
+      this.proposedAppInstances.entries()
+    );
+
+    proposedAppInstances.set(proposal.identityHash, proposal);
+
+    return this.build({
+      proposedAppInstances,
+      monotonicNumProposedApps: this.monotonicNumProposedApps + 1
+    });
+  }
+
+  public removeProposal(appInstanceId: string) {
+    const proposedAppInstances = new Map<string, AppInstanceProposal>(
+      this.proposedAppInstances.entries()
+    );
+
+    proposedAppInstances.delete(appInstanceId);
+
+    return this.build({
+      proposedAppInstances
+    });
+  }
+
   public addAppInstance(appInstance: AppInstance) {
     const appInstances = new Map<string, AppInstance>(
       this.appInstances.entries()
@@ -492,6 +521,11 @@ export class StateChannel {
     return {
       multisigAddress: this.multisigAddress,
       userNeuteredExtendedKeys: this.userNeuteredExtendedKeys,
+      proposedAppInstances: [...this.proposedAppInstances.entries()].map(
+        (proposal): [string, AppInstanceProposalJSON] => {
+          return [proposal[0], proposal[1].toJson()];
+        }
+      ),
       appInstances: [...this.appInstances.entries()].map((appInstanceEntry): [
         string,
         AppInstanceJson
@@ -521,6 +555,14 @@ export class StateChannel {
     return new StateChannel(
       json.multisigAddress,
       json.userNeuteredExtendedKeys,
+      new Map(
+        [...Object.values(json.proposedAppInstances || [])].map((proposal): [
+          string,
+          AppInstanceProposal
+        ] => {
+          return [proposal[0], AppInstanceProposal.fromJson(proposal[1])];
+        })
+      ),
       new Map(
         [...Object.values(json.appInstances || [])].map((appInstanceEntry): [
           string,