Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: indy sdk aries askar migration script #1289

Merged
Show file tree
Hide file tree
Changes from 13 commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
e50ae61
feat(iam): setup package
Feb 12, 2023
144718e
feat: setup some base components
Feb 12, 2023
76e0a8e
chore: remove empty comment line
Feb 12, 2023
a8fc0e2
fix: masterPass -> masterPassword
Feb 12, 2023
2591f7f
chore: push to have fallback
Feb 16, 2023
b79dc58
fix: removed all dependencies
Mar 2, 2023
f93b197
formatted the credentialTags code
Mar 2, 2023
887a813
added test and initial work on the link secret
Mar 2, 2023
f8e423c
fix(migration): added credentials. some TODOs left
Mar 6, 2023
fac9efb
working on tests
Mar 13, 2023
66578f3
feat: working backups
Mar 13, 2023
da2ab24
Update packages/indy-sdk-to-askar-migration/src/utils.ts
berendsliedrecht Mar 14, 2023
c937ad4
fix: more strict checks
Mar 14, 2023
8bc0b26
fix: logger is not optional
Mar 14, 2023
d166be6
fix: improved log messages and removed nodejs check
Mar 14, 2023
d73fbc3
fix: remove console logger from tests
Mar 14, 2023
caa99fd
fix: update the script so migration also happens
Mar 14, 2023
d48c39e
fix: typos
Mar 14, 2023
fa1c488
fix: add warning log for when Node.JS is used
Mar 14, 2023
e2e9846
fix: improved log levels and formatting
Mar 14, 2023
4997517
chore: use highest patch version
Mar 14, 2023
748545a
fix: use released askar
Mar 16, 2023
4c0c99f
Merge branch 'main' into feat/indy-sdk-aries-askar-migration-script
berendsliedrecht Mar 16, 2023
f5605d8
fix: remove reflect-metadata
Mar 16, 2023
e17de56
fix: correct afj version
Mar 16, 2023
419d81b
fix: depend on same askar version
Mar 16, 2023
92cd9d9
fix: credential definition is not supported
Mar 16, 2023
a4dad1c
fix: added a small script for checking if the restore works
Mar 16, 2023
cc2c779
Merge branch 'main' into feat/indy-sdk-aries-askar-migration-script
berendsliedrecht Mar 18, 2023
80044bb
Merge branch 'main' into feat/indy-sdk-aries-askar-migration-script
genaris Mar 18, 2023
473db1a
test: run askar migration only in node18
TimoGlastra Mar 18, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 55 additions & 0 deletions packages/indy-sdk-to-askar-migration/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
<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 Indy SDK To Askar Migration Module</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/indy-sdk-to-askar-migration"
><img
alt="@aries-framework/indy-sdk-to-askar-migration version"
src="https://img.shields.io/npm/v/@aries-framework/indy-sdk-to-askar-migration"
/></a>

</p>
<br />

Indy SDK to Askar migration module for [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript.git).

### 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/indy-sdk-to-askar-migration" peerDependencies
```

Then add the indy-sdk-toaskar-migration module to your project.

```sh
yarn add @aries-framework/indy-sdk-to-askar-migration
```
berendsliedrecht marked this conversation as resolved.
Show resolved Hide resolved

### Quick start

In order for this module to work, we have to inject it into the agent to access agent functionality. See the example for more information.

### Example of usage

```ts
// TODO
```
14 changes: 14 additions & 0 deletions packages/indy-sdk-to-askar-migration/jest.config.ts
Original file line number Diff line number Diff line change
@@ -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,
name: packageJson.name,
displayName: packageJson.name,
setupFilesAfterEnv: ['./tests/setup.ts'],
}

export default config
40 changes: 40 additions & 0 deletions packages/indy-sdk-to-askar-migration/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
{
"name": "@aries-framework/indy-sdk-to-askar-migration",
"main": "build/index",
"types": "build/index",
"version": "0.3.3",
"files": [
"build"
],
"license": "Apache-2.0",
"publishConfig": {
"access": "public"
},
"homepage": "https://github.com/hyperledger/aries-framework-javascript/tree/main/packages/indy-sdk-to-askar-migration",
"repository": {
"type": "git",
"url": "https://github.com/hyperledger/aries-framework-javascript",
"directory": "packages/indy-sdk-to-askar-migration"
},
"scripts": {
"build": "yarn run clean && yarn run compile",
"clean": "rimraf ./build",
"compile": "tsc -p tsconfig.build.json",
"prepublishOnly": "yarn run build",
"test": "jest"
},
"dependencies": {
"@aries-framework/anoncreds": "0.4.0-alpha.71",
"@aries-framework/askar": "0.4.0-alpha.71",
"@aries-framework/core": "0.4.0-alpha.71",
"@aries-framework/indy-sdk": "0.4.0-alpha.71",
"@aries-framework/node": "0.4.0-alpha.71",
"@hyperledger/aries-askar-shared": "file:/Users/beri/Developer/work/hyperledger/aries-askar/wrappers/javascript/aries-askar-shared"
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will replace the local files when they are released again.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't the reference to @aries-framework/* packages point to * instead of an specific version (0.4.0-alpha.71)?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should use 0.3.3 (will be updated when released)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are there any blockers for a new release? Otherwise we can cut one today

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, the. migration addition. So just releasing the wrappers would be good.

},
"devDependencies": {
"@hyperledger/aries-askar-nodejs": "file:/Users/beri/Developer/work/hyperledger/aries-askar/wrappers/javascript/aries-askar-nodejs",
"indy-sdk": "1.16.0-dev-1655",
berendsliedrecht marked this conversation as resolved.
Show resolved Hide resolved
"rimraf": "^4.0.7",
"typescript": "~4.9.4"
}
}
Loading