Basic approach to one off migration

packages/node/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@counterfactual/node",
-  "version": "0.3.2",
+  "version": "0.3.3",
   "main": "dist/index.js",
   "iife": "dist/index.iife.js",
   "types": "dist/src/index.d.ts",

packages/node/src/index.ts

@@ -4,3 +4,4 @@ export * from "./types";
 export * from "./methods/errors";
 export * from "rpc-server";
 export { getNetworkEnum, EthereumNetworkName } from "./network-configuration";
+export { migrateToPatch1 } from "./migrations/patch-1";

packages/node/src/migrations/patch-1.ts

@@ -0,0 +1,123 @@
+import { Node } from "@counterfactual/types";
+import { bigNumberify, BigNumberish } from "ethers/utils";
+
+import { StateChannelJSON } from "../models/state-channel";
+
+const DB_NAMESPACE_CHANNEL = "channel";
+const DB_NAMESPACE_WITHDRAWALS = "multisigAddressToWithdrawalCommitment";
+const DB_NAMESPACE_ALL_COMMITMENTS = "allCommitments";
+
+const bigNumberIshToString = (x: BigNumberish) => bigNumberify(x).toHexString();
+
+export const migrateToPatch1 = async (
+  storeService: Node.IStoreService,
+  storeKeyPrefix: string
+) => {
+  const stateChannelsMap: {
+    [multisigAddress: string]: StateChannelJSON;
+  } = await storeService.get(`${storeKeyPrefix}/${DB_NAMESPACE_CHANNEL}`);
+
+  for (const multisigAddress in stateChannelsMap) {
+    /**
+     * Update proposal:
+     * https://github.com/counterfactual/monorepo/pull/2542/files
+     */
+
+    const proposals = stateChannelsMap[multisigAddress].proposedAppInstances;
+
+    for (let i = 0; i < proposals.length; i += 1) {
+      const proposal = proposals[i][1];
+      stateChannelsMap[multisigAddress].proposedAppInstances[i][1] = {
+        ...proposal,
+        initiatorDeposit: bigNumberIshToString(proposal.initiatorDeposit),
+        responderDeposit: bigNumberIshToString(proposal.responderDeposit),
+        timeout: bigNumberIshToString(proposal.timeout)
+      };
+    }
+
+    /**
+     * Update interpreter params
+     * https://github.com/counterfactual/monorepo/pull/2544/files#diff-95c2150ee50c44be12700a72fd6fbf73R32
+     */
+
+    const apps = stateChannelsMap[multisigAddress].appInstances;
+
+    for (let i = 0; i < apps.length; i += 1) {
+      const app = apps[i][1];
+
+      if (app.twoPartyOutcomeInterpreterParams) {
+        stateChannelsMap[multisigAddress].appInstances[
+          i
+        ][1].twoPartyOutcomeInterpreterParams = {
+          ...app.twoPartyOutcomeInterpreterParams!,
+          amount: bigNumberIshToString(
+            app.twoPartyOutcomeInterpreterParams!.amount
+          )
+        };
+      }
+
+      if (app.singleAssetTwoPartyCoinTransferInterpreterParams) {
+        stateChannelsMap[multisigAddress].appInstances[
+          i
+        ][1].singleAssetTwoPartyCoinTransferInterpreterParams = {
+          ...app.singleAssetTwoPartyCoinTransferInterpreterParams!,
+          limit: bigNumberIshToString(
+            app.singleAssetTwoPartyCoinTransferInterpreterParams!.limit
+          )
+        };
+      }
+
+      if (app.multiAssetMultiPartyCoinTransferInterpreterParams) {
+        stateChannelsMap[multisigAddress].appInstances[
+          i
+        ][1].multiAssetMultiPartyCoinTransferInterpreterParams = {
+          ...app.multiAssetMultiPartyCoinTransferInterpreterParams!,
+          limit: app.multiAssetMultiPartyCoinTransferInterpreterParams.limit.map(
+            bigNumberIshToString!
+          )
+        };
+      }
+    }
+
+    /**
+     * Delete createdAt
+     * https://github.com/counterfactual/monorepo/pull/2541/files
+     */
+    delete stateChannelsMap[multisigAddress]["createdAt"];
+
+    /**
+     * https://github.com/counterfactual/monorepo/pull/2538/files
+     */
+
+    const agreements =
+      stateChannelsMap[multisigAddress]
+        .singleAssetTwoPartyIntermediaryAgreements;
+
+    for (let i = 0; i < agreements.length; i += 1) {
+      const agreement = agreements[i][1];
+      stateChannelsMap[
+        multisigAddress
+      ].singleAssetTwoPartyIntermediaryAgreements[i][1] = {
+        ...agreements[i][1],
+        capitalProvided: bigNumberIshToString(agreement.capitalProvided)
+      };
+    }
+  }
+
+  const withdrawals = await storeService.get(
+    `${storeKeyPrefix}/${DB_NAMESPACE_WITHDRAWALS}`
+  );
+
+  const commitments = await storeService.get(
+    `${storeKeyPrefix}/${DB_NAMESPACE_ALL_COMMITMENTS}`
+  );
+
+  const sharedData = {
+    commitments,
+    withdrawals,
+    stateChannelsMap,
+    version: 1
+  };
+
+  await storeService.set([{ path: storeKeyPrefix, value: sharedData }]);
+};

packages/node/src/store.ts

@@ -1,4 +1,4 @@
-import { NetworkContext, Node, SolidityValueType } from "@counterfactual/types";
+import { Node, SolidityValueType } from "@counterfactual/types";
 import { solidityKeccak256 } from "ethers/utils";
 
 import {
@@ -15,6 +15,7 @@ import {
 import { prettyPrintObject } from "./utils";
 
 interface SharedData {
+  version: 1; // TODO: Add better versioning & migrations tooling
   stateChannelsMap: { [multisigAddress: string]: StateChannelJSON };
   commitments: { [specialHash: string]: any[] };
   withdrawals: { [multisigAddress: string]: Node.MinimalTransaction };
@@ -26,6 +27,7 @@ interface SharedData {
  */
 export class Store {
   public sharedData: SharedData = {
+    version: 1,
     stateChannelsMap: {},
     commitments: {},
     withdrawals: {}
@@ -37,11 +39,16 @@ export class Store {
   ) {}
 
   public async connectDB() {
-    this.sharedData = (await this.storeService.get(this.storeKeyPrefix)) || {
-      stateChannelsMap: {},
-      commitments: {},
-      withdrawals: {}
-    };
+    this.sharedData = Object.assign(
+      {},
+      await this.storeService.get(this.storeKeyPrefix),
+      {
+        version: 1,
+        stateChannelsMap: {},
+        commitments: {},
+        withdrawals: {}
+      }
+    );
   }
 
   public async persistDB() {

packages/simple-hub-server/package.json

@@ -39,7 +39,7 @@
   },
   "dependencies": {
     "@counterfactual/firebase-client": "0.0.7",
-    "@counterfactual/node": "0.3.2",
+    "@counterfactual/node": "0.3.3",
     "@counterfactual/types": "0.0.45",
     "@counterfactual/typescript-typings": "0.1.3",
     "@ebryn/jsonapi-ts": "0.1.17",