Implement DELETE /invoice/:id. Resolves #12

Author: shesek

README.md

@@ -191,6 +191,19 @@ $ curl $CHARGE/invoice/OYwwaOQAPMFvg039gj_Rb
 {"id":"OYwwaOQAPMFvg039gj_Rb","msatoshi":"3738106","quoted_currency":"EUR","quoted_amount":"0.5","status":"unpaid",...}
 ```
 
+### `DELETE /invoice/:id`
+
+Delete the specified invoice.
+
+*Body parameters:* `status`
+
+The current status of the invoice needs to be specified in the request body.
+
+```bash
+$ curl -X DELETE $CHARGE/invoice/OYwwaOQAPMFvg039gj_Rb -d status=unpaid
+204 No Content
+```
+
 ### `GET /invoice/:id/wait?timeout=[sec]`
 
 Long-polling invoice payment notification.

src/invoicing.js

@@ -6,7 +6,7 @@ const debug = require('debug')('lightning-charge')
 const maxWait = +process.env.MAX_WAIT || 600
 
 module.exports = (app, payListen, model, auth, lnconf) => {
-  const { newInvoice, fetchInvoice, listInvoices, delExpired } = model
+  const { newInvoice, fetchInvoice, listInvoices, delInvoice, delExpired } = model
 
   app.on('listening', server => server.timeout = maxWait*1000 + 500)
 
@@ -38,6 +38,11 @@ module.exports = (app, payListen, model, auth, lnconf) => {
     // @TODO remove listener on client disconnect
   }))
 
+  app.delete('/invoice/:invoice', auth, wrap(async (req, res) => {
+    await delInvoice(req.params.invoice, req.body.status)
+    res.sendStatus(204)
+  }))
+
   // Enable automatic cleanup for expired invoices if enabled on c-lightning,
   // using the same configurations.
 

src/model.js

@@ -45,6 +45,11 @@ module.exports = (db, ln) => {
   const fetchInvoice = id =>
     db('invoice').where({ id }).first().then(r => r && format(r))
 
+  const delInvoice = async (id, status) => {
+    await ln.delinvoice(id, status)
+    await db('invoice').where({ id }).del()
+  }
+
   const markPaid = (id, pay_index, paid_at, msatoshi_received) =>
     db('invoice').where({ id, pay_index: null })
                  .update({ pay_index, paid_at, msatoshi_received })
@@ -79,7 +84,7 @@ module.exports = (db, ln) => {
       !err ? { requested_at: now(), success: true,  resp_code: res.status }
            : { requested_at: now(), success: false, resp_error: err })
 
-  return { newInvoice, listInvoices, fetchInvoice
+  return { newInvoice, listInvoices, fetchInvoice, delInvoice
          , getLastPaid, markPaid, delExpired
          , addHook, getHooks, logHook }
 }

test/invoice.js

@@ -115,6 +115,30 @@ describe('Invoice API', function() {
     })
   })
 
+  describe('DELETE /invoice/:invoice', () => {
+    it('deletes an invoice by its id and status', async () => {
+      const inv = await mkInvoice()
+      charge.del(`/invoice/${ inv.id }`)
+        .send({ status: 'unpaid' })
+        .expect(204)
+    })
+
+    it("won't delete the invoice if the status mismatches", async () => {
+      const inv = await mkInvoice()
+
+      await charge.del(`/invoice/${ inv.id }`)
+        .send({ status: 'paid' })
+        .expect(400)
+
+      await lnBob.pay(inv.payreq, 1000)
+
+      await charge.del(`/invoice/${ inv.id }`)
+        .send({ status: 'paid' })
+        .expect(204)
+    })
+  })
+
+
   describe('GET /invoice/:invoice/wait', function() {
     this.slow(500)