@bsv/wallet-toolbox 1.1.0

package/out/src/storage/remoting/StorageServer.js

@@ -0,0 +1,144 @@
+"use strict";
+/**
+ * StorageServer.ts
+ *
+ * A server-side class that "has a" local WalletStorage (like a StorageKnex instance),
+ * and exposes it via a JSON-RPC POST endpoint using Express.
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StorageServer = void 0;
+const express_1 = __importDefault(require("express"));
+const auth_express_middleware_1 = require("@bsv/auth-express-middleware");
+const payment_express_middleware_1 = require("@bsv/payment-express-middleware");
+const index_all_1 = require("../../index.all");
+class StorageServer {
+    constructor(storage, options) {
+        this.app = (0, express_1.default)();
+        this.storage = storage;
+        this.port = options.port;
+        this.wallet = options.wallet;
+        this.monetize = options.monetize;
+        this.calculateRequestPrice = options.calculateRequestPrice;
+        this.setupRoutes();
+    }
+    setupRoutes() {
+        this.app.use(express_1.default.json({ limit: '30mb' }));
+        // This allows the API to be used everywhere when CORS is enforced
+        this.app.use((req, res, next) => {
+            res.header('Access-Control-Allow-Origin', '*');
+            res.header('Access-Control-Allow-Headers', '*');
+            res.header('Access-Control-Allow-Methods', '*');
+            res.header('Access-Control-Expose-Headers', '*');
+            res.header('Access-Control-Allow-Private-Network', 'true');
+            if (req.method === 'OPTIONS') {
+                // Handle CORS preflight requests to allow cross-origin POST/PUT requests
+                res.sendStatus(200);
+            }
+            else {
+                next();
+            }
+        });
+        const options = {
+            wallet: this.wallet
+        };
+        this.app.use((0, auth_express_middleware_1.createAuthMiddleware)(options));
+        if (this.monetize) {
+            this.app.use((0, payment_express_middleware_1.createPaymentMiddleware)({
+                wallet: this.wallet,
+                calculateRequestPrice: this.calculateRequestPrice || (() => 100)
+            }));
+        }
+        // A single POST endpoint for JSON-RPC:
+        this.app.post('/', async (req, res) => {
+            let { jsonrpc, method, params, id } = req.body;
+            // Basic JSON-RPC protocol checks:
+            if (jsonrpc !== '2.0' || !method || typeof method !== 'string') {
+                return res
+                    .status(400)
+                    .json({ error: { code: -32600, message: 'Invalid Request' } });
+            }
+            try {
+                // Dispatch the method call:
+                if (typeof this[method] === 'function') {
+                    // if you wanted to handle certain methods on the server class itself
+                    // e.g. this['someServerMethod'](params)
+                    throw new Error('Server method dispatch not used in this approach.');
+                }
+                else if (typeof this.storage[method] === 'function') {
+                    // method is on the walletStorage:
+                    // Find user
+                    switch (method) {
+                        case 'destroy': {
+                            console.log(`StorageServer: method=${method} IGNORED`);
+                            return res.json({ jsonrpc: '2.0', result: undefined, id });
+                        }
+                        case 'getSettings':
+                            {
+                                /** */
+                            }
+                            break;
+                        case 'findOrInsertUser':
+                            {
+                                if (params[0] !== req.auth.identityKey)
+                                    throw new index_all_1.sdk.WERR_UNAUTHORIZED('function may only access authenticated user.');
+                            }
+                            break;
+                        default:
+                            {
+                                if (typeof params[0] !== 'object' || !params[0]) {
+                                    params = [{}];
+                                }
+                                if (params[0]['identityKey'] &&
+                                    params[0]['identityKey'] !== req.auth.identityKey)
+                                    throw new index_all_1.sdk.WERR_UNAUTHORIZED('identityKey does not match authentiation');
+                                console.log('looking up user with identityKey:', req.auth.identityKey);
+                                const { user, isNew } = await this.storage.findOrInsertUser(req.auth.identityKey);
+                                params[0].reqAuthUserId = user.userId;
+                                if (params[0]['identityKey'])
+                                    params[0].userId = user.userId;
+                            }
+                            break;
+                    }
+                    console.log(`StorageServer: method=${method} params=${JSON.stringify(params).slice(0, 512)}`);
+                    const result = await this.storage[method](...(params || []));
+                    console.log(`StorageServer: method=${method} result=${JSON.stringify(result || 'void').slice(0, 512)}`);
+                    return res.json({ jsonrpc: '2.0', result, id });
+                }
+                else {
+                    // Unknown method
+                    return res.status(400).json({
+                        jsonrpc: '2.0',
+                        error: { code: -32601, message: `Method not found: ${method}` },
+                        id
+                    });
+                }
+            }
+            catch (error) {
+                // Catch any thrown errors from the local walletStorage method
+                const err = error;
+                return res.status(200).json({
+                    jsonrpc: '2.0',
+                    error: {
+                        code: -32000,
+                        message: err.message,
+                        data: {
+                            name: err.name,
+                            stack: err.stack
+                        }
+                    },
+                    id
+                });
+            }
+        });
+    }
+    start() {
+        this.app.listen(this.port, () => {
+            console.log(`WalletStorageServer listening at http://localhost:${this.port}`);
+        });
+    }
+}
+exports.StorageServer = StorageServer;
+//# sourceMappingURL=StorageServer.js.map

