feat: indy sdk aries askar migration script #1289

berendsliedrecht · 2023-02-12T20:40:07Z

feat: setup package
feat: setup some base components

codecov-commenter · 2023-02-12T21:14:58Z

Codecov Report

Merging #1289 (80044bb) into main (5f71dc2) will decrease coverage by 4.88%.
The diff coverage is 62.74%.

@@            Coverage Diff             @@
##             main    #1289      +/-   ##
==========================================
- Coverage   85.42%   80.55%   -4.88%     
==========================================
  Files         782      765      -17     
  Lines       19167    19038     -129     
  Branches     3116     3099      -17     
==========================================
- Hits        16374    15336    -1038     
- Misses       2786     3695     +909     
  Partials        7        7

Impacted Files	Coverage Δ
packages/indy-sdk-to-askar-migration/src/utils.ts	`6.25% <6.25%> (ø)`
...ar-migration/src/IndySdkToAskarMigrationUpdater.ts	`67.02% <67.02%> (ø)`
...gration/src/errors/IndySdkToAskarMigrationError.ts	`100.00% <100.00%> (ø)`
packages/indy-sdk-to-askar-migration/src/index.ts	`100.00% <100.00%> (ø)`

... and 86 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

packages/indy-sdk-to-askar-migration/src/IndySdkToAskarMigrationUpdater.ts

packages/indy-sdk-to-askar-migration/package.json

Signed-off-by: blu3beri <[email protected]>

berendsliedrecht · 2023-03-13T15:35:54Z

packages/indy-sdk-to-askar-migration/package.json

+    "@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"


Will replace the local files when they are released again.

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

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

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

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

genaris

Didn't do a deep review yet but left a few acid remarks regarding the scope and to :clarifying it 💥

genaris · 2023-03-14T01:16:33Z

packages/indy-sdk-to-askar-migration/package.json

+    "@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"


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

packages/indy-sdk-to-askar-migration/src/IndySdkToAskarMigrationUpdater.ts

genaris · 2023-03-14T01:39:02Z

packages/indy-sdk-to-askar-migration/src/IndySdkToAskarMigrationUpdater.ts

+ * Migration class to move a wallet form the indy-sdk structure to the new
+ * askar wallet structure.
+ *
+ * Right now, this is ONLY supported within React Native environments AND only sqlite.


I think this disclaimer is fine here but should be part of the README.

I understand the reasons about stating that it works in React Native because it assumes that no issuer or verifier side has been supported there officially, but I don't think it is accurate as we can also have a NodeJS holder-role agent that would be in the same situation.

Also, what about mediation records? Mediator configuration is not taken into account. In that case you assume only current Bifold case where a mediatorInvite is provided at startup and there is apparently no problem on creating the mediation coordination again. But that's not necessarily the case of every app using AFJ.

What about apps using generic records module? And those that have custom plug-ins that store custom records? 🤯

