First round of modifications on ZIP227 #20

AntoineRondelet · 2023-05-28T11:55:22Z

As per the title, this PR does a first round of changes on ZIP 227.
Each commit does one change, so we can easily cherry pick/rebase to keep the relevant ones.

…ontext

…d circular dependency between ZIPs

netlify · 2023-05-28T11:55:28Z

✅ Deploy Preview for zcash-zips-qedit ready!

Name	Link
🔨 Latest commit	`33ca273`
🔍 Latest deploy log	https://app.netlify.com/sites/zcash-zips-qedit/deploys/64746008f57e220008c03fd7
😎 Deploy Preview	https://deploy-preview-20--zcash-zips-qedit.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

zip-0227.rst

AntoineRondelet · 2023-05-28T12:18:04Z

zip-0227.rst

 Varies            nNotes                          compactSize                The number of notes in the issuance action
+TBD         noteSize       byte                   The size, in bytes, of a Note


As per: #20 (comment) it'd be nice to document the noteSize

AntoineRondelet · 2023-05-28T12:12:37Z

zip-0227.rst

@@ -263,6 +275,7 @@ For each `IssueAction` in `IssueBundle`:

 - check that :math:`0 < \mathsf{assetDescSize} <= 512`.
 - check that :math:`\mathsf{asset\_desc}` is a string of length :math:`\mathsf{assetDescSize}` bytes.
+


asset_desc is defined as "UTF-8 encoded string, of size assetDescSize bytes" in the table. Yet, it's Byte size is set to Varies and its type is set as byte.

It seems like it's Byte size shouldn't be Varies but assetDescSize instead and it's type should be a byte array byte[assetDescSize]

zip-0227.rst

AntoineRondelet · 2023-05-28T12:18:04Z

zip-0227.rst

 Varies            nNotes                          compactSize                The number of notes in the issuance action
+TBD         noteSize       byte                   The size, in bytes, of a Note


As per: #20 (comment) it'd be nice to document the noteSize

AntoineRondelet · 2023-05-28T13:39:16Z

I'm a bit lost on notations (especially the use of math fonts). We seem to be using mathsf which makes sense, but sometimes we use the double backtick or simply backticks (e.g. for 'finalize' and 'notes').
(see screenshot enclosed).

Is there a convention somewhere?

vivek-arte · 2023-05-29T08:39:55Z

I'm a bit lost on notations (especially the use of math fonts). We seem to be using mathsf which makes sense, but sometimes we use the double backtick or simply backticks (e.g. for 'finalize' and 'notes'). (see screenshot enclosed).

Is there a convention somewhere?

Looking at other ZIPs (ZIP 225 for example), it seems that terms that are entries in transaction format tables are always denoted via double backticks (with the use of \mathtt if they appear in a math equation).

vivek-arte

Approved with comments, see above.

AntoineRondelet · 2023-06-04T10:52:41Z

Thanks @vivek-arte, but then, why is notes used with single backticks? (same for IssueBundle, IssueAuthSig etc)
Likewise, AFAICT, finalize is not a transaction field in itself, but rather the LSB of flagIssuance, so shall it be double back ticked? Feels like flagIssuance should be but not finalize. What do I miss?

vivek-arte · 2023-06-06T16:51:20Z

You're right, the use of single backticks was confusing and unnecessary. I've tried to improve on those parts in PR#28, moving to double backticks for the table items.

The finalize is a tricky case for the reason you mentioned, there was a time when we didn't have a full byte and only had the bit in, which is why it originally was in double backticks. That was changed to using the flagIssuance for serialization purposes, but I didn't edit the finalize formatting.

I'm also wondering how strict we need to be about using double backticks only for table entries -- for example, in the above PR, I changed ik to use double backticks because we use it in the issuance bundle table. But then it felt jarring to have isk, the private key that corresponds to ik, in \mathsf format. So I changed isk to also use double backticks. Open to suggestions on how to handle this.

I'm not sure there is a single consistent choice throughout all the prior ZIPs, but if we pick a strict format and stick to it that would be good too. We should document it somewhere, probably in the issue #25 discussion. I'm not sure we should include it in the Rationale section of either ZIP, but we can bring it to the attention of the ZIP editors, and they could choose if they want to make these conventions uniform going ahead and so on.

vivek-arte · 2023-06-10T08:06:32Z

As an update, also see this comment made by Daira on the isk change I was unsure about. That seems to give clarity on the convention we should use (and means isk should be moved back to mathsf).

Improved style and content of ZIP 227. --------- Co-authored-by: Vivek Arte <vivek@qed-it.com>

Improved style and content of ZIP 227. Co-authored-by: Vivek Arte <vivek@qed-it.com>

AntoineRondelet added 10 commits May 28, 2023 11:42

Changed block chain into blockchain

c705cca

Grouped the ' related to BIP43 for consistency

fc63f5b

Added explicit definition for AssetId

