From 8d4f9d11ef4f85dfb68eb29f93e61d40660ba2f7 Mon Sep 17 00:00:00 2001 From: Chloe Cai <93294344+rollerchloe@users.noreply.github.com> Date: Thu, 29 Feb 2024 14:28:26 +0800 Subject: [PATCH] docs: fix links --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 130acfd..c08c8e2 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # 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) @@ -8,8 +8,8 @@ Using the [OpenAttestation (Verify)](https://github.com/Open-Attestation/oa-veri 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 @@ -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 { @@ -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 @@ -277,7 +277,7 @@ const customVerifier: Verifier = { ##### 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