Skip to content

Latest commit

 

History

History
81 lines (46 loc) · 4.01 KB

README.md

File metadata and controls

81 lines (46 loc) · 4.01 KB

Xeon Protocol dApp

GitHub license GitHub license

xeon token

Xeon Protocol

This repository contains the Xeon Protocol frontend. For the smart contracts, see the xeon-v1-core repository.

Follow Us

warpcast twitter follow telegram

Repo Status

GitHub Issues or Pull Requests GitHub commit activity GitHub contributors

Prerequisites

git node npm docker

Directory Structure

  • abi - Contains ABI json files and global references to onchain deployments used in the app.
  • src - Source code for the Next.js application
  • Ensure sensitive data is stored in .env.local

Set Up

Clone the repository:

git clone https://github.com/xeon-protocol/xeon-dapp.git

If already cloned locally, ensure you have the latest changes locally:

git pull origin main

Install all dependencies:

npm install

Then, start the development server:

npm run dev

Open http://localhost:3000 with your browser to see the result.

Product Management

trello

Contributing

PRs Welcome Bug Bounties

If you are a developer looking to contribute, please take a look at the guidelines in CONTRIBUTING first, then feel free to look at open issues or open a new one.

If you are an Solidity developer and are interested in auditing our contracts, you can submit an audit by using the form here.

Security

For any security-related concerns, please refer to the SECURITY policy. This repository is subject to a bug bounty program per the terms outlined in the aforementioned policy.

For vulnerability hunters, please see our Bug Bounty Program.

License

The primary license for core Xeon Protocol contracts (XeonHedging.sol + XeonStaking.sol) is the Business Source License 1.1 (BUSL-1.1), see LICENSE.md.

However, there are some exceptions:

  • Several files in contracts/script and contracts/test are licensed under GPL-3.0-or-later (see: LICENSE-GPL.md) or remain unlicensed (per their SPDX headers).