Merge pull request #356 from pshenmic/feat/search-backend

New logic for search in API

packages/api/README.md

@@ -68,6 +68,7 @@ Reference:
 * [Transactions history](#transactions-history)
 * [Transactions gas history](#transactions-gas-history)
 * [Rate](#rate)
+* [Search](#search)
 * [Decode Raw Transaction](#decode-raw-transaction)
 
 ### Status
@@ -547,7 +548,8 @@ GET /transaction/DEADBEEFDEADBEEFDEADBEEFDEADBEEFDEADBEEFDEADBEEFDEADBEEFDEADBEE
       aliases: [
         {
           alias: "alias.dash",
-          status: "locked"
+          status: "locked",
+          contested: true
         }
       ]
     }
@@ -599,7 +601,8 @@ GET /transactions?=1&limit=10&order=asc&owner=6q9RFbeea73tE31LGMBLFZhtBUX3wZL3Tc
           aliases: [
             {
               alias: "alias.dash",
-              status: "locked"
+              status: "locked",
+              contested: true
             }
           ]
         }
@@ -754,7 +757,8 @@ GET /identity/GWRSAVFMjXx8HpQFaNJMqBV7MBgMK4br5UESsB4S31Ec
     aliases: [
       {
         alias: "alias.dash",
-        status: "locked"
+        status: "locked",
+        contested: true
       }
     ]
 }
@@ -771,10 +775,17 @@ Return identity by given DPNS/alias
 ```
 GET /dpns/identity?dpns=canuseethat2.dash
 
-{
-  "identity_identifier": "8eTDkBhpQjHeqgbVeriwLeZr1tCa6yBGw76SckvD1cwc",
-  "alias": "canuseethat2.dash"
-}
+[
+  {
+    "identity_identifier": "8eTDkBhpQjHeqgbVeriwLeZr1tCa6yBGw76SckvD1cwc",
+    "alias": "canuseethat2.dash",
+    "status": {
+      "alias": "canuseethat2.dash",
+      "contested": false,
+      "status": "ok"
+    }
+  }
+]
 ```
 Response codes:
 ```
@@ -813,7 +824,8 @@ GET /identities?page=1&limit=10&order=asc&order_by=block_height
           aliases: [
             {
               alias: "alias.dash",
-              status: "locked"
+              status: "locked",
+              contested: true
             }
           ]
       }, ...
@@ -1000,6 +1012,78 @@ Response codes:
 200: OK
 500: Internal Server Error
 ```
+---
+### Search
+This endpoint allows search any types of data
+
+* `query` required and must contains data for search
+* Response may contain array for Identity and Data Contract when searching by part of field
+
+#### Can be found:
+* Block
+  * Full `height`
+  * Full `hash`
+* Transaction
+  * Full `hash`
+* Validator
+  * Full `proTxHash`
+  * Full `Identifier` of Masternode Identity
+* Identity
+  * Full `Identifier`
+  * Part `alias`
+* Data Contract
+  * Full `Identifier`
+  * Part `name`
+* Document
+  * Full `Identifier`
+
+```
+GET /search?query=xyz
+
+{
+  "identities": [
+    {
+      "identifier": "36LGwPSXef8q8wpdnx4EdDeVNuqCYNAE9boDu5bxytsm",
+      "alias": "xyz.dash",
+      "status": {
+        "alias": "xyz.dash",
+        "status": "ok",
+        "contested": true
+      }
+    },
+    {
+      "identifier": "5bUPV8KGgL42ZBS9fsmmKU3wweQbVeHHsiVrG3YMHyG5",
+      "alias": "xyz.dash",
+      "status": {
+        "alias": "xyz.dash",
+        "status": "locked",
+        "contested": true
+      }
+    }
+  ]
+}
+```
+
+```
+GET /search?query=36LGwPSXef8q8wpdnx4EdDeVNuqCYNAE9boDu5bxytsm
+
+{
+  "identity": {
+    "identifier": "36LGwPSXef8q8wpdnx4EdDeVNuqCYNAE9boDu5bxytsm",
+    "alias": "xyz.dash",
+    "status": {
+      "alias": "xyz.dash",
+      "status": "ok",
+      "contested": true
+    }
+  }
+}
+```
+Response codes:
+```
+200: OK
+500: Internal Server Error
+```
 ### Transactions history
 Return a series data for the amount of transactions chart
 

packages/api/src/controllers/IdentitiesController.js

@@ -26,7 +26,7 @@ class IdentitiesController {
   getIdentityByDPNSName = async (request, response) => {
     const { dpns } = request.query
 
-    const identity = await this.identitiesDAO.getIdentityByDPNSName(dpns)
+    const identity = await this.identitiesDAO.getIdentitiesByDPNSName(dpns)
 
     if (!identity) {
       return response.status(404).send({ message: 'not found' })

packages/api/src/controllers/MainController.js

@@ -6,6 +6,7 @@ const IdentitiesDAO = require('../dao/IdentitiesDAO')
 const ValidatorsDAO = require('../dao/ValidatorsDAO')
 const TenderdashRPC = require('../tenderdashRpc')
 const Epoch = require('../models/Epoch')
+const { base58 } = require('@scure/base')
 
 const API_VERSION = require('../../package.json').version
 const PLATFORM_VERSION = '1' + require('../../package.json').dependencies.dash.substring(1)
@@ -72,6 +73,8 @@ class MainController {
   search = async (request, response) => {
     const { query } = request.query
 
+    let result = {}
+
     const epoch = Epoch.fromObject({
       startTime: 0,
       endTime: 0
@@ -82,7 +85,7 @@ class MainController {
       const block = await this.blocksDAO.getBlockByHeight(query)
 
       if (block) {
-        return response.send({ block })
+        result = { ...result, block }
       }
     }
 
@@ -91,21 +94,21 @@ class MainController {
       const block = await this.blocksDAO.getBlockByHash(query)
 
       if (block) {
-        return response.send({ block })
+        result = { ...result, block }
       }
 
       // search transactions
       const transaction = await this.transactionsDAO.getTransactionByHash(query)
 
       if (transaction) {
-        return response.send({ transaction })
+        result = { ...result, transaction }
       }
 
-      // search validators
+      // search validators by hash
       const validator = await this.validatorsDAO.getValidatorByProTxHash(query, null, epoch)
 
       if (validator) {
-        return response.send({ validator })
+        result = { ...result, validator }
       }
     }
 
@@ -115,34 +118,52 @@ class MainController {
       const identity = await this.identitiesDAO.getIdentityByIdentifier(query)
 
       if (identity) {
-        return response.send({ identity })
+        result = { ...result, identity }
       }
 
-      // search data contracts
+      // search validator by MasterNode identity
+      const proTxHash = Buffer.from(base58.decode(query)).toString('hex')
+
+      const validator = await this.validatorsDAO.getValidatorByProTxHash(proTxHash, null, epoch)
+
+      if (validator) {
+        result = { ...result, validator }
+      }
+
+      // search data contract by id
       const dataContract = await this.dataContractsDAO.getDataContractByIdentifier(query)
 
       if (dataContract) {
-        return response.send({ dataContract })
+        result = { ...result, dataContract }
       }
 
       // search documents
       const document = await this.documentsDAO.getDocumentByIdentifier(query)
 
       if (document) {
-        return response.send({ document })
+        result = { ...result, document }
       }
     }
 
     // by dpns name
-    if (/^[^\s.]+(\.[^\s.]+)*$/.test(query)) {
-      const identity = await this.identitiesDAO.getIdentityByDPNSName(query)
+    const identities = await this.identitiesDAO.getIdentitiesByDPNSName(query)
 
-      if (identity) {
-        return response.send({ identity })
-      }
+    if (identities) {
+      result = { ...result, identities }
+    }
+
+    // by data-contract name
+    const dataContracts = await this.dataContractsDAO.getDataContractByName(query)
+
+    if (dataContracts) {
+      result = { ...result, dataContracts }
+    }
+
+    if (Object.keys(result).length === 0) {
+      response.status(404).send({ message: 'not found' })
     }
 
-    response.status(404).send({ message: 'not found' })
+    response.send(result)
   }
 }
 

packages/api/src/dao/BlocksDAO.js

@@ -1,7 +1,6 @@
 const Block = require('../models/Block')
 const PaginatedResultSet = require('../models/PaginatedResultSet')
-const { getAliasInfo } = require('../utils')
-const { base58 } = require('@scure/base')
+const { getAliasInfo, getAliasStateByVote } = require('../utils')
 const Transaction = require('../models/Transaction')
 
 module.exports = class BlockDAO {
@@ -70,14 +69,7 @@ module.exports = class BlockDAO {
         const aliases = await Promise.all((row.aliases ?? []).map(async alias => {
           const aliasInfo = await getAliasInfo(alias, this.dapi)
 
-          const isLocked = base58.encode(
-            Buffer.from(aliasInfo.contestedState?.finishedVoteInfo?.wonByIdentityId ?? ''),
-            'base64') !== row.identifier
-
-          return {
-            alias,
-            status: (aliasInfo.contestedState !== null && isLocked) ? 'locked' : 'ok'
-          }
+          return getAliasStateByVote(aliasInfo, alias, row.owner)
         }))
 
         return Transaction.fromRow({ ...row, aliases })

packages/api/src/dao/DataContractsDAO.js

@@ -84,4 +84,30 @@ module.exports = class DataContractsDAO {
 
     return DataContract.fromRow(row)
   }
+
+  getDataContractByName = async (name) => {
+    const rows = await this.knex('data_contracts')
+      .select(
+        'data_contracts.identifier as identifier', 'data_contracts.name as name',
+        'data_contracts.owner as owner', 'data_contracts.is_system as is_system',
+        'data_contracts.version as version', 'data_contracts.schema as schema',
+        'data_contracts.state_transition_hash as tx_hash', 'blocks.timestamp as timestamp'
+      )
+      .select(
+        this.knex('documents')
+          .count('*')
+          .leftJoin('data_contracts', 'data_contracts.id', 'documents.data_contract_id')
+          .whereILike('data_contracts.name', `${name}%`)
+          .as('documents_count')
+      )
+      .whereILike('data_contracts.name', `${name}%`)
+      .leftJoin('state_transitions', 'state_transitions.hash', 'data_contracts.state_transition_hash')
+      .leftJoin('blocks', 'state_transitions.block_hash', 'blocks.hash')
+
+    if (rows.length === 0) {
+      return null
+    }
+
+    return rows.map(row => DataContract.fromRow(row))
+  }
 }