6
URI Formatting
luigi1111 edited this page 2021-08-19 23:03:30 -04:00
Table of Contents
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 for explanation. Spaces must be x-www-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?). |
| tx_payment_id | String | ? | The proposed payment ID of the transaction. |
| recipient_name | String | ? | The proposed contact name of the recipient. |
| tx_amount | String | query | The proposed amount of the transaction in decimal units. |
| tx_description | String | fragment | Describes the transaction which should be initiated. |
Thus the resulting URI may look something like this:
monero:46BeWrHpwXmHDpDEUmZBWZfoQpdc6HaERCNmx1pEYL2rAcuwufPN9rXHHtyUA4QVy66qeFQkn6sfK8aHYjA3jk3o1Bv16em?tx_amount=239.39014&tx_description=donation
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 mnemonic_seed and (spend_key,view_key) may/must be specified.
| Parameter | Type | Description |
|---|---|---|
| address | String | Raw (95-character) address |
| spend_key | Hex String | Private spend key of a wallet. |
| view_key | Hex String | Private view key of a wallet. |
| mnemonic_seed | String | URL Encoded seed to restore a deterministic wallet. |
| height | Long | Block height when the wallet was created. |
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