Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: rfc-0154 contacts and profile deep links #100

Merged
merged 1 commit into from
Jun 14, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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) |
Loading