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

Resurrect EIP-1328 #4416

Merged
merged 16 commits into from
Jul 18, 2022
Merged

Resurrect EIP-1328 #4416

merged 16 commits into from
Jul 18, 2022

Conversation

ligi
Copy link
Member

@ligi ligi commented Nov 3, 2021

EIP-1328 is heavily used in WalletConnect - and very unlikely to change - but as I understand the process we now need to move it to Draft then to Review then to Last Call then to Final. Starting this process now - cc @pedrouid

@eth-bot
Copy link
Collaborator

eth-bot commented Nov 3, 2021

All tests passed; auto-merging...

(pass) eip-1328.md

classification
updateEIP
  • passed!

@pedrouid
Copy link
Contributor

pedrouid commented Nov 3, 2021

Seconded! We should also update the spec with parameters for v1.0 and v2.0

@axic
Copy link
Member

axic commented Nov 3, 2021

I think you can bring it to Review directly given it is mostly ready.

@ligi
Copy link
Member Author

ligi commented Nov 3, 2021

@axic thanks - but according to this state-transition diagram I cannot:

image

axic
axic previously requested changes Nov 3, 2021
Copy link
Member

@axic axic left a comment

Choose a reason for hiding this comment

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

Please update this to the current EIP-1 standards:

  1. Add description: preamble and remove Simple Summary
  2. Optionally add Motivation
  3. Remove References
  4. Add Backwards Compatibility
  5. Add Security Considerations
  6. Make sure at least one author has a GitHub handle and not an email

@axic
Copy link
Member

axic commented Nov 3, 2021

@axic thanks - but according to this state-transition diagram I cannot:

Good catch. I think this is somewhat inconsistent, given if you have caught the bot at the time of making the change, you wouldn't need to do two steps.

@MicahZoltu @lightclient do you want to enforce having two PRs here to first move to Draft then to Review? 😉

@ligi
Copy link
Member Author

ligi commented Nov 3, 2021

I actually caught it the first time: #4020 (comment)
Unfortunately I did not catch the second attempt ..-)

Do we really need to add empty sections for backward compatibility and security considerations when they do not apply?

@axic
Copy link
Member

axic commented Nov 3, 2021

Do we really need to add empty sections for backward compatibility and security considerations when they do not apply?

It seems so.

@MicahZoltu
Copy link
Contributor

I believe we discussed this and agreed that if the author wants to go from stagnant to Review that is fine.

The Backward Compatibility and Security Consideration sections are required. At the least they should have a one-line blurb that says "There are no known backward compatibility issues introduced by this EIP" or "There are no known security issues presented by the introduction of this EIP."

@lightclient
Copy link
Member

Bumping as this is heavily used in WalletConnect and it would be great to move to final

ligi added 3 commits February 4, 2022 22:36
can also be for desktop - maybe we should remove the whole part - because now there is also "copy" - no real value added anyway IMHO
@ligi
Copy link
Member Author

ligi commented Feb 4, 2022

I did most things @axic pointed out changed from EIP-1 in style - just left

  • Add Backwards Compatibility
  • Add Security Considerations

Also @pedrouid can you add the 2.0 changes you mentioned?

Also I think the rationale needs some rework - sounds weird and not that helpful.

## Abstract

This standard defines how the data to connect some application and a wallet can be encoded with a URI. This URI can then be shown either as a QR code or for mobile to mobile as a link.
This standard defines how the data to connect some application and a wallet can be encoded with a URI. This URI can then be shown either as a QR code or as a link.
Copy link
Member Author

Choose a reason for hiding this comment

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

@pedrouid do we perhaps want to remove "This URI can then be shown either as a QR code or as a link." - think it adds no value and restricts us without a need. e.g. how does the "copy" fall in place there.

Copy link
Contributor

Choose a reason for hiding this comment

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

I feel like this is already addressed when "link" is mentioned since it's a common pattern to include copy to clipboard for website links as well

@pedrouid
Copy link
Contributor

pedrouid commented Feb 5, 2022

Thanks @ligi for resurrecting this EIP. I will look into this by Tuesday to include the missing sections and parameters for v2.0

@pedrouid
Copy link
Contributor

pedrouid commented Feb 9, 2022

Sorry for the delay.... I have created a PR to Ligi's PR to include the v2.0 parameters: ligi#2

@ligi ligi marked this pull request as draft February 9, 2022 15:11
@ligi
Copy link
Member Author

ligi commented Feb 9, 2022

Incorporated most things requested - but have one open discussion point with @pedrouid - marking as draft until this is resolved.

EIPS/eip-1328.md Outdated
Comment on lines 2 to 10
eip: 1328
title: WalletConnect Standard URI Format
author: ligi <ligi@ligi.de>, Pedro Gomes <pedrouid@protonmail.com>
author: ligi <@ligi>, Pedro Gomes <@pedrouid>
type: Standards Track
category: ERC
status: Stagnant
status: Draft
created: 2018-08-15
discussions-to: https://ethereum-magicians.org/t/wallet-connect-eip/850
description: Standard for WalletConnect URIs
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
eip: 1328
title: WalletConnect Standard URI Format
author: ligi <ligi@ligi.de>, Pedro Gomes <pedrouid@protonmail.com>
author: ligi <@ligi>, Pedro Gomes <@pedrouid>
type: Standards Track
category: ERC
status: Stagnant
status: Draft
created: 2018-08-15
discussions-to: https://ethereum-magicians.org/t/wallet-connect-eip/850
description: Standard for WalletConnect URIs
eip: 1328
title: WalletConnect Standard URI Format
description: Standard for WalletConnect URIs
author: ligi (@ligi), Pedro Gomes (@pedrouid)
discussions-to: https://ethereum-magicians.org/t/wallet-connect-eip/850
status: Draft
type: Standards Track
category: ERC
created: 2018-08-15