1b6e91e

Fixed inconsistent assetDigest notations

21904b2

Added note about subscript and superscript omission when clear from c…

ee3ae82

…ontext

Fixed a few text typos

3473a4f

Changed u64 for 64-bit unsigned integer type to be language agnostic

9c51447

Started to fix inconsistencies in tables

9ddabee

Refactored the terminology section to make it self contained and avoi…

4067d60

…d circular dependency between ZIPs

Refactored abstract and motivation for ZIP227

bdbac4b

AntoineRondelet mentioned this pull request May 28, 2023

[WIP] Inconsistency fixes for ZIPs 226 and 227 #18

Closed

23 tasks

AntoineRondelet added 2 commits May 28, 2023 13:07

Fixed type of notes

cc8a201

Added placeholder for comment on asset_desc tyoe

d35b4ac

AntoineRondelet commented May 28, 2023

View reviewed changes

AntoineRondelet requested review from vivek-arte and PaulLaux May 28, 2023 12:19

Switched from TBD to Varies for IssueActionSize

f81e13b

AntoineRondelet force-pushed the zip-0227-ar-first-round branch from 9a10f3f to f81e13b Compare May 28, 2023 12:25

AntoineRondelet removed request for PaulLaux and vivek-arte May 28, 2023 12:29

AntoineRondelet added 2 commits May 28, 2023 14:33

Fixed tables and added reference to the flagsIssuance section

da051d1

Removed useless self reference

90f7546

AntoineRondelet requested review from PaulLaux and vivek-arte May 28, 2023 13:39

updating html file for Netlify rendering

33ca273

vivek-arte approved these changes May 29, 2023

View reviewed changes

vivek-arte merged commit 18c1e8d into zsa1 May 29, 2023

This was referenced Jun 4, 2023

Convention for (math) fonts in ZIPs #25

Closed

Removed redundant terminology in ZIP226, building on ZIP227 #26

Merged

vivek-arte mentioned this pull request Jun 10, 2023

ZIPs 226 & 227 - ZSA Protocol: Transfer, Issuance and Burn zcash/zips#680

Closed

PaulLaux pushed a commit that referenced this pull request Oct 4, 2023

First round of modifications on ZIP227 (#20)

a434b9e

Improved style and content of ZIP 227. --------- Co-authored-by: Vivek Arte <vivek@qed-it.com>

vivek-arte added a commit that referenced this pull request Feb 12, 2024

First round of modifications on ZIP227 (#20)

2630ffb

Improved style and content of ZIP 227. Co-authored-by: Vivek Arte <vivek@qed-it.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

First round of modifications on ZIP227 #20

First round of modifications on ZIP227 #20

AntoineRondelet commented May 28, 2023 •

edited

Loading

netlify bot commented May 28, 2023 •

edited

Loading

AntoineRondelet May 28, 2023 •

edited

Loading

AntoineRondelet May 28, 2023

AntoineRondelet May 28, 2023 •

edited

Loading

AntoineRondelet commented May 28, 2023

vivek-arte commented May 29, 2023 •

edited

Loading

vivek-arte left a comment

AntoineRondelet commented Jun 4, 2023 •

edited

Loading

vivek-arte commented Jun 6, 2023

vivek-arte commented Jun 10, 2023

		Varies nNotes compactSize The number of notes in the issuance action
		TBD noteSize byte The size, in bytes, of a Note

		@@ -263,6 +275,7 @@ For each `IssueAction` in `IssueBundle`:

		- check that :math:`0 < \mathsf{assetDescSize} <= 512`.
		- check that :math:`\mathsf{asset\_desc}` is a string of length :math:`\mathsf{assetDescSize}` bytes.

First round of modifications on ZIP227 #20

First round of modifications on ZIP227 #20

Conversation

AntoineRondelet commented May 28, 2023 • edited Loading

netlify bot commented May 28, 2023 • edited Loading

✅ Deploy Preview for zcash-zips-qedit ready!

AntoineRondelet May 28, 2023 • edited Loading

Choose a reason for hiding this comment

AntoineRondelet May 28, 2023

Choose a reason for hiding this comment

AntoineRondelet May 28, 2023 • edited Loading

Choose a reason for hiding this comment

AntoineRondelet commented May 28, 2023

vivek-arte commented May 29, 2023 • edited Loading

vivek-arte left a comment

Choose a reason for hiding this comment

AntoineRondelet commented Jun 4, 2023 • edited Loading

vivek-arte commented Jun 6, 2023

vivek-arte commented Jun 10, 2023

AntoineRondelet commented May 28, 2023 •

edited

Loading

netlify bot commented May 28, 2023 •

edited

Loading

AntoineRondelet May 28, 2023 •

edited

Loading

AntoineRondelet May 28, 2023 •

edited

Loading

vivek-arte commented May 29, 2023 •

edited

Loading

AntoineRondelet commented Jun 4, 2023 •

edited

Loading