Proposed external functions of holium nodes

Queries available against a holium node parallel the structure of the data a node contains. Whether or not a given result can be shown should depend upon privacy settings, something we don't have implemented or spec'd yet. This document will capture the types of operations and types of returns some other node can receive when querying a node.

node-details

node-details takes no arguments. When asked of a node, the node responds with a json payload describing the node's ID and listening addresses and ports, as well as the timestamp of the last received response from its underlying urbit instance. In addition to these general details about the node itself, it will also supply an array of 0 to n objects, each corresponding to the spaces it is hosting. A space object will contain

• the space name and description
• the privacy status of the space
• whether or not the current user is a member in the space, and if so, what role they have
• any styles or images required to render a visual selector for the space
• possibly additional metadata like a timestamp of when the space was last active, member count, etc. This is up to the space admins regarding what they choose to expose.

space-details space

space-details takes the name of a space as an argument. When asked of a node, the node responds with a json payload describing the space's details mentioned above, as well as two additional arrays of information:

• members array
• • ID
• • status
• • avatar, nickname, style and other information useful to rendering (actually would this be Passport info?)
• support services array (showing what support services are currently running)
• • type of service
• • array of service instances
• • • name of instance
• • • privacy status of the instance
• • • any styles or images required to render a visual selector for this instance