Sonivijayk/fix/issue 2319 docs update to remove indy usage by sonivijayk · Pull Request #3997 · openwallet-foundation/acapy

sonivijayk · 2025-12-23T21:23:20Z

Following changes were done based on issue description:

README.md : Removed indy wallet usage
AliceGetsAPhone.md : Removed indy sdk reference from Present the Proof section
AliceWantsAJsonCredential.md : Removed did:sov
ReusingAConnection.md : Replaced did:sov example with did:peer
ContainerImagesAndGithubActions.md : Removed indy sdk image reference from container docs
deploymentModel.md — Updated storage wording
SelectiveDisclosureJWTs.md : Replaced did:sov kid with did:key in SD-JWT example
SupportedRFCs.md : Added clarification on Askar storage support
JsonLdCredentials.md : Removed did:sov info
DIDMethods.md : Minor change to remove did:sov from Registering a DID method

Signed-off-by: Vijay Soni <vijaysoni@sonivijay.com>

…iceGetsAPhone.md (issue 2319) Signed-off-by: Vijay Soni <vijaysoni@sonivijay.com>

Signed-off-by: Vijay Soni <vijaysoni@sonivijay.com>

Copilot

Pull request overview

This pull request removes references to the deprecated Indy SDK from ACA-Py documentation, updating examples and guidance to use modern alternatives like Askar for storage and did:key/did:peer for DID methods instead of did:sov.

Key Changes:

Replaced Indy SDK wallet references with Askar storage documentation
Updated DID method examples from did:sov to did:key and did:peer
Removed outdated documentation about Indy SDK images and indy-wallet usage

Reviewed changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
docs/features/SupportedRFCs.md	Updated Askar description to clarify it's the current storage solution, removing "DEPRECATED" label that was incorrectly applied
docs/features/SelectiveDisclosureJWTs.md	Replaced did:sov kid examples with did:key in SD-JWT examples
docs/features/JsonLdCredentials.md	Removed did:sov documentation and references, keeping only did:key
docs/features/DIDMethods.md	Updated default supported DID methods to only list did:key
docs/deploying/deploymentModel.md	Modernized storage plugin description to reference Askar instead of Indy SDK
docs/deploying/ContainerImagesAndGithubActions.md	Clarified Indy Image is legacy/no longer produced
docs/demo/ReusingAConnection.md	Replaced did:sov examples with did:peer in invitation examples
docs/demo/README.md	Removed indy wallet type option from performance demo instructions
docs/demo/AliceWantsAJsonCredential.md	Removed did:sov method documentation and related requirements
docs/demo/AliceGetsAPhone.md	Removed specific Indy SDK error reference from proof presentation section

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-12-23T22:12:14Z

docs/features/SelectiveDisclosureJWTs.md

    "typ": "JWT",
    "alg": "EdDSA",
-    "kid": "did:sov:WpVJtxKVwGQdRpQP8iwJZy#key-1"
+    "kid": "did:key:z6Mkt3g9hU7F7Qz7fV5oHfC1H2Q8oM6QWwP5p9nX8tQm#key-1"


The DID in this example appears malformed for a did:key identifier. The did:key method has a specific encoding format where the key material is multibase-encoded. The format shown (z6Mkt3g9hU7F7Qz7fV5oHfC1H2Q8oM6QWwP5p9nX8tQm) may not be a valid did:key identifier, and the fragment reference should typically be "z6Mkt..." without the "#key-1" suffix, as did:key identifiers can be directly dereferenced without fragments. Please verify this is a valid did:key example.

Copilot · 2025-12-23T22:12:14Z

docs/features/SelectiveDisclosureJWTs.md

  },
  "valid": true,
-  "kid": "did:sov:WpVJtxKVwGQdRpQP8iwJZy#key-1",
+  "kid": "did:key:z6Mkt3g9hU7F7Qz7fV5oHfC1H2Q8oM6QWwP5p9nX8tQm#key-1",


The DID in this example appears malformed for a did:key identifier. The did:key method has a specific encoding format where the key material is multibase-encoded. The format shown (z6Mkt3g9hU7F7Qz7fV5oHfC1H2Q8oM6QWwP5p9nX8tQm) may not be a valid did:key identifier, and the fragment reference should typically be "z6Mkt..." without the "#key-1" suffix, as did:key identifiers can be directly dereferenced without fragments. Please verify this is a valid did:key example.

Copilot · 2025-12-23T22:12:14Z

