Govern TX

packages/govern-tx/.gitignore

@@ -0,0 +1,2 @@
+coverage/
+dev-data/

packages/govern-tx/README.md

@@ -0,0 +1,66 @@
+# Govern TX
+
+The govern-tx package does include the transaction service of the govern project. 
+This service can get deployed on any server or cloud infrastructure who has nodejs installed.
+
+## Commands
+
+- ``yarn dev`` - Starts the docker containers and the server in dev mode
+- ``yarn start`` - Starts the docker containers and the server in production mode
+- ``yarn start:server`` - Starts the server without starting the docker containers
+- ``yarn start:containers`` - Starts the docker containers
+- ``yarn stop:containers`` - Stops the docker containers
+- ``yarn test`` - Does execute the unit and e2e tests of this package
+
+## Postgres DB diagramm
+
+![DB Diagramm](./assets/db_model.png)
+
+## Directory Structure
+
+Overall are the thoughts to have a modularized structure with the separation between abstract classes and concrete implementations with ``lib`` and ``src``.
+Means ``lib`` and ``src`` should (If abstraction is required for all module) have the same base structure. This is important to increase the readability. 
+
+```
+# All concrete implementations are located in the ./src/ folder
+./src/
+
+# Authentication handler used in the fastify pre-handler
+./src/auth
+
+# Configratuon object with the required validations of the input
+./src/config
+
+# DB wrapper and entities used in the server actions
+./src/db
+
+# Provider class used to connect to a Ethereum node
+./src/provider
+
+# All transactions related action commands
+./src/transactions
+
+# The wallet we use to sign the transactions 
+./src/wallet
+
+# All whitelist related CRUD action commands
+./src/whitelist
+
+# This class is used to boot the entire server and is used in ./src/index.ts
+./Bootstrap.ts
+
+# All abstract classes and helpers are located in the ./lib/ folder
+./lib/
+
+# Base abstraction for all actions
+./lib/AbstractAction.ts
+
+# Base abstraction for all transaction related actions and VO for contract function encoding
+./lib/transactions
+
+# Base abstraction for all whiteliste related CRUD actions
+./lib/whitelist
+
+# Home of all tests (e2e & unit)
+./test
+```

packages/govern-tx/config/dev.config.ts

@@ -0,0 +1,24 @@
+import { Config } from '../src/config/Configuration';
+
+export const config: Config = {
+    ethereum: {
+        publicKey: '', // Add default EOA
+        contracts: {
+            GovernQueue: '', // Add deployment address can get calculated if deployed with create2
+            GovernBaseFactory: ''
+        },
+        url: 'http://localhost:8545',
+        blockConfirmations: 42
+    }, 
+    database: {
+        user: 'govern-tx',
+        host: 'localhost',
+        password: 'tx-service',
+        database: 'govern-tx',
+        port: 5432
+    },
+    server: {
+        host: '0.0.0.0',
+        port: 4040
+    }
+} 

packages/govern-tx/config/prod.config.ts

@@ -0,0 +1,24 @@
+import { Config } from '../src/config/Configuration';
+
+export const config: Config = {
+    ethereum: {
+        publicKey: '', // Add default EOA
+        contracts: {
+            GovernQueue: '', // Add deployment address can get calculated if deployed with create2
+            GovernBaseFactory: ''
+        },
+        url: 'localhost:8545',
+        blockConfirmations: 42
+    }, 
+    database: {
+        user: 'govern-tx',
+        host: 'localhost',
+        password: 'tx-service',
+        database: 'govern-tx',
+        port: 5432
+    },
+    server: {
+        host: '0.0.0.0',
+        port: 4040
+    }
+} 

packages/govern-tx/docker-compose.yml

@@ -0,0 +1,18 @@
+version: "3"
+services:
+  postgres:
+    image: postgres
+    ports:
+      - "5432:5432"
+    environment:
+      POSTGRES_USER: govern-tx
+      POSTGRES_PASSWORD: tx-service
+      POSTGRES_DB: govern-tx
+    user: "${HOST_UID}:${HOST_GID}"
+    volumes:
+      - ./dev-data/postgres:/var/lib/postgresql/data
+      - ./postgres:/docker-entrypoint-initdb.d/
+  ganache:
+    image: trufflesuite/ganache-cli
+    ports:
+      - "8545:8545"

packages/govern-tx/jest.config.e2e.js

@@ -0,0 +1,4 @@
+const jestConfig = require('./jest.config.js')
+jestConfig.testMatch = ['/**/**Test.e2e.ts']
+
+module.exports = jestConfig;

packages/govern-tx/jest.config.js

@@ -0,0 +1,25 @@
+module.exports = {
+    rootDir: './',
+    preset: 'ts-jest',
+    notifyMode: 'success-change',
+    collectCoverage: true,
+    coverageDirectory: './coverage/',
+    coverageThreshold: {
+      global: {
+        functions: 80,
+        lines: 80,
+        statements: 80
+      }
+    },
+    notify: true,
+    clearMocks: true,
+    resetMocks: true,
+    resetModules: true,
+    testMatch: ['/**/**Test.ts'],
+    bail: true,
+    coveragePathIgnorePatterns: [
+      'node_modules',
+      'dist'
+    ]
+  }
+

