Skip to content

Commit

Permalink
merge 'main' of https://github.com/xeon-protocol/xeon-dapp into `add-…
Browse files Browse the repository at this point in the history
…token-list`
  • Loading branch information
heyJonBray committed Aug 7, 2024
2 parents 5c28761 + 69aae00 commit 7561f86
Show file tree
Hide file tree
Showing 65 changed files with 26,015 additions and 10,759 deletions.
6 changes: 6 additions & 0 deletions .auto-changelog
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"output": "CHANGELOG.md",
"template": "keepachangelog",
"unreleased": true,
"commitLimit": false
}
49 changes: 49 additions & 0 deletions .github/ISSUE_TEMPLATE/01-bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
name: Bug report
about: Submit a bug or issue report.
title: 'bug: [description]'
labels: 'type: bug'
assignees: ''
---

## Issue Description

> A clear and concise description of what the bug is.
## Steps to Reproduce

> Steps to reproduce the behavior:
>
> 1. Go to '...'
> 2. Click on '....'
> 3. Scroll down to '....'
> 4. See error
## Expected behavior

> A clear and concise description of what you expected to happen.
## Screenshots

> If applicable, add screenshots to help explain your problem.
## Local Environment

### Desktop (please complete the following information)

- **OS:** [e.g. iOS, windows]
- **Browser:** [e.g. chrome, safari]
- **Version:** [e.g. 22]

### Mobile (please complete the following information)

- **Device:** [e.g. Samsung Galaxy S24+, iPhone14]
- **OS:** [e.g. Android 16, iOS8.1]
- **Browser:** [e.g. stock browser, brave, safari]
- **Version:** [e.g. 22]

## Additional context

> Add any other context about the problem here.
>
> Include references to existing issues or pull requests here
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/02-feature-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
name: Feature request
about: Suggest a new idea for the Xeon Protocol dApp.
title: 'feat: [description]'
labels: 'status: discussing, type: feature request'
assignees: heyJonBray
---

## Feature Request

> Briefly state the name or type of feature being requested.
## Description

> A clear description of the feature.
>
> If the request is associated with an existing problem, explain that here.
## Desired solution

> A clear and concise description of what you want to happen
## References

> Please provide any references, links, or examples of similar features in other applications
>
> Include references to existing issues or pull requests here
## Additional context

> Add any other context or screenshots about the feature request here
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/03-improvement-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: Improvement Request
about: Suggest ways to improve existing features.
title: 'update: [description]'
labels: 'status: discussing, type: enhancement'
assignees: heyJonBray
---

## Current Feature

> What existing feature is this request about?
## Requested Improvement

> A clear and concise description of what you want to happen.
## Purpose

> What is the goal of this improvement or update?
## Additional context

> Add any other context or screenshots about the request here
41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE/04-access-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
name: Request to Audit Xeon v1 Contracts
about: Request read access to `v1-core`
title: 'Xeon v1-core Access Request: [yourName]-[MM-DD-YYYY]'
labels: 'type: audit, status: discussing'
assignees: heyJonBray
---

# Repository Access Request: Xeon Protocol v1-core

If you are a Solidity dev with experience auditing, and would like to help secure the core contracts of Xeon Protocol, please submit an access request here.

Thorough comunity analysis and insights are invaluable for ensuring the security and robustness of our codebase. We look forward to your detailed report and any recommendations for improvement!

## Auditor Information

**Auditor Name:** [Your Name]
**Affiliation:** [Your Company or Independent]
**Contact Information:** [Email or preferred contact method]
**GitHub Username:** [GitHub Username]

## Experience

### Portfolio

[attach a link to your portfolio]

### Audits

[attach links to any audits you have performed]

## Methodology and Tools

- **Audit Methodology:** [Describe the methodology used, such as manual code review, static analysis tools, etc.]
- **Tools Used:** [List any tools or frameworks used during the audit, e.g., MythX, Slither, Echidna]

## References

[If you have any references, either from colleagues or projects you've audited for in the past, include them here]

---
74 changes: 74 additions & 0 deletions .github/ISSUE_TEMPLATE/05-audit-submission.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
---
name: Solidity Audit Submission
about: Begin an audit submission on Xeon Protocol v1-core contracts.
title: 'xeon-v1-core audit [MM-DD-YYYY]-[yourName]'
labels: 'type: audit, status: discussing'
assignees: heyJonBray, wellytg, neonhedge
---

# Solidity Audit Submission: [Xeon Protocol v1-core](https://github.com/xeon-protocol/v1-core)

_Please use this template to submit your audit findings for the Xeon Protocol v1-core contracts. Your thorough analysis and insights are invaluable for ensuring the security and robustness of our codebase. We look forward to your detailed report and any recommendations for improvement._

## Auditor Information

**Auditor Name:** [Your Name]
**Affiliation:** [Your Company or Independent]
**Contact Information:** [Email or preferred contact method]

## Audit Scope and Objectives

**Audit Scope:** [Indicate specific contracts (`XeonHedging.sol`, `XeonStaking.sol`, `PriceOracle.sol`) or `FULL AUDIT` for all contracts.]

**Audit Objectives:**

- **Security Vulnerabilities:** [Detail the focus on potential security vulnerabilities]
- **Code Quality:** [Comment on code readability, maintainability, and clarity]
- **Performance Considerations:** [Evaluate gas efficiency and optimization]
- **Compliance:** [Check for compliance with best practices and standards]

## Methodology and Tools

- **Audit Methodology:** [Describe the methodology used, such as manual code review, static analysis tools, etc.]
- **Tools Used:** [List any tools or frameworks used during the audit, e.g., MythX, Slither, Echidna]

## Findings and Recommendations

### **Summary of Findings:**

- **Critical Issues:** [List any critical security vulnerabilities found, if applicable]
- **High Priority Issues:** [List high priority issues and their potential impact]
- **Medium Priority Issues:** [Detail medium priority issues and suggested improvements]
- **Low Priority Issues:** [Mention any low priority issues or minor recommendations]

### **Detailed Findings:**

- **Issue 1: [Title of Issue]**

- **Description:** [Detailed description of the issue]
- **Location:** [Specify the file and line number, if applicable]
- **Impact:** [Describe the potential impact of the issue]
- **Recommendation:** [Provide recommendations for mitigation or improvement]

- **Issue 2: [Title of Issue]**

- **Description:** [Detailed description of the issue]
- **Location:** [Specify the file and line number, if applicable]
- **Impact:** [Describe the potential impact of the issue]
- **Recommendation:** [Provide recommendations for mitigation or improvement]

- [Include more issues as needed...]

## General Comments

- **Overall Assessment:** [Provide an overall assessment of the code quality and security]
- **Positive Aspects:** [Highlight any particularly well-implemented aspects]
- **Areas for Improvement:** [Suggest areas where the codebase could be improved]

## Follow-Up and Communication

- **Next Steps:** [Outline any next steps or follow-up actions]
- **Preferred Communication:** [Specify the preferred method of communication for any questions or clarifications]
- **Response Time:** [Indicate your availability and expected response times for addressing any questions]

---
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
blank_issues_enabled: false
contact_links:
- name: Dev Support
url: mailto:jon@xeon-protocol.io
about: If you need support or have questions, please contact the developer.
- name: GitBook
url: https://xeon-protocol.gitbook.io/documentation/
about: Learn more about Xeon Protocol
- name: Warpcast
url: https://warpcast.com/xeonprotocol
about: Contact us on Warpcast
- name: Twitter
url: https://twitter.com/xeonprotocol
about: Contact us on Twitter
- name: Telegram
url: https://t.me/XeonProtocolPortal
about: Join us on Telegram
22 changes: 17 additions & 5 deletions .github/workflows/sync-main-to-fleek.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
name: Sync Main to Deploy/Fleek
# this workflow will sync `main` to `deploy/fleek`
# due to differences in the current fleek build requirements
# when `main` is updated, sync to `deploy/fleek`
# due to current fleek build requirements
# it is necessary to keep the branches separate
name: Sync Main to Deploy/Fleek

permissions:
contents: write

on:
push:
Expand All @@ -16,10 +19,19 @@ jobs:
uses: actions/checkout@v2
with:
ref: main
fetch-depth: 0

- name: Checkout deploy/fleek branch
run: git checkout deploy/fleek
run: git checkout -B deploy/fleek origin/deploy/fleek

- name: Set Git user
run: |
git config user.name "xeon-actions"
git config user.email "xeon-protocol-actions@github.com"
- name: Merge main into deploy/fleek
run: git merge main --no-ff
run: git merge origin/main --no-ff

- name: Push changes
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Expand Down
10 changes: 1 addition & 9 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,18 +1,9 @@
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

# dependencies
/node_modules
/.pnp
.pnp.js
.yarn/install-state.gz

# testing
/coverage

# development broadcast logs
!/broadcast
contracts/broadcast/*

# docs
docs/

Expand Down Expand Up @@ -46,3 +37,4 @@ yarn-error.log*
# typescript
*.tsbuildinfo
next-env.d.ts
certificates
15 changes: 0 additions & 15 deletions .gitmodules

This file was deleted.

Loading

0 comments on commit 7561f86

Please sign in to comment.