Use objection.js for ORM

Author: Joonmo Yang

.gitignore

@@ -4,3 +4,4 @@ node_modules/
 /public/stylesheets/*.css
 /public/stylesheets/*.css.map
 .DS_Store
+/config/local*.js

config/default.js

@@ -0,0 +1,20 @@
+const path = require("path");
+
+module.exports = {
+  knex: {
+    client: "pg",
+    connection: {
+      host: "localhost",
+      port: 5432,
+      database: "codechain-keystore",
+      user: "codechain"
+    },
+    migrations: {
+      directory: path.resolve(__dirname, "..", "migrations"),
+      tableName: "knex"
+    },
+    seeds: {
+      directory: path.resolve(__dirname, "..", "seeds")
+    }
+  },
+};

knexfile.js

@@ -0,0 +1 @@
+module.exports = require("config").get("knex");

migrations/00000000000000_keys.js

@@ -0,0 +1,36 @@
+const table = "keys";
+
+exports.up = async (knex) => {
+    const hasTable = await knex.schema.hasTable(table);
+    if (!hasTable) {
+        return knex.schema.createTable(table, (t) => {
+            t.string("type").notNullable();
+            t.string("address").notNullable();
+            t.integer("version").notNullable();
+            t.string("kdf").notNullable();
+            t.json("kdfparams");
+            t.string("mac").notNullable();
+            t.string("cipher").notNullable();
+            t.json("cipherparams");
+            t.string("ciphertext").notNullable();
+            t.json("meta");
+
+            t.primary(["type", "address"]);
+        });
+    }
+    else {
+        // TODO: Add detailed error message
+        throw Error();
+    }
+};
+
+exports.down = async (knex) => {
+    const hasTable = await knex.schema.hasTable(table);
+    if (hasTable) {
+        return knex.schema.dropTable(table);
+    }
+    else {
+        // TODO: Add detailed error message
+        throw Error();
+    }
+};

package.json

@@ -7,16 +7,23 @@
     "start": "ts-node ./bin/www.ts",
     "test": "yarn lint && jest --env node",
     "lint": "tslint -p . && prettier '**/*.ts' -l",
-    "fmt": "tslint -p . --fix && prettier '**/*ts' --write"
+    "fmt": "tslint -p . --fix && prettier '**/*ts' --write",
+    "migrate": "knex migrate:latest --knexfile ./knexfile.js",
+    "rollback": "knex migrate:rollback --knexfile ./knexfile.js",
+    "seed": "knex seed:run --knexfile ./knexfile.js"
   },
   "dependencies": {
+    "@types/config": "^0.0.34",
     "codechain-keystore": "~0.4.0",
-    "config": "^2.0.1",
+    "config": "^3.1.0",
     "debug": "~2.6.9",
     "express": "~4.16.0",
     "http-errors": "~1.6.2",
+    "knex": "^0.16.5",
     "morgan": "~1.9.1",
     "morgan-body": "^2.4.5",
+    "objection": "^1.6.8",
+    "pg": "^7.10.0",
     "request": "^2.88.0",
     "request-promise": "^4.2.2"
   },

seeds/keys.js

@@ -0,0 +1,6 @@
+const table = "keys";
+
+exports.seed = async (knex) => {
+    await knex(table).del();
+    return knex(table).insert([]);
+};

src/app.ts

@@ -1,6 +1,9 @@
+import * as config from "config";
 import * as express from "express";
 import * as createError from "http-errors";
+import * as knex from "knex";
 import * as logger from "morgan";
+import { Model } from "objection";
 import * as path from "path";
 const morganBody = require("morgan-body");
 
@@ -9,6 +12,7 @@ import { createRouter as createApiRouter } from "./routes/api";
 import { createRouter as createPingRouter } from "./routes/ping";
 
 export async function createApp(): Promise<[express.Application, Context]> {
+    Model.knex(knex(config.get("knex")));
     const app = express();
 
     // view engine setup

src/models/key.ts

@@ -0,0 +1,21 @@
+import { Model, snakeCaseMappers } from "objection";
+
+export default class KeyModel extends Model {
+    public static columnNameMappers = snakeCaseMappers();
+
+    public static tableName = "keys";
+    public static idColumn = ["type", "address"];
+    public readonly type!: "asset" | "platform";
+    public readonly address!: string;
+    public readonly version!: number;
+
+    public readonly kdf!: string;
+    public readonly kdfparams?: any;
+    public readonly mac!: string;
+
+    public readonly cipher!: string;
+    public readonly cipherparams?: any;
+    public readonly ciphertext!: string;
+
+    public readonly meta!: any;
+}