packages/govern-tx/lib/AbstractAction.ts

@@ -0,0 +1,75 @@
+import { FastifySchema, FastifyRequest } from 'fastify'
+
+export interface Params {
+    message: string | any,
+    signature: string,
+}
+
+export default abstract class AbstractAction<T> {
+    /**
+     * The given request by the user
+     * 
+     * @var {Request} parameters
+     */
+    protected request: FastifyRequest;
+
+    /**
+     * @param {Request} parameters 
+     * 
+     * @constructor
+     */
+    constructor(request: FastifyRequest) {
+        this.request = this.validateRequest(request);
+    }
+
+     /**
+      * Validates the given request body.
+      * 
+      * @method validateRequest 
+      * 
+      * @param {Request} request 
+      * 
+      * @returns {Request}
+      * 
+      * @protected
+      */
+    protected validateRequest(request: FastifyRequest): FastifyRequest {
+        return request;
+    }
+
+    /**
+     * Executes the actual action
+     * 
+     * @method execute
+     * 
+     * @returns {Promise<any>} 
+     * 
+     * @public
+     */
+    public abstract execute(): Promise<T>
+
+    /**
+     * Returns the required request schema
+     * 
+     * @property schema
+     * 
+     * @returns {FastifySchema}
+     */
+    public static get schema(): FastifySchema {
+        return {
+            body: {
+                type: 'object',
+                required: ['message', 'signature'],
+                properties: {
+                    message: {
+                        oneOf: [
+                          { type: 'string'},
+                          { type: 'object'}
+                        ]
+                      },
+                    signature: { type: 'string' }
+                }
+            }
+        } as FastifySchema
+    }
+}

packages/govern-tx/lib/transactions/AbstractTransaction.ts

@@ -0,0 +1,109 @@
+import { FastifySchema, FastifyRequest } from 'fastify';
+import { TransactionReceipt } from '@ethersproject/abstract-provider'
+import { JsonFragment } from '@ethersproject/abi';
+import AbstractAction from '../AbstractAction'
+import ContractFunction from '../transactions/ContractFunction'
+import Provider from '../../src/provider/Provider'
+import { EthereumOptions } from '../../src/config/Configuration';
+import Whitelist from '../../src/db/Whitelist';
+import { Params } from '../AbstractAction';
+import { AuthenticatedRequest } from '../../src/auth/Authenticator';
+
+export default abstract class AbstractTransaction extends AbstractAction<TransactionReceipt> {
+    /**
+     * The function ABI used to create a transaction
+     * 
+     * @property {Object} functionABI
+     * 
+     * @protected
+     */
+    protected functionABI: JsonFragment
+
+    /**
+     * The contract name
+     * 
+     * @property {string} contract
+     * 
+     * @protected
+     */
+    protected contract: string
+
+    /**
+     * @param {EthereumOptions} config - Ethereum related configurations
+     * @param {Provider} provider - The Ethereum provider object
+     * @param {Whitelist} whitelist - Whitelist DB adapter
+     * @param {Request} request - The request body given by the user
+     * @param {string} publicKey - The public key of the user
+     * 
+     * @constructor
+     */
+    constructor(
+        private config: EthereumOptions,
+        private provider: Provider,
+        private whitelist: Whitelist,
+        request: FastifyRequest,
+    ) {
+        super(request)
+    }
+
+    /**
+     * Executes the transaction and returns the TransactionReceipt
+     * 
+     * @method execute
+     * 
+     * @returns {Promise<TransactionReceipt>} 
+     * 
+     * @public
+     */
+    public async execute(): Promise<TransactionReceipt> {
+        const contractFunction = new ContractFunction(
+            this.functionABI,
+            (this.request.params as Params).message
+        )
+        contractFunction.functionArguments[0].payload.submitter = this.config.publicKey
+
+        let receipt: TransactionReceipt = await this.provider.sendTransaction(this.contract, contractFunction)
+
+        if(!(this.request as AuthenticatedRequest).admin) {
+            this.whitelist.increaseExecutionCounter((this.request as AuthenticatedRequest).publicKey)
+        }
+
+        return receipt;
+    } 
+
+    /**
+     * TODO: Test BigNumber handling of the response and the fastify schema validation
+     * 
+     * Returns the schema of a transaction command
+     * 
+     * @property {FastifySchema} schema
+     * 
+     * @returns {FastifySchema}
+     */
+    public static get schema(): FastifySchema {
+        const schema = AbstractAction.schema
+
+        schema.response = {
+            200: {
+                type: 'object',
+                properties: {
+                    to: { type: 'string' },
+                    from: { type: 'string' },
+                    contractAddress: { type: 'string' },
+                    transactionIndex: { type: 'number' },
+                    gasUsed: { type: 'object' }, // BigNumber
+                    logsBloom: { type: 'string' },
+                    blockHash: { type: 'string' },
+                    transactionHash: { type: 'string' },
+                    logs: { type: 'array' },
+                    confirmations: { type: 'number' },
+                    cumulativeGasUsed: { type: 'object'}, // BigNumber
+                    byzantium: { type: 'boolean' },
+                    status: { type: 'number' }
+                }
+            }
+        }
+
+        return schema
+    }
+}