Fixes field ordering to align with https://raw.githubusercontent.com/ethereum/EIPs/master/eip-template.md.

Also fixes () for GitHub username, <> is for email.

@pedrouid
Copy link
Contributor

pedrouid commented Apr 7, 2022

Thanks @ligi for making sure this EIP is resurrected and merged

I've provided with the final changes regarding parameters for WalletConnect v2.0 protocol

ligi#4

@ligi
Copy link
Member Author

ligi commented Apr 11, 2022

@pedrouid thanks for the final changes for WC2.0!
@MicahZoltu thanks for your suggestions - unfortunately I saw them after merging @pedrouid 's and then got this when trying to merge yours:
image
So I changed it myself and gave you credits in the commit msg - sorry for not seeing it earlier

Think this one should be mergeable now.

@ligi ligi marked this pull request as ready for review April 11, 2022 09:07
@MicahZoltu MicahZoltu dismissed axic’s stale review May 6, 2022 05:25

Changes applied.

@MicahZoltu
Copy link
Contributor

@SamWilsn @lightclient @axic This has been sitting waiting for a review for quite a while. Any chance one of you have some time to take a look?

EIPS/eip-1328.md Outdated
@@ -1,21 +1,18 @@
---
eip: 1328
title: WalletConnect Standard URI Format
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
title: WalletConnect Standard URI Format
title: WalletConnect URI Format

EIPS/eip-1328.md Outdated
@@ -1,21 +1,18 @@
---
eip: 1328
title: WalletConnect Standard URI Format
author: ligi <ligi@ligi.de>, Pedro Gomes <pedrouid@protonmail.com>
description: Standard for WalletConnect URIs
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
description: Standard for WalletConnect URIs
description: Define URIs for initiating connections between applications and wallets

EIPS/eip-1328.md Outdated
Comment on lines 55 to 57
## Rationale

The need for this ERC stems from the discussion to move away from JSON format used in the alpha version of the WalletConnect protocol which makes for very inneficient parsing of the intent of the QR code, making it easier to create better QR code parsers APIs for Wallets to implement. Also by using a URI instead of a JSON inside the QR-Code the Android Intent system can be leveraged.
Copy link
Contributor

Choose a reason for hiding this comment

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

This "Rationale" section reads more like it should belong in the "Motivation" section.

"Motivation" explains why the EIP as a whole needs to exist, while "Rationale" should explain individual choices made in the EIP itself.

@github-actions github-actions bot added the stale label Jul 12, 2022
@SamWilsn
Copy link
Contributor

Opened ligi#5 with my suggestions.

@ligi
Copy link
Member Author

ligi commented Jul 18, 2022

merged

@github-actions github-actions bot removed the stale label Jul 18, 2022
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 think we're good to go!

@kodiakhq kodiakhq bot merged commit c0e1c15 into ethereum:master Jul 18, 2022
@SamWilsn
Copy link
Contributor

@ligi is this good to go to review?

@ligi
Copy link
Member Author

ligi commented Jul 18, 2022

yes!

Pandapip1 pushed a commit to Pandapip1/EIPs that referenced this pull request Jul 18, 2022
* Resurrect EIP-1328

* Update to current EIP-1

* Remove the specific use case

can also be for desktop - maybe we should remove the whole part - because now there is also "copy" - no real value added anyway IMHO

* Update eip-1328.md

* Update eip-1328.md

* Update EIPS/eip-1328.md

* Update EIPS/eip-1328.md

* Update EIPS/eip-1328.md

* Update EIPS/eip-1328.md

* Update eip-1328.md

* Apply suggestions by  @MicahZoltu

* Apply my suggestions to the PR

Co-authored-by: Pedro Gomes <pedrogomes94@gmail.com>
Co-authored-by: Sam Wilson <sam.wilson@mesh.xyz>
nachomazzara pushed a commit to nachomazzara/EIPs that referenced this pull request Jan 13, 2023
* Resurrect EIP-1328

* Update to current EIP-1

* Remove the specific use case

can also be for desktop - maybe we should remove the whole part - because now there is also "copy" - no real value added anyway IMHO

* Update eip-1328.md

* Update eip-1328.md

* Update EIPS/eip-1328.md

* Update EIPS/eip-1328.md

* Update EIPS/eip-1328.md

* Update EIPS/eip-1328.md

* Update eip-1328.md

* Apply suggestions by  @MicahZoltu

* Apply my suggestions to the PR

Co-authored-by: Pedro Gomes <pedrogomes94@gmail.com>
Co-authored-by: Sam Wilson <sam.wilson@mesh.xyz>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants