Merge pull request #120 from Permissionless-Software-Foundation/dh-npub-offer

feat(nostr): Added npub to Offer model

src/adapters/localdb/models/offer.js

@@ -18,7 +18,7 @@ const Offer = new mongoose.Schema({
   p2wdbHash: { type: String },
   offerStatus: { type: String },
   makerAddr: { type: String },
-  makerNpub: { type: String },
+  makerNpub: { type: String, default: null },
 
   // Authentication data
   signature: { type: String },

src/adapters/localdb/models/order.js

@@ -24,6 +24,7 @@ const Order = new mongoose.Schema({
   p2wdbTxid: { type: String },
   p2wdbHash: { type: String },
   makerAddr: { type: String, required: true },
+  makerNpub: { type: String, required: true },
 
   // Authentication data
   signature: { type: String },

src/adapters/nostr.js

@@ -7,6 +7,8 @@ import BchNostr from 'bch-nostr'
 import { RelayPool } from 'nostr'
 import RetryQueue from '@chris.troutner/retry-queue'
 import * as nip19 from 'nostr-tools/nip19'
+import { base58_to_binary as base58Tobinary } from 'base58-js'
+import { getPublicKey } from 'nostr-tools/pure'
 
 class NostrAdapter {
   constructor (localConfig = { nostrRelay: '', nostrTopic: '' }) {
@@ -44,6 +46,7 @@ class NostrAdapter {
     this.npub2pubkey = this.npub2pubkey.bind(this)
     this.readGlobalFeed = this.readGlobalFeed.bind(this)
     this.getFollowers = this.getFollowers.bind(this)
+    this.privKeyToNpub = this.privKeyToNpub.bind(this)
   }
 
   // Create nostr keys.
@@ -247,6 +250,31 @@ class NostrAdapter {
       throw error
     }
   }
+
+  // Convert a BCH private key (WIF) to a Nostr npub.
+  privKeyToNpub (privKey) {
+    try {
+      if (!privKey || typeof privKey !== 'string') {
+        throw new Error('privKey must be a string!')
+      }
+      // Extract the privaty key from the WIF, using this guide:
+      // https://learnmeabitcoin.com/technical/keys/private-key/wif/
+      const wifBuf = base58Tobinary(privKey)
+      const privBuf = wifBuf.slice(1, 33)
+      // console.log('privBuf: ', privBuf)
+
+      const nostrPubKey = getPublicKey(privBuf)
+      // console.log('nostrPubKey: ', nostrPubKey)
+      // Convert pubkey to npub
+      const nostrNpub = nip19.npubEncode(nostrPubKey)
+      // console.log('nostrNpub: ', nostrNpub)
+
+      return nostrNpub
+    } catch (error) {
+      console.log(`Error in nostr.js/privKeyToNpub() ${error.message} `)
+      throw error
+    }
+  }
 }
 
 export default NostrAdapter

src/controllers/timer-controllers.js

@@ -28,6 +28,7 @@ class TimerControllers {
     this.backupUsageInterval = 60000 * 10 // 10 minutes
     this.newSmAccountsInterval = 60000 * 60 // 60 minutes
     this.updateSmAccountsInterval = 60000 * 10 // 10 minutes
+    this.removeOlderDeletedChatsAndPostsInterval = 60000 * 60 * 1 // 1 hour
 
     // Encapsulate dependencies
     this.config = config
@@ -42,7 +43,7 @@ class TimerControllers {
     this.backupUsage = this.backupUsage.bind(this)
     this.newSmAccounts = this.newSmAccounts.bind(this)
     this.updateSmAccounts = this.updateSmAccounts.bind(this)
-
+    this.removeOlderDeletedChatsAndPosts = this.removeOlderDeletedChatsAndPosts.bind(this)
     // State
     this.gcOrdersInt = null
     this.gcOffersInt = null
@@ -50,6 +51,7 @@ class TimerControllers {
     this.loadOffersInt = null
     this.newSmAccountsInt = null
     this.updateSmAccountsInt = null
+    this.removeOlderDeletedChatsAndPostsInt = null
   }
 
   // Start all the time-based controllers.
@@ -62,6 +64,7 @@ class TimerControllers {
     this.backupUsageHandle = setInterval(this.backupUsage, this.backupUsageInterval)
     this.newSmAccountsInt = setInterval(this.newSmAccounts, this.newSmAccountsInterval)
     this.updateSmAccountsInt = setInterval(this.updateSmAccounts, this.updateSmAccountsInterval)
+    this.removeOlderDeletedChatsAndPostsInt = setInterval(this.removeOlderDeletedChatsAndPosts, this.removeOlderDeletedChatsAndPostsInterval)
     return true
   }
 
@@ -74,6 +77,7 @@ class TimerControllers {
     clearInterval(this.backupUsageHandle)
     clearInterval(this.newSmAccountsInt)
     clearInterval(this.updateSmAccountsInt)
+    clearInterval(this.removeOlderDeletedChatsAndPostsInt)
   }
 
   // Garbage Collect the Orders.
@@ -194,6 +198,22 @@ class TimerControllers {
       return false
     }
   }
+
+  // Remove older deleted chats and posts.
+  async removeOlderDeletedChatsAndPosts () {
+    try {
+      // console.log('removeOlderDeletedChatsAndPosts() Timer Controller executing at ', new Date().toLocaleString())
+      clearInterval(this.removeOlderDeletedChatsAndPostsInt)
+      await this.useCases.nostr.removeOlderDeletedChats()
+      await this.useCases.nostr.removeOlderDeletedPosts()
+      this.removeOlderDeletedChatsAndPostsInt = setInterval(this.removeOlderDeletedChatsAndPosts, this.removeOlderDeletedChatsAndPostsInterval)
+      return true
+    } catch (err) {
+      console.error('Error in time-controller.js/removeOlderDeletedChatsAndPosts(): ', err)
+      this.removeOlderDeletedChatsAndPostsInt = setInterval(this.removeOlderDeletedChatsAndPosts, this.removeOlderDeletedChatsAndPostsInterval)
+      return false
+    }
+  }
 }
 
 export default TimerControllers

src/entities/offer.js

@@ -31,6 +31,7 @@ class OfferEntity {
       utxoVout,
       offerStatus,
       makerAddr,
+      makerNpub,
       ticker,
       tokenType,
       nostrEventId,
@@ -89,6 +90,10 @@ class OfferEntity {
     if (!operatorPercentage || typeof operatorPercentage !== 'number') {
       throw new Error("Property 'operatorPercentage' must be a number.")
     }
+    // Validate npub type if it exist
+    if (makerNpub && typeof makerNpub !== 'string') {
+      throw new Error("Property 'makerNpub' must be a string.")
+    }
 
     // Convert the timestamp to a number.
     let timestamp = new Date(offerData.timestamp)
@@ -113,7 +118,8 @@ class OfferEntity {
       makerAddr,
       ticker,
       tokenType,
-      nostrEventId
+      nostrEventId,
+      makerNpub
     }
     // console.log('offer entity validatedOfferData: ', validatedOfferData)
 

src/use-cases/nostr-use-cases.js

@@ -25,6 +25,8 @@ class NostrUseCases {
     this.getDeletedChats = this.getDeletedChats.bind(this)
     this.createDeletedPost = this.createDeletedPost.bind(this)
     this.getDeletedPosts = this.getDeletedPosts.bind(this)
+    this.removeOlderDeletedChats = this.removeOlderDeletedChats.bind(this)
+    this.removeOlderDeletedPosts = this.removeOlderDeletedPosts.bind(this)
   }
 
   // Create a new deleted chat model and add it to the Mongo database.
@@ -87,6 +89,42 @@ class NostrUseCases {
       throw err
     }
   }
+
+  // Remove deleted chats that are older than 3 months.
+  async removeOlderDeletedChats () {
+    try {
+      const deletedChats = await this.DeletedChatModel.find({})
+      const threeMonthsAgo = new Date()
+      threeMonthsAgo.setMonth(threeMonthsAgo.getMonth() - 3)
+      for (let i = 0; i < deletedChats.length; i++) {
+        const deletedChat = deletedChats[i]
+        if (deletedChat.createdAt.getTime() < threeMonthsAgo.getTime()) {
+          await deletedChat.remove()
+        }
+      }
+    } catch (err) {
+      wlogger.error('Error in lib/users.js/removeOlderDeletedChats()')
+      throw err
+    }
+  }
+
+  // Remove deleted posts that are older than 3 months.
+  async removeOlderDeletedPosts () {
+    try {
+      const deletedPosts = await this.DeletedPostModel.find({})
+      const threeMonthsAgo = new Date()
+      threeMonthsAgo.setMonth(threeMonthsAgo.getMonth() - 3)
+      for (let i = 0; i < deletedPosts.length; i++) {
+        const deletedPost = deletedPosts[i]
+        if (deletedPost.createdAt.getTime() < threeMonthsAgo.getTime()) {
+          await deletedPost.remove()
+        }
+      }
+    } catch (err) {
+      wlogger.error('Error in lib/users.js/removeOlderDeletedPosts()')
+      throw err
+    }
+  }
 }
 
 export default NostrUseCases

src/use-cases/order.js

@@ -116,6 +116,9 @@ class OrderLib {
       orderEntity.operatorAddress = this.config.operatorAddress
       orderEntity.operatorPercentage = this.config.operatorPercentage
 
+      // Convert the Seller's BCH private key to a Nostr npub. This is used to identify the seller in Nostr.
+      orderEntity.makerNpub = this.adapters.nostr.privKeyToNpub(userWallet.walletInfo.privateKey)
+
       // Post the new Order information to Nostr under the topic set in the
       // config file.
       const postObj = {

test/unit/adapters/nostr.adapter.unit.js

@@ -224,4 +224,33 @@ describe('#nostr.js', () => {
       assert.isArray(result)
     })
   })
+  describe('#privKeyToNpub', () => {
+    it('should handle  error if providedprivKey is not a string', async () => {
+      try {
+        uut.privKeyToNpub()
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        // console.log('err: ', err)
+        assert.include(err.message, 'privKey must be a string!')
+      }
+    })
+
+    it('should return npub if privKey is valid', async () => {
+      const result = uut.privKeyToNpub('L2kh34VinQNRq1ad8nnXnGoFrb9pT7j8GJXiT6Scsg18KMxsUVDr')
+      // console.log('result: ', result)
+      assert.isString(result)
+      assert.include(result, 'npub')
+    })
+    it('should handle unexpected error', async () => {
+      try {
+        uut.privKeyToNpub('invalid format')
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        // console.log('err: ', err)
+        assert.include(err.message, 'Invalid base58 character')
+      }
+    })
+  })
 })

test/unit/adapters/order-pagination.unit.js

@@ -52,6 +52,7 @@ describe('#OrderPagination', () => {
       nostrEventId: 'nostrEventId',
       dataType: 'dataType',
       makerAddr: 'makerAddr',
+      makerNpub: 'makerNpub',
       rateInBaseUnit: 'rateInBaseUnit',
       minUnitsToExchange: 'minUnitsToExchange',
       ticker: 'ticker',

test/unit/controllers/timer-controllers.unit.js

@@ -187,4 +187,20 @@ describe('#Timer-Controllers', () => {
       assert.equal(result, false)
     })
   })
+  describe('#removeOlderDeletedChatsAndPosts', () => {
+    it('should kick off the Use Cases and return true', async () => {
+      sandbox.stub(uut.useCases.nostr, 'removeOlderDeletedChats').resolves()
+      sandbox.stub(uut.useCases.nostr, 'removeOlderDeletedPosts').resolves()
+      const result = await uut.removeOlderDeletedChatsAndPosts()
+
+      assert.equal(result, true)
+    })
+  })
+  it('should kick off the Use Cases and return false on error', async () => {
+    sandbox.stub(uut.useCases.nostr, 'removeOlderDeletedChats').throws(new Error('test error'))
+    sandbox.stub(uut.useCases.nostr, 'removeOlderDeletedPosts').throws(new Error('test error'))
+    const result = await uut.removeOlderDeletedChatsAndPosts()
+
+    assert.equal(result, false)
+  })
 })

