Merge pull request #111 from Permissionless-Software-Foundation/dh-pagination

feat(NFTs): Added pagination controls for NFTs

src/adapters/localdb/models/offer.js

@@ -39,7 +39,15 @@ const Offer = new mongoose.Schema({
 
   // Operator fee and address
   operatorAddress: { type: String },
-  operatorPercentage: { type: Number }
+  operatorPercentage: { type: Number },
+
+  // Token Data
+  immutableDataCid: { type: String, default: null },
+  mutableDataCid: { type: String, default: null },
+  tokenIconUrl: { type: String, default: null },
+  tokenCategories: { type: Array, default: [] },
+  tokenTags: { type: Array, default: [] },
+  lastUpdatedTokenData: { type: String, default: null } // ISO timestamp of the last time token data was updated.
 })
 
 export default mongoose.model('offer', Offer)

src/controllers/rest-api/ipfs/controller.js

@@ -71,16 +71,25 @@ class IpfsRESTControllerLib {
   }
 
   /**
-   * @api {POST} /ipfs/peers Get IPFS peers
+   * @api {post} /ipfs/peers Get information on IPFS peers this node is connected to
    * @apiPermission public
    * @apiName GetIpfsPeers
    * @apiGroup REST IPFS
    *
-   * @apiExample Example usage:
-   * curl -H "Content-Type: application/json" -X POST -d '{ "showAll": true }' localhost:5001/ipfs/peers
+   * @apiParam {Boolean} [showAll=false] Whether to include detailed peer data
    *
+   * @apiExample Example usage:
+   * curl -H "Content-Type: application/json" -X POST localhost:5001/ipfs/peers \
+   *   -d '{"showAll": false}'
+   *
+   * @apiSuccess {Object[]} peers Array of peer objects
+   * @apiSuccess {String} peers[].peer Peer ID
+   * @apiSuccess {String} peers[].name Peer name
+   * @apiSuccess {String} peers[].protocol Protocol used by the peer
+   * @apiSuccess {String} peers[].version Peer version
+   * @apiSuccess {String} peers[].connectionAddr Connection address
+   * @apiSuccess {Object} [peers[].peerData] Detailed peer data (when showAll=true)
    */
