-
Notifications
You must be signed in to change notification settings - Fork 295
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(cactus-plugin-ledger-connector-aries): add new connector plugin
- Add new plugin for connecting with aries agents and indy ledger.
- Currently it supports only connecting to other aries agents and verifying
proofs.
- Add integration tests in `cactus-test-plugin-ledger-connector-aries`.
- Update `cactus-example-discounted-asset-trade` to use the connector instead
of plain aries agent.
Depends on #2946
Signed-off-by: Michal Bajer <[email protected]>- Loading branch information
Showing
49 changed files
with
5,391 additions
and
154 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -1901,6 +1901,33 @@ jobs: | |
| restore-keys: | | ||
| ${{ runner.os }}-yarn-${{ hashFiles('./yarn.lock') }} | ||
| - run: ./tools/ci.sh | ||
| cactus-test-plugin-ledger-connector-aries: | ||
| continue-on-error: false | ||
| env: | ||
| FULL_BUILD_DISABLED: true | ||
| JEST_TEST_PATTERN: packages/cactus-test-plugin-ledger-connector-aries/src/test/typescript/(unit|integration|benchmark)/.*/*.test.ts | ||
| JEST_TEST_RUNNER_DISABLED: false | ||
| TAPE_TEST_RUNNER_DISABLED: true | ||
| needs: build-dev | ||
| runs-on: ubuntu-20.04 | ||
| steps: | ||
| - name: Use Node.js v16.14.2 | ||
| uses: actions/[email protected] | ||
| with: | ||
| node-version: v16.14.2 | ||
| - uses: actions/[email protected] | ||
| - id: yarn-cache-dir-path | ||
| name: Get yarn cache directory path | ||
| run: echo "::set-output name=dir::$(yarn cache dir)" | ||
| - id: yarn-cache | ||
| name: Restore Yarn Cache | ||
| uses: actions/[email protected] | ||
| with: | ||
| key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }} | ||
| path: ${{ steps.yarn-cache-dir-path.outputs.dir }} | ||
| restore-keys: | | ||
| ${{ runner.os }}-yarn- | ||
| - run: ./tools/ci.sh | ||
| cactus-test-plugin-ledger-connector-ethereum: | ||
| continue-on-error: false | ||
| env: | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
152 changes: 152 additions & 0 deletions
152
examples/cactus-example-discounted-asset-trade/aries-connector.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,152 @@ | ||
| import { IListenOptions, Servers } from "@hyperledger/cactus-common"; | ||
| import { Constants, Configuration } from "@hyperledger/cactus-core-api"; | ||
| import { ConfigUtil } from "@hyperledger/cactus-cmd-socketio-server"; | ||
| import { | ||
| PluginLedgerConnectorAries, | ||
| AriesApiClient, | ||
| } from "@hyperledger/cactus-plugin-ledger-connector-aries"; | ||
|
|
||
| import * as path from "node:path"; | ||
| import * as os from "node:os"; | ||
| import http from "http"; | ||
| import express from "express"; | ||
| import bodyParser from "body-parser"; | ||
| import { readFileSync } from "fs"; | ||
| import { AddressInfo } from "net"; | ||
| import { v4 as uuidv4 } from "uuid"; | ||
| import { getLogger } from "log4js"; | ||
| import { Server as SocketIoServer } from "socket.io"; | ||
|
|
||
| const config: any = ConfigUtil.getConfig(); | ||
| const moduleName = "aries-connector"; | ||
| const logger = getLogger(`${moduleName}`); | ||
| logger.level = config.logLevel; | ||
|
|
||
| // Constants | ||
| const BLP_AGENT_NAME = "cactiDiscountedAssetTradeAgent"; | ||
| const BLP_AGENT_INBOUND_URL = "http://127.0.0.1:5035"; | ||
| const DID_INDY_NAMESPACE = "cacti:test"; | ||
|
|
||
| const ARIES_WALLET_PATH = path.join( | ||
| os.homedir(), | ||
| ".cacti/cactus-example-discounted-asset-trade/wallet", | ||
| ); | ||
|
|
||
| // Read Genesis transactions | ||
| const genesisTransactionsPath = | ||
| "/etc/cactus/indy-all-in-one/pool_transactions_genesis"; | ||
| logger.info( | ||
| "Reading Indy genesis transactions from file:", | ||
| genesisTransactionsPath, | ||
| ); | ||
| const genesisTransactions = readFileSync(genesisTransactionsPath).toString( | ||
| "utf-8", | ||
| ); | ||
|
|
||
| /** | ||
| * Configuration for local indy-all-in-one ledger. | ||
| */ | ||
| export const localTestNetwork = { | ||
| isProduction: false, | ||
| genesisTransactions, | ||
| indyNamespace: DID_INDY_NAMESPACE, | ||
| connectOnStartup: true, | ||
| }; | ||
|
|
||
| // Single Aries connector instance | ||
| let ariesConnectorPlugin: PluginLedgerConnectorAries | undefined = undefined; | ||
| let ariesApiClient: AriesApiClient | undefined = undefined; | ||
|
|
||
| async function createAriesConnector() { | ||
| if (ariesConnectorPlugin) { | ||
| ariesConnectorPlugin.shutdown(); | ||
| ariesConnectorPlugin = undefined; | ||
| } | ||
|
|
||
| ariesConnectorPlugin = new PluginLedgerConnectorAries({ | ||
| instanceId: `ariesAssetTrade-${uuidv4()}`, | ||
| logLevel: config.logLevel, | ||
| walletPath: ARIES_WALLET_PATH, | ||
| ariesAgents: [ | ||
| { | ||
| name: BLP_AGENT_NAME, | ||
| walletKey: BLP_AGENT_NAME, | ||
| indyNetworks: [localTestNetwork], | ||
| inboundUrl: BLP_AGENT_INBOUND_URL, | ||
| autoAcceptConnections: true, | ||
| }, | ||
| ], | ||
| }); | ||
|
|
||
| await ariesConnectorPlugin.onPluginInit(); | ||
|
|
||
| // Run http server | ||
| const expressApp = express(); | ||
| expressApp.use(bodyParser.json({ limit: "250mb" })); | ||
| const connectorServer = http.createServer(expressApp); | ||
| const listenOptions: IListenOptions = { | ||
| hostname: "127.0.0.1", | ||
| port: 0, | ||
| server: connectorServer, | ||
| }; | ||
| const addressInfo = (await Servers.listen(listenOptions)) as AddressInfo; | ||
| const apiHost = `http://${addressInfo.address}:${addressInfo.port}`; | ||
|
|
||
| // Run socketio server | ||
| const socketioServer = new SocketIoServer(connectorServer, { | ||
| path: Constants.SocketIoConnectionPathV1, | ||
| }); | ||
|
|
||
| // Register services | ||
| await ariesConnectorPlugin.getOrCreateWebServices(); | ||
| await ariesConnectorPlugin.registerWebServices(expressApp, socketioServer); | ||
|
|
||
| // Create ApiClient | ||
| const apiConfig = new Configuration({ basePath: apiHost }); | ||
| ariesApiClient = new AriesApiClient(apiConfig); | ||
| } | ||
|
|
||
| /** | ||
| * Create aries connector | ||
| */ | ||
| export async function initAriesConnector(): Promise<void> { | ||
| if (!ariesConnectorPlugin) { | ||
| await createAriesConnector(); | ||
| logger.info("initAriesConnector() done."); | ||
| } else { | ||
| logger.info("initAriesConnector() Aries connector already initialized"); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Get instance of aries connector, initialize it if not done yet. | ||
| */ | ||
| export async function getAriesConnector(): Promise<PluginLedgerConnectorAries> { | ||
| if (!ariesConnectorPlugin) { | ||
| await initAriesConnector(); | ||
| } | ||
|
|
||
| if (ariesConnectorPlugin) { | ||
| return ariesConnectorPlugin; | ||
| } else { | ||
| throw new Error("Could not initialize new aries connector!"); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Get instance of aries api client. | ||
| */ | ||
| export function getAriesApiClient(): AriesApiClient { | ||
| if (ariesApiClient) { | ||
| return ariesApiClient; | ||
| } else { | ||
| throw new Error("Aries connector not initialized yet!"); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Get BLP agent name registered in connector | ||
| */ | ||
| export function getBlpAgentName(): string { | ||
| return BLP_AGENT_NAME; | ||
| } |
Oops, something went wrong.