diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..d418173 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,11 @@ +# Global fallback +* @MergeFi/core-maintainers + +# Smart Contracts +/contracts/ @MergeFi/contract-reviewers + +# Scripts & Tooling +/scripts/ @MergeFi/tooling-reviewers + +# Documentation +/docs/ @MergeFi/doc-reviewers diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..cf504c7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,28 @@ +--- +name: Bug Report +about: Create a report to help us fix a bug +title: 'fix: ' +labels: 'bug' +assignees: '' +--- + +## Description +A clear and concise description of what the bug is. + +## Affected Contract / Component +- [ ] `mergefi-escrow` +- [ ] `mergefi-milestones` +- [ ] `mergefi-maintenance-pool` +- [ ] `mergefi-common` +- [ ] `scripts` / CI + +## Steps to Reproduce +1. +2. +3. + +## Expected Behavior +A clear description of what you expected to happen. + +## Actual Behavior +A clear description of what actually happened. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..106325f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,16 @@ +--- +name: Feature Request +about: Suggest an idea or contract capability +title: 'feat: ' +labels: 'enhancement' +assignees: '' +--- + +## Problem Statement +What problem does this feature solve? + +## Proposed Solution +A clear and concise description of what you want to happen. + +## Alternatives Considered +Any alternative solutions or workarounds you have considered. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..99223fe --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,16 @@ +## Summary + +Brief description of the changes introduced in this PR. + +Closes # + +## Changes + +- + +## Verification + +- [ ] `cargo fmt --check` passes +- [ ] `cargo clippy --all-targets --all-features -- -D warnings` passes +- [ ] `cargo test --workspace` passes +- [ ] New or updated unit tests added where applicable diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..1947899 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,33 @@ +# Contributing to MergeFi Contracts + +Thank you for contributing to MergeFi smart contracts! + +## Development Workflow + +### Prerequisites + +- Rust `1.95.0` (pinned via `rust-toolchain.toml`) +- `wasm32-unknown-unknown` target: `rustup target add wasm32-unknown-unknown` +- Node.js `24+` for scripts + +### Building and Testing + +Run tests and verification before opening a pull request: + +```bash +# Build WASM contracts +make build + +# Run full workspace test suite +make test + +# Format and lint checks +cargo fmt --check +cargo clippy --all-targets --all-features -- -D warnings +``` + +## Pull Request Guidelines + +1. Link relevant issue(s) using closing keywords (e.g. `Closes #123`). +2. Include comprehensive unit/integration test coverage for any new features or bug fixes. +3. Ensure `cargo fmt` and `cargo clippy` pass cleanly with no warnings. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..bd52dfd --- /dev/null +++ b/LICENSE @@ -0,0 +1,176 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or exemplary damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..cebce1f --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,25 @@ +# Security Policy + +## Reporting a Vulnerability + +The MergeFi team takes the security of our smart contracts and funds custody seriously. If you discover a vulnerability or potential exploit, please report it responsibly so we can address it before disclosure. + +### Private Disclosure + +Please report security issues directly via: +- GitHub Security Advisories: Submit a private advisory via the Security tab on the repository. +- Email: Send vulnerability details to `security@mergefi.org` (or contact maintainers directly). + +Please **do not** open a public GitHub issue for undisclosed vulnerabilities or fund-draining exploits. + +### Scope + +- `contracts/escrow`: Escrow lifecycle, fund custody, deadline handling, release, and refund logic. +- `contracts/milestones`: Milestone lifecycle, issue allocations, release, and crowdfunding refund logic. +- `contracts/maintenance-pool`: Maintenance pool deposits, withdrawals, and fee calculations. +- `contracts/common`: Shared administration, TTL extension, and access control helpers. + +### Response Timeline + +- Initial response & acknowledgment: Within 24-48 hours. +- Status update and triage assessment: Within 5 business days. diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..6f5a8cf --- /dev/null +++ b/docs/README.md @@ -0,0 +1,10 @@ +# MergeFi Contracts Documentation Index + +This directory contains technical design documents, architectural analyses, and access-control audits for the MergeFi smart contract system. + +## Documents + +- [**Access Control Audit**](access-control-audit.md) (`access-control-audit.md`): Detailed analysis of access control boundaries, administrative permissions, time-locks, and authorization across all contract entry points. +- [**Escrow Crowdfunding Design**](escrow-crowdfunding-design.md) (`escrow-crowdfunding-design.md`): Specification and design rationale for multi-sponsor crowdfunding in the single-issue escrow contract. +- [**Milestones Crowdfunding Design**](milestones-crowdfunding-design.md) (`milestones-crowdfunding-design.md`): Architecture and proportional refund distribution design for crowdfunding multi-issue milestone pools. +- [**Refund Permissionless Analysis**](refund-permissionless-analysis.md) (`refund-permissionless-analysis.md`): Safety and game-theoretic analysis of permissionless refunds after deadline and grace period expiration. diff --git a/rust-toolchain.toml b/rust-toolchain.toml new file mode 100644 index 0000000..f85d048 --- /dev/null +++ b/rust-toolchain.toml @@ -0,0 +1,5 @@ +[toolchain] +channel = "1.95.0" +components = ["rustfmt", "clippy"] +targets = ["wasm32-unknown-unknown"] +profile = "minimal"