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

Add Try subscribe/broadcast flow doc #19

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Conversation

jhaaaa
Copy link
Collaborator

@jhaaaa jhaaaa commented Aug 23, 2024

Copy link

vercel bot commented Aug 23, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs-xmtp-org ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 24, 2024 0:53am


With XMTP, messages from a contact you haven't messaged before are kept out of your main inbox until you explicitly approve the contact. Only then can the messages display in your main inbox. This helps you keep your main inbox free from spammy and scammy messages.

<img src="https://raw.githubusercontent.com/xmtp/docs-xmtp-org/main/docs/pages/img/main-vs-spam.gif" alt="Gif showing the difference between contacts and conversations in a user's main inbox vs scammy/spammy conversations in a user's secondary requests and spam inboxes" width="50%"/>
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

jha looking for better inbox to capture in gif

2. Connect the wallet you want to subscribe to the broadcast. To demonstrate the consent feature of the Subscribe button, be sure to connect a wallet address that has not already exchanged messages with the broadcast address.
3. Select the broadcast you defined.
4. Click **Subscribe**.
5. Go to XXXXXXxmtp web app on devXXXXXX and connect the subscribed wallet address. The example welcome broadcast message displays in the main inbox.
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Need a web app running on the dev network that also supports consent proofs. Asking Fabri and Saul about this on Mon.

3. In the broadcast dropdown menu, select the broadcast you defined.
4. In the broadcast text field, enter example broadcast text.
5. Click **Broadcast** to send the example broadcast text to the subscribed address.
6. Go to XXXXXXxmtp web app on devXXXXXX and connect the subscribed wallet address. The example broadcast message displays in the main inbox.
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Need a web app running on the dev network that also supports consent proofs. Asking Fabri and Saul about this on Mon.


You can also use the example subscribe-broadcast page to send an example broadcast message.

1. In the **broadcast-example-api** repo, update `addresses.json` to include only the address you just subscribed to the broadcast.
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

In a real-life flow, how does the connected address that clicked the Subscribe button get saved so that this manual step isn't required?

And more specifically, how can a creator get their subscriber list without having to rely on the third-party service they may be using to actually do their subscribe/broadcast? I think this needs to be possible when we say that creators can take their audiences with them.


```html
curl -X GET "http://localhost:6989/broadcast?broadcastId=0624abaf-0312-4653-8236-1ff6bda21328"
```
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

How do https://www.npmjs.com/package/@xmtp/broadcast-sdk and https://github.com/alexrisch/broadcaster-app come into the picture? Is there an opportunity to surface them in this README?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant