Import BIP-0021, text replacement, line wrapping

This commit is contained in:
Joshua Seigler 2020-01-21 16:43:03 -05:00 committed by GitHub
parent 33ae094f44
commit dbd0404dd6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -19,3 +19,129 @@
## Abstract ## Abstract
This DIP augments the URI scheme for making payments to include an identity
claim and a hash that proves the claim's validity.
## Motivation
The purpose of this URI scheme is to enable users to easily make payments by
simply clicking links on webpages or scanning QR Codes.
## Prior Work
[BIP-0021](https://github.com/bitcoin/bips/blob/master/bip-0021.mediawiki), a
URI scheme for making Bitcoin payments
## Specification
### General rules for handling (important!)
Dash clients MUST NOT act on URIs without getting the user's authorization. They
SHOULD require the user to manually approve each payment individually, though in
some cases they MAY allow the user to automatically make this decision.
### Operating system integration
Graphical Dash clients SHOULD register themselves as the handler for the
"dash:" URI scheme by default, if no other handler is already registered. If
there is already a registered handler, they MAY prompt the user to change it
once when they first run the client.
### General Format
Dash URIs follow the general format for URIs as set forth in RFC 3986. The path
component consists of a dash address, and the query component provides
additional payment options.
Elements of the query component may contain characters outside the valid range.
These must first be encoded according to UTF-8, and then each octet of the
corresponding UTF-8 sequence must be percent-encoded as described in RFC 3986.
### ABNF grammar
(See also [a simpler representation of syntax](#simpler-syntax))
dashurn = "dash:" dashaddress [ "?" dashparams ]
dashaddress = *base58
dashparams = dashparam [ "&" dashparams ]
dashparam = [ amountparam / labelparam / messageparam / otherparam / reqparam ]
amountparam = "amount=" *digit [ "." *digit ]
labelparam = "label=" *qchar
messageparam = "message=" *qchar
otherparam = qchar *qchar [ "=" *qchar ]
reqparam = "req-" qchar *qchar [ "=" *qchar ]
Here, "qchar" corresponds to valid characters of an RFC 3986 URI query
component, excluding the "=" and "&" characters, which this DIP takes as
separators.
The scheme component ("dash:") is case-insensitive, and implementations must
accept any combination of uppercase and lowercase letters. The rest of the URI
is case-sensitive, including the query parameter keys.
Query Keys
label: Label for that address (e.g. name of receiver)
address: dash address
message: message that describes the transaction to the user (see examples below)
size: amount of base dash units (see below)
(others): optional, for future extensions
Transfer amount/size
If an amount is provided, it MUST be specified in decimal Dash. All amounts MUST
contain no commas and use a period (.) as the separating character to separate
whole numbers and decimal fractions. I.e. amount=50.00 or amount=50 is treated
as 50 Dash, and amount=50,000.00 is invalid.
Dash clients MAY display the amount in any format that is not intended to
deceive the user. They SHOULD choose a format that is foremost least confusing,
and only after that most reasonable given the amount requested. For example, so
long as the majority of users work in Dash units, values should always be
displayed in Dash by default, even if mDash or something else would be a more
logical interpretation of the amount.
## Appendix
### Simpler syntax
This section is non-normative and does not cover all possible syntax. Please see
the BNF grammar above for the normative syntax.
[foo] means optional, <bar> are placeholders
dash:<address>[?amount=<amount>][?label=<label>][?message=<message>]
### Examples
Just the address:
dash:175tWpb8K1S7NmH4Zx6rewF9WQrcZv245W
Address with name:
dash:175tWpb8K1S7NmH4Zx6rewF9WQrcZv245W?label=Evan
Request 20.30 Dash to "Evan":
dash:175tWpb8K1S7NmH4Zx6rewF9WQrcZv245W?amount=20.3&label=Evan
Request 50 Dash with message:
dash:175tWpb8K1S7NmH4Zx6rewF9WQrcZv245W?amount=50&label=Evan&message=Donation%20for%20project%20xyz
Some future version that has variables which are (currently) not understood and
required and thus invalid:
dash:175tWpb8K1S7NmH4Zx6rewF9WQrcZv245W?req-somethingyoudontunderstand=50&req-somethingelseyoudontget=999
Some future version that has variables which are (currently) not understood but
not required and thus valid:
dash:175tWpb8K1S7NmH4Zx6rewF9WQrcZv245W?somethingyoudontunderstand=50&somethingelseyoudontget=999
Characters must be URI encoded properly.
## Copyright
Copyright (c) 2020 Dash Core Group, Inc. [Licensed under the MIT
License](https://opensource.org/licenses/MIT)