Open Science Platform

Introduction

This artifact demonstrates the creation and management of user accounts, project accounts, and linked accounts using IPFS and Iroha.

This is the repository for the project Open Science, on its final form the project will deliver a sample DApp based on:

• Hyperledger Iroha 1
• Hyperledger Burrow
• Smart contracts
• IPFS

---

Components

Iroha 1 Python SDK

This notebook uses Iroha 1 Python Library

Smart Contracts

The integration of smart contracts into Iroha 1 is executed by Hyperledger Burrow. For additional information refer to Iroha Smart Contracts Integration. Use this docker image hyperledger/iroha-burrow:pr-3960, see below.

IPFS

This project uses Python IPFS HTTP Client

---

Requirements

Docker images:

• new_jupyter_lab (see docker/Dockerfile)

• Iroha 1

• IPFS Kubo

• All containers must be attached to the iroha network.

• Clone the Iroha 1 repo:

git clone https://github.com/iroha

cd iroha

docker network create iroha-network

docker volume create blockstore

git checkout 0d22d117863560c5330299bea592360fd8252941

Genesis Block

The default Genesis block for Iroha 1 docker image admin@test does not have the proper permission to creat smart contracts, therefore it is necessary to add the permission for the admin@test account editing the genesis.blockfile as instructed below.

How to run a specific genesis-block, to add/change permissions for the admin

• Open iroha/example/genesis_block file and locate the following block:

"createRole":{
                             "roleName":"admin",
                             "permissions":[
                                "can_add_peer",
                                "can_add_signatory",
                                "can_create_account",
                                "can_create_domain",
                                "can_get_all_acc_ast",
                                "can_get_all_acc_ast_txs",
                                "can_get_all_acc_detail",
                                "can_get_all_acc_txs",
                                "can_get_all_accounts",
                                "can_get_all_signatories",
                                "can_get_all_txs",
                                "can_get_blocks",
                                "can_get_roles",
                                "can_read_assets",
                                "can_remove_signatory",
                                "can_set_quorum"
                             ]
                          }

