You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Nov 22, 2023. It is now read-only.
Copy file name to clipboardexpand all lines: concepts/web3-notifications/README.md
+2-57
Original file line number
Diff line number
Diff line change
@@ -6,61 +6,6 @@ description: >-
6
6
7
7
# Push Notification for Web3
8
8
9
-
Any successfully created channel, in its **active** state, can send notifications to its subscribers about a wide range of things related to defi, governance proposals, web3 news, or any other crucial updates about their protocol/services.
9
+
Section has been moved to:
10
10
11
-
Notifications land in the inbox of those users who are subscribed to the channel. Non-subscribers of a particular channel aren't alerted about notifications from that channel as they land in their spam box.
12
-
13
-
## Who can Send Notifications?
14
-
15
-
As per the current design of the protocol, there can be 3 main actors who can send notifications:
16
-
17
-
**1. Channel Owners:** The owners of a particular channel can send notifications to their subscribers.
18
-
19
-
**2**. **Delegate Notification Senders:** Channel owners can allow any particular wallet address to send notifications on behalf of his/her channel. This feature is called delegated notifications and you can read more about it in this section 👉[what-are-delegated-notifications.md](what-are-delegated-notifications.md"mention")
20
-
21
-
**3. Notifications To Yourself:** The Push Communicator allows any address to send notifications to themselves 😃 It’s important to note, however, that the address sends the notification to themselves only.
22
-
23
-
{% hint style="info" %}
24
-
**Note:**
25
-
26
-
_Sending notifications is a gasless transaction and therefore notification senders need not pay any gas fee while sending notifications via the Dapp._
27
-
28
-
\
29
-
_**Gas** Fees__are only applicable when **on-chain notifications** are triggered directly from smart contracts._
30
-
{% endhint %}
31
-
32
-
Now that you have a brief overview of notifications in the protocol, let's understand and explore the different ways to send notifications to your users.
Copy file name to clipboardexpand all lines: concepts/web3-notifications/create-your-notif-channel/README.md
+2-46
Original file line number
Diff line number
Diff line change
@@ -4,50 +4,6 @@ description: Quick explainer of what channels are, their state cycles and verifi
4
4
5
5
# What are Channels?
6
6
7
-
Any user who activates themselves as a service on the protocol to send notifications for its users can be considered a **Channel**.
7
+
Section has been moved to new documentation:
8
8
9
-
In other words, any service, i.e., a dapp, protocol, or even a web2 service, that wants to send notifications out to its web3 users can choose to become a channel and establish an adequate communication bridge with its users.
10
-
11
-
The creation of a channel is just a one-time simple procedure. It must be noted that channel creation only happens on the **Ethereum** blockchain and one wallet address can only create one channel only the protocol.
12
-
13
-
{% hint style="info" %}
14
-
**Note:**_Although channel creation only happens on the Ethereum blockchain, the protocol is designed to be chain-agnostic, i.e., channel owners can choose to send notification on any chain of their choice and not just Ethereum network_\
15
-
\
16
-
_This is discussed extensively in the following section 👉_ [enabling-channel-on-other-chains](../../../developer-guides/create-your-notif-channel/enabling-channel-on-other-chains/"mention")
17
-
{% endhint %}
18
-
19
-
A successfully created channel is capable of _**sending notifications**_ to its subscribers, directly tied to their wallet addresses. Any wallet address can become a subscriber of a particular channel by simply **opting into** that channel. 
20
-
21
-
Once opted in, the subscriber shall receive notifications from that channel directly in their inbox. Users who are not a subscriber of a particular channel, receive notifications from that channel in their spam box.
22
-
23
-
{% hint style="info" %}
24
-
_**Opting In or Opting out of a Channel is a completely gasless transaction and requires no fees.**_
25
-
26
-
How to Opt-In to a Channel? 👉 [**Opting-Into a Channel**](https://docs.epns.io/users/epns-dapp/opting-in-to-a-channel)
27
-
{% endhint %}
28
-
29
-
Moreover, the owner of a channel can also choose to _**delegate his/her notification sending power to any other wallet address**_. This enables the selected wallet address to send notifications on behalf of the channel. The channel owner, however, can choose to remove the delegate at any given time. 
30
-
31
-
### How to create a Channel?
32
-
33
-
Now that you have a good understanding of channels, you can follow the quick guide mentioned below to create a channel and start communicating with your users.
If you wish to dive in a bit deep and understand more about channels, their creation procedure, different channel states, verification mechanismsm, etc, please follow the guides mentioned below 👇
Channel Delegates are additional wallets that the channel creators have authorised to send notifications on the channels behalf. 
3
+
Section has been moved to new documentation:
4
4
5
-
They are extremely useful to expand on sending notification capabilities and helps in ensuring an additional level of security besides enabling multiple wallets to send notifications on your behalf.
Copy file name to clipboardexpand all lines: concepts/web3-notifications/create-your-notif-channel/what-is-a-channel-alias.md
+2-16
Original file line number
Diff line number
Diff line change
@@ -4,20 +4,6 @@ description: A quick guide to explain the channel alias feature and its signific
4
4
5
5
# What is a Channel Alias
6
6
7
-
While we know that a channel is created on the Ethereum blockchain, it doesn't necessarily mean that notifications can only be sent on the ETH chain. The protocol is designed to make channels capable of sending notifications on any other chain. Even non-Ethereum ones!
7
+
Section has been moved to new documentation:
8
8
9
-
In order to enable your channel to be blockchain-agnostic and allow multi-chain communication, we have introduced a new term called **Channel Alias.** This property is what enables your channel to send notifications on any other blockchain.
10
-
11
-
## What is Channel Alias?
12
-
13
-
In simpler terms, a channel alias address is a native representation of your Ethereum channel on any other EVM or Non-EVM chain through which you wish to communicate with your subscribers.
14
-
15
-
This means that although channel creation must happen on the Ethereum blockchain itself, notifications or communications can be carried out on any other chain through the same channel if the channel has its alias address adequately configured for that particular chain. 
16
-
17
-
You can communicate with your subscribers on Polygon, BSC, Solana, etc. using an Alias address that is compatible with that respective blockchain.
18
-
19
-
### How to set-up a Channel Alias for your channel?
Copy file name to clipboardexpand all lines: concepts/web3-notifications/types-of-notifications.md
+2-13
Original file line number
Diff line number
Diff line change
@@ -4,18 +4,7 @@ description: Quick explainer of the different types of Notifications
4
4
5
5
# Types of Notifications
6
6
7
-
Below listed are the different types of notifications you can send to the subscribers of your channel on Push protocol. 👇🏼
7
+
_Section has been moved to new documentation:_\
8
8
9
-
***Broadcast Notifications:** This type of notification is basically broadcasted or sent to all the subscribers of a channel at once.
10
-
***Targeted Notifications:** As the name suggests, this type of notification allows channel owners to notify a specific wallet address.
11
-
***Subset Notifications:** Subset notifications are quite helpful when a particular group of subscribers of a channel is supposed to be notified.
12
9
13
-
This list will keep on expanding as Push Protocol adds more and more notification types. For instance:
14
-
15
-
**Secret Notifications** => Notifications that are encrypted before sending using asymmetric encryption, i.e., the public key to encrypt and the private key to decrypt.
16
-
17
-
> _Check out the guide attached below to learn how easily each of the above-mentioned notification can be triggered through the dapp. 👇_
Copy file name to clipboardexpand all lines: concepts/web3-notifications/what-are-delegated-notifications.md
+2-16
Original file line number
Diff line number
Diff line change
@@ -4,20 +4,6 @@ description: Understanding the concept of Delegated Notifications.
4
4
5
5
# What are Delegated Notifications?
6
6
7
-
## Delegated Notifications
7
+
Section has been moved to new documentation:
8
8
9
-
Delegated notifications is a feature that allows channel owners to delegate their power of sending notifications to any other wallet address or multiple wallets of their choice.
10
-
11
-
Once approved by the channel owner, a wallet address can send notifications on behalf of the channel to its subscribers. The channel owner can, however, revoke the approval at any given time.
12
-
13
-
This mechanism of sending delegated notifications is quite effective in providing value-added services to the channels. It also ensures the availability of mechanisms that can be used by Push protocol or any other third-party infrastructure to send on-chain notifications on the channel’s behalf.
14
-
15
-
The channel owner can trigger the above-mentioned functions to either allow or remove an address as a valid notification sender. Once allowed, the specific address(es) can also send notifications on behalf of the channel.
16
-
17
-
{% hint style="info" %}
18
-
**Note:**_Adding a delegate notification sender doesn't remove the ability of the channel maintainer to send notifications._ 
19
-
20
-
_They can keep on sending notifications as well as the delegate notification sender which will always be shown as coming from the same channel._
Copy file name to clipboardexpand all lines: developer-guides/sending-notifications/notification-payload-types/README.md
+2-30
Original file line number
Diff line number
Diff line change
@@ -6,34 +6,6 @@ description: >-
6
6
7
7
# Notification Standard
8
8
9
-
Considering the fact that notifications have been so imperative as well as customizable in web2, we definitely need to ensure that the same experience carries forward in web3 and therefore we have divided notifications into two parts - _**Basic** and **Advanced**._\
9
+
Section has been moved to:
10
10
11
-
12
-
{% hint style="info" %}
13
-
**The notification standard (Basic)** covers all the requirements you need to know to start sending notifications.\
14
-
\
15
-
**Notification standard (Advanced)** covers topics related to the composability of the Push notification protocol, how it works, how it can be expanded, etc
Notifications follow composable blocks that helps achieve modular structure and helps in building on top of them. Any developer can utilize the notification protocol to send out notifications (on-chain or off-chain) to their users from a variety of platforms including web3 protocols, smart contracts, dapps, backend, etc. 
6
-
7
-
These notifications are tied to wallet address of the user and are indexed by push nodes allowing any crypto frontend such as wallet, dapp or mobile app to query and display these notifications for the wallet users along with sending them out as push notifications.
Identity - To understand the storage format and rules to interpret the notification payload
16
-
Payload - To understand what is the type of notification, what data it contains and to whom it should be addresses to
17
-
Content - To interpret or extend format types for content inside the notification
18
-
```
19
-
20
-
*`Verification` - It defines the way to verify that the payload is valid by checking sender, source, and authenticitiy of the payload content.
21
-
*`Identity` - Notification Identity Payload is the standard through which notification payload can be sent to Push Nodes for processing. There are multiple ways by which these payloads can be stored (storage-independent behavior) and identity ensures that the push node are able to understand and construct the notification payload from the data.
22
-
*`Payload` - Each notification sent to the protocol is essentially a JSON payload which contains data about things a notification contains, notification recipients and even data to encrypt these notifications. This json payload is what makes Push Protocol payload content-independent and allows for expansion to several new types of notifications based on the community needs and as the communication protocol develops further.
23
-
*`Content` - Notification Content Markdown standardize the content markdown and create a standard for styling and formatting.
0 commit comments