matt/paperclip-wallet
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Remove excessive formatting from documentation

Browse Source 
- Strip bold text and emoji formatting from README.md
- Clean up CHANGELOG.md formatting
- Maintain professional tone without unnecessary emphasis
This commit is contained in:
matt
2025-06-17 14:49:57 -07:00
parent 97a11985e7
commit a4db7394b0
2 changed files with 67 additions and 67 deletions
Download Patch File Download Diff File Expand all files Collapse all files

74
CHANGELOG.md
View File

@@ -7,57 +7,57 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [1.0.0] - 2024-06-17 ## [1.0.0] - 2024-06-17
### Added - Major DeFi Staking Release 🚀 ### Added - Major DeFi Staking Release
#### **Comprehensive Staking System** #### Comprehensive Staking System
- **Validator Delegation** - Stake CLIPS tokens to active validators and earn rewards - Validator delegation - Stake CLIPS tokens to active validators and earn rewards
- **Real-time Staking Dashboard** - Live overview of staking positions, rewards, and network statistics - Real-time staking dashboard - Live overview of staking positions, rewards, and network statistics
- **Multi-validator Support** - Delegate to multiple validators simultaneously - Multi-validator support - Delegate to multiple validators simultaneously
- **Reward Management** - One-click claiming of accumulated staking rewards - Reward management - One-click claiming of accumulated staking rewards
- **Validator Creation** - Full interface for becoming a validator (10,000 CLIPS minimum) - Validator creation - Full interface for becoming a validator (10,000 CLIPS minimum)
#### **Advanced Staking Features** #### Advanced Staking Features
- **APY Calculations** - Real-time Annual Percentage Yield based on validator performance - APY calculations - Real-time Annual Percentage Yield based on validator performance
- **Commission Tracking** - View validator commission rates and adjusted returns - Commission tracking - View validator commission rates and adjusted returns
- **Staking Statistics** - Network-wide staking data and participation rates - Staking statistics - Network-wide staking data and participation rates
- **Auto-refresh Data** - Automatic updates every 30 seconds for live information - Auto-refresh data - Automatic updates every 30 seconds for live information
- **Transaction Validation** - Comprehensive validation for all staking operations - Transaction validation - Comprehensive validation for all staking operations
#### **Professional UI/UX** #### Professional UI/UX
- **Staking Navigation Tab** - Dedicated staking section in main navigation - Staking navigation tab - Dedicated staking section in main navigation
- **Interactive Validator List** - Sortable table with delegation actions - Interactive validator list - Sortable table with delegation actions
- **Modal Dialog System** - Professional forms for delegation, undelegation, and validator creation - Modal dialog system - Professional forms for delegation, undelegation, and validator creation
- **Responsive Design** - Mobile-friendly interface that works on all screen sizes - Responsive design - Mobile-friendly interface that works on all screen sizes
- **Custom Staking Themes** - Beautiful gradient designs and professional styling - Custom staking themes - Beautiful gradient designs and professional styling
#### **Backend Integration** #### Backend Integration
- **Enhanced RPC Client** - New staking-specific RPC methods for blockchain communication - Enhanced RPC client - New staking-specific RPC methods for blockchain communication
- **Validator Queries** - Fetch active validators, staking info, and reward data - Validator queries - Fetch active validators, staking info, and reward data
- **Transaction Support** - Handle delegate, undelegate, claim, and validator creation transactions - Transaction support - Handle delegate, undelegate, claim, and validator creation transactions
- **IPC Handlers** - Secure communication between frontend and blockchain node - IPC handlers - Secure communication between frontend and blockchain node
#### **Security & Validation** #### Security & Validation
- **Input Validation** - Comprehensive validation for all staking parameters - Input validation - Comprehensive validation for all staking parameters
- **Minimum Requirements** - Enforce minimum staking amounts and validator requirements - Minimum requirements - Enforce minimum staking amounts and validator requirements
- **Error Handling** - Detailed error messages and user feedback - Error handling - Detailed error messages and user feedback
- **Transaction Signing** - Secure transaction signing with wallet private keys - Transaction signing - Secure transaction signing with wallet private keys
### Changed ### Changed
- **Updated Branding** - Complete rebrand from Etho Protocol to PaperclipChain - Updated branding - Complete rebrand from Etho Protocol to PaperclipChain
- **Enhanced Navigation** - Added staking tab to main navigation menu - Enhanced navigation - Added staking tab to main navigation menu
- **Improved RPC Client** - Extended paperclip-rpc.js with staking functionality - Improved RPC client - Extended paperclip-rpc.js with staking functionality
- **Updated Documentation** - Comprehensive README with staking guide and setup instructions - Updated documentation - Comprehensive README with staking guide and setup instructions
### Technical Details ### Technical Details
- **New Files Added**: - New Files Added:
- `renderer/staking.js` - Complete staking interface logic - `renderer/staking.js` - Complete staking interface logic
- `assets/templates/staking.html` - Professional staking UI template - `assets/templates/staking.html` - Professional staking UI template
- `assets/styles/staking.css` - Custom staking interface styling - `assets/styles/staking.css` - Custom staking interface styling
- **Enhanced Files**: - Enhanced Files:
- `modules/paperclip-rpc.js` - Added 5 new staking RPC methods - `modules/paperclip-rpc.js` - Added 5 new staking RPC methods
- `index.html` - Integrated staking navigation and CSS - `index.html` - Integrated staking navigation and CSS
- `renderer/maingui.js` - Added staking navigation handler - `renderer/maingui.js` - Added staking navigation handler
- **Package Updates**: - Package Updates:
- Updated description to include DeFi staking capabilities - Updated description to include DeFi staking capabilities
- Added staking-related keywords for discoverability - Added staking-related keywords for discoverability
@@ -78,4 +78,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
--- ---
**Note**: This changelog focuses on the major staking release. For detailed technical changes, see the git commit history. Note: This changelog focuses on the major staking release. For detailed technical changes, see the git commit history.

