From 79165a6fe9cc909d9adbf9a9e937240a1188f445 Mon Sep 17 00:00:00 2001 From: Seth Date: Thu, 5 Aug 2021 17:42:53 +0800 Subject: [PATCH 1/5] fix: change typo of issued to revoked in issuance-status --- website/docs/how-does-it-work/issuance-status.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/how-does-it-work/issuance-status.md b/website/docs/how-does-it-work/issuance-status.md index ea5e3135..6f94281f 100644 --- a/website/docs/how-does-it-work/issuance-status.md +++ b/website/docs/how-does-it-work/issuance-status.md @@ -47,7 +47,7 @@ An OpenAttestation verifier: 1. Gets back the document store contract address from the document itself. 1. Ensures that the `targetHash` and the `proof` matches the `merkleRoot`. 1. Checks the `merkleRoot` is in the document store provided, by calling the `isIssued` function from the deployed contract. -- Checks the `merkleRoot` of the document has been issued: +- Checks the `merkleRoot` of the document hasn't been revoked: 1. Gets back the document store contract address from the document itself. 1. Checks the `targetHash` is **not** in the document store provided, by calling the `isRevoked` function from the deployed contract. 1. Checks the `merkleRoot` is **not** in the document store provided, by calling the `isRevoked` function from the deployed contract. From 2605b61c846a21fe8654d4ae52be44dfef186298 Mon Sep 17 00:00:00 2001 From: Seth Date: Thu, 5 Aug 2021 17:44:37 +0800 Subject: [PATCH 2/5] fix: grammar typo in sentence about DID in issuance-status.md --- website/docs/how-does-it-work/issuance-status.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/how-does-it-work/issuance-status.md b/website/docs/how-does-it-work/issuance-status.md index 6f94281f..b702a3f8 100644 --- a/website/docs/how-does-it-work/issuance-status.md +++ b/website/docs/how-does-it-work/issuance-status.md @@ -60,7 +60,7 @@ At the moment, OpenAttestation only supports one DID method: `ethr`. ### Issuance -DIDs [are significantly faster and incur not costs](/docs/verifiable-document/comparison). They could directly use the `targetHash` of the document (which is unique) and sign it using the private key associated. However for consistency with our initial design, we sign the `merkleRoot`. +DIDs [are significantly faster and incur no costs](/docs/verifiable-document/comparison). They could directly use the `targetHash` of the document (which is unique) and sign it using the private key associated. However for consistency with our initial design, we sign the `merkleRoot`. The information about the signature are added to the document, into the `proof` property. That's it, the document has been issued. From f1ee78dd54de4aa45e50cb6814ef651d0f26155c Mon Sep 17 00:00:00 2001 From: Seth Date: Thu, 5 Aug 2021 17:52:14 +0800 Subject: [PATCH 3/5] docs: add reason for not being abl eto batch process with other documents for transferable records --- .../docs/transferable-record/preparing-transferable-record.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/website/docs/transferable-record/preparing-transferable-record.md b/website/docs/transferable-record/preparing-transferable-record.md index 52e6df65..0ed16dc6 100644 --- a/website/docs/transferable-record/preparing-transferable-record.md +++ b/website/docs/transferable-record/preparing-transferable-record.md @@ -62,6 +62,8 @@ Remember to replace the `tokenRegistry` value with your token registry smart con Notice the difference between a transferable record and a verifiable document is the use of `tokenRegistry` instead of `documentStore` in declaring the smart contract address. > For transferable record, you may not batch process it with other documents. Your directory `raw-documents` may only contain one file. +> +> Otherwise, this will result in a scenario where multiple documents being tied to a single Title Escrow Contract, preventing changes to the Beneficiary and Holder addresses for the individual documents in that batch. ## Wrapping Transferable Document From c4adc1b01f373a6153b083e4b220a9ae244bc5f5 Mon Sep 17 00:00:00 2001 From: Seth Date: Fri, 6 Aug 2021 10:57:05 +0800 Subject: [PATCH 4/5] docs: replace with table for the example values in issue token registry command just for clarity --- .../transferable-record/issuing-transferable-record.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/website/docs/transferable-record/issuing-transferable-record.md b/website/docs/transferable-record/issuing-transferable-record.md index a110da18..1b82fe69 100644 --- a/website/docs/transferable-record/issuing-transferable-record.md +++ b/website/docs/transferable-record/issuing-transferable-record.md @@ -25,9 +25,11 @@ open-attestation token-registry issue -a 0x8431012Bc040942B59e3C5bf428221eab0b2f Note to replace the following values: -- `0x8431012Bc040942B59e3C5bf428221eab0b2f723` with your token registry contract address -- `0x0d9839a8034cb783d98bd57bcbaafb4dc3614c4193d2edf8a655c1ec6635b7ea` with your merkle root (with a `0x` prefix) -- `0xec733A8322f8216eaf8e5566e750bfee3974B7f3` with your title escrow contract address +|Argument |Description |Example Value | +|---------|---------------------------------------|--------------------------------------------------------------------| +|-a |Address of your token registry contract|`0x8431012Bc040942B59e3C5bf428221eab0b2f723` | +|--tokenId|Merkle root hash (with a `0x` prefix) |`0x0d9839a8034cb783d98bd57bcbaafb4dc3614c4193d2edf8a655c1ec6635b7ea`| +|--to |Address of your title escrow contract |`0xec733A8322f8216eaf8e5566e750bfee3974B7f3` | Once the document has been issued, you will be able to see an output similar to the following: From c9464a5dabce087f5483689c130dbc5797abd0d3 Mon Sep 17 00:00:00 2001 From: Seth Date: Tue, 10 Aug 2021 16:42:44 +0800 Subject: [PATCH 5/5] docs: update reason for not being able to batch process in transferrable records --- .../docs/transferable-record/preparing-transferable-record.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/transferable-record/preparing-transferable-record.md b/website/docs/transferable-record/preparing-transferable-record.md index 0ed16dc6..70e6c62e 100644 --- a/website/docs/transferable-record/preparing-transferable-record.md +++ b/website/docs/transferable-record/preparing-transferable-record.md @@ -63,7 +63,7 @@ Notice the difference between a transferable record and a verifiable document is > For transferable record, you may not batch process it with other documents. Your directory `raw-documents` may only contain one file. > -> Otherwise, this will result in a scenario where multiple documents being tied to a single Title Escrow Contract, preventing changes to the Beneficiary and Holder addresses for the individual documents in that batch. +> Otherwise, the one-to-one mapping between a token ID and the asset ownership record will be violated as batching the records will result in a one-to-many mapping. ## Wrapping Transferable Document