openwallet-foundation / credo-ts-ext

Extension libraries for Credo
https://credo.js.org
Apache License 2.0
30 stars 37 forks source link

Upgrade rest package to use latest aries deps #215

Open dblane-digicatapult opened 1 year ago

dblane-digicatapult commented 1 year ago

We are interested in upgrading the rest package to use the latest available versions of aries-framework/core and aries-framework/node. Our primary driver for this is because as far as we can tell earlier versions do not support the abstraction of hyperledger indy. We believe that it is important to display a variety of anoncreds registries and would benefit other users of this REST API.

We have read your contributing guidelines and will conform to the standards set out within.

Can you please indicate if you would like us to proceed with this work or if you have other plans as to why we should not proceed?

TimoGlastra commented 1 year ago

Hey @dblane-digicatapult! Thanks for opening this issue. It's been on our todo list for a long time to update the rest wrapper, but just haven't got around to it.

I just finished wrapping up the updates for push-notifications, react-hooks, redux-store, so if we can also get the rest package to 0.4.0 that would be awesome.

So, definitely would like you to proceed with the work. 👍

mattdean-digicatapult commented 11 months ago

Hi @TimoGlastra. I'm currently working with @dblane-digicatapult on this and had a couple of questions. Specifically whether this should use indy-sdk and continue to use the legacy schema/credential-definition formats from that module or should we try to swap out for indy-vdr, anoncreds, askar etc.?

It seems to me that the latter is clearly the path forward, but this would cause breaking changes to the API presented by the rest package. I'm also struggling to find docs on even using indy-sdk after the restructure which is making me a bit wary of that approach.

Basically are you happy for me to go straight to indy-vdr and the generic anoncreds modules even though it will lead to some breaking changes?

TimoGlastra commented 11 months ago

I'd recommend to update the REST API to use askar, indy-vdr and anoncreds. We're thinking of deprecating the Indy SDK and this would be a good step in that direction. Optionally you could make it configurable, but I'm not sure that would be worth the effort.

cause breaking changes to the API presented by the rest package

This is totally fine! The API of the framework is also constantly changing and as long as we are not at 1.0 yet, I don't want to get into technical debt of keeping the API the same. There's so much moving parts in this industry :)

Basically are you happy for me to go straight to indy-vdr and the generic anoncreds modules even though it will lead to some breaking changes?

💯% yes!

mattdean-digicatapult commented 11 months ago

Fabulous @TimoGlastra, working towards a PR currently. Hopefully have something for you to look at in the next few days. Thanks for the guidance

djleonskennedy commented 8 months ago

@dblane-digicatapult @TimoGlastra will be update 0.4.0 also based on tsoa?