From 9e40cee62a61032d99d291a9afbb32bdb881a638 Mon Sep 17 00:00:00 2001
From: ATXMJ <26630769+ATXMJ@users.noreply.github.com>
Date: Mon, 6 Mar 2023 18:52:57 -0600
Subject: [PATCH] docs: add URI scheme and QR code standards (#68)

* docs: add URI scheme and QR code standards

* Update integrations.md

* style: add table of contents, section spacers, and change heading levels

* fix: update nano URI descriptions to match fields for clarity

---------

Co-authored-by: mistakia <1823355+mistakia@users.noreply.github.com>
---
 docs/getting-started-devs/integrations.md | 231 +++++++++++++++++++++-
 src/views/components/menu/menu.js         |   3 +
 2 files changed, 231 insertions(+), 3 deletions(-)

diff --git a/docs/getting-started-devs/integrations.md b/docs/getting-started-devs/integrations.md
index 96cf29d4..aa94376f 100644
--- a/docs/getting-started-devs/integrations.md
+++ b/docs/getting-started-devs/integrations.md
@@ -1,7 +1,232 @@
 ---
-title: Integration
+title: Integrations
 description: Integrating with Nano
-tags: nano, integration, guide, building, development
+tags: nano, integration, guide, building, development, uri, links, qr
 ---
 
-# Integration
+# Integrations
+
+### Table of Contents
+
+- [URI Scheme Standards](#uri-scheme-standards)
+- [QR Code Standards](#qr-code-standards)
+
+---
+
+## URI Scheme Standards
+
+Nano wallet clients should support handling of both URI scheme standards: the universal [`payto:` scheme](#payto-payment-invocation-uri-scheme), as well as the original [`nano:` scheme](#nano-payment-invocation-uri-scheme).
+
+Deep links for payment invocation should prefer the payto standard and use the format `payto://` rather than `payto:`.
+
+`amount` values must always default to [RAW units](https://docs.nano.org/protocol-design/distribution-and-units/).
+
+<small>For the `payto:` scheme, other currencies or units may be manually specified (eg XNO, USD, EUR) using the `currency` option.</small>
+
+### Table of Contents
+
+- [`payto:` URI scheme](#payto-payment-invocation-uri-scheme)
+- [`nano:` URI scheme](#nano-payment-invocation-uri-scheme)
+
+---
+
+## payto: Payment Invocation URI Scheme
+
+The `payto:` URI scheme, defined in [RFC-8905](https://www.rfc-editor.org/rfc/rfc8905.html) is a universal standard for designating targets for payments.
+
+### Syntax
+
+```
+payto:nano/nano_<encoded_address>/[?][amount=[<currency>:]<raw_amount>][&][receiver_name=<receiver_name>][&][message=<message>]
+```
+
+<small>Note: Clients MUST accept URIs with options in any order.</small>
+
+#### encoded_address (required)
+
+The recipient's [public Nano address](https://docs.nano.org/integration-guides/the-basics/#account-public-address) MUST be provided, and MUST be encoded using Nano's base32 encoding algorithm.
+
+#### currency
+
+The 3-letter [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217) currency code (or `RAW` or `XNO`). The client SHOULD reference current exchange rates to convert the `amount` value to the currently corresponding amount in [RAW units](https://docs.nano.org/protocol-design/distribution-and-units/). If `XNO` is specified, the client MUST convert the `amount` value to `RAW` units.
+
+<small>MUST default to `RAW`</small>
+
+#### amount
+
+The amount to transfer. If a `currency` value is not provided, the client MUST default to [RAW units](https://docs.nano.org/protocol-design/distribution-and-units/). If `XNO` is specified, the client MUST convert the value to `RAW` units.
+
+<small>MUST not occur more than once.</small>
+
+#### receiver_name
+
+Name of the entity that receives the payment (creditor).
+
+<small>Note: The Nano protocol does not support receiver names. The client may choose to use or ignore this option.</small>
+
+#### message
+
+A short message to identify the purpose of the payment.
+
+<small>Note: The Nano protocol does not support messages. The client may choose to use or ignore this option.</small>
+
+---
+
+## nano: Payment Invocation URI Scheme
+
+### Syntax
+
+```
+nano:nano_<encoded_address>[?][amount=<raw_amount>][&][label=<label>][&][message=<message>]
+```
+
+<small>Note: Clients MUST accept URIs with options in any order.</small>
+
+#### encoded_address (required)
+
+The recipient's [public Nano address](https://docs.nano.org/integration-guides/the-basics/#account-public-address). MUST be provided, and MUST be encoded using Nano's base32 encoding algorithm.
+
+#### amount
+
+MUST not occur more than once.
+The amount to transfer in [RAW units](https://docs.nano.org/protocol-design/distribution-and-units/).
+
+#### label
+
+A short label to identify or organize the transaction.
+
+<small>Note: The Nano protocol does not support receiver names. The client may choose to use or ignore this option.</small>
+
+#### message
+
+A short message for the transaction recipient.
+
+<small>Note: The Nano protocol does not support messages. The client may choose to use or ignore this option.</small>
+
+### Additional nano\*: Action Invocation URI Schemes
+
+In addition to payment invocation URI schemes, Nano clients may support the following action invocation URI scheme standards.
+
+#### Representative change
+
+```
+nanorep:nano_<encoded address>[?][label=<label>][&][message=<message>]
+```
+
+#### Private key import
+
+```
+nanokey:<encoded private key>[?][label=<label>][&][message=<message>]
+```
+
+#### Seed import
+
+```
+nanoseed:<encoded seed>[?][label=<label>][&][message=<message>][&][lastindex=<index>]
+```
+
+#### JSON blob block processing
+
+Sent as the `block` argument to the RPC call [`process`](https://docs.nano.org/commands/rpc-protocol/#process)
+
+```
+nanoblock:<json>
+```
+
+---
+
+## URI Scheme Examples
+
+### Payment with address only
+
+#### payto: <small>(recommended)</small>
+
+```
+payto:nano/nano_3wm37qz19zhei7nzscjcopbrbnnachs4p1gnwo5oroi3qonw6inwgoeuufdp
+```
+
+#### nano:
+
+```
+nano:nano_3wm37qz19zhei7nzscjcopbrbnnachs4p1gnwo5oroi3qonw6inwgoeuufdp
+```
+
+---
+
+### Payment with address and amount
+
+#### payto: <small>(recommended)</small>
+
+```
+payto:nano/nano_3wm37qz19zhei7nzscjcopbrbnnachs4p1gnwo5oroi3qonw6inwgoeuufdp?amount=1000
+```
+
+#### nano:
+
+```
+nano:nano_3wm37qz19zhei7nzscjcopbrbnnachs4p1gnwo5oroi3qonw6inwgoeuufdp?amount=1000
+```
+
+---
+
+### Payment with address and recipient name / label
+
+#### payto: <small>(recommended)</small>
+
+```
+payto:nano/nano_3wm37qz19zhei7nzscjcopbrbnnachs4p1gnwo5oroi3qonw6inwgoeuufdp?receiver-name=Developers%20Fund%20Address
+```
+
+#### nano:
+
+```
+nano:nano_3wm37qz19zhei7nzscjcopbrbnnachs4p1gnwo5oroi3qonw6inwgoeuufdp?label=Developers%20Fund%20Address
+```
+
+---
+
+### Payment with address, recipient name / label, and message
+
+#### payto: <small>(recommended)</small>
+
+```
+payto:nano/nano_3wm37qz19zhei7nzscjcopbrbnnachs4p1gnwo5oroi3qonw6inwgoeuufdp?receiver-name=Developers%20Fund%20Address&message=Donate%20Now
+```
+
+#### nano:
+
+```
+nano:nano_3wm37qz19zhei7nzscjcopbrbnnachs4p1gnwo5oroi3qonw6inwgoeuufdp?label=Developers%20Fund%20Address&message=Donate%20Now
+```
+
+---
+
+### Payment with address, amount, recipient name / label, and message
+
+#### payto: <small>(recommended)</small>
+
+```
+payto:nano/nano_3wm37qz19zhei7nzscjcopbrbnnachs4p1gnwo5oroi3qonw6inwgoeuufdp?amount=1000&receiver-name=Developers%20Fund%20Address&message=Donate%20Now
+```
+
+#### nano:
+
+```
+nano:nano_3wm37qz19zhei7nzscjcopbrbnnachs4p1gnwo5oroi3qonw6inwgoeuufdp?amount=1000&label=Developers%20Fund%20Address&message=Donate%20Now
+```
+
+---
+
+### Representative change
+
+#### nano:
+
+```
+nanorep:nano_1stofnrxuz3cai7ze75o174bpm7scwj9jn3nxsn8ntzg784jf1gzn1jjdkou?label=Official%20Rep%202&message=Thank%20you%20for%20changing%20your%20representative%21
+```
+
+---
+
+## QR Code Standards
+
+QR codes should also be clickable deep links using the [`payto://` URI scheme](#payto-payment-invocation-uri-scheme), or the corresponding [nano action URI scheme](#additional-nano-action-invocation-uri-schemes).
diff --git a/src/views/components/menu/menu.js b/src/views/components/menu/menu.js
index c3d72be8..1b3fbfd4 100644
--- a/src/views/components/menu/menu.js
+++ b/src/views/components/menu/menu.js
@@ -68,6 +68,9 @@ function MenuSections() {
           <NavLink to='/getting-started-devs/getting-started'>
             Getting Started
           </NavLink>
+          <NavLink to='/getting-started-devs/integrations'>
+            Integrations
+          </NavLink>
           <NavLink to='/getting-started-devs/running-a-node'>
             Running a node
           </NavLink>