remove custom mount, update examples, add script to build dashboard

Author: Thoralf-M

Diff for: bin/lib/start.js

@@ -76,7 +76,6 @@ function bin(argv, server) {
   const iotap = require('../../')
   let app
   const options = {
-    value: 0,
     websockets: true,
     api: true,
     dashboard: true

Diff for: docs/README.md

@@ -63,8 +63,9 @@ Creates and returns a express server.
 
 -   `app` **[object][33]** an express application.
 -   `options` **[object][33]** an options object. (optional, default `{}`)
-    -   `options.mount` **[String][34]** The payment route name.
-    -   `options.value` **[Number][32]** The default IOTA value.
+    -   `options.websockets` **[Boolean][34]** websockets.
+    -   `options.dashboard` **[Boolean][34]** dashboard at /iotapay.
+    -   `options.api` **[Boolean][34]** api at /iotapay/api.
 
 ### Examples
 
@@ -73,9 +74,9 @@ Creates and returns a express server.
 var paymentModule = require('iota-payment')
 var app = require('express')()
 
-let server = paymentModule.createServer(app, {mount: '/payments'})
+let server = paymentModule.createServer(app, {api: true})
 
-// Start server with iota-payment module on '/payments'
+// Start server with iota-payment api on '/iotapay/api'
 server.listen(3000, function () {
    console.log(`Server started on http://localhost:3000 `)
 })
@@ -266,8 +267,8 @@ Creates and returns a payout.
 -   `payoutData` **[object][33]** data for the payout
     -   `payoutData.address` **address** 90 trytes iota address (with checksum)
     -   `payoutData.amount` **[number][32]** amount of iotas
-    -   `payoutData.message` **[string][34]?** message which will be send with the transaction
-    -   `payoutData.tag` **[string][34]?** tryte tag
+    -   `payoutData.message` **[string][37]?** message which will be send with the transaction
+    -   `payoutData.tag` **[string][37]?** tryte tag
     -   `payoutData.startIndex` **[number][32]?** custom start index to search for inputaddresses
     -   `payoutData.endIndex` **[number][32]?** custom end index to search for inputaddresses
 
@@ -438,10 +439,10 @@ Returns **[Object][33]** payment
 WebSockets with socket.io
 
 backend:
-[https://github.com/machineeconomy/iota-payment/blob/master/examples/06_websockets.js][37]
+[https://github.com/machineeconomy/iota-payment/blob/master/examples/06_websockets.js][38]
 
 frontend:
-[https://github.com/machineeconomy/iota-payment/blob/master/examples/06_websocket.html][38]
+[https://github.com/machineeconomy/iota-payment/blob/master/examples/06_websocket.html][39]
 
 [1]: #getbalance
 
@@ -509,12 +510,14 @@ frontend:
 
 [33]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
 
-[34]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
+[34]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
 
 [35]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function
 
 [36]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
 
-[37]: https://github.com/machineeconomy/iota-payment/blob/master/examples/06_websockets.js
+[37]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
 
-[38]: https://github.com/machineeconomy/iota-payment/blob/master/examples/06_websocket.html
+[38]: https://github.com/machineeconomy/iota-payment/blob/master/examples/06_websockets.js
+
+[39]: https://github.com/machineeconomy/iota-payment/blob/master/examples/06_websocket.html

Diff for: examples/01_simple_server.js

@@ -1,9 +1,4 @@
-var paymentModule = require('..')
-var app = require('express')()
+const paymentModule = require('..')
 
-let server = paymentModule.createServer(app)
-
-// Start server with iota-payment module on '/'
-server.listen(3000, function () {
-    console.log(`Server started on http://localhost:3000 `)
-})
+// Start iota-payment module
+paymentModule.createServer()

Diff for: examples/02_custom_server.js

@@ -0,0 +1,20 @@
+const paymentModule = require('..')
+const app = require('express')()
+
+app.get("/", (req, res) => {
+    res.send('hello world from 02_express_server_with_gui+api example!');
+});
+
+let options = {
+    api: true,
+    //"npm run build:dashboard" is required for the dashboard
+    dashboard: true
+    // ...
+}
+
+let server = paymentModule.createServer(app, options)
+
+// Start server with iota-payment dashboard on '/iotapay' and api on '/iotapay/api'
+server.listen(3000, () => {
+    console.log(`Server started on http://localhost:3000 `)
+})

Diff for: examples/02_express_server_with_gui+api.js

@@ -1,21 +1,7 @@
 var paymentModule = require('..')
-var app = require('express')()
 
-var options = {
-    mount: '/',
-    value: 1
-    // ...
-}
-app.get("/", function (req, res) {
-    res.send('hello world from 03_events example!');
-});
-
-let server = paymentModule.createServer(app, options)
-
-// Start server with iota-payment module on '/'
-server.listen(3000, function () {
-    console.log(`Server started on http://localhost:3000 `)
-})
+// Start server with iota-payment module on
+paymentModule.createServer()
 
 //Create an event handler which is called, when a payment was created
 var onPaymentCreated = function (payment) {

Diff for: examples/03_events.js

@@ -3,28 +3,23 @@ var paymentModule = require('..')
 async function run() {
   // get all payments
   console.log("All payments:");
-  await paymentModule.payment.getPayments().then(payments => {
-    console.log(payments)
-  })
+  let allPayments = await paymentModule.payment.getPayments()
+  console.log(allPayments)
 
   // get all open payments
   console.log("Open payments:");
-  await paymentModule.payment.getOpenPayments().then(payments => {
-    console.log(payments)
-  })
+  let openPayments = await paymentModule.payment.getOpenPayments()
+  console.log(openPayments)
 
   // create a payment
   console.log("Create payment:");
-  let id;
-  await paymentModule.payment.createPayment({ value: 1, data: { "test": "123" } }).then(payment => {
-    console.log(payment)
-    id = payment.id
-  })
+  let payment = await paymentModule.payment.createPayment({ value: 1, data: { "test": "123" } })
+  console.log(payment)
 
   // get a specific payment
   console.log("Get payment:");
-  await paymentModule.payment.getPaymentByID(id).then(payment => {
-    console.log(payment)
-  })
+  let specificPayment = await paymentModule.payment.getPaymentByID(payment.id)
+  console.log(specificPayment)
+
 }
 run()

Diff for: examples/04_payment.js

@@ -3,7 +3,7 @@ var paymentModule = require('..')
 let payoutObject = {
   //required
   address: 'IKTYKKCZFZZECSFIJYWYSUUTXCIBNIFPFSPGUIUUAYONDYUSHEZVQBNPDYUTDMTNTHBLABCYYLZKLGIVCINGBALQVX', 
-  value: 1, 
+  value: 0, 
   //optional
   message: 'Example message',
   tag: 'TRYTETAG',

Diff for: examples/05_payout.js

@@ -51,7 +51,7 @@
 <script>
     var socketClientId
     const socket = io('http://localhost:3000', {
-        path: '/payments/socket'
+        path: '/iotapay/socket'
     });
 
     var app = new Vue({

Diff for: examples/06_websocket.html

@@ -44,15 +44,13 @@ app.post('/payout', async (req, res) => {
 })
 
 var options = {
-    mount: '/payments',
-    value: 0,
     websockets: true
     // ...
 }
 
 let server = paymentModule.createServer(app, options)
 
-// Start server with iota-payment module on '/payments'
+// Start server
 server.listen(3000, function () {
     console.log(`Server started on http://localhost:3000 `)
 })

Diff for: examples/06_websockets.js

@@ -4,15 +4,12 @@ var allowedOrigins =
   process.env.socket_origins || 'http://localhost:* http://127.0.0.1:*'
 
 var socketServer = undefined
-var socket_path = '/socket'
+var socket_path = '/iotapay/socket'
 var clients = []
 
-function start(server, mount = '') {
+function start(server) {
   if (socketServer) return
 
-  if (mount != '/') {
-    socket_path = mount + '/socket'
-  }
   console.log(`start socketServer on '${socket_path}'`)
 
   socketServer = io(server, {

Diff for: lib/WebSockets.js

@@ -4,20 +4,17 @@ const dotenv = require('dotenv')
 dotenv.config()
 
 const express = require('express')
-const fs = require('fs')
-const https = require('https')
 const http = require('http')
 const bodyParser = require('body-parser')
-var cors = require('cors')
+const cors = require('cors')
+const passport = require('passport')
+const { ExtractJwt, Strategy } = require('passport-jwt')
 
 const eventEmitter = require('./eventEmitter')
-
 const paymentHandler = require('./paymentHandler')
 const payoutHandler = require('./payoutHandler')
 const WebSockets = require('./WebSockets.js')
 const { startZmq } = require('./zmq.js')
-const passport = require('passport')
-const { ExtractJwt, Strategy } = require('passport-jwt')
 const api = require('./api')
 
 // Start Handler
@@ -28,17 +25,18 @@ payoutHandler.start()
  * Creates and returns a express server.
  * @param {object} app - an express application.
  * @param {object} options - an options object.
- * @param {String} options.mount - The payment route name.
- * @param {Number} options.value - The default IOTA value.
+ * @param {Boolean} options.websockets - websockets.
+ * @param {Boolean} options.dashboard - dashboard at /iotapay.
+ * @param {Boolean} options.api - api at /iotapay/api.
  * @returns {object} an http server
  * @example
  * // creates a simple server
  * var paymentModule = require('iota-payment')
  * var app = require('express')()
  *
- * let server = paymentModule.createServer(app, {mount: '/payments'})
+ * let server = paymentModule.createServer(app, {api: true})
  *
- * // Start server with iota-payment module on '/payments'
+ * // Start server with iota-payment api on '/iotapay/api'
  * server.listen(3000, function () {
  *    console.log(`Server started on http://localhost:3000 `)
  * })
@@ -75,32 +73,22 @@ function createServer(app, options = {}) {
   passport.serializeUser(function(user, done) {
     done(null, user)
   })
-  let mount = options.mount || '/iotapay'
 
   if (options.api) {
-    app.use(mount + '/api', api({}))
+    app.use('/iotapay/api', api({}))
+    console.log('API on /iotapay/api')
   }
 
   if (options.dashboard) {
-    app.use(mount, express.static('dashboard/dist'))
+    app.use('/iotapay', express.static('dashboard/dist'))
+    console.log('Dasboard on /iotapay')
   }
 
-  // Removing ending '/'
-  if (mount.length > 1 && mount[mount.length - 1] === '/') {
-    mount = mount.slice(0, -1)
-  }
-
-  let value = options.value || 0
-
-  console.log('Base URL (--mount): ' + mount)
-
-  let server
-
-  server = http.createServer(app)
+  let server = http.createServer(app)
 
   let websockets = options.websockets || false
   if (websockets) {
-    WebSockets.start(server, mount)
+    WebSockets.start(server)
   }
 
   if (process.env.fast_but_risky == 'true' || process.env.zmq == 'true') {
@@ -112,7 +100,7 @@ function createServer(app, options = {}) {
     }
   }
 
-  if (process.env.debug == 'full') {
+  if (process.env.debug == 'basic' || process.env.debug == 'full') {
     console.log('debug true')
   }
 

Diff for: lib/create-server.js

@@ -97,6 +97,14 @@ async function check_transfer(txdata) {
       //check if there is no other outgoing transfer from the input addresses
       await check_for_outgoing_transfers(txs)
     }
+    //return if already confirmed
+    let payment = db
+      .get('payments')
+      .find({ address: checksum.addChecksum(txdata[2]) })
+      .value()
+    if (payment.payed == true) {
+      return
+    }
     //update payment
     let new_payment = db
       .get('payments')

Diff for: lib/zmq.js

@@ -9,7 +9,8 @@
     "lint": "eslint lib --color",
     "p": "prettier --write \"lib/**/*.js\"",
     "p:w": "onchange \"lib/**/*.js\" -- prettier --write {{changed}}",
-    "docs:build": "documentation build lib/** -f md -o docs/README.md"
+    "docs:build": "documentation build lib/** -f md -o docs/README.md",
+    "build:dashboard": "cd ./dashboard && npm i && npm run build:prod"
   },
   "author": "huhn511",
   "license": "MIT",