PUSH SDK
PUSH SDK provides an abstraction layer to integrate PUSH protocol features with your Frontend as well as Backend
PUSH SDK is a growing Monorepo of packages that provide solutions for a wide range of development tasks one might come across while building on top of PUSH protocol. It is a Javascript-based group of packages that helps developers to:
  • Send notifications
  • Subscribe (opt-in) / Unsubscribe (opt-out)
  • Build PUSH features into their dApps
  • Enable Access to Push Nodes APIs
  • Render Default Notifications UI, etc
It is written in Typescript and supports React, React Native, Plain JS, and Node JS-based platforms. (We are adding support for more!).
It is also built on top of standard Web3 packages like ethers, @web3-react

PUSH SDK Features

A brief glance at the most imperative features of PUSH SDK along with the associated package and target platform.
Feature
Description
Monorepo package
Target platform
Sending Notification
Send notification to user(s) from a channel.
@epnsproject/sdk-restapi
UI, Server
Opting to a Channel
Subscribe to a channel
@epnsproject/sdk-restapi
UI, Server
Opting out of a Channel
Unsubscribe to a channel
@epnsproject/sdk-restapi
UI, Server
Fetch Notifications
Get all the notifications for a user address
@epnsproject/sdk-restapi
UI, Server
Fetch Spam
Get all the spam notifications for a user address
@epnsproject/sdk-restapi
UI, Server
Notification component
UI React Component to display a notification item.
@epnsproject/sdk-uiweb
UI
Fetch User Subscriptions
Get list of all the channels a user has subscribed.
@epnsproject/sdk-restapi
UI, Server
Fetch Channel Details
Get channel details for a specific channel address
@epnsproject/sdk-restapi
UI, Server
Search for channel(s)
Query for channel(s) using a keyword
@epnsproject/sdk-restapi
UI, Server
Notification View
UI React Native Component to display a notification item
@epnsproject/sdk-uimobile
UI-mobile
Embed Notifications
UI JS based sidebar modal to display notifications of a user in a dapp.
@epnsproject/sdk-uiembed
UI
Note: It must be noted that the PUSH SDK uses the CAIP format as of now, in order to provide a chain-agnostic protocol for communication between dapps or wallets.
PUSH SDK uses CAIP10 format but defaults to Ethereum address format, CAIP 10 format is a way to identify multichain addresses which is extended from CAIP 2. Any blockchain address becomes namespace + β€œ:” + chain_id + β€œ:” + account_address. However, as we expand our boundaries to multiple chains in the future, we shall define our own specifications, if need be. More details about this are in the @epnsproject/sdk-restapi.

Build using PUSH SDK

Learn more about the PUSH SDK Packages

Copy link
On this page
PUSH SDK Features
Build using PUSH SDK
Learn more about the PUSH SDK Packages