Skip to content

Commit 6dbe140

Browse files
committed
Merge branch 'RELEASE_1.3.1' into 'main'
Release 1.3.1 See merge request koii-network/dev-green/desktop-node!1088
0 parents  commit 6dbe140

File tree

1,444 files changed

+147742
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,444 files changed

+147742
-0
lines changed

CHANGELOG.md

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
## [1.2.1]
2+
- Task Upgrades: Allow upgrading tasks even with low balance if the previous version is still staked.
3+
- VIP Status: Automated adjustments based on real-time VIP token balance.
4+
- Task Fetching: Improved reliability when remote servers are temporarily unavailable.
5+
- UI Enhancements: Fixed notification tray overlaps and ensured version number visibility on all window sizes.
6+
- Onboarding: Refined UI for a smoother initial setup.
7+
- Metadata Source: Updated task metadata sourcing for better availability.
8+
- Zoom Level: Enforced consistent zoom level across the app.
9+
10+
## [1.2.0]
11+
- Notifications: Introduced a modernized notification style with improved spacing.
12+
- Rewards Distribution: Enhanced logic for more reliable task rewards distribution.
13+
14+
## [1.1.5]
15+
- Task Extension Helper: Introduced a tool for quick and secure retrieval of API keys, starting with support for Prometheus tasks.
16+
17+
## [1.1.4]
18+
- Bonus Task View: Added a dedicated view for ended Bonus task seasons.
19+
- KPL Balances: Enabled vertical scrolling for extensive KPL token lists.
20+
- Markdown Support: Task descriptions now support Markdown formatting.
21+
- VIP Theme Fixes: Corrected thumbnail shadow issues in VIP theme.
22+
23+
## [1.1.3]
24+
- Orca Logs: Optimized to reduce log file size by saving only key logs.
25+
- Wallet Display: Active wallet now expands by default for better visibility.
26+
- Network Tunneling: Auto-enforced for secure connections during networking features.
27+
- KPL Tokens: Implemented fallback display for tokens without metadata.
28+
- Memory Logging: Added logging for memory usage to aid in testing and optimization.
29+
- Task Variables: Enabled auto-save in the background.
30+
- UX Enhancements: Improved token item interactions and redesigned the Claim Rewards button with a glowing animation.
31+
32+
## [1.1.2]
33+
- Task Upgrade Flow: Streamlined UI for upgrading tasks.
34+
- Extension Repair: Simplified process to restore proper variable pairings in tasks.
35+
- Onboarding: Rolled out improvements for a smoother user experience.
36+
- VIP Theme: Fixed notification contrast issues.
37+
- Alerts: Prevented duplicate executable modified alerts.
38+
- KPL Rewards: Adjusted UX for clearer display of miner rewards.
39+
40+
## [1.1.1]
41+
- Notifications: Resolved missing titles in external notifications.
42+
- Orca Enhancements: Improved installation process and status detection for Mac and Linux users.
43+
- RPC Status Widget: Redesigned for clarity and consistency.
44+
- Onboarding Flow: Polished for a better first-time experience.
45+
- UI Touch-ups: Various subtle improvements across the app.
46+
47+
## [1.1.0]
48+
- ORCA Add-on: Introduced a sandboxed environment for secure task execution.
49+
- VIP Skin: Launched an exclusive app skin for VIP users.
50+
- Notifications: Enhanced layout for externally triggered notifications.
51+
- Staking Banner: Added a bottom banner for Haji.ro staking updates.
52+
- UI Fixes: Polished various elements for improved user experience.
53+
54+
## [1.0.4]
55+
- Task States: Implemented caching to reduce RPC node load.
56+
- Bonus Task: Prepared groundwork for a new Bonus Task feature.
57+
58+
## [1.0.3]
59+
- KPL Rewards UX: Adjusted progress bar for clearer reward distribution.
60+
- Banner State: Made bottom banner state persistent across sessions.
61+
- Task Restart: Added a restart option for faulty tasks.
62+
- Animations: Introduced subtle animations for smoother interactions.
63+
64+
## [1.0.2]
65+
- Stake Modal: Fixed predefined stake value issue.
66+
- KOII Balances: Displayed dollar values using CoinGecko API with caching.
67+
- Rewards Bar: Resolved negative value display and added "Reconnecting" state.
68+
- Responsiveness: Improved layouts for various window sizes.
69+
- Navbar Layout: Fixed misalignment issues for new users.
70+
71+
## [1.0.1]
72+
- Migration Flow: Enhanced UX for users with KOII tokens but insufficient KPL balance.
73+
- Bug Fixes: Resolved issues with node initialization, referral banner, and balance display.
74+
- UI Updates: Removed token launch counter widget and re-added task search filters.
75+
- Network Switch: Enabled mainnet switch for ready users.
76+
77+
## [1.0.0]
78+
- Mainnet Migration: Transitioned Desktop Node to mainnet, including token migration and vesting.
79+
- Transaction Checks: Added confirmation checks for staking, unstaking, and claiming.
80+
- Task Visibility: Restored switch to show/hide non-verified tasks.

CODE_OF_CONDUCT.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at https://discord.com/invite/Koii-Network. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72+
73+
[homepage]: https://www.contributor-covenant.org
74+
75+
For answers to common questions about this code of conduct, see
76+
https://www.contributor-covenant.org/faq

