Implementation of v1.0 of Hedera DID Method (HIP-27)

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/custom.md

@@ -0,0 +1,10 @@
+---
+name: Custom issue template
+about: Describe this issue template's purpose here.
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/workflows/release.yml

@@ -12,15 +12,16 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node: [ '14', '16' ]
+        node: [ '16' ]
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v2
         with:
           cache: 'npm'
           node-version: ${{ matrix.node }}
       - run: npm ci
-      - run: npm test
+      - run: npm run build --if-present
+      - run: npm run test
         env:
           OPERATOR_ID: ${{ secrets.OPERATOR_ID }}
           OPERATOR_KEY: ${{ secrets.OPERATOR_KEY }}

.github/workflows/test.unit.yml

@@ -0,0 +1,29 @@
+name: Test
+
+on:
+  pull_request:
+    branches: 
+      - develop 
+  push:
+    branches: 
+      - develop 
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node: [ '16' ]
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: install dependencies
+        run: npm ci
+      - name: build
+        run: npm run build --if-present
+      - name: run unit test  
+        run: npm run test:unit
+

.github/workflows/test.yml

@@ -2,24 +2,30 @@ name: Test
 
 on:
   pull_request:
-    branches: [ main ]
+    branches: 
+      - main
   push:
-    branches: [ main ]
+    branches: 
+      - main
 
 jobs:
   build:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node: [ '14', '16' ]
+        node: [ '16' ]
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v2
         with:
-          cache: 'npm'
-          node-version: ${{ matrix.node }}
-      - run: npm ci
-      - run: npm test
+          node-version: ${{ matrix.node-version }}
+      - name: install dependencies
+        run: npm ci
+      - name: build
+        run: npm run build --if-present
+      - name: run all tests
+        run: npm run test
         env:
           OPERATOR_ID: ${{ secrets.OPERATOR_ID }}
           OPERATOR_KEY: ${{ secrets.OPERATOR_KEY }}

.gitignore

@@ -1,2 +1,3 @@
 /node_modules/
 /dist/
+/demo/.env.json

.npmrc

@@ -0,0 +1 @@
+engine-strict=true

.prettierignore

@@ -0,0 +1 @@
+/dist/

.prettierrc.json

@@ -0,0 +1,6 @@
+{
+    "singleQuote": false,
+    "printWidth": 120,
+    "tabWidth": 4,
+    "trailingComma": "es5"
+}

CHANGELOG.md

@@ -0,0 +1,126 @@
+
+# Changelog
+
+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
+
+## Removed
+
+* Generation of decentralized identifiers and creation of DID documents based on old [Hedera DID Method][did-method-spec]
+* Creation of `identity networks` within `appnets`.
+* Address book - a file on `Hedera File Service` that provides information about HCS topics and `appnet servers`.
+* Creation and initialization of the `VC topic` - an HCS topic playing a role of verifiable credentials' registry.
+* Creation (publishing), update, deletion and resolution of DID documents in `appnet identity networks`.
+* Issuance, revocation and status verification of `Verifiable Credentials`.
+
+## Added
+
+* Generation of decentralized identifiers and creation of DID documents based on new [Hedera DID Method][did-method-spec]
+ Creation and initialization of the DID registration on `HCS Private Topic`
+* Create, update, revoke, deletion, and resolution of DID documents based on [DID Document Core Properties][did-core-prop] `event/log messages` recorded on `HCS Topic`
+* Transferring ownership of DID identifier and DID Document to another party.
+* Publishing **DID Events Messages** to resolve and validate **DID Document**
+
+[did-core-prop]: https://w3c.github.io/did-core/#core-properties
+[did-method-spec]: https://github.com/hashgraph/did-method
+
+### DID API's
+
+* Generate & Register
+
+    ```js
+    ...
+    const registeredDid = await did.register();
+    ```
+
+* Resolve
+
+    ```js
+    ...
+    const didDoc = await registeredDid.resolve();
+    ```
+
+* Change Ownership
+
+    ```js
+    ...
+    await registeredDid.changeOwner({
+    controller: newOwnerIdentifier,
+    newPrivateKey: newOwnerDidPrivateKey,
+    });
+    ```
+
+* Create, Update and Revoke [DID Document Core Properties][did-core-prop]
+  * Service
+
+    ```js
+    ...
+    await registeredDid.addService({
+        id: serviceIdentifier + "#service-1",
+        type: "LinkedDomains",
+        serviceEndpoint: "https://example.com/vcs",
+    });
+    ...
+    await registeredDid.updateService({
+        id: serviceIdentifier + "#service-1",
+        type: "LinkedDomains",
+        serviceEndpoint: "https://test.com/did",
+    });
+    ...
+    await registeredDid.revokeService({
+        id: serviceIdentifier + "#service-1",
+    });
+    ```
+
+* Verification Method
+
+    ```js
+    ...
+    await registeredDid.addVerificationMethod({
+        id: verificationMethodIdentifier + "#key-1",
+        type: "Ed25519VerificationKey2018",
+        controller: registeredDid.getIdentifier(),
+        publicKey: verificationMethodPublicKey,
+    });
+    ...
+    await registeredDid.updateVerificationMethod({
+        id: verificationMethodIdentifier + "#key-1",
+        type: "Ed25519VerificationKey2018",
+        controller: registeredDid.getIdentifier(),
+        publicKey: updatedVerificationMethodPublicKey,
+    });
+    ...
+    await registeredDid.revokeVerificationMethod({
+        id: verificationMethodIdentifier + "#key-1",
+    });
+    ```
+
+* Verification Relationship
+
+    ```js
+    ...
+    await registeredDid.addVerificationRelationship({
+        id: verificationRelationshipIdentifier + "#key-1",
+        relationshipType: verificationRelationshipType,
+        type: "Ed25519VerificationKey2018",
+        controller: registeredDid.getIdentifier(),
+        publicKey: verificationRelationshipPublicKey,
+    });
+    ...
+    await registeredDid.updateVerificationRelationship({
+        id: verificationRelationshipIdentifier + "#key-1",
+        relationshipType: verificationRelationshipType,
+        type: "Ed25519VerificationKey2018",
+        controller: registeredDid.getIdentifier(),
+        publicKey: updatedVerificationRelationshipPublicKey,
+    });
+    ...
+    await registeredDid.revokeVerificationRelationship({
+        id: verificationRelationshipIdentifier + "#key-1",
+        relationshipType: verificationRelationshipType,
+    });
+    ```