API

EFS public and private APIs

Public APIs (These change as needed, nailing down the internal/core APIs first)

• read(path, edgeType, propName)
• write(path, edgeType, propName, propValue)
• editionWrite() // Must be called specifically by edition owner address, e.g. UAC prompt in Windows

Core graph APIs

• getNodes(parentNode, type, start, dir, numResults) // See all nodes connected by a certain edge type
  • start - where in the list to start reading for pagenation, e.g. 20 for the second page
    • If blank, then direction=asc starts at beginning and direction=desc starts at end
  • direction - ascending or descending
    • Default: ascending
  • numResults - How many entires to get before turning. e.g. 10 to get 10 records per request
• getNodeByIndex(parentNode, type, index, value) // Find a specific node connected by a certain edge type
• readProperties(node, propNames[]) // gets data bytes, type, and edition etc
• readProperty(node, name) // just gets one property like the raw bytes of data
• writeProperty(node, name, value)