Skip to content
This repository has been archived by the owner on Jun 14, 2024. It is now read-only.

feat(60/STATUS-URL-SCHEME): initial draft #602

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
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
70 changes: 70 additions & 0 deletions content/docs/rfcs/60/README.md
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is very raw

@fryorcraken and what do you suggest?

  1. Merge it with feat(59/STATUS-URL-DATA): initial draft #600?
  2. Extend it for deep link implementations after
    a. Use https:// deep links instead of status-im:// - Windows status-im/status-desktop#9549
    b. Use https:// deep links instead of status-im:// - MacOS status-im/status-desktop#7957
    c. Make deep links work for Linux status-im/status-desktop#8027
  3. Else?

This should grow with more paths being supported post MVP, and personally I wouldn't mind keeping it separate, simple and serve more as an overview with references.

Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
---
slug: 60
title: 60/STATUS-URL-SCHEME
name: Status URL Scheme
status: draft
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
status: draft
status: raw

category: Standards Track
tags: waku-application
editor: Felicio Mununga <felicio@status.im>
contributors:
---

# Abstract

This document describes URL scheme for previewing and deep linking content as well as for triggering actions.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This document describes URL scheme for previewing and deep linking content as well as for triggering actions.
This document specifies an URL scheme for previewing and deep linking content as well as for triggering actions.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Assuming this RFC is planned to grow into a normative specification.


# Background / Rationale / Motivation

## Requirements

### Related scope

#### Features

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These features would need more context. E.g. what is an onboarding website, etc.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

- Onboarding website
- Link preview
- Link sharing
- Deep linking
- Routing and navigation
- Payment requests
- Chat creation

# Wire Format Specification / Syntax

## Schemes

- Internal `status-app://`
- External `https://` (i.e. univers/deep links)

## Paths

| Name | Url | Description |
| ----- | ---- | ---- |
| User profile | `/u/<encoded_data>#<user_chat_key>` | Preview/Open user profile |
| | `/u#<user_chat_key>` | |
| | `/u#<ens_name>` | |
| Community | `/c/<encoded_data>#<community_chat_key>` | Preview/Open community |
| | `/c#<community_chat_key>` | |
| Community channel | `/cc/<encoded_data>#<community_chat_key >`| Preview/Open community channel |
| | `/cc/<channel_uuid>#<community_chat_key>` | |

<!-- # Security/Privacy Considerations

A standard track RFC in `stable` status MUST feature this section.
A standard track RFC in `raw` or `draft` status SHOULD feature this section.
Informational RFCs (in any state) may feature this section.
If there are none, this section MUST explicitly state that fact.
This section MAY contain additional relevant information, e.g. an explanation as to why there are no security consideration for the respective document. -->

# Discussions

- See <https://github.com/status-im/specs/pull/159>
- See <https://github.com/status-im/status-web/issues/327>

# Copyright

Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).

# References

- [59/STATUS-URL-DATA](/spec/59/)
Copy link
Author

@felicio felicio May 16, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See #600

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This reference should be used somewhere in the text.

I assume /59 specifies the encoding which is used to encode the URL scheme specified in this doc?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right.

1 change: 1 addition & 0 deletions content/menu/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ bookMenuLevels: 1
- [54/WAKU2-X3DH-SESSIONS]({{< relref "/docs/rfcs/54/README.md" >}})
- [55/STATUS-1TO1-CHAT]({{< relref "/docs/rfcs/55/README.md" >}})
- [56/STATUS-COMMUNITIES]({{< relref "/docs/rfcs/56/README.md" >}})
- [60/STATUS-URL-SCHEME]({{< relref "/docs/rfcs/60/README.md" >}})
- Stable
- [2/MVDS]({{< relref "/docs/rfcs/2/README.md" >}})
- [6/WAKU1]({{< relref "/docs/rfcs/6/README.md" >}})
Expand Down