CONTRIBUTING.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# Contributing to Koii Desktop Node
2+
3+
Thank you for your interest in contributing to the Koii Desktop Node! This document provides guidelines and instructions for contributing to this project.
4+
5+
## Code of Conduct
6+
7+
Please read and follow our [Code of Conduct](CODE_OF_CONDUCT.md) in all your interactions with the project.
8+
9+
## Development Workflow
10+
11+
1. **Fork the Repository**
12+
- Fork the repository to your GitHub account
13+
- Clone your fork locally
14+
15+
2. **Create a Feature Branch**
16+
- Create a new branch for your feature/fix
17+
- Use descriptive branch names (e.g., `feature/add-login`, `fix/button-styling`)
18+
19+
3. **Make Your Changes**
20+
- Follow the coding standards (see below)
21+
- Write tests for new functionality
22+
- Update documentation as needed
23+
24+
4. **Commit Your Changes**
25+
- Write clear, descriptive commit messages
26+
- Reference issues in your commits (e.g., `fix: resolve #123`)
27+
28+
5. **Push and Create a Pull Request**
29+
- Push your changes to your fork
30+
- Create a pull request to the main repository
31+
- Fill out the pull request template
32+
33+
## Coding Standards
34+
35+
### TypeScript/JavaScript
36+
- Use TypeScript for all new code
37+
- Follow the existing ESLint configuration
38+
- Use meaningful variable and function names
39+
- Add appropriate type annotations
40+
- Document complex functions with JSDoc comments
41+
42+
### React Components
43+
- Use functional components with hooks
44+
- Follow the existing component structure
45+
- Use proper prop types
46+
- Implement error boundaries where appropriate
47+
48+
### Styling
49+
- Use Tailwind CSS for styling
50+
- Follow the existing design system
51+
- Ensure responsive design
52+
- Maintain consistent spacing and typography
53+
54+
### Testing
55+
- Write tests for new features
56+
- Maintain existing test coverage
57+
- Use Jest and React Testing Library
58+
- Include both unit and integration tests
59+
60+
## Pull Request Process
61+
62+
1. Update the README.md with details of changes if needed
63+
2. Update the CHANGELOG.md with a summary of changes
64+
3. Ensure all tests pass
65+
4. Request review from at least one maintainer
66+
67+
## Getting Help
68+
69+
If you need help or have questions:
70+
- Check the [documentation](https://docs.koii.network)
71+
- Join our [Discord community](https://discord.gg/koii)
72+
- Open an issue in this repository
73+
74+
## Security
75+
76+
If you discover any security-related issues, please email security@koii.network instead of using the issue tracker.
77+
78+
Thank you for contributing to Koii Desktop Node!

LICENSE.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 KOI Labs Inc.
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in
13+
all copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21+
THE SOFTWARE.

README.md

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
# Koii UI for Node
2+
3+
## Description
4+
5+
This repo contains the desktop application as the UI for the [Koii Node](https://github.com/koii-network/node). It provides a user-friendly interface for interacting with the Koii Network.
6+
7+
The project structure is based on [Electron React Boilerplate](https://electron-react-boilerplate.js.org)
8+
9+
## Features
10+
11+
- Desktop application for Koii Node management
12+
- Task management and monitoring
13+
- Network status and statistics
14+
- Secure wallet integration
15+
- Task extension support (including Orca)
16+
17+
## Prerequisites
18+
19+
- [NodeJS](https://nodejs.org/en/) (v16 or higher recommended)
20+
- npm or yarn package manager
21+
- Git
22+
23+
## Installation
24+
25+
1. Clone the repository:
26+
```sh
27+
git clone https://github.com/koii-network/desktop-node
28+
cd desktop-node
29+
```
30+
31+
2. Install dependencies:
32+
```sh
33+
npm install
34+
```
35+
36+
3. Configure environment variables:
37+
- Copy `.env.example` to `.env`
38+
- Update the values in `.env` with your configuration
39+
40+
## Development
41+
42+
Start the development server:
43+
```bash
44+
npm start
45+
```
46+
47+
### Common Issues
48+
49+
#### File Watcher Limit
50+
If you encounter the error `ENOSPC: System limit for number of file watchers reached`, run:
51+
```sh
52+
sudo sysctl fs.inotify.max_user_watches=524288
53+
sudo sysctl -p
54+
```
55+
56+
#### Linux Dependencies
57+
On Linux, you may need to install additional packages:
58+
```sh
59+
sudo apt-get update
60+
sudo apt-get install build-essential
61+
```
62+
63+
## Testing
64+
65+
Run the test suite:
66+
```bash
67+
npm test
68+
```
69+
70+
## Building for Production
71+
72+
To package the app for your local platform:
73+
```bash
74+
npm run package
75+
```
76+
77+
The packaged application will be available in `release/build/`
78+
79+
## Contributing
80+
81+
We welcome contributions from the community! Please follow these steps:
82+
83+
1. Fork the repository
84+
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
85+
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
86+
4. Push to the branch (`git push origin feature/amazing-feature`)
87+
5. Open a Pull Request
88+
89+
Please ensure your code follows our coding standards and includes appropriate tests.
90+
91+
## License
92+
93+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
94+
95+
## Support
96+
97+
For support, please:
98+
- Check the [documentation](https://docs.koii.network)
99+
- Join our [Discord community](https://discord.gg/koii)
100+
- Open an issue in this repository
101+
102+
## Security
103+
104+
If you discover any security-related issues, please email security@koii.network instead of using the issue tracker.
105+
106+
## Using Orca
107+
108+
In the desktop node, go to Settings > Task Extensions and install Orca. If it doesn't install automatically or if you run into any issues after installing, [these](https://docs.chaindeck.io/orcaNode) are the instructions to install manually and troubleshoot.
109+
110+
If you are having errors with virtualization on Linux, you may need to install qemu:
111+
112+
```sh
113+
apt install qemu-system
114+
```
115+
116+
## Packaging for Production
117+
118+
To package apps for the local platform:
119+
120+
```bash
121+
npm run package
122+
```
123+
124+
Then ready to be run/installed version of application can be found in `release/build`

0 commit comments

Comments
 (0)