This is your gateway to understanding and contributing to the PeoPay-Core repository, the foundation of the PeoPay ecosystem. Here, you'll find detailed documentation on smart contracts, setup instructions, development workflows, testing guides, and more.
PeoPay-Core is the essential codebase powering the PeoPay ecosystem. It brings together:
- PeoCoin (PEO): An ERC-20 token serving as the ecosystem’s primary utility token.
- Staking: Lock tokens to earn rewards, with APY calculations and lock periods.
- Governance: Create and vote on proposals, weighted by Dynamic Contribution Scores (DCS).
- DCS (Dynamic Contribution Scoring): Determine user influence and rewards based on token balances, staking, and participation.
- Conversion (Crypto-to-Mobile): Facilitate off-chain conversions of PEO to mobile money, bridging traditional and decentralized finance.
By leveraging these components, PeoPay-Core enables secure, transparent, and extensible decentralized functionalities that underpin the PeoPay environment.
- Getting Started: Set up your environment, clone the repo, and run tests.
- Contracts Overview: Deep dives into each smart contract’s functionality and architecture.
- Deployment & Configuration: Learn how to deploy contracts to various networks, including Polygon.
- Testing & QA: Guidelines for running tests, analyzing coverage, and ensuring code quality.
- Security & Audits: Review our self-audit process, security best practices, and future audit plans.
- Governance & DCS Parameters: Understand how to update governance and DCS settings, and the implications of these changes.
- FAQ: Answers to common questions and troubleshooting tips.
- Website: peopay.io
Explore the official PeoPay website to understand the broader vision, ecosystem components, and user-friendly interfaces. - Documentation: docs.peopay.io
Access detailed developer and user guides, API references, and architectural diagrams that complement this wiki.
We welcome community contributions! Check out the CONTRIBUTING.md file in the repository for guidelines on submitting bug reports, proposing features, writing tests, and improving the codebase or documentation.
- Issues & Discussions: Participate in GitHub Issues for bug reports and proposals.
- Community Channels: Join our Discord or Telegram groups (links on the main website) to engage with other developers and community members.
By starting here, you can quickly orient yourself within the PeoPay-Core ecosystem. Explore the linked pages, review contract specifics, and learn how to contribute to building a secure and vibrant decentralized financial infrastructure within the PeoPay universe.