package/out/src/storage/remoting/StorageServer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"StorageServer.js","sourceRoot":"","sources":["../../../../src/storage/remoting/StorageServer.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;;;AAGH,sDAAoD;AACpD,0EAGqC;AACrC,gFAAyE;AACzE,+CAA8D;AAW9D,MAAa,aAAa;IAQxB,YAAY,OAAwB,EAAE,OAAmC;QAPjE,QAAG,GAAG,IAAA,iBAAO,GAAE,CAAA;QAQrB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAA;QACxB,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAA;QAC5B,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAA;QAChC,IAAI,CAAC,qBAAqB,GAAG,OAAO,CAAC,qBAAqB,CAAA;QAE1D,IAAI,CAAC,WAAW,EAAE,CAAA;IACpB,CAAC;IAEO,WAAW;QACjB,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,iBAAO,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC,CAAA;QAE7C,kEAAkE;QAClE,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;YAC9B,GAAG,CAAC,MAAM,CAAC,6BAA6B,EAAE,GAAG,CAAC,CAAA;YAC9C,GAAG,CAAC,MAAM,CAAC,8BAA8B,EAAE,GAAG,CAAC,CAAA;YAC/C,GAAG,CAAC,MAAM,CAAC,8BAA8B,EAAE,GAAG,CAAC,CAAA;YAC/C,GAAG,CAAC,MAAM,CAAC,+BAA+B,EAAE,GAAG,CAAC,CAAA;YAChD,GAAG,CAAC,MAAM,CAAC,sCAAsC,EAAE,MAAM,CAAC,CAAA;YAC1D,IAAI,GAAG,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;gBAC7B,yEAAyE;gBACzE,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,CAAA;YACrB,CAAC;iBAAM,CAAC;gBACN,IAAI,EAAE,CAAA;YACR,CAAC;QACH,CAAC,CAAC,CAAA;QAEF,MAAM,OAAO,GAA0B;YACrC,MAAM,EAAE,IAAI,CAAC,MAAyB;SACvC,CAAA;QACD,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAA,8CAAoB,EAAC,OAAO,CAAC,CAAC,CAAA;QAC3C,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,IAAI,CAAC,GAAG,CAAC,GAAG,CACV,IAAA,oDAAuB,EAAC;gBACtB,MAAM,EAAE,IAAI,CAAC,MAAM;gBACnB,qBAAqB,EAAE,IAAI,CAAC,qBAAqB,IAAI,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC;aACjE,CAAC,CACH,CAAA;QACH,CAAC;QAED,uCAAuC;QACvC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,KAAK,EAAE,GAAY,EAAE,GAAa,EAAE,EAAE;YACvD,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,GAAG,GAAG,CAAC,IAAI,CAAA;YAE9C,kCAAkC;YAClC,IAAI,OAAO,KAAK,KAAK,IAAI,CAAC,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;gBAC/D,OAAO,GAAG;qBACP,MAAM,CAAC,GAAG,CAAC;qBACX,IAAI,CAAC,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,iBAAiB,EAAE,EAAE,CAAC,CAAA;YAClE,CAAC;YAED,IAAI,CAAC;gBACH,4BAA4B;gBAC5B,IAAI,OAAQ,IAAY,CAAC,MAAM,CAAC,KAAK,UAAU,EAAE,CAAC;oBAChD,qEAAqE;oBACrE,wCAAwC;oBACxC,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAA;gBACtE,CAAC;qBAAM,IAAI,OAAQ,IAAI,CAAC,OAAe,CAAC,MAAM,CAAC,KAAK,UAAU,EAAE,CAAC;oBAC/D,kCAAkC;oBAClC,YAAY;oBACZ,QAAQ,MAAM,EAAE,CAAC;wBACf,KAAK,SAAS,CAAC,CAAC,CAAC;4BACf,OAAO,CAAC,GAAG,CAAC,yBAAyB,MAAM,UAAU,CAAC,CAAA;4BACtD,OAAO,GAAG,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC,CAAA;wBAC5D,CAAC;wBACD,KAAK,aAAa;4BAChB,CAAC;gCACC,MAAM;4BACR,CAAC;4BACD,MAAK;wBACP,KAAK,kBAAkB;4BACrB,CAAC;gCACC,IAAI,MAAM,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,IAAI,CAAC,WAAW;oCACpC,MAAM,IAAI,eAAG,CAAC,iBAAiB,CAC7B,8CAA8C,CAC/C,CAAA;4BACL,CAAC;4BACD,MAAK;wBACP;4BACE,CAAC;gCACC,IAAI,OAAO,MAAM,CAAC,CAAC,CAAC,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;oCAChD,MAAM,GAAG,CAAC,EAAE,CAAC,CAAA;gCACf,CAAC;gCACD,IACE,MAAM,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC;oCACxB,MAAM,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,KAAK,GAAG,CAAC,IAAI,CAAC,WAAW;oCAEjD,MAAM,IAAI,eAAG,CAAC,iBAAiB,CAC7B,0CAA0C,CAC3C,CAAA;gCACH,OAAO,CAAC,GAAG,CACT,mCAAmC,EACnC,GAAG,CAAC,IAAI,CAAC,WAAW,CACrB,CAAA;gCACD,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,CACzD,GAAG,CAAC,IAAI,CAAC,WAAW,CACrB,CAAA;gCACD,MAAM,CAAC,CAAC,CAAC,CAAC,aAAa,GAAG,IAAI,CAAC,MAAM,CAAA;gCACrC,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC;oCAAE,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAA;4BAC9D,CAAC;4BACD,MAAK;oBACT,CAAC;oBACD,OAAO,CAAC,GAAG,CACT,yBAAyB,MAAM,WAAW,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CACjF,CAAA;oBACD,MAAM,MAAM,GAAG,MAAO,IAAI,CAAC,OAAe,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,CAAA;oBACrE,OAAO,CAAC,GAAG,CACT,yBAAyB,MAAM,WAAW,IAAI,CAAC,SAAS,CAAC,MAAM,IAAI,MAAM,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAC3F,CAAA;oBACD,OAAO,GAAG,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,CAAA;gBACjD,CAAC;qBAAM,CAAC;oBACN,iBAAiB;oBACjB,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;wBAC1B,OAAO,EAAE,KAAK;wBACd,KAAK,EAAE,EAAE,IAAI,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,qBAAqB,MAAM,EAAE,EAAE;wBAC/D,EAAE;qBACH,CAAC,CAAA;gBACJ,CAAC;YACH,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,8DAA8D;gBAC9D,MAAM,GAAG,GAAG,KAAc,CAAA;gBAC1B,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;oBAC1B,OAAO,EAAE,KAAK;oBACd,KAAK,EAAE;wBACL,IAAI,EAAE,CAAC,KAAK;wBACZ,OAAO,EAAE,GAAG,CAAC,OAAO;wBACpB,IAAI,EAAE;4BACJ,IAAI,EAAE,GAAG,CAAC,IAAI;4BACd,KAAK,EAAE,GAAG,CAAC,KAAK;yBACjB;qBACF;oBACD,EAAE;iBACH,CAAC,CAAA;YACJ,CAAC;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAEM,KAAK;QACV,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,EAAE;YAC9B,OAAO,CAAC,GAAG,CACT,qDAAqD,IAAI,CAAC,IAAI,EAAE,CACjE,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;CACF;AAzJD,sCAyJC"}

