Git-Mirrors/monero
1
0
Fork 0
mirror of https://github.com/monero-project/monero.git synced 2025-08-09 18:02:24 -04:00
Code Issues Projects Releases Packages Wiki Activity

docs: add URI scheme

Browse source
This commit is contained in:
tobtoht 2025-07-13 22:29:58 +02:00
parent a1aef9e017
commit d5eb1e6518
No known key found for this signature in database
GPG key ID: E45B10DD027D2472
1 changed files with 62 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

62
docs/URI_SCHEME.md Normal file
View file

@ -0,0 +1,62 @@
# URI Formatting
URIs are useful for easy payment solutions, especially for the use of merchandising purposes by generating QR codes from the specification-regulated protocol scheme described below.
Its syntax follows RFC 3986. See [URI scheme](https://en.wikipedia.org/wiki/URI_scheme) for explanation. Spaces must be [x-www-urlencoded](https://en.wikipedia.org/wiki/Application/x-www-form-urlencoded) as `%20`.
## TX Scheme
```
monero: [address <string>]
```
The following parameters can be optionally appended to the resulting URI:
| Parameter | Type | Kind | Description |
|:-----------------|:------:|:----:|:------------|
| `address` | String | hierarch.| The raw address (or the openalias?). Multiple addresses can be provided if separated by a semicolon (`;`).|
| `recipient_name` | String | ? | The proposed contact name of the recipient. Multiple names can be provided if separated by a semicolon (`;`).|
| `tx_amount` | String | query | The proposed amount of the transaction in decimal units. Multiple amounts can be provided if separated by a semicolon (`;`).|
| `tx_description` | String | fragment | Describes the transaction which should be initiated. |
>*Note:* If multiple `address` parameters are supplied, there must be a matching number of `tx_amount` parameters.
>*Note:* The `tx_payment_id` parameter was supported in earlier versions of this specification but is now deprecated and no longer allowed for manual inclusion.
Thus the resulting URI may look something like this:
```
monero:46BeWrHpwXmHDpDEUmZBWZfoQpdc6HaERCNmx1pEYL2rAcuwufPN9rXHHtyUA4QVy66qeFQkn6sfK8aHYjA3jk3o1Bv16em?tx_amount=239.39014&tx_description=donation
```
or
```
monero:46BeWrHpwXmHDpDEUmZBWZfoQpdc6HaERCNmx1pEYL2rAcuwufPN9rXHHtyUA4QVy66qeFQkn6sfK8aHYjA3jk3o1Bv16em;888tNkZrPN6JsEgekjMnABU4TBzc2Dt29EPAvkRxbANsAnjyPbb3iQ1YBRk1UXcdRsiKc9dhwMVgN5S9cQUiyoogDavup3H?tx_amount=239.39014;132.44&tx_description=donations
```
## Wallet Definition Scheme
The following scheme is proposed as a means of describing wallets. This scheme may be used for restoring.
```
monero_wallet: [address <string>]
```
Only one of `seed` and `(spend_key,view_key)` may/must be specified.
| Parameter | Type | Requires | Description |
|:---------------|:------: |:-------- |:------------|
| `address` | String | `view_key` |Raw (95-character) address |
| `spend_key` | Hex String | `address`, `view_key` | Private spend key of a wallet. |
| `view_key` | Hex String | `address`, absence of `seed` | Private view key of a wallet. |
| `seed` | String | Absence of `view_key` | URL encoded mnemonic seed to restore a deterministic wallet. |
| `height` | Long | Absence of `txid` | Block height when the wallet was created. |
| `txid` | String | Absence of `height` | Transaction ID(s) to scan. Multiple transaction IDs can be provided if separated by a semicolon (`;`). |
>*Note:* The `seed` parameter was named `mnemonic_seed` in earlier versions of this specification.
The resulting URI for a wallet may look like this:
```
monero_wallet:467iotZU5tvG26k2xdZWkJ7gwATFVhfbuV3yDoWx5jHoPwxEi4f5BuJQwkP6GpCb1sZvUVB7nbSkgEuW8NKrh9KKRRga5qz?spend_key=029c559cd7669f14e91fd835144916009f8697ab5ac5c7f7c06e1ff869c17b0b&view_key=afaf646edbff3d3bcee8efd3383ffe5d20c947040f74e1110b70ca0fbb0ef90d
```
or
```
monero_wallet:467iotZU5tvG26k2xdZWkJ7gwATFVhfbuV3yDoWx5jHoPwxEi4f5BuJQwkP6GpCb1sZvUVB7nbSkgEuW8NKrh9KKRRga5qz?seed=python%20runway%20gossip%20lymph%20hills%20karate%20ruined%20innocent%20ought%20dual%20shipped%20shipped%20sushi%20pyramid%20guys%20entrance%20obedient%20natural%20kiwi%20wobbly%20vixen%20wipeout%20template%20typist%20innocent&height=12345676
```