The latter case is maybe extreme (don't worry for us, as we are starting production using 0.4.0 right away 😎 ), but generic records and maybe proofs are used in some mobile wallets.

I think all the cases you described should work in Node.JS, however it's not too much work to add credential definitions (the only one missing) after which it will fully work in Node.JS. We can do that in an upcoming release I think

Yeah we would only need to create migration for the indy records, like Indy::Key or Indy::Credential. Every custom afj record does not need additional conversion, just moving to a different table (which is dan with the new askar ffi function).

Node.js and postgres should be trivial, without any breaking changes, to add but not a MUST required for now.

Ah good to see that all records are copied (it´s not always a good idea to review a PR at midnight). So if the only missing objects in migration are the Credential Definitions I think it makes more sense to allow migration in NodeJS as not all server deployments are used to issue credentials (we have a mediator for instance, or other services that verify but not issue credentials).

packages/indy-sdk-to-askar-migration/package.json

genaris · 2023-03-14T01:43:37Z

yarn.lock

@@ -10,6 +10,88 @@
    "@jridgewell/gen-mapping" "^0.1.0"
    "@jridgewell/trace-mapping" "^0.3.9"

+"@aries-framework/[email protected]", "@aries-framework/[email protected]+a4204ef2":


These additions here can be avoided if using * for modules in package.json

packages/indy-sdk-to-askar-migration/src/IndySdkToAskarMigrationUpdater.ts

packages/indy-sdk-to-askar-migration/README.md

packages/indy-sdk-to-askar-migration/src/IndySdkToAskarMigrationUpdater.ts

packages/indy-sdk-to-askar-migration/src/utils.ts

packages/indy-sdk-to-askar-migration/tests/migrate.test.ts

TimoGlastra · 2023-03-14T08:27:26Z

packages/indy-sdk-to-askar-migration/tests/migrate.test.ts

+  // TODO: update with an aca-py issued revokable credential
+  // community agent MIGHT have revocrevoc


community agent has a tails server set-up so that should work

packages/indy-sdk-to-askar-migration/tests/migrate.test.ts

Co-authored-by: Timo Glastra <[email protected]> Signed-off-by: Berend Sliedrecht <[email protected]>

Signed-off-by: blu3beri <[email protected]>

packages/indy-sdk-to-askar-migration/src/IndySdkToAskarMigrationUpdater.ts

Signed-off-by: blu3beri <[email protected]>

packages/indy-sdk-to-askar-migration/src/IndySdkToAskarMigrationUpdater.ts

Signed-off-by: blu3beri <[email protected]>

berendsliedrecht · 2023-03-14T13:00:45Z

@TimoGlastra @genaris I think I will do a release of the askar wrappers and after that it should be ready for a rereview.

Signed-off-by: blu3beri <[email protected]>

packages/indy-sdk-to-askar-migration/package.json

packages/indy-sdk-to-askar-migration/src/IndySdkToAskarMigrationUpdater.ts

TimoGlastra · 2023-03-16T10:25:36Z

packages/indy-sdk-to-askar-migration/src/IndySdkToAskarMigrationUpdater.ts

+
+      for (const row of credentials) {
+        this.agent.config.logger.debug(`Migrating ${row.name} to the new askar format`)
+        const data = JSON.parse(row.value as string) as {


how does this type differ from AnonCredsCredential interface?

I see it has rev_reg and witness keys. Are those added when stored, or are those also transfered over the wire from issuer to holder?

I see it has rev_reg and witness keys. Are those added when stored, or are those also transfered over the wire from issuer to holder?

I am not entirely sure what you mean here.

how does this type differ from AnonCredsCredential interface?

I think I can use the AnonCredsCredential interface, this was just the object I saw after logging it.

I see your interface contains the rev_reg and witness properties, but these are not in the AnonCredsCredential. Do you know if these properties are added when storing to the credential, or is the interface we have in AFJ incorrect (and we should add those keys to that interface)

yarn.lock

packages/indy-sdk-to-askar-migration/tests/migrate.test.ts

packages/indy-sdk-to-askar-migration/src/IndySdkToAskarMigrationUpdater.ts

Signed-off-by: blu3beri <[email protected]>

Signed-off-by: Timo Glastra <[email protected]>

Initial version ready for mege

berendsliedrecht changed the title ~~feat/indy sdk aries askar migration script~~ feat: indy sdk aries askar migration script Feb 12, 2023

berendsliedrecht commented Mar 2, 2023

View reviewed changes

packages/indy-sdk-to-askar-migration/src/IndySdkToAskarMigrationUpdater.ts Outdated Show resolved Hide resolved

TimoGlastra reviewed Mar 2, 2023

View reviewed changes

packages/indy-sdk-to-askar-migration/package.json Outdated Show resolved Hide resolved

blu3beri added 10 commits March 13, 2023 14:42

feat(iam): setup package

e50ae61

Signed-off-by: blu3beri <[email protected]>

feat: setup some base components

144718e

Signed-off-by: blu3beri <[email protected]>

chore: remove empty comment line

76e0a8e

Signed-off-by: blu3beri <[email protected]>

fix: masterPass -> masterPassword

a8fc0e2

Signed-off-by: blu3beri <[email protected]>

chore: push to have fallback

2591f7f

Signed-off-by: blu3beri <[email protected]>

fix: removed all dependencies

b79dc58

Signed-off-by: blu3beri <[email protected]>

formatted the credentialTags code

f93b197

Signed-off-by: blu3beri <[email protected]>

added test and initial work on the link secret

887a813

Signed-off-by: blu3beri <[email protected]>

fix(migration): added credentials. some TODOs left

f8e423c

Signed-off-by: blu3beri <[email protected]>

working on tests

fac9efb

Signed-off-by: blu3beri <[email protected]>

berendsliedrecht force-pushed the feat/indy-sdk-aries-askar-migration-script branch from 43e45cb to fac9efb Compare March 13, 2023 13:43

feat: working backups

66578f3

Signed-off-by: blu3beri <[email protected]>

berendsliedrecht marked this pull request as ready for review March 13, 2023 15:30

berendsliedrecht requested a review from a team as a code owner March 13, 2023 15:30

berendsliedrecht commented Mar 13, 2023

View reviewed changes

genaris previously requested changes Mar 14, 2023

View reviewed changes

TimoGlastra requested changes Mar 14, 2023

View reviewed changes

berendsliedrecht and others added 2 commits March 14, 2023 09:38

Update packages/indy-sdk-to-askar-migration/src/utils.ts

da2ab24

Co-authored-by: Timo Glastra <[email protected]> Signed-off-by: Berend Sliedrecht <[email protected]>

fix: more strict checks

c937ad4

Signed-off-by: blu3beri <[email protected]>

TimoGlastra reviewed Mar 14, 2023

View reviewed changes

packages/indy-sdk-to-askar-migration/src/IndySdkToAskarMigrationUpdater.ts Outdated Show resolved Hide resolved

blu3beri added 4 commits March 14, 2023 12:11

fix: logger is not optional

8bc0b26

Signed-off-by: blu3beri <[email protected]>

fix: improved log messages and removed nodejs check

d166be6

Signed-off-by: blu3beri <[email protected]>

fix: remove console logger from tests

d73fbc3

Signed-off-by: blu3beri <[email protected]>

fix: update the script so migration also happens

caa99fd

Signed-off-by: blu3beri <[email protected]>

genaris reviewed Mar 14, 2023

View reviewed changes

packages/indy-sdk-to-askar-migration/src/IndySdkToAskarMigrationUpdater.ts Outdated Show resolved Hide resolved

genaris reviewed Mar 14, 2023

View reviewed changes

packages/indy-sdk-to-askar-migration/src/IndySdkToAskarMigrationUpdater.ts Outdated Show resolved Hide resolved

blu3beri added 4 commits March 14, 2023 13:47

fix: typos

d48c39e

Signed-off-by: blu3beri <[email protected]>

fix: add warning log for when Node.JS is used

fa1c488

Signed-off-by: blu3beri <[email protected]>

fix: improved log levels and formatting

e2e9846

Signed-off-by: blu3beri <[email protected]>

chore: use highest patch version

4997517

Signed-off-by: blu3beri <[email protected]>

blu3beri and others added 3 commits March 16, 2023 10:30

fix: use released askar

748545a

Signed-off-by: blu3beri <[email protected]>

Merge branch 'main' into feat/indy-sdk-aries-askar-migration-script

4c0c99f

fix: remove reflect-metadata

f5605d8

Signed-off-by: blu3beri <[email protected]>

TimoGlastra requested changes Mar 16, 2023

View reviewed changes

blu3beri and others added 5 commits March 16, 2023 12:07

fix: correct afj version

e17de56

Signed-off-by: blu3beri <[email protected]>

fix: depend on same askar version

419d81b

Signed-off-by: blu3beri <[email protected]>

fix: credential definition is not supported

92cd9d9

Signed-off-by: blu3beri <[email protected]>

fix: added a small script for checking if the restore works

a4dad1c

Signed-off-by: blu3beri <[email protected]>

Merge branch 'main' into feat/indy-sdk-aries-askar-migration-script

cc2c779

TimoGlastra approved these changes Mar 18, 2023

View reviewed changes

genaris and others added 2 commits March 18, 2023 08:55

Merge branch 'main' into feat/indy-sdk-aries-askar-migration-script

80044bb

test: run askar migration only in node18

473db1a

Signed-off-by: Timo Glastra <[email protected]>

TimoGlastra enabled auto-merge (squash) March 18, 2023 16:06

TimoGlastra merged commit 4a6b99c into openwallet-foundation:main Mar 18, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: indy sdk aries askar migration script #1289

feat: indy sdk aries askar migration script #1289

berendsliedrecht commented Feb 12, 2023 •

edited

Loading

codecov-commenter commented Feb 12, 2023 •

edited

Loading

berendsliedrecht Mar 13, 2023

genaris Mar 14, 2023

TimoGlastra Mar 14, 2023

TimoGlastra Mar 14, 2023

berendsliedrecht Mar 14, 2023

genaris left a comment

genaris Mar 14, 2023

genaris Mar 14, 2023

TimoGlastra Mar 14, 2023

berendsliedrecht Mar 14, 2023

genaris Mar 14, 2023

genaris Mar 14, 2023

TimoGlastra Mar 14, 2023

berendsliedrecht commented Mar 14, 2023

TimoGlastra Mar 16, 2023

berendsliedrecht Mar 16, 2023

TimoGlastra Mar 17, 2023

		// TODO: update with an aca-py issued revokable credential
		// community agent MIGHT have revocrevoc

feat: indy sdk aries askar migration script #1289

feat: indy sdk aries askar migration script #1289

Conversation

berendsliedrecht commented Feb 12, 2023 • edited Loading

codecov-commenter commented Feb 12, 2023 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

genaris left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

berendsliedrecht commented Mar 14, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

berendsliedrecht commented Feb 12, 2023 •

edited

Loading

codecov-commenter commented Feb 12, 2023 •

edited

Loading