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: custom wallet URI scheme #578

Merged

Conversation

genaris
Copy link
Contributor

@genaris genaris commented Jul 9, 2024

A proposal to make wallet deep link URI scheme configurable, so it may not only be used with BC Wallet (bcwallet://) but also with any Aries-capable agent that implements the concept defined in Aries RFC 0268.

It basically consists on using WALLET_DEEP_LINK_PREFIX environment variable on the controller to set the URI scheme and host used as a prefix. For example, 'didcomm://oob-invitation' for URLs such as didcomm://oob-invitation?c_i={base64encoded msg}.

It keeps the default bcwallet://aries_proof-request to make this straightforward for BCGov use case.

I hope you like it as much as we had fun using this project 🎉

genaris added 2 commits July 9, 2024 19:06
Signed-off-by: Ariel Gentile <[email protected]>
Signed-off-by: Ariel Gentile <[email protected]>
@genaris genaris force-pushed the feat/custom-wallet-uri-scheme branch from dcee226 to 37be6e0 Compare July 9, 2024 22:46
loneil
loneil previously approved these changes Jul 10, 2024
Copy link
Contributor

@loneil loneil left a comment

Choose a reason for hiding this comment

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

We've discussed making this configurable, hadn't gotten around to adding the config so this is exactly what we'd set up. Thanks! 😄

I'll note we use aries_proof-request after the URI scheme, but it doesn't seem to matter to the BC Wallet what that string is. So that could optionally be configurable I guess if other wallets may care about that or something.

@genaris genaris force-pushed the feat/custom-wallet-uri-scheme branch from d1adad7 to a26e971 Compare July 10, 2024 12:12
@genaris
Copy link
Contributor Author

genaris commented Jul 10, 2024

We've discussed making this configurable, hadn't gotten around to adding the config so this is exactly what we'd set up. Thanks! 😄

I'll note we use aries_proof-request after the URI scheme, but it doesn't seem to matter to the BC Wallet what that string is. So that could optionally be configurable I guess if other wallets may care about that or something.

Thanks for the comment! Certainly, both BC Wallet and some other apps won't care about the host part of the deep link when using their own custom URI scheme. However, I think you are right and it's worth to make it more flexible from the beginning, so I did some small modifications to convert this environment variable into a complete prefix.

Copy link
Member

@esune esune left a comment

Choose a reason for hiding this comment

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

LGTM 👍🏻
Thanks @genaris!

@esune esune merged commit 4cf5899 into openwallet-foundation:main Jul 11, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants