-
Notifications
You must be signed in to change notification settings - Fork 2
docs: random updates #78
base: master
Are you sure you want to change the base?
Changes from all commits
79165a6
2605b61
f1ee78d
c4adc1b
c9464a5
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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. | ||
|
|
@@ -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`. | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Probably just a grammar typo. If I understood correctly, it meant that using DID will not incur costs until there is a need for revocation. Let me know if that's right. :)
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. correct |
||
|
|
||
| The information about the signature are added to the document, into the `proof` property. That's it, the document has been issued. | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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` | | ||
|
Comment on lines
+28
to
+32
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I just thought a table with the arguments looked easier when following through the tutorial. But the original bullet points is perfectly fine too!😁
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. table looks good to me :) |
||
|
|
||
| Once the document has been issued, you will be able to see an output similar to the following: | ||
|
|
||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It reads to me like this section of the bullet points is for checking of documents to see if they have been revoked, is that right?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yea looks like it! good catch