background - move pojo migrator to outside of metamask controller

1 files changed, 13 insertions, 0 deletions

diff --git a/app/scripts/lib/migrations.js b/app/scripts/lib/migrations.js
index f026cbe53..12f60def1 100644
--- a/app/scripts/lib/migrations.js
+++ b/app/scripts/lib/migrations.js
@@ -1,3 +1,16 @@
+/* The migrator has two methods the user should be concerned with:
+ * 
+ * getData(), which returns the app-consumable data object
+ * saveData(), which persists the app-consumable data object.
+ */
+
+// Migrations must start at version 1 or later.
+// They are objects with a `version` number
+// and a `migrate` function.
+//
+// The `migrate` function receives the previous
+// config data format, and returns the new one.
+
 module.exports = [
   require('../migrations/002'),
   require('../migrations/003'),