Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update ERC-4527: Move to Review #694

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

aaronisme
Copy link

add new fields on the sign request and change the status to review

@eip-review-bot
Copy link
Collaborator

eip-review-bot commented Oct 31, 2024

File ERCS/erc-4527.md

Requires 1 more reviewers from @g11tech, @SamWilsn, @xinbenlv

@eip-review-bot eip-review-bot changed the title Update ERC-4527: add new fields on the sign request and change to review Update ERC-4527: Move to Review Oct 31, 2024
Deluaney1

This comment was marked as spam.

@aaronisme
Copy link
Author

Would you please help review this change ? @axic, @g11tech, @SamWilsn, @xinbenlv

Copy link
Contributor

@SamWilsn SamWilsn left a comment

Choose a reason for hiding this comment

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

I took the liberty of adding some RFC references for CBOR and CDDL. Please ensure they are the correct documents.

ERCS/erc-4527.md Outdated
@@ -45,7 +45,7 @@ In order to work with offline signers, the watch-only wallet should follow the f

Since a single QR Code can only contain a limited amount of data, animated QR Codes should be utilized for data transmission. The `BlockchainCommons` have published a series of data transmission protocol called Uniform Resources (UR). It provides a basic method to encode data into animated QR Codes. This EIP will use UR and extend its current definition.
Copy link
Contributor

Choose a reason for hiding this comment

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

The BlockchainCommons have published a series of data transmission protocol called Uniform Resources (UR).

This is an external link. We generally don't permit links to external resources, except for the exceptions listed in EIP-1. You can see our rationale over here: https://ethereum.github.io/eipw/markdown-rel-links/

There are two options for referring to this external standard:

  1. Copy the relevant files into your assets directory, and link to them there. Unless I'm looking at the wrong repository, the UR specs are BSD licensed, so it would be fine to reproduce them here. Just include the license file alongside.
  2. Make a pull request adding Blockchain Commons as a permitted external source. The process for that is documented in EIP-5757.

Copy link
Author

Choose a reason for hiding this comment

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

Hi @SamWilsn, I removed the links since they weren't necessary for this descriptive text.

ERCS/erc-4527.md Outdated
The following specification is written in Concise Data Definition Language `CDDL`.
UUIDs in this specification notated UUID are CBOR binary strings tagged with #6.37, per the IANA `CBOR Tags Registry`.
The following specification is written in Concise Data Definition Language (CDDL).
UUIDs in this specification notated UUID are CBOR binary strings tagged with #6.37, per the IANA CBOR Tags Registry.
Copy link
Contributor

Choose a reason for hiding this comment

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

Same kind of external link problem here. The IANA CBOR Tags Registry isn't a permitted external resource. I think you could get away here just removing this text.

Copy link
Author

Choose a reason for hiding this comment

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

updated

@aaronisme
Copy link
Author

Hi @SamWilsn I have updated the PR based on your comments, please check it. Thanks!

@@ -43,20 +43,20 @@ In order to work with offline signers, the watch-only wallet should follow the f

### Data Transmission Protocol

Since a single QR Code can only contain a limited amount of data, animated QR Codes should be utilized for data transmission. The `BlockchainCommons` have published a series of data transmission protocol called Uniform Resources (UR). It provides a basic method to encode data into animated QR Codes. This EIP will use UR and extend its current definition.
Since a single QR Code can only contain a limited amount of data, animated QR Codes should be utilized for data transmission. The BlockchainCommons have published a series of data transmission protocol called Uniform Resources (UR). It provides a basic method to encode data into animated QR Codes. This EIP will use UR and extend its current definition.
Copy link
Contributor

Choose a reason for hiding this comment

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

This paragraph is still an external link (even though it lacks an explicit hyperlink.) ERC-4527 isn't implementable without also reading the Uniform Resources standard.

We require that such information fulfill any one of the following:

  • It is included in the EIP or its assets directory (license permitting);
  • It is hosted on a source permitted in EIP-1 (eg. IETF or W3C); or
  • It has been assigned a DOI.

We have these requirements in place to ensure that external information doesn't disappear or change once the EIP is finalized. BlockchainCommons hasn't been approved as an external origin.

I'll draft up a pull request copying the relevant standards here.

Copy link
Contributor

Choose a reason for hiding this comment

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

Huh, as it turns out, these are deeply interlinked and would be a pain in the ass to rehost here. I'll figure something else out.

Copy link
Author

Choose a reason for hiding this comment

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

Hi @SamWilsn anything to do for moving the PR forward?

Copy link
Contributor

Choose a reason for hiding this comment

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

Nothing on your end. I'll make sure this moves along on mine.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants