The purpose of this URI scheme is to enable users to easily make SLP token & Bitcoin Cash payments by simply clicking links on webpages or scanning QR Codes.
SLP 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.
Graphical SLP clients SHOULD register themselves as the handler for the "simpleledger:" 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.
SLP URIs follow the general format for URIs as set forth in RFC 3986. The path component consists of a simpleledger 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.
| Placeholder | Format |
|---|---|
| slpurn | = "simpleledger:" address [ "?" params ] |
| address | = *slpaddr |
| params | = param [ "&" params ] |
| param | = [ amountparam / multiamounts / labelparam / messageparam / otherparam / reqparam ] |
| amountparam | = "amount=" *digit [ "." *digit ] [ tokenid ] |
| multiamounts | = multiamount [ "&" multiamounts ] |
| multiamount | = "amount" *uniquechar "=" *digit [ "." *digit ] [ tokenid ] |
| tokenid | = "-" 64*hexchar [ "-" tokenflags ] |
| tokenflags | = tokenflag [ "-" tokenflags ] |
| tokenflag | = [ "isgroup" / *qchar ] |
| labelparam | = "label=" *qchar |
| messageparam | = "message=" *qchar |
| otherparam | = qchar *qchar [ "=" *qchar ] |
| reqparam | = "req-" qchar *qchar [ "=" *qchar ] |
- Bitcoin Cash is the blockchain associated with the "simpleledger" URI scheme.
- If
tokenflagsis omitted the payment shall be made using the tokenid specified. However, if theisgrouptokenflag option is provided then the payment request can satisfied using any valid NFT originating from the NFT group tokenid provided. Read NFT group specification here for more information. In the future additionaltokenflagoptions may be possible. - The character set requirements for the
*slpaddraddress format are specified here.
This section is non-normative and does not cover all possible syntax. Please see the BNF grammar above for the normative syntax.
-
Just the address:
simpleledger:qqmtw4c35mpv5rcjnnsrskpxvzajyq3f9ygldn8fj0
-
Address with name:
simpleledger:qqmtw4c35mpv5rcjnnsrskpxvzajyq3f9ygldn8fj0?label=Satoshi-Nakamoto
-
Request 10.0001 XYZ tokens to "Satoshi-Nakamoto":
simpleledger:qqmtw4c35mpv5rcjnnsrskpxvzajyq3f9ygldn8fj0?amount1=10.0001-<xyzTokenID>&label=Satoshi-Nakamoto
-
Request 20.30 BCH & 1000 XYZ tokens to "Satoshi-Nakamoto":
simpleledger:qqmtw4c35mpv5rcjnnsrskpxvzajyq3f9ygldn8fj0?amount=20.3&amount2=1000-<xyzTokenID>&label=Satoshi-Nakamoto
-
Request 50 BCH & 1 ABC token with message:
simpleledger:qqmtw4c35mpv5rcjnnsrskpxvzajyq3f9ygldn8fj0?amount1=50&amount2=1-<abcTokenID>&label=Satoshi-Nakamoto&message=Donation%20for%20project%20xyz
-
Request any 1 NFT token from group XYZ (using "isgroup"):
simpleledger:qqmtw4c35mpv5rcjnnsrskpxvzajyq3f9ygldn8fj0?amount1=1&amount2=1-<xyzGroupID>-isgroup&label=Satoshi-Nakamoto
-
Some future version that has variables which are (currently) not understood and required and thus invalid:
simpleledger:qqmtw4c35mpv5rcjnnsrskpxvzajyq3f9ygldn8fj0?req-somethingyoudontunderstand=50&req-somethingelseyoudontget=999
-
Some future version that has variables which are (currently) not understood but not required and thus valid:
simpleledger:qqmtw4c35mpv5rcjnnsrskpxvzajyq3f9ygldn8fj0?somethingyoudontunderstand=50&somethingelseyoudontget=999
- Electron Cash SLP
- Badger
- SLPJS Utils.parseSlpUri()