Merge pull request #3 from hashgraph/merge-branch

Merge branch

CHANGELOG.md

@@ -4,7 +4,7 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [v1.0.0-beta] - 2021-10-14
+## [v1.0.0-beta.1] - 2021-10-14
 
 ### Added
 

CONTRIBUTING.md

@@ -69,7 +69,7 @@ Code contributions to the Guardian are handled using [Pull Requests][pull-reques
 
   If you're working on a bug fix, check to see whether the bug has already been reported. If it has but no one is assigned to it, ask one of the maintainers to assign it to you before beginning work. If you're confident the bug hasn't been reported yet, create a new [Bug Report](#bug-reports) and ask us to assign it to you.
 
-  If you are thinking about adding entirely new functionality, open a [Feature Request](#feature-requests) or get in touch with us on [Discord](discord) to ask for feedback first before beginning work; this is to ensure that nobody else is already working on the feature (or another similar feature) and to confirm that it makes sense for such functionality to be included in the Guardian.
+  If you are thinking about adding entirely new functionality, open a [Feature Request](#feature-requests) or get in touch with us on [Discord](https://hedera.com/discord) to ask for feedback first before beginning work; this is to ensure that nobody else is already working on the feature (or another similar feature) and to confirm that it makes sense for such functionality to be included in the Guardian.
 * All code contributions must be accompanied with new or modified tests that verify that the code works as expected; i.e. that the issue has been fixed or that the functionality works as intended.
 
 ### Pull Request Readiness
@@ -86,11 +86,11 @@ To contribute, please fork the GitHub repository and submit a pull request to th
 
 ### Getting Your Pull Request Merged
 
-All Pull Requests must be approved by at least one member of the Guardian team before it can be merged in. The members only have limited bandwidth to review Pull Requests so it's not unusual for a Pull Request to go unreviewed for a few days, especially if it's a large or complex one. After a couple of weeks, if you haven't received any feedback regarding your Pull Request from the Guardian team, feel free to contact us on [Discord](discord) to ask for a review.
+All Pull Requests must be approved by at least one member of the Guardian team before it can be merged in. The members only have limited bandwidth to review Pull Requests so it's not unusual for a Pull Request to go unreviewed for a few days, especially if it's a large or complex one. After a couple of weeks, if you haven't received any feedback regarding your Pull Request from the Guardian team, feel free to contact us on [Discord](https://hedera.com/discord) to ask for a review.
 
 ## Getting in Contact
 
-* Join us in our [Discord][discord] channel; there you can engage with the Hedera team and other developers and enthusiasts.
+* Join us in our [Discord](https://hedera.com/discord) channel; there you can engage with the Hedera team and other developers and enthusiasts.
 
 [license]: https://github.com/hashgraph/guardian/blob/main/LICENSE
 [mwe]: https://en.wikipedia.org/wiki/Minimal_Working_Example

README.md

@@ -1,13 +1,9 @@
 [![Apache 2.0 License][license-shield]][license-url]
 
-
-
-
 <!-- PROJECT LOGO -->
 <br />
 <div align="center">
 <h1 align="center">Guardian</h1>
-
   <p align="center">
     The Guardian is a modular open-source solution that includes best-in-class identity management and decentralized ledger technology (DLT) libraries. At the heart of the Guardian solution is a sophisticated Policy Workflow Engine (PWE) that enables the ability for applications to offer a requirements-based tokenization implementation.
     <br />
@@ -16,19 +12,18 @@
 
 <p align="center">
     <br />
-    <a href="https://github.com/EnvisionBlockchain/hedera-improvement-proposal/blob/master/HIP/hip-19.md">HIP-19</a>
+    <a href="https://github.com/hashgraph/hedera-improvement-proposal/blob/master/HIP/hip-19.md">HIP-19</a>
     ·
-    <a href="https://github.com/EnvisionBlockchain/hedera-improvement-proposal/blob/master/HIP/hip-28.md">HIP-28</a>
+    <a href="https://github.com/hashgraph/hedera-improvement-proposal/blob/master/HIP/hip-28.md">HIP-28</a>
     ·
-     <a href="https://github.com/EnvisionBlockchain/hedera-improvement-proposal/blob/master/HIP/hip-29.md">HIP-29</a>
+    <a href="https://github.com/hashgraph/hedera-improvement-proposal/blob/master/HIP/hip-29.md">HIP-29</a>
     ·
-     <a href="https://github.com/github_username/repo_name/issues">Report Bug</a>
+    <a href="https://github.com/hashgraph/guardian/issues">Report Bug</a>
     ·
-    <a href="https://github.com/github_username/repo_name/issues">Request Policy or Feature</a>
+    <a href="https://github.com/hashgraph/guardian/issues">Request Policy or Feature</a>
   </p>
 </div>
 
-
 <!-- TABLE OF CONTENTS -->
 <details>
   <summary>Table of Contents</summary>
@@ -56,7 +51,6 @@
   </ol>
 </details>
 
-
 <!-- DISCOVERING ESG ASSETS ON HEDERA -->
 
 ## Discovering ESG assets on Hedera
@@ -75,20 +69,42 @@ To get a local copy up and running follow these simple example steps. When build
 
 * [Docker](https://www.docker.com/) (To build with one command)
 * [MongoDB](https://www.mongodb.com/) and [NodeJS](https://nodejs.org/) (If you would like to manually build every componant) 
+* [Hedera Testnet Account](https://portal.hedera.com/) 
 
 <!-- INSTALLATION -->
 
 ### Installation
 
 1. Clone the repo
    ```
-   git clone https://github.com/github_username/repo_name.git
+   git clone https://github.com/hashgraph/guardian.git
+   ```
+2. Update the following files with your Hedera Testnet account info as indicated. For example:
+
+   - in `ui-service/.env`:
+   ```
+   ACCOUNT_ID=0.0.123456789
+   PRIVATE_KEY=302e020100300506032b657004220420f4361ec73dc43e568f1620a7b7ecb7330790b8a1c7620f1ce353aa1de4f0eaa6
+   TOPIC_ID=0.0.28583
    ```
-2. If you want to build with Docker (Once this step you are finished)
+   - in `ui-service/.env.docker`:
+   ```
+   ACCOUNT_ID=0.0.123456789
+   PRIVATE_KEY=302e020100300506032b657004220420f4361ec73dc43e568f1620a7b7ecb7330790b8a1c7620f1ce353aa1de4f0eaa6
+   TOPIC_ID=0.0.28583
+   ```
+   - in `guardian-service/config.json`:
+   ```
+   {"OPERATOR_ID":"0.0.123456789","OPERATOR_KEY":"302e020100300506032b657004220420f4361ec73dc43e568f1620a7b7ecb7330790b8a1c7620f1ce353aa1de4f0eaa6"}
+   ```
+
+   The `TOPIC_ID` is used when connecting to an existing topic. If you don't have one, just delete the `TOPIC_ID` line.
+
+3. If you want to build with Docker (Once this step you are finished)
     ```
     docker-compose up -d --build
     ```
-3. If you want to manually build every componant then build and run the services in the following sequence: Message Broker, UI Service, Guardian Service, and lastly the MRV Sender Service. See below for commands.
+4. If you want to manually build every componant then build and run the services in the following sequence: Message Broker, UI Service, Guardian Service, and lastly the MRV Sender Service. See below for commands.
 
     **From the Message broker folder (Need to run first)**
 
@@ -192,7 +208,7 @@ Place holder for some Executive Summary about the iRec Demo
 
 ## Contribute a New Policy
 
-We welcome all methodologies and workflow to be contributed to this repo as an open-source token template and Policy Workflow & Policy Action Execution instance. To do so, please follow the CONTRIBUTING.md instructions to submit a pull request.
+We welcome all methodologies and workflow to be contributed to this repo as an open-source token template and Policy Workflow & Policy Action Execution instance. To do so, please follow the [CONTRIBUTING.md](CONTRIBUTING.md) instructions to submit a pull request.
 
 This is critical to scaling the [Hedera Sustainability Ecosystem](https://github.com/dubgeis/HederaSustainabilityEcosystem/). 
 
@@ -207,7 +223,6 @@ This repo contains a reference implementation of the Guardian to learn how to us
 <p align="right">(<a href="#top">back to top</a>)</p>
 
 
-
 <!-- BUILT WITH -->
 
 ## Built With
@@ -231,11 +246,6 @@ The Guardian solution is built with the following major frameworks/libraries.
 
 <p align="right">(<a href="#top">back to top</a>)</p>
 
-<!-- GETTING STARTED -->
-
-
-
-
 
 <!-- ROADMAP -->
 ## Roadmap
@@ -245,15 +255,15 @@ Roadmap TBA
 - [] Feature 1
     - [] Nested Feature
 
-See the [open issues](https://github.com/github_username/repo_name/issues) for a full list of proposed features (and known issues).
+See the [open issues](https://github.com/hashgraph/guardian/issues) for a full list of proposed features (and known issues).
 
 <p align="right">(<a href="#top">back to top</a>)</p>
 
 
 <!-- CHANGE LOG -->
 ## Change Log
 
-All notable changes to this project will be documented in this CHANGELOG.md file.
+All notable changes to this project will be documented in this [CHANGELOG.md](CHANGELOG.md) file.
 
 <p align="right">(<a href="#top">back to top</a>)</p>
 
@@ -264,21 +274,21 @@ Thank you for your interest in contributing to the Guardian!
 
 We appreciate your interest in helping us and the rest of our community. We welcome bug reports, feature requests, and code contributions.
 
-For contributing guidlines please see the CONTRIBUTING.md here
+For contributing guidlines please see the [CONTRIBUTING.md](CONTRIBUTING.md) here
 
 <p align="right">(<a href="#top">back to top</a>)</p>
 
 <!-- LICENSE -->
 ## License
 
-This repo is under Apache 2.0 License. See `LICENSE.txt` for more information.
+This repo is under Apache 2.0 License. See [LICENSE](LICENSE) for more information.
 
 <p align="right">(<a href="#top">back to top</a>)</p>
 
 <!-- Security -->
 ## Security
 
-Please do not file a public ticket mentioning the vulnerability. Refer to the security policy defined in the SECURITY.md.
+Please do not file a public ticket mentioning the vulnerability. Refer to the security policy defined in the [SECURITY.md](SECURITY.md).
 
 <p align="right">(<a href="#top">back to top</a>)</p>
 
@@ -296,4 +306,4 @@ For any questions please reach out to the Envision Blockchain Solutions team at:
 
 [license-shield]: https://img.shields.io/hexpm/l/apa
 
-[license-url]: https://github.com/EnvisionBlockchain/tomcat-guardian/blob/policy-engine/LICENSE
+[license-url]: https://github.com/hashgraph/guardian/blob/main/LICENSE

frontend/package.json

@@ -1,4 +1,5 @@
 {
+  "author": "Envision Blockchain Solutions <[email protected]>",
   "dependencies": {
     "@angular/animations": "~12.1.1",
     "@angular/cdk": "^12.1.1",
@@ -39,6 +40,7 @@
     "karma-jasmine-html-reporter": "^1.7.0",
     "typescript": "~4.3.2"
   },
+  "license": "Apache-2.0",
   "name": "guardian",
   "private": true,
   "scripts": {
@@ -49,5 +51,5 @@
     "test": "ng test",
     "watch": "ng build --watch --configuration development --output-path ../www-data"
   },
-  "version": "0.0.0"
+  "version": "1.0.0-beta.1"
 }

guardian-service/config.json

@@ -1 +1 @@
-{"OPERATOR_ID":"0.0.1548173","OPERATOR_KEY":"302e020100300506032b657004220420e749aa65835ce90cab1cfb7f0fa11038e867e74946abca993f543cf9509c8edc","ADDRESS_BOOK":"0.0.2276271","VC_TOPIC_ID":"0.0.2276270","DID_TOPIC_ID":"0.0.2276269"}
+{"OPERATOR_ID":"...","OPERATOR_KEY":"..."}

guardian-service/package.json

@@ -4,7 +4,7 @@
     "@entity": "dist/entity",
     "@subscribers": "dist/subscribers"
   },
-  "author": "",
+  "author": "Envision Blockchain Solutions <[email protected]>",
   "dependencies": {
     "@hashgraph/sdk": "^2.0.26",
     "@transmute/credentials-context": "^0.7.0-unstable.5",
@@ -37,7 +37,7 @@
     "tslint": "^6.1.3",
     "typescript": "^4.3.5"
   },
-  "license": "ISC",
+  "license": "Apache-2.0",
   "main": "dist/index.js",
   "name": "guardian-service",
   "scripts": {
@@ -47,5 +47,5 @@
     "lint": "tslint --project .",
     "start": "node dist/index.js"
   },
-  "version": "0.0.1"
+  "version": "1.0.0-beta.1"
 }

interfaces/package.json

@@ -1,5 +1,5 @@
 {
-  "author": "",
+  "author": "Envision Blockchain Solutions <[email protected]>",
   "description": "",
   "devDependencies": {
     "@types/node": "^16.3.2",
@@ -9,7 +9,7 @@
   "files": [
     "dist"
   ],
-  "license": "ISC",
+  "license": "Apache-2.0",
   "main": "dist/index.js",
   "module": "dist/index.js",
   "name": "interfaces",
@@ -19,5 +19,5 @@
     "lint": "tslint --project .",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
-  "version": "1.0.0"
+  "version": "1.0.0-beta.1"
 }

message-broker/package.json

@@ -1,6 +1,5 @@
 {
   "name": "message-broker",
-  "version": "0.0.1",
   "description": "",
   "main": "index.js",
   "scripts": {
@@ -9,8 +8,8 @@
     "debug": "nodemon dist/index.js",
     "build": "tsc"
   },
-  "author": "",
-  "license": "ISC",
+  "author": "Envision Blockchain Solutions <[email protected]>",
+  "license": "Apache-2.0",
   "dependencies": {
     "express": "^4.17.1",
     "fastmq": "^1.3.8"
@@ -20,5 +19,6 @@
     "nodemon": "^2.0.7",
     "typescript": "^4.2.4",
     "@types/express": "^4.17.13"
-  }
+  },
+  "version": "1.0.0-beta.1"
 }

mrv-sender/package.json

@@ -1,5 +1,5 @@
 {
-  "author": "",
+  "author": "Envision Blockchain Solutions <[email protected]>",
   "dependencies": {
     "@hashgraph/sdk": "^2.0.26",
     "@transmute/credentials-context": "^0.7.0-unstable.5",
@@ -18,7 +18,7 @@
     "nodemon": "^2.0.12",
     "typescript": "^4.3.5"
   },
-  "license": "ISC",
+  "license": "Apache-2.0",
   "main": "dist/index.js",
   "name": "mrv-sender",
   "scripts": {
@@ -27,5 +27,5 @@
     "start": "node dist/index.js",
     "debug": "nodemon dist/index.js"
   },
-  "version": "0.0.1"
+  "version": "1.0.0-beta.1"
 }

ui-service/.env

@@ -4,3 +4,5 @@ MRV_ADDRESS="http://localhost:3003/mrv"
 ACCESS_TOKEN_SECRET="youraccesstokensecret"
 DB_HOST="localhost"
 DB_DATABASE="ui_db"
+OPERATOR_ID="..."
+OPERATOR_KEY="..."

ui-service/.env.docker

@@ -4,3 +4,5 @@ MRV_ADDRESS="http://message-broker:3003/mrv"
 ACCESS_TOKEN_SECRET="youraccesstokensecret"
 DB_HOST="mongo"
 DB_DATABASE="ui_db"
+OPERATOR_ID="..."
+OPERATOR_KEY="..."

ui-service/package.json

@@ -6,7 +6,7 @@
     "@policy-engine": "dist/policy-engine",
     "@subscribers": "dist/subscribers"
   },
-  "author": "",
+  "author": "Envision Blockchain Solutions <[email protected]>",
   "dependencies": {
     "@hashgraph/sdk": "^2.0.26",
     "@transmute/credentials-context": "^0.7.0-unstable.5",
@@ -47,7 +47,7 @@
   "files": [
     "dist"
   ],
-  "license": "ISC",
+  "license": "Apache-2.0",
   "main": "dist/index.js",
   "module": "dist/index.js",
   "name": "ui-service",
@@ -59,5 +59,5 @@
     "start": "node dist/index.js",
     "test": "mocha tests/**/*.test.js"
   },
-  "version": "0.0.1"
+  "version": "1.0.0-beta.1"
 }

ui-service/src/api/service/profile.ts

@@ -273,8 +273,8 @@ profileAPI.post('/set-vc-profile', async (req: Request, res: Response) => {
 
 profileAPI.get('/random-key', async (req: Request, res: Response) => {
     try {
-        const OPERATOR_ID = '0.0.1548173';
-        const OPERATOR_KEY = '302e020100300506032b657004220420e749aa65835ce90cab1cfb7f0fa11038e867e74946abca993f543cf9509c8edc';
+        const OPERATOR_ID = process.env.OPERATOR_ID;
+        const OPERATOR_KEY = process.env.OPERATOR_KEY;
         const treasury = await HederaHelper.setOperator(OPERATOR_ID, OPERATOR_KEY).SDK.newAccount(40);
         res.status(200).json({
             id: treasury.id.toString(),

vc-modules/package.json

@@ -1,5 +1,5 @@
 {
-  "author": "",
+  "author": "Envision Blockchain Solutions <[email protected]>",
   "dependencies": {
     "@hashgraph/sdk": "^2.0.26",
     "@transmute/credentials-context": "^0.7.0-unstable.5",
@@ -20,7 +20,7 @@
   "files": [
     "dist"
   ],
-  "license": "ISC",
+  "license": "Apache-2.0",
   "main": "dist/index.js",
   "module": "dist/index.js",
   "name": "vc-modules",
@@ -30,5 +30,5 @@
     "lint": "tslint --project .",
     "test": "mocha test/**/*.js"
   },
-  "version": "1.0.0"
+  "version": "1.0.0-beta.1"
 }