Skip to content

Commit

Permalink
feat: RFC-0154 - /contacts and /profile deep links
Browse files Browse the repository at this point in the history
- Added /contacts and /profile deep links descriptions to the RFC-0154
  • Loading branch information
TruszczynskiA committed Jun 6, 2023
1 parent 4a52db7 commit a208aff
Showing 1 changed file with 29 additions and 3 deletions.
32 changes: 29 additions & 3 deletions src/RFC-0154_DeepLinksConvencion.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,7 @@ 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
tari://nextnet/contacts/list[0][alias]=MrTari&list[0][hex]=01234556789abcde&list[1][alias]=AdamSmith&list[1][hex]=edcba9876543210
```

### Deeplinks in use:
Expand All @@ -113,8 +114,33 @@ The data contains a custom base node configuration. This deep link adds a new ba
| name | String | The name of the base node |
| peer | String | Base node's public link and onion address combined together |

* `{network_name}/contacts`

List of contacts. This deep link is used to share multiple Tari contacts with another user.

| Value Name | Value Type | Note |
| ---------- | :--------------: | ----------------------------------------------------- |
| list | Array\<Contact\> | List of `Contact` objects |

`Contact` object

| Value Name | Value Type | Note |
| ---------- | :--------: | ----------------------------------------------------------- |
| alias | String? | Contact's name/alias |
| hex | String | Contact's Tari Address |

* `{network_name}/profile`

User's profile card. It is used to initiate the transaction with a predefined receiver address and presented alias.

| Value Name | Value Type | Note |
| ---------- | :--------: | ----------------------------------------------------------- |
| alias | String | User's name/alias |
| hex | String | User's Tari Address |

# Change Log

| Date | Change | Author |
|:------------|:--------------------|:----------|
| 19 Apr 2023 | First stable, replace public key with tari address | SWvHeerden|
| Date | Change | Author |
|:------------|:-------------------------------------------------------------|:--------------------------------------------------------|
| 19 Apr 2023 | First stable, replace public key with tari address | [SWvHeerden](https://github.com/SWvheerden) |
| 06 Jun 2023 | Added descriptions for `/contacts` and `/profile` deep links | [Adrian Truszczyński](https://github.com/TruszczynskiA) |

0 comments on commit a208aff

Please sign in to comment.