LogoLogo
PAO DocsCommunity DocsInfrastructure DocsPeerplays.com
  • Developer Documentation
  • API Reference
    • Peerplays Core API
      • Popular API Calls
      • Account History
      • Asset API
      • Block API
      • Crypto API
      • Database API
      • Network Broadcast API
      • Network Nodes API
      • Orders API
    • Wallet API
      • Account Calls
      • Asset Calls
      • Blockchain Inspection
      • General Calls
      • Governance
      • Privacy Mode
      • Trading Calls
      • Transaction Builder
      • Wallet Calls
    • Bookie API
      • General Calls
      • Listeners
      • Tournaments
  • Peerplays API Libraries
    • Python Peerplays
      • Installation
      • Creating an Account
      • Creating a Peerplays Wallet
      • NFT API
      • Marketplace API
      • Role Based Permissions API
  • Development Guides
    • Creating User Issued Assets
    • Introduction to Permissions
    • NFT Minting
    • Calculating Costs
  • The Cookbook
    • NFTs for Staking Creator Tokens
  • Tools and Integrations
    • PeerID
      • 1.0.0
        • Infrastructure
          • Deployment on a Linux Serve
          • Deployment to AWS ECS
            • Building the Docker Images
            • Storing Secrets in Amazon Parameter Store to use in ECS
            • Creating the Task Definition
            • Creating the Cluster
            • Creating the Service
        • Development
          • How does PeerID work without storing the keys ?
          • Authentication with PeerID
          • Brain Storming
          • Software Requirements
      • Authentication with PeerID
      • Requirements Specification
    • Random Number Generator
      • RNG Technical Summary
      • RNG API
  • Supporting & Reference Docs
    • Peerplays Development FAQs
    • Sidechain Operator Node (SON) Development
      • Generic Sidechain Docs
        • Quick joining GLADIATOR
        • Changes to Peerplaysjs-lib
        • Requirements Specification
        • Low Level Designs
          • bitcoin-deposit-handling-lld
          • bitcoin-operations-draft
          • bitcoin-sidechain-handler-lld
          • bitcoin-sidechain-multisig-bitcoin-wallet-and-bitcoin-addresses-pw
          • bitcoin-withdrawal-handling-lld
          • btc-address-scripting-mechanism
          • comparison-between-scenarios-for-handling-deposits-and-withdrawals
          • exchange-rate-list
          • generic-sidechain-deposit-hld
          • generic-sidechain-high-level-design
          • generic-sidechain-listener-hld
          • generic-sidechain-withdrawal-hld
          • refund-btc-mechanism
          • son-configuration
          • son-consensus-communication-and-transaction-signing-on-chain-lld
          • son-de-register-proposals-lld
          • son-objects-and-operators
          • son-rewards-lld
          • son-voting-lld
          • son-wallet-list_sons-lld
          • creation of a multi-sig bitcoin address lld
          • claiming initial son vesting lld
          • changeover and SON maintenance scenarios lld
          • user-sidechain-addresses-mapping
          • wallet-commands-for-son
        • Functional Specs
          • SON Configuration
          • SON rewards
          • SON Voting and Consensus
          • SONs switchover scenarios
          • SON Status Operations & Monitoring
          • Proposals
          • SON Smart Contracts
      • Bitcoin Sidechain Docs
        • Functional Specs
          • btc-refunds
          • voting-and-consensus
          • son-switchover
          • son-rewards
          • son-proposals
          • son-configuration
          • heartbeat-monitoring
          • BTC Transaction Processing & Signing
          • Bitcoin Withdrawal Handling
          • Bitcoin Deposit Handling
          • SON Multisig Bitcoin Wallet
      • Hive Sidechain Docs
        • Functional Specs
          • HIVE Deposit Handling
          • HIVE Withdrawal Handling
    • Peerplays DEX Development
      • Peerplays NEX
        • Functional Specifications
          • NEX-FS01 Dashboard Page
            • NEX-FS12 ETH-SONs Deposit/Withdraw Functionality
          • NEX-FS02 Login and Account Creation
          • NEX-FS03 Menus and Nav
          • NEX-FS04 Notifications
          • NEX-FS05a Market Page (alpha)
          • NEX-FS05 Market Page
          • NEX-FS06 Profile Page
          • NEX-FS07 Wallet Functions
          • NEX-FS08 App Settings
          • NEX-FS09 Blockchain Page
          • NEX-FS10 GPOS Page
          • NEX-FS11 WhaleVault Integration
      • Requirements Specification
      • Functional Specs
        • Asset Info Page and Asset Lists
        • Dashboard
        • Exchange Page
        • Login and Account Creation
        • User Account Page
        • Voting Page
    • SPK Network
      • Functional Specs
        • Claimdrop Snapshot Functional Specification
        • Initial Claimdrop Functional Specification
    • NFT Development
      • NFT Store
        • NFT Store User Stories
        • NFT Store UI HLD
        • NFT Store Requirements Specification
        • Functional Specifications
          • APP-FS01 App Header
          • APP-FS02 App Body
          • APP-FS03 App Footer
          • APP-FS04 App Navigation
          • APP-FS05 Wallet Functions
          • APP-FS06 App Home Page
          • APP-FS07 Account Page
          • APP-FS08 Browse View
        • App Page List
        • Requirement Traceability Matrix
    • Operation IDs List
    • Sidechain Flow Diagram (HIVE coin)
    • Sidechain Flow Diagram (Bitcoin)
    • Sidechain Flow Diagram (Ethereum coin)
    • TradeHands Explorer
      • User Personas
      • User stories
      • APP-FS01 Detailed View
      • Draft: APP-FS02 Front Page
      • APP-FS03 Collection Details Page
    • Grafana
      • Grafana Installation
      • Install Grafana Behind reverse proxy
      • Loki Installation
      • Promtail agent Installation
      • Grafana Explorer
    • NEX Deployment & Configuration
      • NEX Deployment
      • NEX - Blockchain API configuration
      • Deploying NEX in a HA scenario
    • API Node
      • MarketCap API
    • TOTO Application
      • FS-Subscription Plan
      • FS-Achievements
  • Development Workflow Docs
    • Development Workflow
  • Other Documentation
    • Peerplays Home
    • Community Docs
    • Infrastructure Docs
    • Site Reliability Engineering
