Skip to content
This repository was archived by the owner on Oct 1, 2025. It is now read-only.

docs: random updates#78

Open
superical wants to merge 5 commits intomasterfrom
docs/random-updates
Open

docs: random updates#78
superical wants to merge 5 commits intomasterfrom
docs/random-updates

Conversation

@superical
Copy link
Contributor

@superical superical commented Aug 5, 2021

Just some random edits I've made when going through the documentation. Let me know if any of them make sense or we can revert any of the edit commits too! Thanks!😄

Remarks for the edits are added as comments in this PR.

Comment on lines 65 to 66
>
> 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.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Is this the correct reason for not being able to do batch process when creating transferrable records? I'm also trying to understand the reason behind this.😄

Copy link
Contributor

Choose a reason for hiding this comment

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

close but slightly inaccurate - the title escrow contract is just a construct to enable constraints on transfers

the actual mechanism of transferable record is done by the token registry (which conforms to ethereum ERC721 specification), so the violation here is that the MLETR requires a 1-1 mapping between a token id and the asset ownership record. if batching happens then it will be a 1-many mapping from token id to asset records

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks @rjchow!🙇‍♂️ I have updated the reason for this part. Let me know if it is more accurate now.😀

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:
Copy link
Contributor Author

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?

Copy link
Contributor

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

Comment on lines +28 to +32
|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` |
Copy link
Contributor Author

Choose a reason for hiding this comment

The 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!😁

Copy link
Contributor

Choose a reason for hiding this comment

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

table looks good to me :)

### 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`.
Copy link
Contributor Author

@superical superical Aug 6, 2021

Choose a reason for hiding this comment

The 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. :)

Copy link
Contributor

Choose a reason for hiding this comment

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

correct

@superical superical marked this pull request as ready for review August 6, 2021 04:09
@superical superical requested review from Nebulis and rjchow August 6, 2021 04:10
Copy link
Contributor

@rjchow rjchow left a comment

Choose a reason for hiding this comment

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

i can't remove this review request and it's cluttering up my inbox

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants