chore: merge 0.3.0-pre into main branch (openwallet-foundation#1057)

Author: TimoGlastra

.eslintrc.js

@@ -99,7 +99,16 @@ module.exports = {
       },
     },
     {
-      files: ['*.test.ts', '**/__tests__/**', '**/tests/**', 'jest.*.ts', 'samples/**', 'demo/**', 'scripts/**'],
+      files: [
+        '*.test.ts',
+        '**/__tests__/**',
+        '**/tests/**',
+        'jest.*.ts',
+        'samples/**',
+        'demo/**',
+        'scripts/**',
+        '**/tests/**',
+      ],
       env: {
         jest: true,
         node: false,

DEVREADME.md

@@ -2,6 +2,11 @@
 
 This file is intended for developers working on the internals of the framework. If you're just looking how to get started with the framework, see the [docs](./docs)
 
+## Installing dependencies
+
+Right now, as a patch that will later be changed, some platforms will have an "error" when installing the dependencies with yarn. This is because the BBS signatures library that we use is built for Linux x86 and MacOS x86 (and not Windows and MacOS arm). This means that it will show that it could not download the binary.
+This is not an error for developers, the library that fails is `node-bbs-signaturs` and is an optional dependency for perfomance improvements. It will fallback to a, slower, wasm build.
+
 ## Running tests
 
 Test are executed using jest. Some test require either the **mediator agents** or the **ledger** to be running. When running tests that require a connection to the ledger pool, you need to set the `TEST_AGENT_PUBLIC_DID_SEED` and `GENESIS_TXN_PATH` environment variables.

demo/src/Alice.ts

@@ -52,11 +52,17 @@ export class Alice extends BaseAgent {
   }
 
   public async acceptProofRequest(proofRecord: ProofRecord) {
-    const retrievedCredentials = await this.agent.proofs.getRequestedCredentialsForProofRequest(proofRecord.id, {
-      filterByPresentationPreview: true,
+    const requestedCredentials = await this.agent.proofs.autoSelectCredentialsForProofRequest({
+      proofRecordId: proofRecord.id,
+      config: {
+        filterByPresentationPreview: true,
+      },
+    })
+
+    await this.agent.proofs.acceptRequest({
+      proofRecordId: proofRecord.id,
+      proofFormats: requestedCredentials.proofFormats,
     })
-    const requestedCredentials = this.agent.proofs.autoSelectCredentialsForProofRequest(retrievedCredentials)
-    await this.agent.proofs.acceptRequest(proofRecord.id, requestedCredentials)
     console.log(greenText('\nProof request accepted!\n'))
   }
 

demo/src/BaseAgent.ts

@@ -31,6 +31,7 @@ export class BaseAgent {
         {
           genesisTransactions: bcovrin,
           id: 'greenlights' + name,
+          indyNamespace: 'greenlights' + name,
           isProduction: false,
         },
       ],
@@ -42,7 +43,7 @@ export class BaseAgent {
 
     this.config = config
 
-    this.agent = new Agent(config, agentDependencies)
+    this.agent = new Agent({ config, dependencies: agentDependencies })
     this.agent.registerInboundTransport(new HttpInboundTransport({ port }))
     this.agent.registerOutboundTransport(new HttpOutboundTransport())
   }

demo/src/Faber.ts

@@ -3,10 +3,11 @@ import type { CredDef, Schema } from 'indy-sdk'
 import type BottomBar from 'inquirer/lib/ui/bottom-bar'
 
 import {
-  V1CredentialPreview,
   AttributeFilter,
   ProofAttributeInfo,
+  ProofProtocolVersion,
   utils,
+  V1CredentialPreview,
   ConnectionEventTypes,
 } from '@aries-framework/core'
 import { ui } from 'inquirer'
@@ -187,8 +188,18 @@ export class Faber extends BaseAgent {
     const connectionRecord = await this.getConnectionRecord()
     const proofAttribute = await this.newProofAttribute()
     await this.printProofFlow(greenText('\nRequesting proof...\n', false))
-    await this.agent.proofs.requestProof(connectionRecord.id, {
-      requestedAttributes: proofAttribute,
+
+    await this.agent.proofs.requestProof({
+      protocolVersion: ProofProtocolVersion.V1,
+      connectionId: connectionRecord.id,
+      proofFormats: {
+        indy: {
+          name: 'proof-request',
+          version: '1.0',
+          nonce: '1298236324864',
+          requestedAttributes: proofAttribute,
+        },
+      },
     })
     this.ui.updateBottomBar(
       `\nProof request sent!\n\nGo to the Alice agent to accept the proof request\n\n${Color.Reset}`

docs/getting-started/ledger.md

@@ -18,11 +18,13 @@ const agentConfig: InitConfig = {
   indyLedgers: [
     {
       id: 'sovrin-main',
+      didIndyNamespace: 'sovrin',
       isProduction: true,
       genesisPath: './genesis/sovrin-main.txn',
     },
     {
       id: 'bcovrin-test',
+      didIndyNamespace: 'bcovrin:test',
       isProduction: false,
       genesisTransactions: 'XXXX',
     },

package.json

@@ -57,7 +57,7 @@
     "ts-jest": "^27.0.3",
     "ts-node": "^10.0.0",
     "tsconfig-paths": "^3.9.0",
-    "tsyringe": "^4.6.0",
+    "tsyringe": "^4.7.0",
     "typescript": "~4.3.0",
     "ws": "^7.4.6"
   },

packages/action-menu/README.md

@@ -0,0 +1,78 @@
+<p align="center">
+  <br />
+  <img
+    alt="Hyperledger Aries logo"
+    src="https://raw.githubusercontent.com/hyperledger/aries-framework-javascript/aa31131825e3331dc93694bc58414d955dcb1129/images/aries-logo.png"
+    height="250px"
+  />
+</p>
+<h1 align="center"><b>Aries Framework JavaScript Action Menu Plugin</b></h1>
+<p align="center">
+  <a
+    href="https://raw.githubusercontent.com/hyperledger/aries-framework-javascript/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/@aries-framework/action-menu"
+    ><img
+      alt="@aries-framework/action-menu version"
+      src="https://img.shields.io/npm/v/@aries-framework/action-menu"
+  /></a>
+
+</p>
+<br />
+
+Action Menu plugin for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript.git). Implements [Aries RFC 0509](https://github.com/hyperledger/aries-rfcs/blob/1795d5c2d36f664f88f5e8045042ace8e573808c/features/0509-action-menu/README.md).
+
+### Installation
+
+Make sure you have set up the correct version of Aries Framework JavaScript according to the AFJ repository. To find out which version of AFJ you need to have installed you can run the following command. This will list the required peer dependency for `@aries-framework/core`.
+
+```sh
+npm info "@aries-framework/action-menu" peerDependencies
+```
+
+Then add the action-menu plugin to your project.
+
+```sh
+yarn add @aries-framework/action-menu
+```
+
+### Quick start
+
+In order for this plugin to work, we have to inject it into the agent to access agent functionality. See the example for more information.
+
+### Example of usage
+
+```ts
+import { ActionMenuModule } from '@aries-framework/action-menu'
+
+const agent = new Agent({
+  config: {
+    /* config */
+  },
+  dependencies: agentDependencies,
+  modules: {
+    actionMenu: new ActionMenuModule(),
+    /* other custom modules */
+  },
+})
+
+await agent.initialize()
+
+// To request root menu to a given connection (menu will be received
+// asynchronously in a ActionMenuStateChangedEvent)
+await agent.modules.actionMenu.requestMenu({ connectionId })
+
+// To select an option from the action menu
+await agent.modules.actionMenu.performAction({
+  connectionId,
+  performedAction: { name: 'option-1' },
+})
+```

packages/action-menu/jest.config.ts

@@ -0,0 +1,13 @@
+import type { Config } from '@jest/types'
+
+import base from '../../jest.config.base'
+
+import packageJson from './package.json'
+
+const config: Config.InitialOptions = {
+  ...base,
+  name: packageJson.name,
+  displayName: packageJson.name,
+}
+
+export default config

packages/action-menu/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@aries-framework/action-menu",
+  "main": "build/index",
+  "types": "build/index",
+  "version": "0.2.5",
+  "private": true,
+  "files": [
+    "build"
+  ],
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "homepage": "https://github.com/hyperledger/aries-framework-javascript/tree/main/packages/action-menu",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/hyperledger/aries-framework-javascript",
+    "directory": "packages/action-menu"
+  },
+  "scripts": {
+    "build": "yarn run clean && yarn run compile",
+    "clean": "rimraf -rf ./build",
+    "compile": "tsc -p tsconfig.build.json",
+    "prepublishOnly": "yarn run build",
+    "test": "jest"
+  },
+  "dependencies": {
+    "rxjs": "^7.2.0",
+    "class-transformer": "0.5.1",
+    "class-validator": "0.13.1"
+  },
+  "peerDependencies": {
+    "@aries-framework/core": "0.2.5"
+  },
+  "devDependencies": {
+    "@aries-framework/node": "0.2.5",
+    "reflect-metadata": "^0.1.13",
+    "rimraf": "~3.0.2",
+    "typescript": "~4.3.0"
+  }
+}