docs/demo/ReusingAConnection.md

    ],
    "services": [
-        "did:sov:4JiUsoK85pVkkB1bAPzFaP"
+        "did:peer:2.4JiUsoK85pVkkB1bAPzFaP4JiUsoK85pVkkB1bAPzFaP"


The did:peer identifier shown is malformed. The format "did:peer:2.4JiUsoK85pVkkB1bAPzFaP4JiUsoK85pVkkB1bAPzFaP" doesn't follow the did:peer specification. A valid did:peer:2 identifier should have the format "did:peer:2.<encoded_service>.<encoded_key>" with proper multibase encoding. The example appears to concatenate unencoded values. Please provide a correctly formatted did:peer example that follows the specification.

Suggested change

"did:peer:2.4JiUsoK85pVkkB1bAPzFaP4JiUsoK85pVkkB1bAPzFaP"

"did:peer:2.Ez6MksLe95M7VKQm2D9p1Zr2wP4G9jVwQZm4tqkbn3G9v3W.Sz6Mkhj5P3yAJi7L4hG2Vx8k1hP9d2s6cB1f4n8qEr7Dx"

Copilot · 2025-12-23T22:12:15Z

docs/demo/ReusingAConnection.md

    ],
    "services": [
-        "did:sov:4JiUsoK85pVkkB1bAPzFaP"
+        "did:peer:2.4JiUsoK85pVkkB1bAPzFaP4JiUsoK85pVkkB1bAPzFaP"


The did:peer identifier shown is malformed. The format "did:peer:2.4JiUsoK85pVkkB1bAPzFaP4JiUsoK85pVkkB1bAPzFaP" doesn't follow the did:peer specification. A valid did:peer:2 identifier should have the format "did:peer:2.<encoded_service>.<encoded_key>" with proper multibase encoding. The example appears to concatenate unencoded values. Please provide a correctly formatted did:peer example that follows the specification.

Suggested change

"did:peer:2.4JiUsoK85pVkkB1bAPzFaP4JiUsoK85pVkkB1bAPzFaP"

"did:peer:2.Ez6LSj5pPzM3gYroG9q4CPGKcPvXHiYAdV5vW7QGjY3qS8p7.z6MkqRYqQiSgvZQdnkY4Cz9C8QG7bZz3WvCfs7xZk1xWnG7H"

Copilot · 2025-12-23T22:12:15Z

docs/demo/ReusingAConnection.md

-example invitation above, the DID is a `did:sov` DID that is resolvable on a public
-Hyperledger Indy network. The DID could also be a [Peer DID] of types 2 or 4,
+example invitation above, the DID is a `did:peer` DID that is resolvable without
+requiring a public ledger. The DID could also be a [Peer DID] of types 2 or 4,


There's a grammatical issue with the phrase "DID could also be a [Peer DID] of types 2 or 4". The article "a" is incorrect when referring to multiple types. It should be "DIDs could also be [Peer DIDs] of types 2 or 4" (plural) or keep singular if referring to a single instance: "The DID could also be a [Peer DID] of type 2 or 4".

Suggested change

requiring a public ledger. The DID could also be a [Peer DID] of types 2 or 4,

requiring a public ledger. The DID could also be a [Peer DID] of type 2 or 4,

…ove-indy-usage

jamshale

Thank you for the contribution. Looks good to me. There's a few co-pilot notes about the examples being malformed but I'm not sure if they really are. I'll ask some other reviewers to have a quick look.

…ove-indy-usage

sonarqubecloud · 2025-12-29T22:42:32Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

…t-foundation#3997) * docs: remove indy wallet usage from README.md (issue 2319) Signed-off-by: Vijay Soni <vijaysoni@sonivijay.com> * docs: removed indy sdk reference from Present the Proof section of AliceGetsAPhone.md (issue 2319) Signed-off-by: Vijay Soni <vijaysoni@sonivijay.com> * removed did:sov from AliceWantsAJsonCredential.md Signed-off-by: Vijay Soni <vijaysoni@sonivijay.com> * replaced did:sov example with did:peer in ReusingAConnection.md Signed-off-by: Vijay Soni <vijaysoni@sonivijay.com> * Removed indy sdk image reference from container docs Signed-off-by: Vijay Soni <vijaysoni@sonivijay.com> * Updated deploymentModel.md storage wording Signed-off-by: Vijay Soni <vijaysoni@sonivijay.com> * Replaced did:sov kid with did:key in SD-JWT example Signed-off-by: Vijay Soni <vijaysoni@sonivijay.com> * Added clarification on Askar storage support in SupportedRFCs.md Signed-off-by: Vijay Soni <vijaysoni@sonivijay.com> * Removed did:sov info from JsonLdCredentials.md Signed-off-by: Vijay Soni <vijaysoni@sonivijay.com> * Minor change to remove did:sov from Registering a DID method section Signed-off-by: Vijay Soni <vijaysoni@sonivijay.com> --------- Signed-off-by: Vijay Soni <vijaysoni@sonivijay.com> Co-authored-by: Vijay Soni <vijaysoni@sonivijay.com> Co-authored-by: jamshale <31809382+jamshale@users.noreply.github.com>

Vijay Soni added 10 commits December 23, 2025 14:15

docs: remove indy wallet usage from README.md (issue 2319)

52277c3

Signed-off-by: Vijay Soni <vijaysoni@sonivijay.com>

docs: removed indy sdk reference from Present the Proof section of Al…

f99def7

…iceGetsAPhone.md (issue 2319) Signed-off-by: Vijay Soni <vijaysoni@sonivijay.com>

removed did:sov from AliceWantsAJsonCredential.md

3b99fa4

Signed-off-by: Vijay Soni <vijaysoni@sonivijay.com>

replaced did:sov example with did:peer in ReusingAConnection.md

67d17b6

Signed-off-by: Vijay Soni <vijaysoni@sonivijay.com>

Removed indy sdk image reference from container docs

eb7b613

Signed-off-by: Vijay Soni <vijaysoni@sonivijay.com>

Updated deploymentModel.md storage wording

6beb00c

Signed-off-by: Vijay Soni <vijaysoni@sonivijay.com>

Replaced did:sov kid with did:key in SD-JWT example

8b91890

Signed-off-by: Vijay Soni <vijaysoni@sonivijay.com>

Added clarification on Askar storage support in SupportedRFCs.md

37793af

Signed-off-by: Vijay Soni <vijaysoni@sonivijay.com>

Removed did:sov info from JsonLdCredentials.md

1a25d3b

Signed-off-by: Vijay Soni <vijaysoni@sonivijay.com>

Minor change to remove did:sov from Registering a DID method section

73f8cb2

Signed-off-by: Vijay Soni <vijaysoni@sonivijay.com>

jamshale requested a review from Copilot December 23, 2025 22:09

Copilot started reviewing on behalf of jamshale December 23, 2025 22:10 View session

Copilot AI reviewed Dec 23, 2025

View reviewed changes

Merge branch 'main' into sonivijayk/fix/issue-2319-docs-update-to-rem…

665e673

…ove-indy-usage

jamshale approved these changes Dec 29, 2025

View reviewed changes

jamshale requested review from esune and swcurran December 29, 2025 17:27

Merge branch 'main' into sonivijayk/fix/issue-2319-docs-update-to-rem…

76129e5

…ove-indy-usage

jamshale enabled auto-merge (squash) December 29, 2025 22:39

jamshale merged commit 2152299 into openwallet-foundation:main Dec 29, 2025
10 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Sonivijayk/fix/issue 2319 docs update to remove indy usage#3997

Sonivijayk/fix/issue 2319 docs update to remove indy usage#3997
jamshale merged 12 commits intoopenwallet-foundation:mainfrom
sonivijayk:sonivijayk/fix/issue-2319-docs-update-to-remove-indy-usage

sonivijayk commented Dec 23, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Dec 23, 2025

Uh oh!

Copilot AI Dec 23, 2025

Uh oh!

Copilot AI Dec 23, 2025

Uh oh!

Copilot AI Dec 23, 2025

Uh oh!

Copilot AI Dec 23, 2025

Uh oh!

jamshale left a comment

Uh oh!

Uh oh!

sonarqubecloud bot commented Dec 29, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	"did:peer:2.4JiUsoK85pVkkB1bAPzFaP4JiUsoK85pVkkB1bAPzFaP"
	"did:peer:2.Ez6MksLe95M7VKQm2D9p1Zr2wP4G9jVwQZm4tqkbn3G9v3W.Sz6Mkhj5P3yAJi7L4hG2Vx8k1hP9d2s6cB1f4n8qEr7Dx"

	"did:peer:2.4JiUsoK85pVkkB1bAPzFaP4JiUsoK85pVkkB1bAPzFaP"
	"did:peer:2.Ez6LSj5pPzM3gYroG9q4CPGKcPvXHiYAdV5vW7QGjY3qS8p7.z6MkqRYqQiSgvZQdnkY4Cz9C8QG7bZz3WvCfs7xZk1xWnG7H"

	requiring a public ledger. The DID could also be a [Peer DID] of types 2 or 4,
	requiring a public ledger. The DID could also be a [Peer DID] of type 2 or 4,

Conversation

sonivijayk commented Dec 23, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Dec 23, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 23, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 23, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 23, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 23, 2025

Choose a reason for hiding this comment

Uh oh!

jamshale left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

sonarqubecloud bot commented Dec 29, 2025

Quality Gate passed

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants