Skip to content

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

⭐ Getting Started

Ethereum Push Notification Service (EPNS) is the world’s first decentralized communication & notification protocol for Web3.

Using the protocol, any smart contract, dApp, or backend service can send on-chain or off-chain notifications tied to the wallet addresses of users in a gasless, multichain, open, and platform-agnostic way.

Being an open communication middleware, notifications can be integrated and shown on any crypto wallet, mobile app, browser extension, or dApps enabling a native communication layer for Web3.0

Quick Guide to Getting Started with EPNS 🛣
  • Any user who activates themselves on the protocol to send a notification is called a Channel.
  • In other words, a Channel is any service (protocol, dApp, or even web2 service) that wants to send notifications out to web3 usernames (wallet addresses).
  • A wallet address can create only one Channel **** on the protocol.
  • A channel is free to delegate (or revoke delegates) sending notifications functionality to any other wallet addresses on their behalf.
  • Creating a channel requires 50 DAI and Channel info (Channel name, Image, description, CTA) and some ETH too.
  • Channels can send notifications to their users(wallet addresses) in a number of ways including:
    • Backend SDK (Gasless, Best for automated logic from dApp / Backend)
    • ****Showrunners Framework (Scaffold / Gasless, Best for automated logic via scaffold backend)
    • Smart contract to Smart contract (requires gas, **** Best for instant on-chain events, piggybacks on an on-chain transaction via Interface ABI call)
    • Manually from EPNS dApp (Gasless, Best for manual logic)
  • Opted-in users are called subscribers of the Channels. Subscribers of the Channel receive notifications from those Channels in their Inboxes.
  • Non-opted users or non-subscribers of the Channel aren't alerted when they receive a notif from a non-subscribed channel, instead, it lands in their spam folder.
  • Currently, we have Staging and Prod dApp that interfaces with EPNS Protocol to enable communication & notifications.

Developer Guides & Concepts

1. Channels

🖥 Lear️n everything about channels, their working mechanisms, and how to create one.

2. Notificatins

🔔 Explore all about notifications, their types, the different ways of sending and receiving notifications as well as other imperative details.

3. EPNS SDK

⚙ Understand the key features of EPNS SDK and how to use it in your own project easily.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors