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: improve RFC-0154 - Update #148

Merged
merged 1 commit into from
Jul 17, 2024
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
37 changes: 19 additions & 18 deletions src/RFC-0154_DeepLinksConvencion.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +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
tari://nextnet/contacts/list[0][alias]=MrTari&list[0][tariAddress]=01234556789abcde&list[1][alias]=AdamSmith&list[1][tariAddress]=edcba9876543210
```

### Deeplinks in use:
Expand All @@ -99,11 +99,11 @@ tari://nextnet/contacts/list[0][alias]=MrTari&list[0][hex]=01234556789abcde&list

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

| Value Name | Value Type | Note |
| ---------- | :--------: | ---------------------------- |
| tariAddress | String | Receiver's Tari Address |
| amount | UInt64? | The amount in micro Tari |
| note | String? | Note passed with transaction |
| Value Name | Value Type | Note |
| ---------- | :--------: | -------------------------------- |
| tariAddress | String | Receiver's Tari Address (base58) |
| amount | UInt64? | The amount in micro Tari |
| note | String? | Note passed with transaction |

* `{network_name}/base_nodes/add`

Expand All @@ -124,23 +124,24 @@ List of contacts. This deep link is used to share multiple Tari contacts with an

`Contact` object

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

* `{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 |
| Value Name | Value Type | Note |
| ----------- | :--------: | ----------------------------------------------------------- |
| alias | String | User's name/alias |
| tariAddress | String | User's Tari Address (base58) |

# Change Log

| 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) |
| 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) |
| 17 Jul 2024 | Updated documentation for `transactions/send`, `/contacts`, and `/profile` deep links | [Adrian Truszczyński](https://github.com/TruszczynskiA) |
Loading