Skip to content

Commit

Permalink
📝 Add restrictions docs (#832)
Browse files Browse the repository at this point in the history 
* add restrictions docs

* remove place holder text

* formatting

* fix some some field names in example docs

* update link in docs to restriction examples

* 🎨

* 🎨

* 🎨 rename file/folder

* 🎨 GPT proof read 🤖

---------

Co-authored-by: ff137 <ff137@proton.me>
Co-authored-by: cl0ete <cloete.dupreez@gmail.com>
  • Loading branch information
@cl0ete @ff137
cl0ete and ff137 authored Sep 13, 2024
1 parent 3d7d069 commit 908118d
Show file tree
Hide file tree
Showing 2 changed files with 473 additions and 36 deletions.
72 changes: 36 additions & 36 deletions docs/examples/7. Verify Credential.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
Once the connection is established, the Verifier can send a proof request.

> There are optional restrictions and additional fields that can be added to the proof request, which are beyond the
> scope of this simple example. For more information, please see the
> [Aries RFC for proof presentations](https://github.com/hyperledger/aries-rfcs/tree/main/features/0037-present-proof).
> scope of this simple example. For more information, please see our docs for
> [restrictions on proofs](./Restrictions%20on%20Proofs/1.%20Restrictions%20on%20Proofs.md).
```bash
curl -X 'POST' \
Expand All @@ -18,12 +18,12 @@ curl -X 'POST' \
"comment": "Demo",
"type": "indy",
"indy_proof_request": {
"requested_attributes": {
"surname": { "name": "Surname", "restrictions":[]},
"name": { "name": "Name", "restrictions": []},
"age": { "name": "Age", "restrictions": []}
},
"requested_predicates": {}
"requested_attributes": {
"holder_surname": { "name": "Surname", "restrictions":[]},
"holder_name": { "name": "Name", "restrictions": []},
"holder_age": { "name": "Age", "restrictions": []}
},
"requested_predicates": {}
},
"connection_id": "5ef9f4e0-9f98-4e43-aef7-de11da2ccd40"
}'
Expand All @@ -43,19 +43,19 @@ Response:
"non_revoked": null,
"nonce": "1040329690360437135931695",
"requested_attributes": {
"surname": {
"holder_surname": {
"name": "Surname",
"names": null,
"non_revoked": null,
"restrictions": []
},
"name": {
"holder_name": {
"name": "Name",
"names": null,
"non_revoked": null,
"restrictions": []
},
"age": {
"holder_age": {
"name": "Age",
"names": null,
"non_revoked": null,
Expand Down Expand Up @@ -130,19 +130,19 @@ Response:
"non_revoked": null,
"nonce": "234234",
"requested_attributes": {
"holder surname": {
"holder_surname": {
"name": "surname",
"names": null,
"non_revoked": null,
"restrictions": []
},
"holder name": {
"holder_name": {
"name": "name",
"names": null,
"non_revoked": null,
"restrictions": []
},
"holder age": {
"holder_age": {
"name": "age",
"names": null,
"non_revoked": null,
Expand Down Expand Up @@ -200,7 +200,7 @@ Response:
"schema_id": "QpSW24YVf61A3sAWxArfF6:2:Person:0.1.0"
},
"interval": null,
"presentation_referents": ["name", "age", "surname"]
"presentation_referents": ["holder_name", "holder_age", "holder_surname"]
}
]
```
Expand All @@ -218,15 +218,15 @@ curl -X 'POST' \
"type": "indy",
"indy_presentation_spec": {
"requested_attributes": {
"holder surname": {
"holder_surname": {
"cred_id": "10e6b03f-2b60-431a-9634-731594423120",
"revealed": true
},
"holder name": {
"holder_name": {
"cred_id": "10e6b03f-2b60-431a-9634-731594423120",
"revealed": true
},
"holder age": {
"holder_age": {
"cred_id": "10e6b03f-2b60-431a-9634-731594423120",
"revealed": true
}
Expand Down Expand Up @@ -275,9 +275,9 @@ curl -X 'POST' \
},
"m2": "9527966448141582634179217567781606687146704440935821032302777460114542256740868407661366941...",
"revealed_attrs": {
"age": "25",
"name": "27034640024117331033063128044004318218486816931520886405535659934417438781507",
"surname": "108415864455171922802944099373800995974825385451497756533671241088029831060565"
"holder_age": "25",
"holder_name": "27034640024117331033063128044004318218486816931520886405535659934417438781507",
"holder_surname": "108415864455171922802944099373800995974825385451497756533671241088029831060565"
},
"v": "13310269669535827858183383537992882823597862340798892194315939604086055386082234517559247559..."
},
Expand All @@ -290,17 +290,17 @@ curl -X 'POST' \
"predicates": {},
"revealed_attr_groups": null,
"revealed_attrs": {
"holder surname": {
"holder_surname": {
"encoded": "108415864455171922802944099373800995974825385451497756533671241088029831060565",
"raw": "Holder",
"sub_proof_index": 0
},
"holder name": {
"holder_name": {
"encoded": "27034640024117331033063128044004318218486816931520886405535659934417438781507",
"raw": "Alice",
"sub_proof_index": 0
},
"holder age": {
"holder_age": {
"encoded": "25",
"raw": "25",
"sub_proof_index": 0
Expand All @@ -315,19 +315,19 @@ curl -X 'POST' \
"non_revoked": null,
"nonce": "234234",
"requested_attributes": {
"holder surname": {
"holder_surname": {
"name": "surname",
"names": null,
"non_revoked": null,
"restrictions": []
},
"holder name": {
"holder_name": {
"name": "name",
"names": null,
"non_revoked": null,
"restrictions": []
},
"holder age": {
"holder_age": {
"name": "age",
"names": null,
"non_revoked": null,
Expand Down Expand Up @@ -421,9 +421,9 @@ curl -X 'GET' \
},
"m2": "952796644814158263417921756778160668714670444093582103230277746011454225674086840766136694...",
"revealed_attrs": {
"age": "25",
"name": "27034640024117331033063128044004318218486816931520886405535659934417438781507",
"surname": "108415864455171922802944099373800995974825385451497756533671241088029831060565"
"holder_age": "25",
"holder_name": "27034640024117331033063128044004318218486816931520886405535659934417438781507",
"holder_surname": "108415864455171922802944099373800995974825385451497756533671241088029831060565"
},
"v": "1331026966953582785818338353799288282359786234079889219431593960408605538608223451755924755..."
},
Expand All @@ -436,17 +436,17 @@ curl -X 'GET' \
"predicates": {},
"revealed_attr_groups": null,
"revealed_attrs": {
"holder surname": {
"holder_surname": {
"encoded": "108415864455171922802944099373800995974825385451497756533671241088029831060565",
"raw": "Holder",
"sub_proof_index": 0
},
"holder name": {
"holder_name": {
"encoded": "27034640024117331033063128044004318218486816931520886405535659934417438781507",
"raw": "Alice",
"sub_proof_index": 0
},
"holder age": {
"holder_age": {
"encoded": "25",
"raw": "25",
"sub_proof_index": 0
Expand All @@ -461,19 +461,19 @@ curl -X 'GET' \
"non_revoked": null,
"nonce": "234234",
"requested_attributes": {
"holder surname": {
"holder_surname": {
"name": "surname",
"names": null,
"non_revoked": null,
"restrictions": []
},
"holder name": {
"holder_name": {
"name": "name",
"names": null,
"non_revoked": null,
"restrictions": []
},
"holder age": {
"holder_age": {
"name": "age",
"names": null,
"non_revoked": null,
Expand Down
Loading

0 comments on commit 908118d

Please sign in to comment.