|
1 | | -# 🎲 Pyth Entropy Hackathon Submission |
| 1 | +# Pyth Examples Contribution |
2 | 2 |
|
3 | | -## Project Information |
4 | | - |
5 | | -**Project Name:** <!-- Enter your project name --> |
6 | | - |
7 | | -**Team/Individual:** <!-- Your name or team name --> |
| 3 | +## Type of Contribution |
| 4 | +<!-- Please check the type of contribution this PR represents --> |
8 | 5 |
|
9 | | -**Hackathon Event:** <!-- Name of the hackathon --> |
| 6 | +- [ ] **New Example Project** (Adding a new example to demonstrate Pyth integration) |
| 7 | +- [ ] **Bug Fix** (Fixing an issue in existing examples) |
| 8 | +- [ ] **Documentation Update** (Improving README, comments, or guides) |
| 9 | +- [ ] **Enhancement** (Improving existing functionality or adding features) |
| 10 | +- [ ] **Hackathon Submission** (Submitting a project from a hackathon) |
10 | 11 |
|
11 | | -**Contact:** <!-- Your GitHub username, email, or Discord handle --> |
| 12 | +## Project Information |
12 | 13 |
|
13 | | -## Project Description |
| 14 | +**Project/Example Name:** <!-- Enter the name of your project or the example you're working on --> |
14 | 15 |
|
15 | | -### What does your project do? |
16 | | -<!-- Provide a clear, concise description of your entropy-based application --> |
| 16 | +**Pyth Product Used:** |
| 17 | +- [ ] Pyth Price Feeds |
| 18 | +- [ ] Pyth Entropy |
| 19 | +- [ ] Multiple Products |
| 20 | +- [ ] Other: ___________ |
17 | 21 |
|
18 | | -### How does it use Pyth Entropy? |
19 | | -<!-- Explain how your project integrates with Pyth Entropy and what randomness features you utilize --> |
| 22 | +**Blockchain/Platform:** |
| 23 | +- [ ] Ethereum/EVM |
| 24 | +- [ ] Solana |
| 25 | +- [ ] Aptos |
| 26 | +- [ ] Sui |
| 27 | +- [ ] Fuel |
| 28 | +- [ ] Starknet |
| 29 | +- [ ] TON |
| 30 | +- [ ] Other: ___________ |
20 | 31 |
|
21 | | -### What problem does it solve? |
22 | | -<!-- Describe the real-world problem your project addresses --> |
| 32 | +## Description |
23 | 33 |
|
24 | | -## Technical Implementation |
| 34 | +### What does this contribution do? |
| 35 | +<!-- Provide a clear description of what you're adding or changing --> |
25 | 36 |
|
26 | | -### Architecture Overview |
27 | | -<!-- Briefly describe your project's architecture --> |
| 37 | +### How does it integrate with Pyth? |
| 38 | +<!-- Explain how your code uses Pyth products/services --> |
28 | 39 |
|
29 | | -**Network Details:** <!-- e.g., Ethereum Sepolia, Arbitrum Sepolia, etc. --> |
| 40 | +### What problem does it solve or demonstrate? |
| 41 | +<!-- Describe the use case or issue this addresses --> |
30 | 42 |
|
31 | | -### Smart Contract Details |
32 | | -**Contract Address(es):** <!-- Deployed contract addresses --> |
| 43 | +## Changes Made |
33 | 44 |
|
34 | | -## Project Structure |
| 45 | +### Files Added/Modified |
| 46 | +<!-- List the main files you've added or modified --> |
| 47 | +- [ ] Smart contracts |
| 48 | +- [ ] Frontend/UI components |
| 49 | +- [ ] Documentation (README, comments) |
| 50 | +- [ ] Configuration files |
| 51 | +- [ ] Tests |
| 52 | +- [ ] Other: ___________ |
35 | 53 |
|
| 54 | +### Directory Structure (for new examples) |
| 55 | +<!-- If adding a new example, show the directory structure --> |
36 | 56 | ``` |
37 | | -entropy/[your-project-name]/ |
38 | | -├── contract/ # Smart contracts |
39 | | -├── app/ # Frontend application (if applicable) |
| 57 | +[product]/[example-name]/ |
| 58 | +├── contract/ # Smart contracts (if applicable) |
| 59 | +├── app/ # Frontend application (if applicable) |
40 | 60 | ├── README.md # Project documentation |
41 | 61 | └── ... |
42 | 62 | ``` |
43 | 63 |
|
44 | | -## Demo & Usage |
| 64 | +## Testing & Verification |
45 | 65 |
|
46 | | -### Live Demo |
47 | | -**Demo URL:** <!-- Link to your live demo (if available) --> |
48 | | - |
49 | | -**Video Demo:** <!-- Link to video demonstration --> |
50 | | - |
51 | | -### How to Run Locally |
| 66 | +### How to Test This Contribution |
| 67 | +<!-- Provide clear instructions for reviewers to test your changes --> |
52 | 68 |
|
53 | 69 | #### Prerequisites |
54 | | -<!-- List any prerequisites needed to run your project --> |
| 70 | +<!-- List any prerequisites needed --> |
55 | 71 | - Node.js version: ___ |
56 | 72 | - Other dependencies: ___ |
57 | 73 |
|
58 | | -#### Installation & Setup |
| 74 | +#### Setup & Run Instructions |
59 | 75 | ```bash |
60 | | -# Add your installation commands here |
61 | | -cd entropy/[your-project-name] |
| 76 | +# Add your setup and run commands here |
| 77 | +cd [path-to-your-example] |
62 | 78 | npm install |
63 | | -# ... other setup commands |
| 79 | +# ... other commands |
64 | 80 | ``` |
65 | 81 |
|
66 | | -#### Running the Application |
67 | | -```bash |
68 | | -# Add commands to run your application |
69 | | -npm run dev |
70 | | -# or other run commands |
71 | | -``` |
| 82 | +### Deployment Information (if applicable) |
| 83 | +**Network:** <!-- e.g., Ethereum Sepolia, Solana Devnet, etc. --> |
| 84 | + |
| 85 | +**Contract Address(es):** <!-- Deployed contract addresses --> |
| 86 | + |
| 87 | +**Demo URL:** <!-- Link to live demo if available --> |
| 88 | + |
| 89 | +## Documentation |
| 90 | + |
| 91 | +- [ ] Added/updated README.md with clear instructions |
| 92 | +- [ ] Code is well-commented and self-explanatory |
| 93 | +- [ ] Included usage examples |
| 94 | +- [ ] Added any necessary configuration details |
| 95 | + |
| 96 | +## Checklist |
| 97 | + |
| 98 | +### Code Quality |
| 99 | +- [ ] Code follows existing patterns in the repository |
| 100 | +- [ ] Proper error handling implemented |
| 101 | +- [ ] No hardcoded values (use environment variables where appropriate) |
| 102 | + |
| 103 | +### Testing |
| 104 | +- [ ] Tested locally and works as expected |
| 105 | +- [ ] All existing functionality still works (no breaking changes) |
| 106 | + |
| 107 | +## Additional Context |
72 | 108 |
|
73 | | -## Technical Challenges & Solutions |
| 109 | +### Related Issues |
| 110 | +<!-- Link any related GitHub issues --> |
| 111 | +Fixes #<!-- issue number --> |
74 | 112 |
|
75 | | -### Challenges Faced |
76 | | -<!-- Describe any technical challenges you encountered --> |
| 113 | +### Screenshots/Demo (if applicable) |
| 114 | +<!-- Add screenshots or links to demos that help explain your contribution --> |
77 | 115 |
|
78 | | -### How You Solved Them |
79 | | -<!-- Explain your solutions and any innovative approaches --> |
| 116 | +### Notes for Reviewers |
| 117 | +<!-- Add any additional context that would help reviewers --> |
80 | 118 |
|
81 | 119 | --- |
82 | 120 |
|
83 | | -**Thank you for reviewing my hackathon submission!** |
| 121 | +**Thank you for contributing to Pyth Examples!** |
84 | 122 |
|
85 | 123 | <!-- |
86 | | -Helpful Links: |
87 | | -- Pyth Entropy Documentation: https://docs.pyth.network/entropy |
88 | | -- Example Projects: Check the existing entropy/ directory for reference implementations |
89 | | -- Pyth Discord: [Add Discord link for support] |
| 124 | +Helpful Resources: |
| 125 | +- Pyth Documentation: https://docs.pyth.network/ |
| 126 | +- Price Feeds: https://docs.pyth.network/price-feeds |
| 127 | +- Entropy: https://docs.pyth.network/entropy |
| 128 | +- Lazer: https://docs.pyth.network/lazer |
| 129 | +- Existing Examples: Browse the repository for reference implementations |
90 | 130 | --> |
0 commit comments