package/out/src/storage/schema/KnexMigrations.d.ts

@@ -0,0 +1,39 @@
+import { Knex } from 'knex';
+import { sdk } from '../../index.all';
+import { DBType } from '../StorageReader';
+interface Migration {
+    up: (knex: Knex) => Promise<void>;
+    down?: (knex: Knex) => Promise<void>;
+    config?: object;
+}
+interface MigrationSource<TMigrationSpec> {
+    getMigrations(loadExtensions: readonly string[]): Promise<TMigrationSpec[]>;
+    getMigrationName(migration: TMigrationSpec): string;
+    getMigration(migration: TMigrationSpec): Promise<Migration>;
+}
+export declare class KnexMigrations implements MigrationSource<string> {
+    chain: sdk.Chain;
+    storageName: string;
+    storageIdentityKey: string;
+    maxOutputScriptLength: number;
+    migrations: Record<string, Migration>;
+    /**
+     * @param chain
+     * @param storageName human readable name for this storage instance
+     * @param maxOutputScriptLength limit for scripts kept in outputs table, longer scripts will be pulled from rawTx
+     */
+    constructor(chain: sdk.Chain, storageName: string, storageIdentityKey: string, maxOutputScriptLength: number);
+    getMigrations(): Promise<string[]>;
+    getMigrationName(migration: string): string;
+    getMigration(migration: string): Promise<Migration>;
+    getLatestMigration(): Promise<string>;
+    static latestMigration(): Promise<string>;
+    setupMigrations(chain: string, storageName: string, storageIdentityKey: string, maxOutputScriptLength: number): Record<string, Migration>;
+    /**
+     * @param knex
+     * @returns {DBType} connected database engine variant
+     */
+    static dbtype(knex: Knex<any, any[]>): Promise<DBType>;
+}
+export {};
+//# sourceMappingURL=KnexMigrations.d.ts.map