test/unit/entities/offer.entity.unit.js

@@ -491,6 +491,36 @@ describe('#Offer-Entity', () => {
         assert.include(err.message, "Property 'operatorPercentage' must be a number.")
       }
     })
+    it('should throw an error if makerNpub is not a string', () => {
+      try {
+        const offerData = {
+          data: {
+            messageType: 1,
+            messageClass: 1,
+            tokenId: 'fakeId',
+            buyOrSell: 'buy',
+            rateInBaseUnit: 1000,
+            minUnitsToExchange: 350,
+            numTokens: 1,
+            utxoTxid: 'fakeTxid',
+            utxoVout: 0,
+            offerStatus: 'posted',
+            makerAddr: 'bitcoincash:qzl0d3gcqeypv4cy7gh8rgdszxa9vvm2acv7fqtd00',
+            tokenType: 1,
+            nostrEventId: 'test',
+            operatorAddress: 'bitcoincash:qzl0d3gcqeypv4cy7gh8rgdszxa9vvm2acv7fqtd00',
+            operatorPercentage: 10,
+            makerNpub: 1234
+          }
+        }
+        uut.validate(offerData)
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        // console.log(err)
+        assert.include(err.message, "Property 'makerNpub' must be a string.")
+      }
+    })
 
     it('should validate a new offer', () => {
       const offerObj = {
@@ -513,7 +543,8 @@ describe('#Offer-Entity', () => {
           tokenType: 1,
           nostrEventId: 'test',
           operatorAddress: 'bitcoincash:qzl0d3gcqeypv4cy7gh8rgdszxa9vvm2acv7fqtd00',
-          operatorPercentage: 10
+          operatorPercentage: 10,
+          makerNpub: 'npub1dtkf954h5k2yuv04xp44g5hnmk5k0ppv8mekxafm2gc0vveaxh6s0297qg'
         },
         timestamp: '2021-09-20T17:54:26.395Z',
         localTimeStamp: '9/20/2021, 10:54:26 AM',
@@ -539,6 +570,8 @@ describe('#Offer-Entity', () => {
       assert.property(result, 'txid')
       assert.property(result, 'p2wdbHash')
       assert.property(result, 'tokenType')
+      assert.property(result, 'makerAddr')
+      assert.property(result, 'makerNpub')
     })
   })
 })

