Applied MR Changes

.dockerignore

@@ -1,10 +1,7 @@
+.idea/
+.vscode/
+
 __pycache__
 config
 
-src/src
-oasis_api_server
-config/user_config_main.ini
-config/user_config_nodes.ini
-config/user_config_sentry.ini
-config/tls_identity_cert.pem
-.vscode/
+oasis_api_server

.gitignore

@@ -1,10 +1,10 @@
 .idea/
+.vscode/
+
 __pycache__/
 
-src/src
 oasis_api_server
 config/user_config_main.ini
 config/user_config_nodes.ini
 config/user_config_sentry.ini
 config/tls_identity_cert.pem
-.vscode/

docs/CHANGELOG.md

@@ -1,6 +1,6 @@
 ## 1.0.0
 
-Released on March 2020
+Released on May 2020
 
 ### Added
 

docs/INSTALL_AND_RUN.md

@@ -1,6 +1,7 @@
 # Install and Run the Oasis API Server
 
 ## Configuring the Nodes
+
 In order for the API to be able to run correctly, Prometheus Metrics should be enabled in the Oasis node's configuration file `config.yml` in the `/serverdir/etc/` directory which was set during the installation of the Oasis Node. To enable the metrics append this to the end of the file :
 
 ```
@@ -12,6 +13,7 @@ metrics:
 Change `:9090` to the port you want prometheus to be exposed at.
 
 ## Configuring the API
+
 Configuring the API involves setting up three config files. This is a strict requirement for the API to be able to run.
 
 Start off by cloning this repository and navigating into it:
@@ -37,9 +39,11 @@ pipenv sync
 pipenv run python run_setup.py
 ```
 ### Manually
+
 Alternatively, for advanced users, you can make a copy of the `example_*.ini` files inside the `config` folder without the `example_` prefix, and manually change the values as required.
 
 ## Installing the API and Dependencies
+
 This section will guide you through the installation of the API and any of its dependencies.
 
 We recommend that the API is installed on a Linux system, given the simpler installation and running process. 