60
README.md
View File

@@ -1,30 +1,30 @@
# PaperclipWallet - Desktop Wallet for PaperclipChain # PaperclipWallet - Desktop Wallet for PaperclipChain
**A modern, feature-rich desktop wallet for PaperclipChain with comprehensive DeFi staking capabilities.** A modern, feature-rich desktop wallet for PaperclipChain with comprehensive DeFi staking capabilities.
PaperclipWallet is the official desktop wallet for PaperclipChain, providing secure wallet management, transaction handling, and advanced staking features for earning rewards through validator delegation. PaperclipWallet is the official desktop wallet for PaperclipChain, providing secure wallet management, transaction handling, and advanced staking features for earning rewards through validator delegation.
## Features ## Features
### 🏦 **Core Wallet Functions** ### Core Wallet Functions
- **Secure Wallet Management** - Create, import, and manage multiple CLIPS wallets - Secure wallet management - Create, import, and manage multiple CLIPS wallets
- **Transaction History** - View detailed transaction history and status - Transaction history - View detailed transaction history and status
- **Address Book** - Manage frequently used addresses - Address book - Manage frequently used addresses
- **Balance Tracking** - Real-time CLIPS balance updates - Balance tracking - Real-time CLIPS balance updates
- **Send/Receive** - Simple and secure CLIPS transfers - Send/Receive - Simple and secure CLIPS transfers
### 🚀 **Advanced DeFi Staking** ### Advanced DeFi Staking
- **Validator Delegation** - Stake CLIPS to active validators and earn rewards - Validator delegation - Stake CLIPS to active validators and earn rewards
- **Reward Claiming** - One-click claiming of accumulated staking rewards - Reward claiming - One-click claiming of accumulated staking rewards
- **Validator Creation** - Become a validator with minimum 10,000 CLIPS stake - Validator creation - Become a validator with minimum 10,000 CLIPS stake
- **Real-time Statistics** - Live network staking data and APY calculations - Real-time statistics - Live network staking data and APY calculations
- **Multi-validator Support** - Delegate to multiple validators simultaneously - Multi-validator support - Delegate to multiple validators simultaneously
### 📊 **Professional Interface** ### Professional Interface
- **Modern Dashboard** - Clean, intuitive interface with real-time data - Modern dashboard - Clean, intuitive interface with real-time data
- **Responsive Design** - Works seamlessly on all screen sizes - Responsive design - Works seamlessly on all screen sizes
- **Theme Support** - Professional dark and light themes - Theme support - Professional dark and light themes
- **Data Visualization** - Charts and graphs for staking performance - Data visualization - Charts and graphs for staking performance
## Installation & Setup ## Installation & Setup
@@ -109,10 +109,10 @@ By default, the wallet connects to `localhost:26657` (PaperclipChain RPC). To co
## Security ## Security
### Best Practices ### Best Practices
- **Backup Wallets** - Always backup your wallet files and private keys - Backup wallets - Always backup your wallet files and private keys
- **Secure Storage** - Store backups in multiple secure locations - Secure storage - Store backups in multiple secure locations
- **Regular Updates** - Keep the wallet updated to the latest version - Regular updates - Keep the wallet updated to the latest version
- **Network Security** - Only connect to trusted PaperclipChain nodes - Network security - Only connect to trusted PaperclipChain nodes
### Private Key Management ### Private Key Management
- Private keys are stored locally and encrypted - Private keys are stored locally and encrypted
@@ -141,10 +141,10 @@ paperclip-wallet/
``` ```
### Technology Stack ### Technology Stack
- **Frontend**: Electron, jQuery, Handlebars - Frontend: Electron, jQuery, Handlebars
- **Backend**: Node.js, Ed25519 cryptography - Backend: Node.js, Ed25519 cryptography
- **Blockchain**: PaperclipChain RPC integration - Blockchain: PaperclipChain RPC integration
- **Styling**: Custom CSS with Material Design elements - Styling: Custom CSS with Material Design elements
## Troubleshooting ## Troubleshooting
@@ -167,9 +167,9 @@ paperclip-wallet/
### Support ### Support
For technical support and bug reports, please visit: For technical support and bug reports, please visit:
- **Repository**: https://git.takoyaki.cool/matt/paperclip-wallet - Repository: https://git.takoyaki.cool/matt/paperclip-wallet
- **Issues**: Create a new issue with detailed information - Issues: Create a new issue with detailed information
- **Documentation**: Check PaperclipChain main repository - Documentation: Check PaperclipChain main repository
## Contributing ## Contributing
@@ -186,4 +186,4 @@ We welcome contributions! Please:
--- ---
**PaperclipWallet** - Secure, Modern, and Feature-Rich Desktop Wallet for PaperclipChain PaperclipWallet - Secure, Modern, and Feature-Rich Desktop Wallet for PaperclipChain