Skip to content

Commit

Permalink
docs: fix links (#281)
Browse files Browse the repository at this point in the history
* docs: fix links

* docs: capitalize the first letter of sepolia
  • Loading branch information
rollerchloe authored Mar 28, 2024
1 parent 6d33b8b commit 26bf36f
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# OpenAttestation (Verify)

Using the [OpenAttestation (Verify)](https://github.com/Open-Attestation/oa-verify) repository as the codebase for the `npm` module, you can verify [wrapped documents](https://www.openattestation.com/docs/developer-section/libraries/remote-files/open-attestation#wrapping-documents) programmatically. This is useful if you are building your own API or web components. The following are common use cases where you will need this module:
Using the [OpenAttestation (Verify)](https://github.com/Open-Attestation/oa-verify) repository as the codebase for the `npm` module, you can verify [wrapped documents](https://www.openattestation.com/docs/lib-section/remote-files/open-attestation#wrapping-documents) programmatically. This is useful if you are building your own API or web components. The following are common use cases where you will need this module:

- [Verifying a document](#verifying-a-document)
- [Building a custom verifier](#custom-verification)
- [Adding custom validation](#custom-validation)

This module does not provide the following functionalities:

- Programmatic wrapping of OA documents (refer to [OpenAttestation](https://www.openattestation.com/docs/developer-section/libraries/remote-files/open-attestation#wrapping-documents))
- Encryption or decryption of OA documents (refer to [OpenAttestation (Encryption)](https://www.openattestation.com/docs/developer-section/libraries/remote-files/open-attestation-encryption))
- Programmatic wrapping of OA documents (refer to [OpenAttestation](https://www.openattestation.com/docs/lib-section/remote-files/open-attestation#wrapping-documents))
- Encryption or decryption of OA documents (refer to [OpenAttestation (Encryption)](https://www.openattestation.com/docs/lib-section/remote-files/open-attestation-encryption))
- Programmatic issuance or revocation of any document on the Ethereum blockchain

## Verification flow
Expand Down Expand Up @@ -50,9 +50,9 @@ A verification happens on a wrapped document, which performs the following check

- Has the document been tampered with?
- Is the issuance state of the document valid?
- Is the document issuer identity valid? (See [identity proof](https://www.openattestation.com/docs/docs-section/how-does-it-work/issuance-identity))
- Is the document issuer identity valid? (See [identity proof](https://www.openattestation.com/docs/verify-section/issuance-identity))

The verification requires a wrapped document created using [OpenAttestation](https://www.openattestation.com/docs/developer-section/libraries/remote-files/open-attestation). The following shows an example of a wrapped document, which is valid and has been issued on the sepolia network.
The verification requires a wrapped document created using [OpenAttestation](https://www.openattestation.com/docs/lib-section/remote-files/open-attestation). The following shows an example of a wrapped document, which is valid and has been issued on the Sepolia network.

```json
{
Expand Down Expand Up @@ -199,7 +199,7 @@ The following explains what the functions return with reasons:

- `isValid(fragments, ["DOCUMENT_INTEGRITY"])` returns `true` because the integrity of the document is not dependent on the network where it has been published.
- `isValid(fragments, ["DOCUMENT_STATUS"])` returns `false` because the document has not been published on the Ethereum main network.
- `isValid(fragments, ["ISSUER_IDENTITY"])` returns `false` because there is no [DNS TXT record](https://www.openattestation.com/docs/integrator-section/verifiable-document/ethereum/dns-proof) associated with the Ethereum main network's document store.
- `isValid(fragments, ["ISSUER_IDENTITY"])` returns `false` because there is no [DNS TXT record](https://www.openattestation.com/docs/ethereum-section/dns-proof) associated with the Ethereum main network's document store.
- `isValid(fragments)` returns `false` because at least one of the above returns false.

### Listening to an individual verification method
Expand Down Expand Up @@ -277,7 +277,7 @@ const customVerifier: Verifier<any> = {
##### The `name` property

Once you have decided `when` the verification method will run, you need to write the logic of the verifier in the `verify` method. You will use the [getData](https://www.openattestation.com/docs/developer-section/libraries/remote-files/open-attestation#retrieving-document-data) utility to access the document data and return the appropriate fragment depending on the content:
Once you have decided `when` the verification method will run, you need to write the logic of the verifier in the `verify` method. You will use the [getData](https://www.openattestation.com/docs/lib-section/remote-files/open-attestation#retrieving-the-document-data) utility to access the document data and return the appropriate fragment depending on the content:

```ts
// index.ts
Expand Down

0 comments on commit 26bf36f

Please sign in to comment.