Powered by GitBook
On this page
  • 1. Purpose
  • 2. Document Tracking
  • 2.1. Parent Document
  • 2.2. Categorization
  • 3. Scope
  • 3.1. Components
  • 4. Document Conventions
  • 5. Context
  • 6. Design Wire-frames
  • 7. Requirements
  • 7.1. Notifications
  • 7.2. Notifications in Pages
  • 7.3. Notifications in Menus
  • 8. Appendix A: Glossary

Was this helpful?

Export as PDF
  1. Supporting & Reference Docs
  2. Peerplays DEX Development
  3. Peerplays NEX
  4. Functional Specifications

NEX-FS04 Notifications

The Peerplays NEX application functional requirements specification for the notification functions.

1. Purpose

The purpose of this functional specification (FS) document is to detail functional requirements for the Peerplays NEX application (the “app”) relating to the notification functions from a business and user perspective.

2. Document Tracking

2.1. Parent Document

This document is a child document of the NEX Requirements Specification (NEX-RS).

2.2. Categorization

This document relates to the following tags.

App Component

Page Fragment

3. Scope

This FS will describe the requirements and basic design for the app’s notification functions.

3.1. Components

Specific components and features covered in this FS include:

  • Notifications in pages

  • Notifications in menus

4. Document Conventions

For the purpose of traceability, the following code(s) will be used in this functional specification:

Code
Meaning

NEX-FS04-#

NEX App Requirement - Notifications

The keyword shall indicates a requirement statement.

The keywords may, could, and should are not requirements but rather indicate items related to requirements that are worthy of consideration.

5. Context

Notifications provide users with timely and important details about the status of their account. These brief messages are easy for users to digest so they can absorb the information and get back to their tasks quickly.

6. Design Wire-frames

Designs for the NEX app notification functions are available here:

Specific to menus and navigation, see screens:

7. Requirements

Requirements specific to the items listed in this FS are as follows.

7.1. Notifications

NEX-FS04-1: shall be displayed as “unread” when new activities occur, as close to real-time as feasible.

7.2. Notifications in Pages

The viewing all activity page:

NEX-FS04-2: shall display a table of all activity related to the user’s account.

The all activity table:

NEX-FS04-3: shall display a reasonable number of records for the given display (desktop, mobile, etc.). Additional records shall be accessible via table pagination controls.

NEX-FS04-4: shall display the following columns of data per record:

  • Data and time (local)

  • Activity type

  • Detailed description of the activity

  • Transaction ID

  • Fee (in PPY)

  • Transaction memo

NEX-FS04-5: shall display date and time information in the user’s local time and format.

NEX-FS04-6: shall display activity type as the operation relevant to the activity record. For example: Transfer, Account Creation, etc.

NEX-FS04-7: shall display a detailed description that explains what happened in the given activity. For example: “hiltos1 sent 1.000 BTC to m0rris0n” where “hiltos1” and “m0rris0n” are user accounts.

NEX-FS04-8: shall, in the detailed descriptions, provide links to any included user accounts.

NEX-FS04-9: shall sort the table in descending order based on date and time (newest first) by default.

NEX-FS04-10: shall allow users to sort the date and time, activity type, transaction ID, and Fee columns in ascending or descending order.

NEX-FS04-11: shall allow users to filter the date and time, activity type, transaction ID, and Fee columns as follows:

  • Date and Time (Date and Time range)

  • Activity Type (multi-select combo box of all activity types)

  • Transaction ID (ID number range)

  • Fee (Fee range)

NEX-FS04-12: shall allow users to perform text search of keywords like account names, assets, amounts, and transaction IDs.

7.3. Notifications in Menus

The notification bell menu:

NEX-FS04-13: shall display a list of all activity related to the user’s account, limited to the last 30 days of activity.

NEX-FS04-14: shall display a reasonable number of records for the given display (desktop, mobile, etc.). Additional records shall be accessible via table pagination controls or scrolling.

NEX-FS04-15: shall divide the list items by date.

NEX-FS04-16: shall display the current day’s activities in a “Today” group.

NEX-FS04-17: shall display the previous day’s activities in a “Yesterday” group.

NEX-FS04-18: shall display older activities in groups labeled by their date. For example: “August 12, 2021”

NEX-FS04-19: shall indicate “read” vs. “unread” notifications with icons, colors, or other style elements.

NEX-FS04-20: shall display a detailed description that explains what happened in the given activity. For example: “You sent 1.000 BTC to m0rris0n” where “m0rris0n” is a user account.

NEX-FS04-21: shall, in the detailed descriptions, provide links to any included user accounts.

NEX-FS04-22: shall sort the list in descending order by date and time (newest first).

8. Appendix A: Glossary

Term
Meaning

RS

Requirements Specification

FS

Functional Specification

UI

User Interface

PreviousNEX-FS03 Menus and NavNextNEX-FS05a Market Page (alpha)

Last updated 2 years ago

Was this helpful?

for the Notifications in pages

for the Notifications in menus

DEX Hifi - All tabs with Market
Adobe XD screen 34
Adobe XD screens 35 - 37