test/unit/mocks/adapters/index.js

@@ -240,7 +240,8 @@ const nostr = {
   read: async () => { return true },
   eventId2note: () => { return 'testNoteId' },
   readGlobalFeed: async () => { return [] },
-  getFollowers: async () => { return [] }
+  getFollowers: async () => { return [] },
+  privKeyToNpub: async () => { return 'fakeNpub' }
 }
 
 export default { ipfs, localdb, bch, wallet, p2wdb, bchjs, nostr}

test/unit/mocks/use-cases/index.js

@@ -148,7 +148,12 @@ class NostrUseCasesMock {
   async getDeletedPosts() {
     return []
   }
-
+  async removeOlderDeletedChats() {
+    return true
+  }
+  async removeOlderDeletedPosts() {
+    return true
+  }
 }
 
 class UseCasesMock {

test/unit/use-cases/nostr.use-case.unit.js

@@ -210,4 +210,78 @@ describe('#nostr-use-cases', () => {
       assert.include(err.message, 'test error')
     }
   })
+  describe('#removeOlderDeletedChats', () => {
+    it('should remove older deleted chats from the database', async () => {
+      const threeMonthsAgo = new Date()
+      threeMonthsAgo.setMonth(threeMonthsAgo.getMonth() - 3) // 3 months ago
+      threeMonthsAgo.setDate(threeMonthsAgo.getDate() - 1) // 1 day ago
+      const spy = sinon.spy()
+      const deletedChatsMock = [
+        // Newer deleted chat
+        {
+          eventId: 'note19e93faw4ffqepsqsrwrnstd3ee00nmzakwwuyfjm43dankgummfqms4p6q',
+          createdAt: new Date(),
+          remove: spy
+        },
+        // Older deleted chat
+        {
+          eventId: 'note19e93faw4ffqepsqsrwrnstd3ee00nmzakwwuyfjm43dankgummfqms4p6q',
+          createdAt: threeMonthsAgo,
+          remove: spy
+        }
+      ]
+      sandbox.stub(uut.DeletedChatModel, 'find').resolves(deletedChatsMock)
+      await uut.removeOlderDeletedChats()
+      assert.equal(spy.callCount, 1, 'Expected to be called once.')
+    })
+    it('should handle error', async () => {
+      try {
+        // Force an error.
+        sandbox.stub(uut.DeletedChatModel, 'find').throws(new Error('test error'))
+
+        await uut.removeOlderDeletedChats()
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        assert.include(err.message, 'test error')
+      }
+    })
+  })
+  describe('#removeOlderDeletedPosts', () => {
+    it('should remove older deleted posts from the database', async () => {
+      const threeMonthsAgo = new Date()
+      threeMonthsAgo.setMonth(threeMonthsAgo.getMonth() - 3) // 3 months ago
+      threeMonthsAgo.setDate(threeMonthsAgo.getDate() - 1) // 1 day ago
+      const spy = sinon.spy()
+      const deletedPostsMock = [
+        // Newer deleted post
+        {
+          eventId: 'note19e93faw4ffqepsqsrwrnstd3ee00nmzakwwuyfjm43dankgummfqms4p6q',
+          createdAt: new Date(),
+          remove: spy
+        },
+        // Older deleted post
+        {
+          eventId: 'note19e93faw4ffqepsqsrwrnstd3ee00nmzakwwuyfjm43dankgummfqms4p6q',
+          createdAt: threeMonthsAgo,
+          remove: spy
+        }
+      ]
+      sandbox.stub(uut.DeletedPostModel, 'find').resolves(deletedPostsMock)
+      await uut.removeOlderDeletedPosts()
+      assert.equal(spy.callCount, 1, 'Expected to be called once.')
+    })
+    it('should handle error', async () => {
+      try {
+        // Force an error.
+        sandbox.stub(uut.DeletedPostModel, 'find').throws(new Error('test error'))
+
+        await uut.removeOlderDeletedPosts()
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        assert.include(err.message, 'test error')
+      }
+    })
+  })
 })