sub2
  • sub2 protocol
  • Concepts
    • Subscription
    • Fees
    • Fee auction
    • Sponsored subscriptions
    • Processors
  • Deployments
  • SDK
    • Query subscriptions
    • Listen for incoming subscriptions
    • Listen for canceled subscriptions
    • Listen for incoming payments
    • Sponsor subscriptions
    • Check if user is a payed subscriber
    • Cancel subscription
    • Process payments
    • Query active subscriptions to recipient
    • Query active subscriptions from sender
  • Popup integration
  • Become a payment processor
  • Technical Reference
  • DAO
Powered by GitBook
On this page
  1. SDK

Listen for incoming subscriptions

PreviousQuery subscriptionsNextListen for canceled subscriptions

Last updated 11 months ago

In this example, we will use the sub2 SDK to set up a listener for incoming subscriptions to our address. This is useful for anyone who wishes to accept payments with sub2 as you can validate that a subscription has successfully gone through. It is assumed that sub2-sdk is installed and set up as done .

const unwatch: WatchEventReturnType = sub2SDK.watchIncomingSubscriptions(recipientAddress, callbackFn);

Here recipientAddress is of type `0x{string}` and callbackFn is of type (subscription: Subscription) => any. The callback function is defined by you and is what is called on newly observed subscriptions to the address. For example, you can make a callback function which checks that the subscription has the correct parameters and if so update your backend and register the user as subscribed.

The returned value unwatch of the viem type WatchEventReturnType is a function that can be called to stop listening for events.

here