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

ERC-1328 - WalletConnect Standard URI Format #1330

Merged
merged 6 commits into from Aug 28, 2018
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
49 changes: 49 additions & 0 deletions EIPS/eip-1328.md
@@ -0,0 +1,49 @@
---
eip: 1328
title: WalletConnect Standard URI Format
authors: ligi <ligi@ligi.de>, Pedro Gomes <pedrouid@protonmail.com>
type: Standards Track
category: ERC
status: WIP
Copy link
Contributor

Choose a reason for hiding this comment

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

This should be draft. If you don't want this PR merged, put [WIP] in the PR title.

created: 2018-08-15
discussions-to: https://ethereum-magicians.org/t/wallet-connect-eip/850
requires: 831
---

## Simple Summary

A standard way of creating WalletConnect URIs for establishing connections between wallets and dapps
Copy link
Member

Choose a reason for hiding this comment

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

I would reword to:

A standard to create WalletConnect URIs for establishing connections between wallets and applications.

Copy link
Member

Choose a reason for hiding this comment

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

If you want to keep the sentence this way for some reason - please just add the "." on the end


## Abstract

Sesion data in QR codes for initiating a connection between a wallet and dapp using the WalletConnect standard require a standardized URI format for effictively parsing the intenet. This ERC is expandable between versions of the standard and also mobile-to-mobile deep links.
Copy link
Member

Choose a reason for hiding this comment

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

intenet needs to be changed as it is not a word ;-)

In general I would change it to:

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.


## Specification

### Syntax

Function call URIs follow the ERC-831 URI format, with the following parameters:

request = "ethereum" ":" [ "wc-" ]sessionID [ "@" version ][ "?" parameters ]
sessionID = STRING
version = 1*DIGIT
parameters = parameter *( "&" parameter )
parameter = key "=" value
key = "name" / "bridge" / "symKey"
value = NUMBER / STRING

### Semantics

Required parameters are dependent on the WalletConnect standard version which currently is specified to only include mobile-to-desktop connection sessions which only require `name` which describes the dapp name, `bridge` which includes the bridge URL, `symKey` which includes the symmetric key in base64.

## Rationale

The need for this ERC stems from the discussion to move away from JSON format used in current beta version of the WalletConnect standard 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 for other compatible EIPs using the ERC-831 URI format for Ethereum.
Copy link
Member

Choose a reason for hiding this comment

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

I would add.

Also by using a URI instead of a JSON inside the QR-Code the Android Intent system can be leveraged.


## References

1. ERC-831, http://eips.ethereum.org/EIPS/eip-831

## Copyright

Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).