holochain_roles

Generic holochain mixin to include administrator and dynamic roles in any holochain application, using the progenitor pattern.

This mixin is built to target hc v0.0.42-alpha3. It also depends on the holochain_anchors to be present and configured.

Known issue: due to updated entries not being propagated, this mixin won't actually work in a real environtment, since it depends on an update on the role entry to be propagated througout the network.

Design

Here is the design for this mixin: https://hackmd.io/6xfwfSVYSGeZe3vQ_-1cWw?view.

Documentation

Here you can find the documentation for this mixin: https://docs.rs/holochain_roles.

Installation

Add the following to your zomes cargo toml.

holochain_anchors = "0.2.1" holochain_roles = "0.1.2"

Usage

Setup

Add the anchor entry definition to your zome.

rust #[entry_def] fn anchor_def() -> ValidatingEntryType { holochain_anchors::anchor_definition() }

Add the roles entry definition to your zome.

rust #[entry_def] fn roles_def() -> ValidatingEntryType { holochain_roles::role_entry_def() }

Assign a role

To assign a role, simply call the assign_role function:

```rust

[zomefn("hcpublic")]

fn someotherpublicfunction(agentaddress: Address) { let myrolename = String::from("editor");

holochain_roles::handlers::assign_role(&my_role_name, &agent_address)?;
...

} ```

Assign an administrator

Only agents that have the administrator role or the progenitor of the DNA can assign or unassign roles. To assign an administrator role, call the assign_role function with the imported administrator role name:

```rust

[zomefn("hcpublic")]

fn someotherpublicfunction(agentaddress: Address) { let myrolename = String::from(holochainroles::ADMINROLE_NAME);

holochain_roles::handlers::assign_role(&my_role_name, &agent_address)?;
...

} ```

Check if user currently has a certain role

To check if a user has a certain role, you can use the validation has_agent_role function:

```rust validation: | validationdata: hdk::EntryValidationData| { match validationdata { hdk::EntryValidationData::Create { entry, validationdata } => { let agentaddress = &validationdata.sources()[0]; let isagentpermittedtocreatethisentry = holochainroles::validaton::hasagentrole(&agent_address, String::from("editor"))?;

        if !is_agent_permitted_to_create_this_entry {
            return Err(String::from("Only editors can create a new entry"));
        }
        ...

    }
}

} ```

Check if user had a certain role in a certain moment in time

To check if a user has a certain role, you can use the validation has_agent_role function:

```rust validation: | validationdata: hdk::EntryValidationData| { match validationdata { hdk::EntryValidationData::Create { entry, validationdata } => { let agentaddress = &validationdata.sources()[0]; let timestamp = &validationdata.package.chainheader.timestamp(); let isagentpermittedtocreatethisentry = holochainroles::validaton::hadagentrole(&agent_address, String::from("editor"), timestamp)?;

        if !is_agent_permitted_to_create_this_entry {
            return Err(String::from("Only editors can create a new entry"));
        }
        ...

    }
}

} ```

Get all role assignments for an agent

To get all role assignments for a certain agent, you can use the validation get_agent_roles function:

```rust

[zomefn("hcpublic")]

fn somepublicfunction(agentaddress: Address) { let roles: Vec = holochainroles::handlers::getagentroles(&agent_address)?; } ```

Get all agents that have a certain role assigned

To get all role assignments for a certain agent, you can use the validation get_role_agents function:

```rust

[zomefn("hcpublic")]

fn somepublicfunction(rolename: String) { let agents: Vec

holochain_roles::handlers::unassign_role(&my_role_name, &agent_address)?;
...