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.

Sign up for GitHub

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

Jump to bottom

Remove references to forceRevocationCheck #370

Merged
merged 1 commit into from
Oct 12, 2023
Merged

Remove references to forceRevocationCheck #370

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion example/vcdm.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,6 @@ async function main() {
domain,
resolver,
compactProof: true,
forceRevocationCheck: false,
});

if (ver.verified) {
Expand Down
2 changes: 0 additions & 2 deletions src/utils/vc/presentations.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,8 +106,6 @@ export async function verifyPresentationCredentials(
* @property {DIDResolver} [resolver] - Resolver to resolve the issuer DID (optional)
* @property {Boolean} [unsignedPresentation] - Whether to verify the proof or not
* @property {Boolean} [compactProof] - Whether to compact the JSON-LD or not.
* @property {Boolean} [forceRevocationCheck] - Whether to force revocation check or not.
Copy link
Member

Choose a reason for hiding this comment

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

We removed this in favour of skipRevocationCheck. Another missing option is skipSchemaCheck. See here for details. Can you please add those docs here? Thanks

Copy link
Member Author

@cykoder cykoder Oct 12, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

will spin off an issue and make a separate PR when have a bit of spare time - #372

* Warning, setting forceRevocationCheck to false can allow false positives when verifying revocable credentials.
* @property {object} [presentationPurpose] - A purpose other than the default AuthenticationProofPurpose
* @property {object} [documentLoader] - A document loader, can be null and use the default
*/
Expand Down
12 changes: 3 additions & 9 deletions tutorials/src/tutorial_ipv.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,10 +190,7 @@ with the `verify` method. The `verify` method takes an object of arguments,
and is optional.

If you've used DIDs you need to pass a `resolver` for them.
You can also use the booleans `compactProof` (to compact the JSON-LD) and
`forceRevocationCheck` (to force revocation check). Please beware that
setting `forceRevocationCheck` to false can allow false positives when
verifying revocable credentials.
You can also use the booleans `compactProof` (to compact the JSON-LD).

If your credential has uses the `credentialStatus` field, the credential will be checked
not to be revoked unless you pass `skipRevocationCheck` flag.
Expand Down Expand Up @@ -382,10 +379,7 @@ Once your Verifiable Presentation has been signed you can proceed to verify
it with the `verify` method.

If you've used DIDs you need to pass a `resolver` for them. You can also use
the booleans `compactProof` (to compact the JSON-LD) and
`forceRevocationCheck` (to force revocation check). Please beware that
setting `forceRevocationCheck` to false can allow false positives when
verifying revocable credentials.
the booleans `compactProof` (to compact the JSON-LD).

If your credential uses the `credentialStatus` field, the credential will be checked to be not revoked unless you pass `skipRevocationCheck`.
For the simplest cases you only need a `challenge` string and possibly a
Expand Down Expand Up @@ -459,7 +453,7 @@ Here's an example of issuing a Verifiable Credential using DIDs, provided that y
```javascript
const issuerKey = getKeyDoc(issuerDID, dock.keyring.addFromUri(issuerSeed, null, 'ed25519'), 'Ed25519VerificationKey2018');
await vc.sign(issuerKey);
const verificationResult = await signedCredential.verify({ resolver, compactProof: true, forceRevocationCheck: true, revocationApi: { dock } });
const verificationResult = await signedCredential.verify({ resolver, compactProof: true });
console.log(verificationResult.verified); // Should print `true`
```

Expand Down
Loading