• Edit it with the admin role permission set root like this:

                       
                       {
                          "createRole":{
                             "roleName":"admin",
                             "permissions":[
                                "root",
                             ]
                          }
                       

---

• Running Postgress (Database for Iroha 1)

docker run --name some-postgres \
-e POSTGRES_USER=postgres \
-e POSTGRES_PASSWORD=mysecretpassword \
-p 5432:5432 \
--network=iroha-network \
-d postgres:9.5 \
-c 'max_prepared_transactions=100' \
-- restart always

• Create local directories at your docker host:

mkdir ipfs_repo ipfs_repo/staging ipfs_repo/data

Setup

2.1 - Jupyter Notebooks

docker run -it -p 10.0.0.100:10000:8888 --network=iroha-network new_jupyter_lab

2.2 IPFS Node

docker run -d --name ipfs_node -v ~/ipfs_repo/staging:/export -v ~/ipfs_repo/data:/data/ipfs -p 4001:4001 -p 8080:8080 -p 5001:5001 --network iroha-network ipfs/go-ipfs:v0.4.23

2.3 Iroha Network

docker run --name iroha -d -p 50051:50051 -p 7001:7001 -v $(pwd)/iroha/example:/opt/iroha_data -v blockstore:/tmp/block_store --network=iroha-network --restart always -e KEY='node0' hyperledger/iroha-burrow:pr-3960

2.4 - IP Address and related connections parameters

For iroha and IPFS, go to the Jupyter, check and edit config.json according to the networking settings for your environment.

---

Test the Platform

Step	Description	Outcome
1	User Account Creation	Creates an user account
2	Project Account Creation	Creates a project account
3	Cross Linking User and Project accounts	Sets a bi-directional link between an user account and a project account
4	Querying linked accounts	Querying Linked Account and Project accounts

Summary

This artifact demonstrates the creation and management of user accounts, project accounts, and linked accounts using IPFS and Iroha. The sequence diagram shows the steps involved in creating and linking these accounts.

---

Caveats and Workarounds

Genesis Block

The default Genesis block for Iroha 1 docker image admin@test does not have the proper permission to creat smart contracts, therefore it is necessary to add the permission for the admin@test account editing the genesis.blockfile as instructed below.

How to run a specific genesis-block, to add/change permissions

• The genesis block file is read from the local iroha/example/genesis_block file.

• This is the modified block, with the admin role permission set root.

• After that you only need to execute docker run with the proper parameters of the iroha container.

                       {
                          "createRole":{
                             "roleName":"admin",
                             "permissions":[
                                "root"                             
                             ]
                          }
                       },

---

Future Improvements

New features

• Improve function upload_file_to_ipfs to get the original file name and store it on file_n_metadata JSON automatically - Done

Monitoring

• Use Prometheus for monitoring basic metrics.

Document functions and generate documentation

• Check functions and maybe breakdown them further for better maintainability

• Use a vanilla Jupyter Notebook docker image from Jupyter Stacks

Smart Contracts

• Publish smart contracts in IPFS

CSV versus JSON

• Replace CSV usage by JSON and store them in IPFS - In progress

RBAC (Role Based Access Control)

• The project owner can designate the role of the other collaborators in RBAC

Search Engine

• Include projects metadata for indexing - Done
• Consider a knowledge graph for search results (Consider Ontologies like FOAF and Dublin Core) - Done
• Include user_account and project_acccount, affiliation, full name, role as indexed criterias for searching

Outputs

• Standardize on IC (icecream) or Logger whenever is possible - In progress

Entity Relationships Model

• A user should be able to own n projects
• On project details:

Project Account id = {'account_id': '18286@test'}, {
  "admin@test": {
    "file_1": {
      "CID": "QmV1vYkuiwKGPA5Tyi4ECNFfWYocyTtQ3E5j7CSvPBX49Q",
      "metadata_CID": "QmRMyo5mMDKgwCPjh3Q2FFqvcRC6Nodu4eCcbpv8oiDaL2"
    },
    "is_owner": "wizardly_lamport@test",
    "project_metadata_cid": "Qmah9rr9rV51TKpL83ZHL9MheiDnqgTEapZSV4ipjdE51s"
  }
}
 }

Or

Project Account id = {'account_id': '18286@test'}, {
  "admin@test": {
    "file_1": {
      "CID": "QmV1vYkuiwKGPA5Tyi4ECNFfWYocyTtQ3E5j7CSvPBX49Q",
      "metadata_CID": "QmRMyo5mMDKgwCPjh3Q2FFqvcRC6Nodu4eCcbpv8oiDaL2"
    },
    "is_reviewer": "wizardly_lamport@test",
    "project_metadata_cid": "Qmah9rr9rV51TKpL83ZHL9MheiDnqgTEapZSV4ipjdE51s"
  }
}

Provenance

• Implementing a git like version control system for provenance

Project Details

• Optmize file and file metadata entries

As - Is

Project Account id = {'account_id': '18286@test'}, { "admin@test" : { "file_1_CID" : "QmV1vYkuiwKGPA5Tyi4ECNFfWYocyTtQ3E5j7CSvPBX49Q", "file_1_metadata_CID" : "QmRMyo5mMDKgwCPjh3Q2FFqvcRC6Nodu4eCcbpv8oiDaL2", "linked_user" : "wizardly_lamport@test", "project_metadata_cid" : "Qmah9rr9rV51TKpL83ZHL9MheiDnqgTEapZSV4ipjdE51s" } }

To - Be (something like this)

Project Account id = {'account_id': '18286@test'}, {
  "admin@test": {
    "file_1": {
      "CID": "QmV1vYkuiwKGPA5Tyi4ECNFfWYocyTtQ3E5j7CSvPBX49Q",
      "metadata_CID": "QmRMyo5mMDKgwCPjh3Q2FFqvcRC6Nodu4eCcbpv8oiDaL2"
    },
    "linked_user": "wizardly_lamport@test",
    "project_metadata_cid": "Qmah9rr9rV51TKpL83ZHL9MheiDnqgTEapZSV4ipjdE51s"
  }
}