@@ -49,19 +53,23 @@ You can either [run the API from source](#running-from-source) or [run the API u
 This affects what dependencies you will need to install.
 
 ### Running from Source
+
 Running the API from source only requires you to install Golang.
 
 #### Install Golang
+
 It is assumed that since this API needs to be run on the same machine as the Oasis node then Golang is already installed,
 therefore no documentation is provided for it's installation,
 
 #### Running the API
+
 After having installed golang you can now run the API as follows from the project directory:
 ```bash
 bash run_api.sh
 ```
 
 #### Running the API as a Linux Service
+
 Running the API as a service means that it starts up automatically on boot and restarts automatically if it runs into some issue and stops running. To do so, we recommend the following steps:
 ```bash
 # Add a new user to run the API
@@ -109,17 +117,21 @@ Check out `systemctl status oasis_api_server` to confirm that the API is running
 
 
 ### Run using Docker
+
 To run the API using Docker, you shouldn't be surprised to find out that you need to install Docker.
 
 You will then obtain the Docker image, make sure that the config files are where they should be, and run everything.
 
 #### Installing Docker on your Machine
+
 To install Docker on your machine, follow [this guide](INSTALL_DOCKER.md)
 
 #### Obtaining the Docker Image
+
 This part can be done in either of two ways, either by building the Docker image yourself, or by downloading it from Docker Hub.
 
 ##### Building the Docker Image
+
 First start off by cloning this repository:
 ```bash
 git clone https://github.com/SimplyVC/oasis_api_server
@@ -133,38 +145,44 @@ docker build -t simplyvc/oasis_api_server:1.0.0 .
 
 
 ##### Downloading the Pre-Built Docker Image from DockerHub
+
 The pre-built Docker image can simply be downloaded by running the following command:
 ```bash
 docker pull simplyvc/oasis_api_server:1.0.0
 ```
 
 #### Config Files Directory and Permissions
+
 The config files needed by the Docker image are the same as those generated in the `Configuring the API` section above.\
 These config files can be moved to any directory of your choosing `<CONFIG_DIR>`.
 
 ##### On Ubuntu
+
 If you created a new user `<USER>` earlier on, set the permissions as follows:
 ```bash
 sudo chown -R <USER>:<USER> <CONFIG_DIR>
 ```
 
 ##### On Windows
+
 No further steps are required.
 
 #### Running the Docker Image
+
 Now that the Docker image is on your machine, and you have written configurations for it, you can run it as follows, where `<CONFIG_DIR>` is the **full path** to the folder containing the previously created config files. Suppose that <CONFIG_DIR> is the **full path** to the folder containing the previously created config files, <INTERNAL_SOCK_DIR> is the **full path** on your machine where the internal socket file can be found for the Oasis node (e.g: serverdir/node/), and <PATH_IN_NODE_CONFIG> is the specified location in the API setup where the API will look for the internal socket (e.g: serverdir/node/). The API Server must also be able to find the **full path** of the Sentry `tls_identity_cert.pem` files. Therefore the path <INTERNAL_TLS_DIR> is the **full path** on your machine where the `tls_identity_cert.pem` file can be found, and <PATH_IN_SENTRY_CONFIG> is the specified location in the API setup where the API will look for the `tls_identity_cert.pem` file (e.g: serverdir/etc/). Now that the Docker image is on your machine and you have written configuration for it, you can run it as follows:
 ```bash
 docker run --network="host" -p 127.0.0.1:8686:8686 \
-    -v <CONFIG_DIR>:/app/config/ \
-    -v <INTERNAL_SOCK_DIR>:<PATH_IN_NODE_CONFIG> \
-    -v <INTERNAL_TLS_DIR>:<PATH_IN_SENTRY_CONFIG> \
+    --mount type=bind,source=<CONFIG_DIR>,target=/app/config/ \
+    --mount type=bind,source=<INTERNAL_SOCK_DIR>,target=<PATH_IN_NODE_CONFIG> \
+    --mount type=bind,source=<INTERNAL_TLS_DIR>,target=<PATH_IN_SENTRY_CONFIG> \
     -d simplyvc/oasis_api_server:1.0.0
 ```
 
 Note: The port after `-p` and before the `:` can be used to route a port from the machine to the internal port of the Docker. If changing this, any program which refers to the API Docker container must refer to this port.\
 Example: with `5678`:3000, the the API URL must look like `http://1.2.3.4:5678`, i.e. the port must match `5678`, and not 3000.
 
 ## Confirming the API Works
+
 If you wish to make sure that the API is running, the following should return `{"result":"pong"}`:
 ```bash
 curl -X GET http://localhost:3000/api/pingapi

docs/INSTALL_DOCKER.md

@@ -1,6 +1,7 @@
 # Installing Docker
 
 ## On Ubuntu
+
 First, install Docker on your machine:
 ```bash
 sudo apt update
@@ -19,6 +20,7 @@ docker --version
 ```
 
 ### Creating a new user
+
 You should create a new user from which you will run the Docker images. This is not required, but suggested for security reasons.
 ```bash
 sudo adduser oasis_api_server
@@ -36,6 +38,7 @@ su oasis_api_server
 ```
 
 ## On Windows
+
 Download and Install the `Stable` version of `Docker Desktop for Windows` from [here](https://hub.docker.com/editions/community/docker-ce-desktop-windows).\
 Once it has installed, you must Log out and back in in order for the installation to complete
 

docs/INSTALL_NODE_EXPORTER.md

@@ -5,23 +5,31 @@
 [Github](https://github.com/prometheus/node_exporter) link to most recent version of Node Exporter.
 
 ### Create a Node Exporter user for running the exporter:
+
 ```
     sudo useradd --no-create-home --shell /bin/false node_exporter
 ```
+
 ### Download and extract the latest version of Node Exporter:
+
 ```
 wget https://github.com/prometheus/node_exporter/releases/download/v0.18.1/node_exporter-0.18.1.linux-amd64.tar.gz
 tar -xzvf node_exporter-0.18.1.linux-amd64.tar.gz
 ```
+
 ### Send the executable to /usr/local/bin:
+
 ```
 sudo cp node_exporter-0.18.1.linux-amd64/node_exporter /usr/local/bin/
 ```
+
 ### Give the Node Exporter user ownership of the executable:
+
 ```
 sudo chown node_exporter:node_exporter /usr/local/bin/node_exporter
 ```
 ### Perform some cleanup and create and save a Node Exporter service with the below contents:
+
 ```
 sudo rm node_exporter-0.18.1.linux-amd64 -rf
 sudo nano /etc/systemd/system/node_exporter.service

docs/SERVER.xml

@@ -1 +1 @@
-<mxfile host="app.diagrams.net" modified="2020-03-20T12:04:17.280Z" agent="Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/80.0.3987.132 Safari/537.36" etag="fV9etpap1wrgD3Kei5WF" version="12.8.8"><diagram id="jlKB5raUCACtt_PIqlPo" name="Page-1">7VtRc+I2EP41zLQPYSzLNvAIhFzbSS6ZcHOX9k1gAeoZy5VFAvfrK9kyxpINvsQQ0sJDYq2ltfx9q93VIlpwuFx/Yiha3FEfBy3b8tcteN2ybQDsnvgnJZtU4jluKpgz4qtOuWBMfmAltJR0RXwcFzpySgNOoqJwSsMQT3lBhhijL8VuMxoUnxqhOTYE4ykKTOk34vNFKu3anVz+GybzRfZk4KkXXqKss3qTeIF8+rIjgqMWHDJKeXq1XA9xIMHLcEnH3VTc3U6M4ZDXGfDt+q+vXcd+Av74sWtP/NXSj69gquUZBSv1wv0pp0zNmG8yGMTkI3m5WgZpBzh4xowTAdQtmuDggcaEExqKLhPKOV2KDoG8MUDT73NGV6E/pIEcJ7TBWfLZ0dEPyFyO5TQS0gVfBqIBxCVd8YCEeLhl1xJCNWcxFq8rwQBbiIVtYrrEnG1EFzUA9hRNyiwdRdJLzjFUosUOvZ6SIWVV863iHHhxobD/CR4cgweDggRE7CtgXhaE43GEpvLui1h7RdwagKhjFRACngmR13FMjKB1LJC6BibYF4tVNSnjCzqnIQpGuXSQoyYtJ+9zS6WpJVj9jTnfKM+DVpwWkcRrwp/k8HbHVc0/lTZ5fb3ebWyyRije9ynTIBvJmDbUPtndXEvSKqh5wIwI/DArWL988/3ECqDoik3xHkA95VARm2N+yEuYhsJwgDh5Ls6jcdaB6aP+GN9/FpIbyoSX5YJd2wvE/AcT4bi8ubx6xHFEwxgbFiPWAy8SjJTvmQr4MCtxSkvi+6kt4Zj8QJNElWQioiTkyeu6g5Z7Xc/lVa5MFcGU/jxu7BJbvSwql/GV1Xa8rldYy1fqkbUJVNof5AvvdKGzWSwMR2d4O4nXk+4ZnN+jmMRC1H/4XfwdYyYgrAxTEaNTHMeH/eRky9V9Gmma85/Acgqg21aJA7VPGWQ67+o/d51nqSOs9qaioXvBrYe12rZbcLIHfGqD7hPWdJ/eG91nMrTPGNrsdFDOx1ycyvxst5jheJZmP6nCRldtz8wmk9U6Cv0onZ3up3/5NPoiOjzif1Y45r/+H9x1Z6/XsNoWgFpu2nubt84CgVOu9vjOHJRlt6klLEBmCeP+3Ug69tHj19Fjdls8Lu9Rwzhizuh3nPEYUunPBzMSBJooFgGBhHMhcPPWl8SjXdlWRdigwgpmQbKFWwgbw6HhHhuIGhAeTrtBryRqOMeKGsA12PsstvlCAsz1XBmRpxsRXf1kwR4KySmkt5MTxOhtTFZow05JjC4Bu3s0sM3ER4FtfTBo9fTn/aHtVEFr7rXPG1p4dlbbrYIWfjRotbrQu0ObpRUmtM4Hg9bpnZnVZq+wr+gm1JAoxoeRRHGUFihnZC3zAZWKZDVj0FB64GlL37FcMz0oAREcDUT7A4IIzw1Es8R1/iD2zg1EM76fP4jeuYFoRnITxNDvy2/WZKQJUByTaVXFHBQq5m0ra9Yv86QPb6RaAyrKMDtQuyVQZ7I37r63+zM9+mUq0vmrUTmLhiKQ1cOzsqKnzSUtRxmKmtrMwzpR8wwt5N2IBzrx8HXE64qMOvGxia8T6S/E51uJpojXFZ2c+DrZyYX4fKOjeehXE68rOjnxNU4lXIjP+XKNuswridcVnZx4swp5IX4P8cA9wFft5M49YEHHJv6Dpv/vltw1Rbyu6OTEm1/dXojfl9w1Rbyu6NTEZ9vSC/E1k7umiNcVnZz4yz7+55I7pyHidUUnJ97czl0jjoTkRh5u0G3g9Ycs6p/UKSvGNn6yQjvPDIFZanVKzMe2qi3lbUe+zd3VHWXymz35BV/83yXC0wsjJUdcus0wIZr5DyzSBZT/TAWO/gU=</diagram></mxfile>
+<mxfile host="app.diagrams.net" modified="2020-05-11T15:06:55.846Z" agent="5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/81.0.4044.122 Safari/537.36" etag="WPVBHedYlV5EHjsGYVNP" version="13.0.8" type="device"><diagram id="jlKB5raUCACtt_PIqlPo" name="Page-1">7Vrbcts2EP0azbQP5vB+eXRsy20njT1Wpkn6BpGQhDFJMCRkS/36LATeQECRLcu2OhEfNMLBjdhzsFhyOXIustV1iYrF3zTB6cg2k9XIuRzZduS48MuBtQC8BpiXJBGQ1QET8h+uQbNGlyTBldSQUZoyUshgTPMcx0zCUFnSR7nZjKbyrAWaYwWYxChV0S8kYQuBhnbQ4X9gMl80M1t+JGoy1DSuV1ItUEIfe5BzNXIuSkqZ+JetLnDKbdfYRfQbb6ltb6zEOXtKhy+X//4TuvZXK5nchfY0WWZJdeaIUR5QuqwX/AkYBOSmwCVitKzvna0bg8AyCv53maXnMW/gfHjAJSNgso9oitNbWhFGaA5NppQxmkGDlFd8QPH9vKTLPLmgKe8HozmzzdUb4zwlc96X0QLQBctSKFjwly5ZSnJ80fJsAjgjaSqNhv04BrxiJb3HvZokiKYm76FarTYkvwG86kG1Fa8xzTAr19CkrnUsW3RZy1J97PTh1NCiJw2/xlCtyHk7cEca/Kl5ewaHrsKhQtrG7DipTfm4IAxPChTz2kfYtrKlFaPO7C1G9ae+5x/GqIEp29RXjerprOo4r2VWXzHrDapIBdD57Z/wO8ElLG/r/ihKGuOq2m3uabsvboTE9TQkCIczLQ1+HOLp7DA0WKYr8WCbKg+u67+lulUXdYkYAmScgjsdmh/WyWT7yvbKKTewZNwaQrXnicF6uNS4pIwkCZ9GS2i3ww7kZUJ5QziWpxDha/aDfQAellU4W5vmVYZuq4/3VjGxnPmZpdBQnxQwoZ9ym09hM/hz1i6/x0qPjp2HhcLD3qeHYL45tm3d3hmPQ3NzLrSnMy8kqFq0XDYbOlvNeYRjEFoFBoF4ozISLsRmuQq1GgFs33f2gO5A4/90h4prWK9EuL2NcOtE73PpbWOE46F3a+SnRg8nendFhObR0RvsDgpxnpzzJyTOVoqqisTywYlXhH3lZjQ8J6jL36B8Zhqm1TS4XNWG3hTWvcItLgmshYtAYDmsS4xnRmEDfNsAUeg3QDfgprTul4ZDVgyVTF3DBh6TtFmIWDlOlCc95Xiu6LKM8e5TECaYY7YreFT1skMPDVbiFDHyIN+uTiL1DLeUwEK6wySS5eiag6BALLPu1X9kHAwEPWVde4OBhB2UgTaKbZe9v4jDoxZx0NewdQT6fS+92Y5rBOAD20t+PgZvaJimG0bN5e+pRscz7CDqrkCaBsJhI7DeVJ/RSZ//B306NtfnzzW5nyQdGyQZvrcMm+BSjeWcUyz37FgujI4tlrPUZ++TnzlCP+NajhHsOPv28zOu5Rq27rjrHbru2/qcra8H3JPPea7PcYcv+47A56jvB04+5wh9jme6is/xI8OOXuxzPNPT+Ryzfw0i+df2OfvG21u41kqVZ/dkqZr+s6X6VNXIbxyO702C68uOSUkvPDlQHrwhs4avJF5ZOrYaIh9eOkGrlNbL/bLK4a7Ck7Vj7asd/820o7WjpUuwi5TXwmpSXk02WOAwT1elCG3/HGVVoJjkcwC8rvSZhzuXXOL61CSFG5ulGwEvSJJgCJEG6coZzZkuLNqqvaenMe1QPpx0if1II8NDpPX1nkD3MCVY42YY8U+JGkv435dUMFi/3epDPUYbkA9wVm2+YTqHBkGxGtnCjiZP7J81C+SVm4yf1x9QqEV8XHCVJ4XQ8zC3+tv11WdocIe/L3HFfu8pTtz+wTV3yLz4z4X2shTbIIPaZlTfK2HenDAvFlrDqOgLmz5/sviGg/w1ufkEdWNaZogxoEWR1x2uCni4wbqkfqs0cQ8K/GsL0Amt3QLUfDmzh6eDYvfdoDjmuo8vnasf</diagram></mxfile>