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

@@ -202,7 +202,7 @@ class TimerControllers {
   // Remove older deleted chats and posts.
   async removeOlderDeletedChatsAndPosts () {
     try {
-      //console.log('removeOlderDeletedChatsAndPosts() Timer Controller executing at ', new Date().toLocaleString())
+      // console.log('removeOlderDeletedChatsAndPosts() Timer Controller executing at ', new Date().toLocaleString())
       clearInterval(this.removeOlderDeletedChatsAndPostsInt)
       await this.useCases.nostr.removeOlderDeletedChats()
       await this.useCases.nostr.removeOlderDeletedPosts()

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/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/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}