status-im
/
EIPs
mirror of https://github.com/status-im/EIPs.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #831 from ligi/url_format 

EIP-831: Standard URL Format
This commit is contained in:
Yoichi Hirai 2018-01-25 14:29:05 +01:00 committed by GitHub
parent e44db98df6 afabcb5f46
commit 71d6f0bc9c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 47 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
EIPS/eip-831.md Normal file
View File

@ -0,0 +1,47 @@
## Preamble
EIP: 831
Title: URL Format for Ethereum
Author: ligi <ligi@ligi.de>
Type: Standard Track
Category: ERC
Status: Draft
Created: 2018-01-15
## Simple Summary
A standard way of creating Ethereum URLs for various use-cases.
## Abstract
URLs embedded in QR-codes, hyperlinks in web-pages, emails or chat messages provide for robust cross-application signaling between very loosely coupled applications. A standardized URL format allows for instant invocation of the user's preferred wallet application.
## Specification
### Syntax
Ethereum URLs contain "ethereum" in their schema (protocol) part and are constructed as follows:
request = "ethereum" ":" [ prefix "-" ] payload
prefix = STRING
payload = STRING
### Semantics
`prefix` is optional and defines the use-case for this URL. If no prefix is given: "pay-" is assumed to be concise and ensure backward compatibility to ERC-67. When the prefix is omitted, the payload must start with `0x`. Also prefixes must not start with `0x`. So starting with `0x` can be used as a clear signal that there is no prefix.
`payload` is mandatory and the content depends on the prefix. Structuring of the content is defined in the ERC for the specific use-case and not in the scope of this document. One example is ERC-681 for the pay- prefix.
## Rationale
The need for this ERC emerged when refining ERC-681. We need a container that does not carry the weight of the use-cases. ERC-67 was the first attempt on defining Ethereum-URLs. This ERC tries to keep backward compatibility and not break existing things. This means ERC-67 URLs should still be valid and readable. Only if the prefix feature is used, ERC-67 parsers might break. No way was seen to avoid this and innovate on the same time. This is also the reason this open prefix approach was chosen to being able to adopt to future use-cases and not block the whole "ethereum:" scheme for a limited set of use-cases that existed at the time of writing this.
## References
1. ERC-67, https://github.com/ethereum/EIPs/issues/67
2. ERC-681, https://github.com/ethereum/EIPs/pull/681
## Copyright
Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).