PUSH Protocol Integration
PUSH Protocol integrated with the USDAO ecosystem
Overview
This documentation outlines the steps and technical specifications for integrating PUSH Protocol (previously known as EPNS - Ethereum Push Notification Service) into the USDAO Borrowing Protocol. The goal of this integration is to enhance user experience by providing real-time notifications for key events within the USDAO system.
PUSH Protocol allows applications to send notifications to wallet addresses, ensuring that users stay informed about important events, such as Vault status updates, liquidations, and system changes.
Integration Goals
Real-time Notifications:
Notify users about Vault status (e.g., undercollateralized or liquidated).
Inform users about system state changes (e.g., entering or exiting Recovery Mode).
Send reminders for debt repayment and collateral top-ups.
User Engagement:
Increase protocol engagement by providing timely and actionable updates.
Security and Transparency:
Enhance the transparency of operations and reduce user risk by ensuring critical updates are communicated.
Buying / Selling USDAO on https://app.usdao.io/.
Opening Vault, Adjusting vault, closing vault, staking, and liquidations on https://onvault.usdao.io/.
Key Events for Notifications
Event
Description
Notification Content Example
Vault Creation
A new Vault is created.
"Your Vault has been successfully created."
Vault Liquidation
The user's Vault is liquidated.
"Alert! Your Vault has been liquidated due to insufficient collateral."
Under-Collateralization Warning
The Vault’s ICR is approaching the MCR.
"Warning: Your Vault's collateral ratio is below the recommended threshold."
System Enters Recovery Mode
The protocol enters Recovery Mode.
"USDAO Protocol has entered Recovery Mode. Actions may be restricted."
Debt Repayment Reminder
Reminder to repay outstanding debt.
"Reminder: Your USDAO debt is due. Please ensure timely repayment."
Collateral Top-up Suggestion
Suggestion to increase collateral to avoid liquidation.
"Suggestion: Consider adding collateral to improve your Vault's safety margin."
Technical Architecture
1. PUSH Protocol Setup
Deploy a PUSH Protocol channel for USDAO Borrowing Protocol.
Ensure that the PUSH channel is configured to send notifications for events specified above.
Define message templates and notification payloads for each event.
2. Event Listeners
Integrate event listeners in the USDAO smart contracts (VaultManager.sol
, BorrowerOperations.sol
) to trigger notifications. Example:
The event listeners will call the PUSH Protocol API to send notifications when these events are emitted.
3. Backend Integration
A backend service can be created to monitor events and interact with the PUSH Protocol API. The steps include:
Subscribing to relevant contract events.
Formatting the notification content.
Sending notifications via PUSH Protocol.
4. User Subscription
Users must subscribe to the USDAO PUSH channel to receive notifications. This can be done via the PUSH Protocol frontend or directly through supported wallet interfaces.
NOTE: Integrating PUSH Protocol into the USDAO Borrowing Protocol will greatly improve the user experience by providing timely and relevant notifications. This integration will reduce user risk, increase engagement, and ensure a more transparent protocol operation.
Last updated