package/out/src/storage/schema/KnexMigrations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"KnexMigrations.d.ts","sourceRoot":"","sources":["../../../../src/storage/schema/KnexMigrations.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAA;AAC3B,OAAO,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAA;AACrC,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAA;AAEzC,UAAU,SAAS;IACjB,EAAE,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IACjC,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IACpC,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,UAAU,eAAe,CAAC,cAAc;IACtC,aAAa,CAAC,cAAc,EAAE,SAAS,MAAM,EAAE,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC,CAAA;IAC3E,gBAAgB,CAAC,SAAS,EAAE,cAAc,GAAG,MAAM,CAAA;IACnD,YAAY,CAAC,SAAS,EAAE,cAAc,GAAG,OAAO,CAAC,SAAS,CAAC,CAAA;CAC5D;AAED,qBAAa,cAAe,YAAW,eAAe,CAAC,MAAM,CAAC;IASnD,KAAK,EAAE,GAAG,CAAC,KAAK;IAChB,WAAW,EAAE,MAAM;IACnB,kBAAkB,EAAE,MAAM;IAC1B,qBAAqB,EAAE,MAAM;IAXtC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAK;IAE1C;;;;OAIG;gBAEM,KAAK,EAAE,GAAG,CAAC,KAAK,EAChB,WAAW,EAAE,MAAM,EACnB,kBAAkB,EAAE,MAAM,EAC1B,qBAAqB,EAAE,MAAM;IAUhC,aAAa,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAGxC,gBAAgB,CAAC,SAAS,EAAE,MAAM;IAG5B,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IAInD,kBAAkB,IAAI,OAAO,CAAC,MAAM,CAAC;WAK9B,eAAe,IAAI,OAAO,CAAC,MAAM,CAAC;IAK/C,eAAe,CACb,KAAK,EAAE,MAAM,EACb,WAAW,EAAE,MAAM,EACnB,kBAAkB,EAAE,MAAM,EAC1B,qBAAqB,EAAE,MAAM,GAC5B,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC;IA0Y5B;;;OAGG;WACU,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;CAyB7D"}

package/out/src/storage/schema/KnexMigrations.js

