Home

Welcome to the holodex wiki !

Holodex is an indexing application(Holochain helper application) that is used by other HC applications for creating index and for performing searches.

To utilize the indexing services of holodex, the consumer application has to include specifications:

• What would be provided to the consumer application from holodex ?

  A zome named "holodex" will be added to the DNA along with the corresponding file holodex.js.

  Below are the functions which need to be called :

  indexObject <object>

  This function takes input of json object of format : {content:<string>Content to be indexed,objHash:Hash of the object which is being indexed}

  The function returns the hash of the object that was indexed upon successful indexing.

  searchContent <string>

  This function takes a string of words to be searched as input and returns a list of objects(hash) which contain the searched words.

• What the consumer application needs to include to use the holodex zome ?

  Provide input to entry VolunteerNode (which is a part of the holodex zome) to specify whether the current node wants to serve as an index node or not.

  • For index nodes : VolunteerNode = true
  • For non index nodes : VolunteerNode = false

  Call the index and search functions where required.