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

Verify credential tutorial (Python) #3030

Merged
merged 2 commits into from
Mar 21, 2025
Merged

Verify credential tutorial (Python) #3030

merged 2 commits into from
Mar 21, 2025

Conversation

mDuo13
Copy link
Collaborator

@mDuo13 mDuo13 commented Mar 8, 2025

Companion tutorial to #2960 based on feedback. Demonstrates how to verify that a credential exists and is valid.

Preview link: https://xrpl-dev-portal--verify-cred.preview.redocly.app/docs/tutorials/python/compliance/verify-credential

These steps are not necessary for DepositAuth or many of other forthcoming the use cases that use Credentials as part of Permissioned Domains to grant access to things like Permissioned DEXes, MPTs, etc—because, in those cases, the ledger performs credential verification automatically. However, there are other use cases for Credentials in which you might want to verify them like this.

If you want to create additional credentials for testing with this, you can run the code from #2960.

I expect (someone) to make a separate JavaScript version with a web interface (possibly as a Dev Tool also) eventually. To make the review process easier, I did not try to include both languages in one PR.

@mDuo13 mDuo13 added the new topic Describes a detailed document to be added or expanded in detail label Mar 8, 2025
@mDuo13 mDuo13 marked this pull request as ready for review March 11, 2025 20:16
@mDuo13 mDuo13 added the needs japanese translation PRs with English changes that need to be added/updated in the Japanese translation of the site label Mar 12, 2025
maria-robobug
maria-robobug previously approved these changes Mar 19, 2025
Copy link
Contributor

@maria-robobug maria-robobug left a comment

Choose a reason for hiding this comment

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

LGTM, just added a few minor comments.

FYI, I encountered an issue when running the credential issuer code on my Mac (nothing to do with the code itself, just Flask and macOS issues). Basically it looks like port 5000 is already used by macOS Sequoia (and probably previous versions) for the AirPlay Receiver, if it's enabled. We should suggest that Mac users try a different port from the default Flask port if they have this enabled:

flask --app issuer_service run --port 8000 

More info here:
https://stackoverflow.com/questions/72795799/how-to-solve-403-error-with-flask-in-python

mDuo13 added 2 commits March 20, 2025 16:52
verify_credential: comment out unused error

Verify credential: implement commandline usage

Add verify creds tutorial

Verify credential: expand example usage

Verify credential: clarify Python version

Verify Credential: add description metadata

Apply suggestions from @maria-robobug review

Co-authored-by: Maria Shodunke <[email protected]>

Credential Verification: Add hex example & remove old TODO
@mDuo13
Copy link
Collaborator Author

mDuo13 commented Mar 21, 2025

Applied review changes, rebased & squashed, and added links between the two Credentials tutorials.

@mDuo13 mDuo13 merged commit 94e1d9c into master Mar 21, 2025
5 of 6 checks passed
@mDuo13 mDuo13 deleted the verify_cred branch March 21, 2025 17:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs japanese translation PRs with English changes that need to be added/updated in the Japanese translation of the site new topic Describes a detailed document to be added or expanded in detail
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants