updated docs #11

zaunders · 2024-10-09T10:02:27Z

No description provided.

guillemcordoba · 2024-10-09T10:12:27Z

docs/index.md

+
+This module gives your apps the power of **role management**.
+
+It uses a *progenitor* as initial admin and allows consuming applications to create arbitrary roles and bind the possibility of preforming actions to those roles. 


List of progenitors, not a single one - important distinction

guillemcordoba · 2024-10-09T10:12:48Z

docs/overview.md

+# @darksoil-studio/roles
+
+## Modularity
+This module follows the [holochain-open-dev](https://github.com/holochain-open-dev/) pattern of developing holochain modules. Read [its documentation](https://holochain-open-dev.github.io) to understand more about its motivation and the big picture.


to be changed to t-nesh in the near future, fine for now.

yeah, figured we'd change that after a conversation

guillemcordoba · 2024-10-09T10:13:36Z

docs/overview.md

+
+
+## Module design
+Creating roles in fully peer-to-peer systems can be tricky. There is no node in the network that by default is able to administer the system. In order to introduce rolebased management on Holochain, someone needs to be written into the app as it is generated as the agent that has special rights, this will then be part of the rules of the app that everyone plays by (the DNA).


"In order to introduce role based management" notice the whitespace

guillemcordoba · 2024-10-09T10:13:57Z

docs/overview.md

+## Module design
+Creating roles in fully peer-to-peer systems can be tricky. There is no node in the network that by default is able to administer the system. In order to introduce rolebased management on Holochain, someone needs to be written into the app as it is generated as the agent that has special rights, this will then be part of the rules of the app that everyone plays by (the DNA).
+
+The pattern we are using in this module is the progenitor pattern. This means that the agent that instansiates the DNA writes themselves into the DNA as the original admin. Once an original admin is created, this administrator is able to generate further roles including additional administrators. Administrators are also able to remove all of the roles from Agents (including the Admin role of the progenitor). Below you will find graphical representations of how the module works.


"Instantiates"

guillemcordoba · 2024-10-09T10:14:27Z

docs/overview.md

+
+The pattern we are using in this module is the progenitor pattern. This means that the agent that instansiates the DNA writes themselves into the DNA as the original admin. Once an original admin is created, this administrator is able to generate further roles including additional administrators. Administrators are also able to remove all of the roles from Agents (including the Admin role of the progenitor). Below you will find graphical representations of how the module works.
+
+**This pattern creates the requirement of a layer outside the app (like a lobby) where a user is able to create the instanciation of the app so that the public key (AgentPubKey) associated with the original user is encoded into the DNA as it is being created. Read more about this in the implementation considerations section below.**


"Instantiation"

guillemcordoba · 2024-10-09T10:15:45Z

docs/overview.md

+
+
+```mermaid
+graph TD;


We probably want to use sequence diagrams for this type of time based sequences

guillemcordoba · 2024-10-09T10:16:33Z

docs/overview.md

+It is implemented in this way in order to be sure that when someone is evaluating if an action is allowed (through a role) from an Agent, that enabling role claim must be found earlier in the source chain of that Agent to become deterministic.
+
+## Implementation considerations
+It is very important to understand that if you want to use this module, the instansiators AgentPubKey needs to be inserted into the [DNA properties](https://docs.rs/holochain_types/0.5.0-dev.0/holochain_types/prelude/struct.DnaModifiers.html#structfield.properties). This means that you need to have a running conductor that has access to an AgentPubKey that can be insterted into the app. 


Instantiator's

guillemcordoba and others added 5 commits September 27, 2024 10:31

Add macos-13

096340a

RoleClaim validation for the assign role create link hash

34706a7

Mermaid docs working

eed4f7e

updated docs & rust docs

9b9c782

cleaned end of overview

a3c46a0

zaunders enabled auto-merge October 9, 2024 10:03

guillemcordoba suggested changes Oct 9, 2024

View reviewed changes

zaunders merged commit b9ccae0 into main Oct 9, 2024
6 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

updated docs #11

updated docs #11

zaunders commented Oct 9, 2024

guillemcordoba Oct 9, 2024

guillemcordoba Oct 9, 2024

zaunders Oct 9, 2024

guillemcordoba Oct 9, 2024

guillemcordoba Oct 9, 2024

guillemcordoba Oct 9, 2024

guillemcordoba Oct 9, 2024

guillemcordoba Oct 9, 2024


		This module gives your apps the power of role management.

		It uses a progenitor as initial admin and allows consuming applications to create arbitrary roles and bind the possibility of preforming actions to those roles.



		## Module design
		Creating roles in fully peer-to-peer systems can be tricky. There is no node in the network that by default is able to administer the system. In order to introduce rolebased management on Holochain, someone needs to be written into the app as it is generated as the agent that has special rights, this will then be part of the rules of the app that everyone plays by (the DNA).


		The pattern we are using in this module is the progenitor pattern. This means that the agent that instansiates the DNA writes themselves into the DNA as the original admin. Once an original admin is created, this administrator is able to generate further roles including additional administrators. Administrators are also able to remove all of the roles from Agents (including the Admin role of the progenitor). Below you will find graphical representations of how the module works.

		This pattern creates the requirement of a layer outside the app (like a lobby) where a user is able to create the instanciation of the app so that the public key (AgentPubKey) associated with the original user is encoded into the DNA as it is being created. Read more about this in the implementation considerations section below.



		```mermaid
		graph TD;

updated docs #11

updated docs #11

Conversation

zaunders commented Oct 9, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment