feat: Add Hedera module

README.md

@@ -51,7 +51,7 @@ See [Supported Features](https://credo.js.org/guides/features) on the Credo webs
 
 - 🏃 **Platform agnostic** - out of the box support for Node.JS and React Native
 - 🔒 **DIDComm and AIP** - Support for [DIDComm v1](https://hyperledger.github.io/aries-rfcs/latest/concepts/0005-didcomm/), and both v1 and v2 of the [Aries Interop Profile](https://github.com/hyperledger/aries-rfcs/blob/main/concepts/0302-aries-interop-profile/README.md).
-- 🛂 **Extendable [DID](https://www.w3.org/TR/did-core/) resolver and registrar** - out of the box support for `did:web`, `did:key`, `did:jwk`, `did:peer`, `did:sov`, `did:indy` and `did:cheqd`.
+- 🛂 **Extendable [DID](https://www.w3.org/TR/did-core/) resolver and registrar** - out of the box support for `did:web`, `did:key`, `did:jwk`, `did:peer`, `did:sov`, `did:indy`, `did:cheqd` and `did:hedera`.
 - 🔑 **[OpenID4VC](https://openid.net/sg/openid4vc/)** - support for [OpenID for Verifiable Credential Issuance](https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html), [OpenID for Verifiable Presentations](https://openid.net/specs/openid-4-verifiable-presentations-1_0.html) and [Self-Issued OpenID Provider v2](https://openid.net/specs/openid-connect-self-issued-v2-1_0.html).
 - 🪪 **Multiple credential formats** - [W3C Verifiable Credential Data Model v1.1](https://www.w3.org/TR/vc-data-model/), [SD-JWT VCs](https://www.ietf.org/archive/id/draft-ietf-oauth-sd-jwt-vc-03.html), and [AnonCreds](https://hyperledger.github.io/anoncreds-spec/).
 - 🏢 **Multi-tenant** - Optional multi-tenant module for managing multiple tenants under a single agent.
@@ -158,6 +158,14 @@ See [Supported Features](https://credo.js.org/guides/features) on the Credo webs
       </a>
     </td>
   </tr>
+  <tr>
+    <td>@credo-ts/hedera</td>
+    <td>
+      <a href="https://npmjs.com/package/@credo-ts/hedera">
+        <img alt="@credo-ts/hedera version" src="https://img.shields.io/npm/v/@credo-ts/hedera"/>
+      </a>
+    </td>
+  </tr>  
   <tr>
     <td><s>@aries-framework/indy-sdk</s> (deprecated, unmaintained after 0.4.x)</td>
     <td>

demo/package.json

@@ -13,19 +13,21 @@
     "faber": "ts-node src/FaberInquirer.ts"
   },
   "dependencies": {
-    "@hyperledger/indy-vdr-nodejs": "catalog:",
     "@hyperledger/anoncreds-nodejs": "catalog:",
+    "@hyperledger/indy-vdr-nodejs": "catalog:",
     "@openwallet-foundation/askar-nodejs": "catalog:",
     "inquirer": "^8.2.5"
   },
   "devDependencies": {
     "@credo-ts/anoncreds": "workspace:*",
     "@credo-ts/askar": "workspace:*",
+    "@credo-ts/cheqd": "workspace:*",
     "@credo-ts/core": "workspace:*",
     "@credo-ts/didcomm": "workspace:*",
+    "@credo-ts/hedera": "workspace:*",
     "@credo-ts/indy-vdr": "workspace:*",
-    "@credo-ts/cheqd": "workspace:*",
     "@credo-ts/node": "workspace:*",
+    "@hiero-did-sdk/client": "0.1.3",
     "@types/figlet": "^1.5.4",
     "@types/inquirer": "^8.2.6",
     "clear": "^0.1.0",

demo/src/BaseAgent.ts

@@ -1,7 +1,3 @@
-import type { InitConfig } from '@credo-ts/core'
-import type { DidCommModuleConfigOptions } from '@credo-ts/didcomm'
-import type { IndyVdrPoolConfig } from '@credo-ts/indy-vdr'
-
 import {
   AnonCredsCredentialFormatService,
   AnonCredsModule,
@@ -19,7 +15,9 @@ import {
   CheqdModule,
   CheqdModuleConfig,
 } from '@credo-ts/cheqd'
+import type { InitConfig } from '@credo-ts/core'
 import { Agent, DidsModule } from '@credo-ts/core'
+import type { DidCommModuleConfigOptions } from '@credo-ts/didcomm'
 import {
   AutoAcceptCredential,
   AutoAcceptProof,
@@ -31,13 +29,16 @@ import {
   V2ProofProtocol,
   getDefaultDidcommModules,
 } from '@credo-ts/didcomm'
+import type { IndyVdrPoolConfig } from '@credo-ts/indy-vdr'
 import { IndyVdrAnonCredsRegistry, IndyVdrIndyDidResolver, IndyVdrModule } from '@credo-ts/indy-vdr'
 import { HttpInboundTransport, agentDependencies } from '@credo-ts/node'
+import { HederaNetwork } from '@hiero-did-sdk/client'
 import { anoncreds } from '@hyperledger/anoncreds-nodejs'
 import { indyVdr } from '@hyperledger/indy-vdr-nodejs'
 import { askar } from '@openwallet-foundation/askar-nodejs'
 
 import { AskarModuleConfigStoreOptions } from '@credo-ts/askar'
+import { HederaAnonCredsRegistry, HederaDidRegistrar, HederaDidResolver, HederaModule } from '@credo-ts/hedera'
 import { greenText } from './OutputClass'
 
 const bcovrin = `{"reqSignature":{},"txn":{"data":{"data":{"alias":"Node1","blskey":"4N8aUNHSgjQVgkpm8nhNEfDf6txHznoYREg9kirmJrkivgL4oSEimFF6nsQ6M41QvhM2Z33nves5vfSn9n1UwNFJBYtWVnHYMATn76vLuL3zU88KyeAYcHfsih3He6UHcXDxcaecHVz6jhCYz1P2UZn2bDVruL5wXpehgBfBaLKm3Ba","blskey_pop":"RahHYiCvoNCtPTrVtP7nMC5eTYrsUA8WjXbdhNc8debh1agE9bGiJxWBXYNFbnJXoXhWFMvyqhqhRoq737YQemH5ik9oL7R4NTTCz2LEZhkgLJzB3QRQqJyBNyv7acbdHrAT8nQ9UkLbaVL9NBpnWXBTw4LEMePaSHEw66RzPNdAX1","client_ip":"138.197.138.255","client_port":9702,"node_ip":"138.197.138.255","node_port":9701,"services":["VALIDATOR"]},"dest":"Gw6pDLhcBcoQesN72qfotTgFa7cbuqZpkX3Xo6pLhPhv"},"metadata":{"from":"Th7MpTaRZVRYnPiabds81Y"},"type":"0"},"txnMetadata":{"seqNo":1,"txnId":"fea82e10e894419fe2bea7d96296a6d46f50f93f9eeda954ec461b2ed2950b62"},"ver":"1"}
@@ -121,7 +122,7 @@ function getAskarAnonCredsIndyModules(
       ],
     }),
     anoncreds: new AnonCredsModule({
-      registries: [new IndyVdrAnonCredsRegistry(), new CheqdAnonCredsRegistry()],
+      registries: [new IndyVdrAnonCredsRegistry(), new CheqdAnonCredsRegistry(), new HederaAnonCredsRegistry()],
       anoncreds,
     }),
     indyVdr: new IndyVdrModule({
@@ -140,12 +141,23 @@ function getAskarAnonCredsIndyModules(
       })
     ),
     dids: new DidsModule({
-      resolvers: [new IndyVdrIndyDidResolver(), new CheqdDidResolver()],
-      registrars: [new CheqdDidRegistrar()],
+      resolvers: [new IndyVdrIndyDidResolver(), new CheqdDidResolver(), new HederaDidResolver()],
+      registrars: [new CheqdDidRegistrar(), new HederaDidRegistrar()],
     }),
     askar: new AskarModule({
       askar,
       store: askarStoreConfig,
     }),
+    hedera: new HederaModule({
+      networks: [
+        {
+          network: (process.env.HEDERA_NETWORK as HederaNetwork) ?? 'testnet',
+          operatorId: process.env.HEDERA_OPERATOR_ID ?? '0.0.5489553',
+          operatorKey:
+            process.env.HEDERA_OPERATOR_KEY ??
+            '302e020100300506032b6570042204209f54b75b6238ced43e41b1463999cb40bf2f7dd2c9fd4fd3ef780027c016a138',
+        },
+      ],
+    }),
   } as const
 }

demo/src/Faber.ts

@@ -14,6 +14,7 @@ import { Color, Output, greenText, purpleText, redText } from './OutputClass'
 export enum RegistryOptions {
   indy = 'did:indy',
   cheqd = 'did:cheqd',
+  hedera = 'did:hedera',
 }
 
 export class Faber extends BaseAgent {
@@ -38,11 +39,22 @@ export class Faber extends BaseAgent {
     // and store the existing did in the wallet
     // indy did is based on private key (seed)
     const unqualifiedIndyDid = '2jEvRuKmfBJTRa7QowDpNN'
-    const cheqdDid = 'did:cheqd:testnet:d37eba59-513d-42d3-8f9f-d1df0548b675'
-    const indyDid = `did:indy:${indyNetworkConfig.indyNamespace}:${unqualifiedIndyDid}`
-    const didDocumentRelativeKeyId = registry === RegistryOptions.indy ? '#verkey' : '#key-1'
 
-    const did = registry === RegistryOptions.indy ? indyDid : cheqdDid
+    const rootKeyIds: Record<string, string> = {
+      [RegistryOptions.indy]: '#verkey',
+      [RegistryOptions.cheqd]: '#key-1',
+      [RegistryOptions.hedera]: '#did-root-key',
+    }
+
+    const Dids: Record<string, string> = {
+      [RegistryOptions.indy]: `did:indy:${indyNetworkConfig.indyNamespace}:${unqualifiedIndyDid}`,
+      [RegistryOptions.cheqd]: 'did:cheqd:testnet:d37eba59-513d-42d3-8f9f-d1df0548b675',
+      [RegistryOptions.hedera]: 'did:hedera:testnet:44eesExqdsUvLZ35FpnBPErqRGRnYbzzyG3wgCCYxkmq_0.0.6231121',
+    }
+
+    const didDocumentRelativeKeyId = rootKeyIds[registry]
+    const did = Dids[registry]
+
     const { privateJwk } = transformPrivateKeyToPrivateJwk({
       type: {
         crv: 'Ed25519',

demo/src/FaberInquirer.ts

@@ -90,7 +90,9 @@ export class FaberInquirer extends BaseInquirer {
   }
 
   public async credential() {
-    const registry = await prompt([this.inquireOptions([RegistryOptions.indy, RegistryOptions.cheqd])])
+    const registry = await prompt([
+      this.inquireOptions([RegistryOptions.indy, RegistryOptions.cheqd, RegistryOptions.hedera]),
+    ])
     await this.faber.importDid(registry.options)
     await this.faber.issueCredential()
     const title = 'Is the credential offer accepted?'

packages/hedera/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+
+## 0.5.13
+
+### Patch Changes
+
+- Added Hedera module 
+

packages/hedera/README.md

@@ -0,0 +1,31 @@
+<p align="center">
+  <br />
+  <img
+    alt="Credo Logo"
+    src="https://github.com/openwallet-foundation/credo-ts/blob/c7886cb8377ceb8ee4efe8d264211e561a75072d/images/credo-logo.png"
+    height="250px"
+  />
+</p>
+<h1 align="center"><b>Credo Hedera Module</b></h1>
+<p align="center">
+  <a
+    href="https://raw.githubusercontent.com/openwallet-foundation/credo-ts/main/LICENSE"
+    ><img
+      alt="License"
+      src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"
+  /></a>
+  <a href="https://www.typescriptlang.org/"
+    ><img
+      alt="typescript"
+      src="https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg"
+  /></a>
+    <a href="https://www.npmjs.com/package/@credo-ts/hedera"
+    ><img
+      alt="@credo-ts/hedera version"
+      src="https://img.shields.io/npm/v/@credo-ts/hedera"
+  /></a>
+
+</p>
+<br />
+
+Credo hedera provides integration of the Hedera network into Credo. See the [Hedera Setup](https://credo.js.org/guides/getting-started/set-up/hedera) for installation instructions.

packages/hedera/jest.config.ts

@@ -0,0 +1,14 @@
+import type { Config } from '@jest/types'
+
+import base from '../../jest.config.base'
+
+import packageJson from './package.json'
+
+const config: Config.InitialOptions = {
+  ...base,
+  displayName: packageJson.name,
+  setupFilesAfterEnv: ['./tests/setup.ts'],
+  coveragePathIgnorePatterns: ['../tests'],
+}
+
+export default config

packages/hedera/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@credo-ts/hedera",
+  "main": "src/index",
+  "types": "src/index",
+  "version": "0.5.13",
+  "files": ["build"],
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "homepage": "https://github.com/openwallet-foundation/credo-ts/tree/main/packages/hedera",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/openwallet-foundation/credo-ts",
+    "directory": "packages/hedera"
+  },
+  "scripts": {
+    "build": "pnpm run clean && pnpm run compile",
+    "clean": "rimraf ./build",
+    "compile": "tsc -p tsconfig.build.json",
+    "prepublishOnly": "pnpm run build",
+    "test": "jest",
+    "test:coverage": "jest --coverage",
+    "style:check": "biome check --unsafe",
+    "style:fix": "biome check --write --unsafe"
+  },
+  "dependencies": {
+    "@credo-ts/anoncreds": "workspace:*",
+    "@credo-ts/core": "workspace:*",
+    "@hashgraph/sdk": "^2.72.0",
+    "@hiero-did-sdk/anoncreds": "^0.1.3",
+    "@hiero-did-sdk/client": "^0.1.3",
+    "@hiero-did-sdk/core": "^0.1.3",
+    "@hiero-did-sdk/hcs": "^0.1.3",
+    "@hiero-did-sdk/publisher-internal": "^0.1.3",
+    "@hiero-did-sdk/registrar": "^0.1.3",
+    "@hiero-did-sdk/resolver": "^0.1.3"
+  },
+  "devDependencies": {
+    "@credo-ts/node": "workspace:*",
+    "@hyperledger/anoncreds-nodejs": "^0.3.1",
+    "rimraf": "^4.4.0",
+    "zstd-napi": "^0.0.10"
+  }
+}

packages/hedera/src/HederaModule.ts

@@ -0,0 +1,32 @@
+import { DependencyManager, Module } from '@credo-ts/core'
+
+import { AgentConfig, Buffer } from '@credo-ts/core'
+
+import { HederaModuleConfig, HederaModuleConfigOptions } from './HederaModuleConfig'
+import { HederaLedgerService } from './ledger/HederaLedgerService'
+
+export class HederaModule implements Module {
+  public readonly config: HederaModuleConfig
+
+  public constructor(config: HederaModuleConfigOptions) {
+    this.config = new HederaModuleConfig(config)
+  }
+
+  public register(dependencyManager: DependencyManager) {
+    // Warn about experimental module
+    dependencyManager
+      .resolve(AgentConfig)
+      .logger.warn(
+        "The '@credo-ts/hedera' module is experimental and could have unexpected breaking changes. When using this module, make sure to use strict versions for all @credo-ts packages."
+      )
+
+    // Register config
+    dependencyManager.registerInstance(HederaModuleConfig, this.config)
+    dependencyManager.registerSingleton(HederaLedgerService)
+
+    // Hedera module needs Buffer to be available globally
+    // If it is not available yet, we overwrite it with the
+    // Buffer implementation from Credo
+    global.Buffer = global.Buffer || Buffer
+  }
+}

packages/hedera/src/HederaModuleConfig.ts

@@ -0,0 +1,11 @@
+import { HederaAnoncredsRegistryConfiguration } from '@hiero-did-sdk/anoncreds'
+
+export interface HederaModuleConfigOptions extends HederaAnoncredsRegistryConfiguration {}
+
+export class HederaModuleConfig {
+  public readonly options: HederaModuleConfigOptions
+
+  public constructor(options: HederaModuleConfigOptions) {
+    this.options = options
+  }
+}