Skip to content

Commit 2152299

Browse files
sonivijaykVijay Sonijamshale
authored
Sonivijayk/fix/issue 2319 docs update to remove indy usage (#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>
1 parent 8a9d4aa commit 2152299

10 files changed

Lines changed: 15 additions & 29 deletions

docs/demo/AliceGetsAPhone.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -357,7 +357,7 @@ The presentation (proof) request should automatically show up in the mobile agen
357357

358358
If the mobile agent is able to successfully prepare and send the proof, you can go back to the Play with Docker terminal to see the status of the proof.
359359

360-
The process should "just work" for the non-revocation use case. If you are using revocation, your results may vary. As of writing this, we get failures on the wallet side with some mobile wallets, and on the Faber side with others (an error in the Indy SDK). As the results improve, we'll update this. Please let us know through GitHub issues if you have any problems running this.
360+
The process should "just work" for the non-revocation use case. If you are using revocation, your results may vary. As of writing this, we get failures on the wallet side with some mobile wallets, and on the Faber side with others. As the results improve, we'll update this. Please let us know through GitHub issues if you have any problems running this.
361361

362362
## Review the Proof
363363

docs/demo/AliceWantsAJsonCredential.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,14 +41,11 @@ Now open up two browser windows to the [Faber](http://localhost:8021/api/doc) an
4141

4242
Using the Faber admin api, you have to create a DID with the appropriate:
4343

44-
- DID method ("key" or "sov")
45-
- if you use DID method "sov" you must use key type "ed25519"
44+
- DID method ("key")
4645
- Either one of the following key types:
4746
- "ed25519" (corresponding to signature types "Ed25519Signature2018" or "Ed25519Signature2020")
4847
- "bls12381g2" (corresponding to signature type "BbsBlsSignature2020")
4948

50-
Note that "did:sov" must be a public DID (i.e. registered on the ledger) but "did:key" is not.
51-
5249
For example, in Faber's swagger page call the `/wallet/did/create` endpoint with the following payload:
5350

5451
```json

docs/demo/README.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -460,19 +460,14 @@ You can also run the demo against a postgres database using the following:
460460

461461
(Obviously you need to be running a postgres database - the command to start postgres is in the yml file provided above.)
462462

463-
You can tweak the number of credentials issued using the `--count` and `--batch` parameters, and you can run against an Askar database using the `--wallet-type askar` option (or run using indy-sdk using `--wallet-type indy`).
463+
You can tweak the number of credentials issued using the `--count` and `--batch` parameters, and you can run against an Askar database using the `--wallet-type askar` option.
464464

465465
An example full set of options is:
466466

467467
``` bash
468468
./run_demo performance --arg-file demo/postgres-indy-args.yml -c 10000 -b 10 --wallet-type askar
469469
```
470470

471-
Or:
472-
473-
``` bash
474-
./run_demo performance --arg-file demo/postgres-indy-args.yml -c 10000 -b 10 --wallet-type indy
475-
```
476471

477472
## Coding Challenge: Adding ACME
478473

docs/demo/ReusingAConnection.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Example invitation:
2525
"https://didcomm.org/didexchange/1.0"
2626
],
2727
"services": [
28-
"did:sov:4JiUsoK85pVkkB1bAPzFaP"
28+
"did:peer:2.4JiUsoK85pVkkB1bAPzFaP4JiUsoK85pVkkB1bAPzFaP"
2929
]
3030
}
3131
```
@@ -65,8 +65,8 @@ agents (the inviter and the invitee) that establish connections with one another
6565
The [RFC 0434 Out of Band] protocol requirement enables `reuse` message by the
6666
invitee (the Wallet in the flow above) is that the `service` in the invitation
6767
**MUST** be a resolvable DID that is the same in all of the invitations. In the
68-
example invitation above, the DID is a `did:sov` DID that is resolvable on a public
69-
Hyperledger Indy network. The DID could also be a [Peer DID] of types 2 or 4,
68+
example invitation above, the DID is a `did:peer` DID that is resolvable without
69+
requiring a public ledger. The DID could also be a [Peer DID] of types 2 or 4,
7070
which encode the entire DIDDoc contents into the DID identifier (thus they are
7171
"resolvable DIDs"). What cannot be used is either the old "unqualified" DIDs
7272
that were commonly used in Aries prior to 2024, and [Peer DID] type 1. Both of
@@ -87,7 +87,7 @@ Example invitation:
8787
"https://didcomm.org/didexchange/1.0"
8888
],
8989
"services": [
90-
"did:sov:4JiUsoK85pVkkB1bAPzFaP"
90+
"did:peer:2.4JiUsoK85pVkkB1bAPzFaP4JiUsoK85pVkkB1bAPzFaP"
9191
]
9292
}
9393
```

docs/deploying/ContainerImagesAndGithubActions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,9 +87,9 @@ variants and between the BC Gov ACA-Py images.
8787
- Uses container's system python environment rather than `pyenv`
8888
- Askar and Indy Shared libraries are installed as dependencies of ACA-Py through pip from pre-compiled binaries included in the python wrappers
8989
- Built from repo contents
90-
- Indy Image (no longer produced but included here for clarity)
90+
- Indy Image (no longer produced; legacy reference only)
9191
- Based on slim variant of Debian
92-
- Built from multi-stage build step (`indy-base` in the Dockerfile) which includes Indy dependencies; this could be replaced with an explicit `indy-python` image from the Indy SDK repo
92+
- Built from multi-stage build step (`indy-base` in the Dockerfile) which includes Indy dependencies
9393
- Includes `libindy` but does **NOT** include the Indy CLI
9494
- Default user is `indy`
9595
- Uses container's system python environment rather than `pyenv`

docs/deploying/deploymentModel.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ Instances of the ACA-Py agents are configured with the following sub-components:
2929
- **Controller REST API** - a dynamically generated REST API (with a Swagger/OpenAPI user interface) based on the set of DIDComm protocols included in the agent deployment. The controller, activated via the webhooks from the protocol DIDComm message handlers, controls the ACA-Py agent by calling the REST API that invoke the protocol admin message handlers.
3030
- **Handler API** - provides abstract interfaces to various handlers needed by the protocols and core ACA-Py agent components for accessing the secure storage (wallet), other storage, the ledger and so on. The API calls the handler implementations configured into the agent deployment.
3131
- **Handler Plugins** - are the handler implementations called from the Handler API. The plugins may be internal to the Agent (in the same process space) or could be external (for example, in other processes/containers).
32-
- **Secure Storage Plugin** - the Indy SDK is embedded in the ACA-Py agent and implements the default secure storage. An ACA-Py agent can be configured to use one of a number of indy-sdk storage implementations - in-memory, SQLite and Postgres at this time.
33-
- **Ledger Interface Plugin** - In the current ACA-Py agent implementation, the Indy SDK provides an interface to an Indy-based public ledger for verifiable credential protocols. In future, ledger implementations (including those other than Indy) might be moved into the DIDComm protocol modules to be included as needed within a configured ACA-Py agent instance based on the DIDComm protocols used by the agent.
32+
- **Secure Storage Plugin** - Askar is used by the ACA-Py agent to implement secure storage. An ACA-Py agent can be configured to use a supported storage backend such as in-memory, SQLite, or Postgres at this time.
33+
- **Ledger Interface Plugin** - The ACA-Py agent provides an interface to an Indy-based public ledger for verifiable credential protocols. In future, ledger implementations (including those other than Indy) might be moved into the DIDComm protocol modules to be included as needed within a configured ACA-Py agent instance based on the DIDComm protocols used by the agent.
3434

3535
## Controller
3636

docs/features/DIDMethods.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ ACA-Py provides a `DIDMethods` registry holding all the DID methods supported fo
1010
1111
## Registering a DID method
1212

13-
By default, ACA-Py supports `did:key` and `did:sov`.
13+
By default, ACA-Py supports `did:key`.
1414
Plugins can register DID additional methods to make them available to holders.
1515
Here's a snippet adding support for `did:web` to the registry from a plugin `setup` method.
1616

docs/features/JsonLdCredentials.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ By design ACA-Py is credential format agnostic. This means you can use it for an
1111
- [Writing JSON-LD Contexts](#writing-json-ld-contexts)
1212
- [Signature Suite](#signature-suite)
1313
- [DID Method](#did-method)
14-
- [`did:sov`](#didsov)
1514
- [`did:key`](#didkey)
1615
- [Issuing Credentials](#issuing-credentials)
1716
- [Retrieving Issued Credentials](#retrieving-issued-credentials)
@@ -83,13 +82,8 @@ Generally you should always use `BbsBlsSignature2020` as it allows the holder to
8382

8483
Besides the JSON-LD context, we need a DID to use for issuing the credential. ACA-Py currently supports two did methods for issuing credentials:
8584

86-
- `did:sov` - Can only be used for `Ed25519Signature2018` signature suite.
8785
- `did:key` - Can be used for both `Ed25519Signature2018` and `BbsBlsSignature2020` signature suites.
8886

89-
#### `did:sov`
90-
91-
When using `did:sov` you need to make sure to use a public did so other agents can resolve the did. It is also important the other agent is using the same indy ledger for resolving the did. You can get the public did using the `/wallet/did/public` endpoint. For backwards compatibility the did is returned without `did:sov` prefix. When using the did for issuance make sure this prepend this to the did. (so `DViYrCMPWfuLiY7LLs8giB` becomes `did:sov:DViYrCMPWfuLiY7LLs8giB`)
92-
9387
#### `did:key`
9488

9589
A `did:key` did is not anchored to a ledger, but embeds the key directly in the identifier part of the did. See the [did:key Method Specification](https://w3c-ccg.github.io/did-key-spec/) for more information.

docs/features/SelectiveDisclosureJWTs.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ Note that attributes in the `non_sd_list` (`given_name`, `family_name`, and `nat
148148
"headers": {
149149
"typ": "JWT",
150150
"alg": "EdDSA",
151-
"kid": "did:sov:WpVJtxKVwGQdRpQP8iwJZy#key-1"
151+
"kid": "did:key:z6Mkt3g9hU7F7Qz7fV5oHfC1H2Q8oM6QWwP5p9nX8tQm#key-1"
152152
},
153153
"payload": {
154154
"_sd": [
@@ -179,7 +179,7 @@ Note that attributes in the `non_sd_list` (`given_name`, `family_name`, and `nat
179179
"_sd_alg": "sha-256"
180180
},
181181
"valid": true,
182-
"kid": "did:sov:WpVJtxKVwGQdRpQP8iwJZy#key-1",
182+
"kid": "did:key:z6Mkt3g9hU7F7Qz7fV5oHfC1H2Q8oM6QWwP5p9nX8tQm#key-1",
183183
"disclosures": [
184184
[
185185
"xvDX00fjZferiNiPod51qQ",

docs/features/SupportedRFCs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ A summary of the Aries Interop Profiles and Aries RFCs supported in ACA-Py can b
8484

8585
| Secure Storage Types | Supported | Notes |
8686
| --- | :--: | -- |
87-
| [Askar] | :white_check_mark: | **DEPRECATED** - Askar provides equivalent/evolved secure storage and cryptography support to the removed "indy-wallet" part of the Indy SDK. When using Askar (via the `--wallet-type askar` startup parameter), credential handling functionality is by [CredX](https://github.com/hyperledger/indy-shared-rs) (AnonCreds) and [Indy VDR](https://github.com/hyperledger/indy-vdr) (Indy ledger interactions). |
87+
| [Askar] | :white_check_mark: | Askar provides secure storage and cryptography support, replacing the former "indy-wallet" component. When using Askar (via the `--wallet-type askar` startup parameter), credential handling functionality is by [CredX](https://github.com/hyperledger/indy-shared-rs) (AnonCreds) and [Indy VDR](https://github.com/hyperledger/indy-vdr) (Indy ledger interactions). |
8888
| [Askar]-AnonCreds | :white_check_mark: | Recommended - When using Askar/AnonCreds (via the `--wallet-type askar-anoncreds` startup parameter), AnonCreds credential handling functionality is by [AnonCreds RS](https://github.com/hyperledger/anoncreds-rs). All key management and ACA-Py storage is managed by Askar.|
8989
| [Kanon]-AnonCreds | :white_check_mark: | Recommended - When using Kanon/AnonCreds (via the `--wallet-type kanon-anoncreds` startup parameter), AnonCreds credential handling functionality is by [AnonCreds RS](https://github.com/hyperledger/anoncreds-rs). All key management is handled by Askar, and all other ACA-Py storage is managed by [Kanon] and the selected database management system. With [Kanon], data is encrypted at rest using the database management system's handling.|
9090
| [Indy SDK](https://github.com/hyperledger/indy-sdk/tree/main/docs/design/003-wallet-storage) | :x: | **Removed in ACA-Py Release 1.0.0rc5** |

0 commit comments

Comments
 (0)