-  // Return information on IPFS peers this node is connected to.
   async getPeers (ctx) {
     try {
       const showAll = ctx.request.body.showAll
@@ -96,16 +105,22 @@ class IpfsRESTControllerLib {
   }
 
   /**
-   * @api {POST} /ipfs/relays Get IPFS relays
+   * @api {post} /ipfs/relays Get data about the known Circuit Relays
    * @apiPermission public
    * @apiName GetIpfsRelays
    * @apiGroup REST IPFS
    *
+   * @apiDescription Returns information about Circuit Relays, both v1 and v2, that this node knows about. V2 relays are hydrated with peer data from the connected peers list.
+   *
    * @apiExample Example usage:
    * curl -H "Content-Type: application/json" -X POST localhost:5001/ipfs/relays
    *
-   * @apiSuccessExample {json} Success-Response:
-   *     HTTP/1.1 200 OK
+   * @apiSuccess {Object} relays Object containing relay information
+   * @apiSuccess {Object[]} relays.v2Relays Array of v2 Circuit Relay objects
+   * @apiSuccess {String} relays.v2Relays[].ipfsId IPFS ID of the relay
+   * @apiSuccess {String} relays.v2Relays[].name Name of the relay (hydrated from peer data)
+   * @apiSuccess {String} relays.v2Relays[].description Description of the relay (hydrated from peer data)
+   * @apiSuccess {Object[]} relays.v1Relays Array of v1 Circuit Relay configurations
    */
   // Get data about the known Circuit Relays. Hydrate with data from peers list.
   async getRelays (ctx) {
@@ -121,15 +136,22 @@ class IpfsRESTControllerLib {
   }
 
   /**
-   *
-   * @api {POST} /ipfs/connect Connect to an IPFS peer
+   * @api {post} /ipfs/connect Connect to a specific IPFS peer
    * @apiPermission public
    * @apiName ConnectToIpfsPeer
    * @apiGroup REST IPFS
    *
-   * @apiExample Example usage:
-   * curl -H "Content-Type: application/json" -X POST -d '{ "multiaddr": "/ip4/123.45.67.89/tcp/4001/p2p/1234567890", "getDetails": true }' localhost:5001/ipfs/connect
+   * @apiDescription Attempts to establish a connection to a specific IPFS peer using the provided multiaddr. Optionally returns detailed information about the connection.
    *
+   * @apiParam {String} multiaddr Multiaddress of the peer to connect to (required)
+   * @apiParam {Boolean} [getDetails=false] Whether to return detailed connection information
+   *
+   * @apiExample Example usage:
+   * curl -H "Content-Type: application/json" -X POST localhost:5001/ipfs/connect \
+   *   -d '{"multiaddr": "/ip4/161.35.99.207/tcp/4001/p2p/12D3KooWDtj9cfj1SKuLbDNKvKRKSsGN8qivq9M8CYpLPDpcD5pu", "getDetails": false}'
+   *
+   * @apiSuccess {Boolean} success Indicates whether the connection attempt was successful
+   * @apiSuccess {Object} [details] Additional connection details (when getDetails=true)
    */
   async connect (ctx) {
     try {

src/controllers/rest-api/order/index.js

@@ -54,7 +54,7 @@ class OrderRouter {
     // Define the routes and attach the controller.
     this.router.post('/', this.createOrder)
     this.router.get('/list/all/:page', _this.orderRESTController.listOrders)
-    this.router.post('/delete', _this.orderRESTController.deleteOrder)
+    this.router.post('/delete', this.deleteOrder)
 
     // Attach the Controller routes to the Koa app.
     app.use(_this.router.routes())
@@ -65,6 +65,11 @@ class OrderRouter {
     await _this.validators.ensureUser(ctx, next)
     await _this.orderRESTController.createOrder(ctx, next)
   }
+
+  async deleteOrder (ctx, next) {
+    await _this.validators.ensureUser(ctx, next)
+    await _this.orderRESTController.deleteOrder(ctx, next)
+  }
 }
 
 export default OrderRouter

src/use-cases/offer/index.js

@@ -267,7 +267,7 @@ class OfferUseCases {
     }
   }
 
-  async listNftOffers (page = 0, nsfw = false) {
+  /*   async listNftOffers (page = 0, nsfw = false) {
     try {
       const data = await this.OfferModel.find({
         displayCategory: { $ne: 'fungible' },
@@ -287,6 +287,42 @@ class OfferUseCases {
       console.error('Error in use-cases/offer/listNftOffers()')
       throw error
     }
+  } */
+
+  async listNftOffers (page = 0, nsfw = false) {
+    try {
+      const query = {
+        displayCategory: { $ne: 'fungible' },
+        nsfw
+      }
+      // Total query offers
+      const totalOffers = await this.OfferModel.countDocuments(query)
+      // Total pages
+      const totalPages = Math.ceil(totalOffers / NFT_ENTRIES_PER_PAGE)
+
+      const data = await this.OfferModel.find(query)
+        // Sort entries so newest entries show first.
+        .sort('-timestamp')
+        // Skip to the start of the selected page.
+        .skip(page * NFT_ENTRIES_PER_PAGE)
+        // Only return 20 results.
+        .limit(NFT_ENTRIES_PER_PAGE)
+
+      // console.log('listNftOffers() returning this data: ', data)
+
+      return {
+        data,
+        pagination: {
+          currentPage: page,
+          totalPages,
+          totalOffers,
+          pageSize: NFT_ENTRIES_PER_PAGE
+        }
+      }
+    } catch (error) {
+      console.error('Error in use-cases/offer/listNftOffers()')
+      throw error
+    }
   }
 
   async listFungibleOffers (page = 0) {

test/unit/controllers/rest-api/order/order.rest.router.unit.js

@@ -83,4 +83,13 @@ describe('#Order-REST-Router', () => {
       assert.isTrue(spy.calledOnce)
     })
   })
+  describe('#deleteOrder', () => {
+    it('should route to controller', async () => {
+      sandbox.stub(uut.validators, 'ensureUser').resolves(true)
+      const spy = sandbox.stub(uut.orderRESTController, 'deleteOrder').resolves(true)
+
+      await uut.deleteOrder()
+      assert.isTrue(spy.calledOnce)
+    })
+  })
 })

test/unit/mocks/adapters/index.js

@@ -149,7 +149,7 @@ const localdb = {
     static findById () {}
     static find () {}
     static findOne () {}
-
+    static countDocuments(){}
     async save () {
       return {}
     }

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

@@ -400,7 +400,7 @@ describe('#offer-use-case', () => {
       }
     })
 
-    it('should list orders', async () => {
+    it('should list offers', async () => {
       const queryMock = {
         sort () {
           return this
@@ -414,7 +414,11 @@ describe('#offer-use-case', () => {
       sandbox.stub(uut.OfferModel, 'find').returns(queryMock)
 
       const result = await uut.listNftOffers(1, true)
-      assert.isArray(result)
+      assert.isObject(result)
+      assert.property(result, 'data')
+      assert.property(result, 'pagination')
+      assert.isArray(result.data)
+      assert.isObject(result.pagination)
     })
   })