@@ -0,0 +1,442 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KnexMigrations = void 0;
+const index_all_1 = require("../../index.all");
+class KnexMigrations {
+    /**
+     * @param chain
+     * @param storageName human readable name for this storage instance
+     * @param maxOutputScriptLength limit for scripts kept in outputs table, longer scripts will be pulled from rawTx
+     */
+    constructor(chain, storageName, storageIdentityKey, maxOutputScriptLength) {
+        this.chain = chain;
+        this.storageName = storageName;
+        this.storageIdentityKey = storageIdentityKey;
+        this.maxOutputScriptLength = maxOutputScriptLength;
+        this.migrations = {};
+        this.migrations = this.setupMigrations(chain, storageName, storageIdentityKey, maxOutputScriptLength);
+    }
+    async getMigrations() {
+        return Object.keys(this.migrations).sort();
+    }
+    getMigrationName(migration) {
+        return migration;
+    }
+    async getMigration(migration) {
+        return this.migrations[migration];
+    }
+    async getLatestMigration() {
+        const ms = await this.getMigrations();
+        return ms[ms.length - 1];
+    }
+    static async latestMigration() {
+        const km = new KnexMigrations('test', 'dummy', '1'.repeat(64), 100);
+        return await km.getLatestMigration();
+    }
+    setupMigrations(chain, storageName, storageIdentityKey, maxOutputScriptLength) {
+        const migrations = {};
+        const addTimeStamps = (knex, table, dbtype) => {
+            if (dbtype === 'MySQL') {
+                table
+                    .timestamp('created_at', { precision: 3 })
+                    .defaultTo(knex.fn.now(3))
+                    .notNullable();
+                table
+                    .timestamp('updated_at', { precision: 3 })
+                    .defaultTo(knex.fn.now(3))
+                    .notNullable();
+            }
+            else {
+                table
+                    .timestamp('created_at', { precision: 3 })
+                    .defaultTo(knex.fn.now())
+                    .notNullable();
+                table
+                    .timestamp('updated_at', { precision: 3 })
+                    .defaultTo(knex.fn.now())
+                    .notNullable();
+            }
+        };
+        migrations['2025-01-21-001 add activeStorage to users'] = {
+            async up(knex) {
+                await knex.schema.alterTable('users', table => {
+                    table.string('activeStorage', 130).nullable().defaultTo(null);
+                });
+            },
+            async down(knex) {
+                await knex.schema.alterTable('users', table => {
+                    table.dropColumn('activeStorage');
+                });
+            }
+        };
+        migrations['2024-12-26-001 initial migration'] = {
+            async up(knex) {
+                const dbtype = await KnexMigrations.dbtype(knex);
+                await knex.schema.createTable('proven_txs', table => {
+                    addTimeStamps(knex, table, dbtype);
+                    table.increments('provenTxId').notNullable();
+                    table.string('txid', 64).notNullable().unique();
+                    table.integer('height').unsigned().notNullable();
+                    table.integer('index').unsigned().notNullable();
+                    table.binary('merklePath').notNullable();
+                    table.binary('rawTx').notNullable();
+                    table.string('blockHash', 64).notNullable();
+                    table.string('merkleRoot', 64).notNullable();
+                });
+                await knex.schema.createTable('proven_tx_reqs', table => {
+                    addTimeStamps(knex, table, dbtype);
+                    table.increments('provenTxReqId');
+                    table
+                        .integer('provenTxId')
+                        .unsigned()
+                        .references('provenTxId')
+                        .inTable('proven_txs');
+                    table.string('status', 16).notNullable().defaultTo('unknown');
+                    table.integer('attempts').unsigned().defaultTo(0).notNullable();
+                    table.boolean('notified').notNullable().defaultTo(false);
+                    table.string('txid', 64).notNullable().unique();
+                    table.string('batch', 64).nullable();
+                    table.text('history', 'longtext').notNullable().defaultTo('{}');
+                    table.text('notify', 'longtext').notNullable().defaultTo('{}');
+                    table.binary('rawTx').notNullable();
+                    table.binary('inputBEEF');
+                    table.index('status');
+                    table.index('batch');
+                });
+                await knex.schema.createTable('users', table => {
+                    addTimeStamps(knex, table, dbtype);
+                    table.increments('userId');
+                    table.string('identityKey', 130).notNullable().unique();
+                });
+                await knex.schema.createTable('certificates', table => {
+                    addTimeStamps(knex, table, dbtype);
+                    table.increments('certificateId');
+                    table
+                        .integer('userId')
+                        .unsigned()
+                        .references('userId')
+                        .inTable('users')
+                        .notNullable();
+                    table.string('serialNumber', 100).notNullable();
+                    table.string('type', 100).notNullable();
+                    table.string('certifier', 100).notNullable();
+                    table.string('subject', 100).notNullable();
+                    table.string('verifier', 100).nullable();
+                    table.string('revocationOutpoint', 100).notNullable();
+                    table.string('signature', 255).notNullable();
+                    table.boolean('isDeleted').notNullable().defaultTo(false);
+                    table.unique(['userId', 'type', 'certifier', 'serialNumber']);
+                });
+                await knex.schema.createTable('certificate_fields', table => {
+                    addTimeStamps(knex, table, dbtype);
+                    table
+                        .integer('userId')
+                        .unsigned()
+                        .references('userId')
+                        .inTable('users')
+                        .notNullable();
+                    table
+                        .integer('certificateId')
+                        .unsigned()
+                        .references('certificateId')
+                        .inTable('certificates')
+                        .notNullable();
+                    table.string('fieldName', 100).notNullable();
+                    table.string('fieldValue').notNullable();
+                    table.string('masterKey', 255).defaultTo('').notNullable();
+                    table.unique(['fieldName', 'certificateId']);
+                });
+                await knex.schema.createTable('output_baskets', table => {
+                    addTimeStamps(knex, table, dbtype);
+                    table.increments('basketId');
+                    table
+                        .integer('userId')
+                        .unsigned()
+                        .references('userId')
+                        .inTable('users')
+                        .notNullable();
+                    table.string('name', 300).notNullable();
+                    table.integer('numberOfDesiredUTXOs', 6).defaultTo(6).notNullable();
+                    table
+                        .integer('minimumDesiredUTXOValue', 15)
+                        .defaultTo(10000)
+                        .notNullable();
+                    table.boolean('isDeleted').notNullable().defaultTo(false);
+                    table.unique(['name', 'userId']);
+                });
+                await knex.schema.createTable('transactions', table => {
+                    addTimeStamps(knex, table, dbtype);
+                    table.increments('transactionId');
+                    table
+                        .integer('userId')
+                        .unsigned()
+                        .references('userId')
+                        .inTable('users')
+                        .notNullable();
+                    table
+                        .integer('provenTxId')
+                        .unsigned()
+                        .references('provenTxId')
+                        .inTable('proven_txs');
+                    table.string('status', 64).notNullable();
+                    table.string('reference', 64).notNullable().unique();
+                    table.boolean('isOutgoing').notNullable();
+                    table.bigint('satoshis').defaultTo(0).notNullable();
+                    table.integer('version').unsigned().nullable();
+                    table.integer('lockTime').unsigned().nullable();
+                    table.string('description', 500).notNullable();
+                    table.string('txid', 64);
+                    table.binary('inputBEEF');
+                    table.binary('rawTx');
+                    table.index('status');
+                });
+                await knex.schema.createTable('commissions', table => {
+                    addTimeStamps(knex, table, dbtype);
+                    table.increments('commissionId');
+                    table
+                        .integer('userId')
+                        .unsigned()
+                        .references('userId')
+                        .inTable('users')
+                        .notNullable();
+                    table
+                        .integer('transactionId')
+                        .unsigned()
+                        .references('transactionId')
+                        .inTable('transactions')
+                        .notNullable()
+                        .unique();
+                    table.integer('satoshis', 15).notNullable();
+                    table.string('keyOffset', 130).notNullable();
+                    table.boolean('isRedeemed').defaultTo(false).notNullable();
+                    table.binary('lockingScript').notNullable();
+                    table.index('transactionId');
+                });
+                await knex.schema.createTable('outputs', table => {
+                    addTimeStamps(knex, table, dbtype);
+                    table.increments('outputId');
+                    table
+                        .integer('userId')
+                        .unsigned()
+                        .references('userId')
+                        .inTable('users')
+                        .notNullable();
+                    table
+                        .integer('transactionId')
+                        .unsigned()
+                        .references('transactionId')
+                        .inTable('transactions')
+                        .notNullable();
+                    table
+                        .integer('basketId')
+                        .unsigned()
+                        .references('basketId')
+                        .inTable('output_baskets');
+                    table.boolean('spendable').defaultTo(false).notNullable();
+                    table.boolean('change').defaultTo(false).notNullable();
+                    table.integer('vout', 10).notNullable();
+                    table.bigint('satoshis').notNullable();
+                    table.string('providedBy', 130).notNullable();
+                    table.string('purpose', 20).notNullable();
+                    table.string('type', 50).notNullable();
+                    table.string('outputDescription', 300); // allow extra room for encryption and imports
+                    table.string('txid', 64);
+                    table.string('senderIdentityKey', 130);
+                    table.string('derivationPrefix', 32);
+                    table.string('derivationSuffix', 32);
+                    table.string('customInstructions', 2500);
+                    table
+                        .integer('spentBy')
+                        .unsigned()
+                        .references('transactionId')
+                        .inTable('transactions');
+                    table.integer('sequenceNumber').unsigned().nullable();
+                    table.string('spendingDescription');
+                    table.bigint('scriptLength').unsigned().nullable();
+                    table.bigint('scriptOffset').unsigned().nullable();
+                    table.binary('lockingScript');
+                    table.unique(['transactionId', 'vout', 'userId']);
+                });
+                await knex.schema.createTable('output_tags', table => {
+                    addTimeStamps(knex, table, dbtype);
+                    table.increments('outputTagId');
+                    table
+                        .integer('userId')
+                        .unsigned()
+                        .references('userId')
+                        .inTable('users')
+                        .notNullable();
+                    table.string('tag', 150).notNullable();
+                    table.boolean('isDeleted').notNullable().defaultTo(false);
+                    table.unique(['tag', 'userId']);
+                });
+                await knex.schema.createTable('output_tags_map', table => {
+                    addTimeStamps(knex, table, dbtype);
+                    table
+                        .integer('outputTagId')
+                        .unsigned()
+                        .references('outputTagId')
+                        .inTable('output_tags')
+                        .notNullable();
+                    table
+                        .integer('outputId')
+                        .unsigned()
+                        .references('outputId')
+                        .inTable('outputs')
+                        .notNullable();
+                    table.boolean('isDeleted').notNullable().defaultTo(false);
+                    table.unique(['outputTagId', 'outputId']);
+                    table.index('outputId');
+                });
+                await knex.schema.createTable('tx_labels', table => {
+                    addTimeStamps(knex, table, dbtype);
+                    table.increments('txLabelId');
+                    table
+                        .integer('userId')
+                        .unsigned()
+                        .references('userId')
+                        .inTable('users')
+                        .notNullable();
+                    table.string('label', 300).notNullable();
+                    table.boolean('isDeleted').notNullable().defaultTo(false);
+                    table.unique(['label', 'userId']);
+                });
+                await knex.schema.createTable('tx_labels_map', table => {
+                    addTimeStamps(knex, table, dbtype);
+                    table
+                        .integer('txLabelId')
+                        .unsigned()
+                        .references('txLabelId')
+                        .inTable('tx_labels')
+                        .notNullable();
+                    table
+                        .integer('transactionId')
+                        .unsigned()
+                        .references('transactionId')
+                        .inTable('transactions')
+                        .notNullable();
+                    table.boolean('isDeleted').notNullable().defaultTo(false);
+                    table.unique(['txLabelId', 'transactionId']);
+                    table.index('transactionId');
+                });
+                await knex.schema.createTable('monitor_events', table => {
+                    addTimeStamps(knex, table, dbtype);
+                    table.increments('id');
+                    table.string('event', 64).notNullable();
+                    table.text('details', 'longtext').nullable();
+                });
+                await knex.schema.createTable('settings', table => {
+                    addTimeStamps(knex, table, dbtype);
+                    table.string('storageIdentityKey', 130).notNullable();
+                    table.string('storageName', 128).notNullable();
+                    table.string('chain', 10).notNullable();
+                    table.string('dbtype', 10).notNullable();
+                    table.integer('maxOutputScript', 15).notNullable();
+                });
+                await knex.schema.createTable('sync_states', table => {
+                    addTimeStamps(knex, table, dbtype);
+                    table.increments('syncStateId');
+                    table
+                        .integer('userId')
+                        .unsigned()
+                        .notNullable()
+                        .references('userId')
+                        .inTable('users');
+                    table.string('storageIdentityKey', 130).notNullable().defaultTo('');
+                    table.string('storageName').notNullable();
+                    table.string('status').notNullable().defaultTo('unknown');
+                    table.boolean('init').notNullable().defaultTo(false);
+                    table.string('refNum', 100).notNullable().unique();
+                    table.text('syncMap', 'longtext').notNullable();
+                    table.dateTime('when');
+                    table.bigint('satoshis');
+                    table.text('errorLocal', 'longtext');
+                    table.text('errorOther', 'longtext');
+                    table.index('status');
+                    table.index('refNum');
+                });
+                if (dbtype === 'MySQL') {
+                    await knex.raw('ALTER TABLE proven_tx_reqs MODIFY COLUMN rawTx LONGBLOB');
+                    await knex.raw('ALTER TABLE proven_tx_reqs MODIFY COLUMN inputBEEF LONGBLOB');
+                    await knex.raw('ALTER TABLE proven_txs MODIFY COLUMN rawTx LONGBLOB');
+                    await knex.raw('ALTER TABLE transactions MODIFY COLUMN rawTx LONGBLOB');
+                    await knex.raw('ALTER TABLE transactions MODIFY COLUMN inputBEEF LONGBLOB');
+                    await knex.raw('ALTER TABLE outputs MODIFY COLUMN lockingScript LONGBLOB');
+                }
+                else {
+                    await knex.schema.alterTable('proven_tx_reqs', table => {
+                        table.binary('rawTx', 10000000).alter();
+                        table.binary('beef', 10000000).alter();
+                    });
+                    await knex.schema.alterTable('outputs', table => {
+                        table.binary('lockingScript', 10000000).alter();
+                    });
+                    await knex.schema.alterTable('proven_txs', table => {
+                        table.binary('rawTx', 10000000).alter();
+                    });
+                    await knex.schema.alterTable('transactions', table => {
+                        table.binary('rawTx', 10000000).alter();
+                        table.binary('beef', 10000000).alter();
+                    });
+                }
+                await knex('settings').insert({
+                    storageIdentityKey,
+                    storageName,
+                    chain,
+                    dbtype,
+                    maxOutputScript: maxOutputScriptLength
+                });
+            },
+            async down(knex) {
+                await knex.schema.dropTable('sync_states');
+                await knex.schema.dropTable('settings');
+                await knex.schema.dropTable('monitor_events');
+                await knex.schema.dropTable('certificate_fields');
+                await knex.schema.dropTable('certificates');
+                await knex.schema.dropTable('commissions');
+                await knex.schema.dropTable('output_tags_map');
+                await knex.schema.dropTable('output_tags');
+                await knex.schema.dropTable('outputs');
+                await knex.schema.dropTable('output_baskets');
+                await knex.schema.dropTable('tx_labels_map');
+                await knex.schema.dropTable('tx_labels');
+                await knex.schema.dropTable('transactions');
+                await knex.schema.dropTable('users');
+                await knex.schema.dropTable('proven_tx_reqs');
+                await knex.schema.dropTable('proven_txs');
+            }
+        };
+        return migrations;
+    }
+    /**
+     * @param knex
+     * @returns {DBType} connected database engine variant
+     */
+    static async dbtype(knex) {
+        try {
+            const q = `SELECT 
+    CASE 
+        WHEN (SELECT VERSION() LIKE '%MariaDB%') = 1 THEN 'Unknown'
+        WHEN (SELECT VERSION()) IS NOT NULL THEN 'MySQL'
+        ELSE 'Unknown'
+    END AS database_type;`;
+            let r = await knex.raw(q);
+            if (!r[0]['database_type'])
+                r = r[0];
+            if (r['rows'])
+                r = r.rows;
+            const dbtype = r[0].database_type;
+            if (dbtype === 'Unknown')
+                throw new index_all_1.sdk.WERR_NOT_IMPLEMENTED(`Attempting to create database on unsuported engine.`);
+            return dbtype;
+        }
+        catch (eu) {
+            const e = index_all_1.sdk.WalletError.fromUnknown(eu);
+            if (e.code === 'SQLITE_ERROR')
+                return 'SQLite';
+            throw new index_all_1.sdk.WERR_NOT_IMPLEMENTED(`Attempting to create database on unsuported engine.`);
+        }
+    }
+}
+exports.KnexMigrations = KnexMigrations;
+//# sourceMappingURL=KnexMigrations.js.map