SUMMARY.md

Table of contents

• ⭐ Getting Started

😎 Concepts

• Push Notification for Web3
  • What are Channels?
    • What is a Channel Alias
    • What are Channel Delegates
  • Types of Notifications
  • What are Delegated Notifications?
  • Design Notification Content
• Push Chat for Web3

⚡ Developer Guides

• Creating A Channel
  • Enabling Channel on other Chains
    • Polygon
    • BNB Chain
  • Adding Delegates For Channel
  • Channel Creation Guides
    • Deploying your First Channel
    • Creating a Channel using Gnosis Safe
• Sending Notifications
  • Using Smart Contract
  • Using Push dApp (Gasless)
  • Using Push SDK (Gasless)
  • Using Showrunners (Scaffold / Gasless)
  • Using Subgraph (Gasless)
  • Notification Standard
    • Notification Standard (Basics)
    • Notification Standard (Advanced)
      • Notification Verification Proof
      • Notification Identity
      • Notification Payload
      • Notification Content
• Receiving Notifications
  • Receiving Notifications via dApp
  • Receiving via Restful API
  • Receiving via AWS SNS
  • Receiving via Delivery Node
• Integrating on Frontend
  • Integrating Channel opt ins
  • Integrating Notifications
• Testing Sent Notifications
• Integrating Push Chat
• Integrating Push Video
• Examples
  • Notification Via Smart Contract examples
    • Token transfer notification via Smart Contract example
    • Channel Creation and Notifications via smart contract example (Advance)
  • Showrunners Examples
    • NFT transfer notification via Showrunner example
    • NFT-Based notification via Showrunner example
    • Service based notification via Showrunner example
    • Defi based notification via Showrunner example
    • Advance examples
      • Off-chain (or Web2) based notification via Showrunner example
      • Expert Level - Oasis
  • Frontend Examples
    • Checkout our Repo and Youtube

⚙ Developer Tooling

• Push SDK
  • Quick Start
  • Push SDK Starter Kit
  • SDK Packages / Details
    • @pushprotocol/restapi
      • For Notification
        • Fetching User and Channel Details
        • Opt-In and Opt-Out
        • Send Notifications
        • Notification Helper Utils
      • For Chat
      • For Video
        • Initializing Video Object
        • Start a video call
        • Enable/Disable Local Audio/Video
        • Handling video call retries
    • @pushprotocol/socket
      • Example - SDK Sockets
    • @pushprotocol/uiembed
    • @pushprotocol/reactnative
    • @pushprotocol/uiweb
      • Push Support Chat
  • Troubleshooting
• Showrunners Framework
  • How to Setup Showrunners?
  • Hello World Channel
  • Understanding Channel Structure - Showrunners
  • Github Repositories
• Push Smart Contracts
  • Core & Communicator Smart Contracts
  • Push Core Contract
    • Types & Modifiers - Core
    • Methods - Core
    • Interface
    • Channel creation process on Smart Contract
    • Channel Verification Feature
  • Push Communicator Protocol
    • Types & Modifiers - Comm
    • Methods - Comm
  • Push Contract Addresses
  • Security Audits
  • GitHub Respositories

📓 Additional Resources

• Push Roadmaps
  • 🛣 Roadmap 2021
  • 🛣 Roadmap 2022
• Hack Ideas
• Push Grants
• Frequently Asked
• Join our Discord