Skip to content

Commit

Permalink
docs(rfc): deep links structure convention - deep links is use (#3897)
Browse files Browse the repository at this point in the history
- Added a list of the deep links in use with the short description and documentation of the passed values.
  • Loading branch information
TruszczynskiA authored Mar 7, 2022
1 parent 023a250 commit 5169a80
Showing 1 changed file with 23 additions and 2 deletions.
25 changes: 23 additions & 2 deletions RFC/src/RFC-0154_DeepLinksConvencion.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Deep links structure convention.

![status: raw](theme/images/status-raw.svg)
![status: raw](theme/images/status-draft.svg)

**Maintainer(s)**: [Adrian Truszczyński](https://github.com/TruszczynskiA)

Expand Down Expand Up @@ -90,4 +90,25 @@ Combining all three components, they will form a deep link with a structure pres
tari://mainnet/profile
tari://mainnet/profile/username
tari://testnet/payments/send?amount=1.23&pubKey=01234556789abcde
```
```

### Deeplinks in use:

* `/transactions/send`

The data contains transaction information used in the send tokens process.

| Value Name | Value Type | Note |
| ---------- | :--------: | ---------------------------- |
| publicKey | String | Receiver's public key |
| amount | UInt64? | The amount in micro Tari |
| note | String? | Note passed with transaction |

* `/base_nodes/add`

The data contains a custom base node configuration. This deep link adds a new base node configuration to the pool and switches to the added base node.

| Value Name | Value Type | Note |
| ---------- | :--------: | ----------------------------------------------------------- |
| name | String | The name of the base node |
| peer | String | Base node's public link and onion address combined together |

0 comments on commit 5169a80

Please sign in to comment.