AAStarCommunity · jhfnetboy · Apr 28, 2026 · Apr 28, 2026 · Apr 28, 2026 · Apr 29, 2026
diff --git a/.github/workflows/cla.yml b/.github/workflows/cla.yml
@@ -0,0 +1,39 @@
+# CLA Assistant GitHub Action
+# Copy this file to: .github/workflows/cla.yml in each repo
+#
+# Prerequisites:
+#   1. Go to repo Settings → Secrets → add secret named CLA_TOKEN
+#      (a Personal Access Token with repo scope from an org admin account)
+#   2. The CLA text lives at:
+#      https://github.com/AAStarCommunity/Brood/blob/main/protocol/CLA.md
+
+name: CLA Assistant
+
+on:
+  issue_comment:
+    types: [created]
+  pull_request_target:
+    types: [opened, closed, synchronize]
+
+permissions:
+  actions: write
+  contents: write
+  pull-requests: write
+  statuses: write
+
+jobs:
+  cla-check:
+    runs-on: ubuntu-latest
+    steps:
+      - name: CLA Assistant
+        uses: contributor-assistant/github-action@v2.6.1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          PERSONAL_ACCESS_TOKEN: ${{ secrets.CLA_TOKEN }}
+        with:
+          path-to-signatures: 'signatures/cla.json'
+          path-to-document: 'https://github.com/AAStarCommunity/Brood/blob/main/protocol/CLA.md'
+          branch: 'cla-signatures'
+          allowlist: bot*,dependabot[bot],github-actions[bot]
+          remote-organization-name: AAStarCommunity
+          remote-repository-name: Brood
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,109 +1,43 @@
-## Contributing to Rundler
+# Contributing Guide
 
-Thanks for your interest in improving Rundler!
+> Part of [Mycelium Protocol](https://github.com/AAStarCommunity/Brood) ecosystem.  
+> Full contribution guide & CLA text: [protocol/CONTRIBUTING.md](https://github.com/AAStarCommunity/Brood/blob/main/protocol/CONTRIBUTING.md)
 
-There are multiple opportunities to contribute at any level. It doesn't matter if you are just getting started with Rust or are an expert, we can use your help.
+---
 
-**No contribution is too small and all contributions are valued.**
+## Apache 2.0 — 2 分钟白话版
 
-This document will help you get started. **Do not let the document intimidate you**.
-It should be considered as a guide to help you navigate the process.
+本项目使用 Apache License 2.0，对所有人开放：
 
-The [Telegram][dev-tg] is available for any concerns you may have that are not covered in this guide.
+**可以做**：免费用、商业用、修改、集成进闭源产品、分发  
+**必须做**：保留版权行 · 保留 NOTICE 文件 · 修改文件须注明 · 不能蹭品牌（见 TRADEMARK.md）  
+**不要求**：改了代码不用开源（这是和 GPL 最大的区别）
 
-If you contribute to this project, your contributions will be made to the project as follows: (a) contributions to the Rundler library (i.e. all code outside of the `bin` directory) will be licensed under the GNU Lesser General Public License v3.0, also included in our repository in the COPYING.LESSER file; and (b) contributions to the Rundler binaries (i.e. all code inside of the `bin` directory) will be licensed under the GNU General Public License v3.0, also included in our repository in the COPYING file.
+---
 
-### Ways to contribute
+## 签署 CLA
 
-There are fundamentally three ways an individual can contribute:
+本项目要求所有贡献者签署 **CLA（贡献者许可协议）**，以确保项目对所有贡献代码有清晰的法律授权。
 
-1. **By opening an issue:** For example, if you believe that you have uncovered a bug
-   in Rundler, creating a new issue in the [issue tracker][gh-issues] is the way to report it.
-2. **By adding context:** Providing additional context to existing issues,
-   such as screenshots and code snippets to help resolve issues.
-3. **By resolving issues:** Typically this is done in the form of either
-   demonstrating that the issue reported is not a problem after all, or more often,
-   by opening a pull request that fixes the underlying problem, in a concrete and
-   reviewable manner.
+> **CLA 是什么**：你签一次的声明："我提交的代码是我的原创（或我有权提交），授权本项目在 Apache 2.0 下使用。"  
+> **为什么需要**：没有明确授权，项目分发你的代码存在法律漏洞。  
+> **怎么签**：提交 PR 后，`@cla-assistant` 机器人自动评论并引导你签名，只需 1 分钟，永久有效，只签一次。
 
-**Anybody can participate in any stage of contribution**. We urge you to participate in the discussion around bugs and participate in reviewing PRs.
+完整 CLA 协议文本：[CLA.md](https://github.com/AAStarCommunity/Brood/blob/main/protocol/CLA.md) | [中文参考译本](https://github.com/AAStarCommunity/Brood/blob/main/protocol/CLA-zh.md)
 
-### Submitting a bug report
+---
 
-When filing a new bug report in the [issue tracker][gh-issues], you will be presented with a basic form to fill out.
+## 贡献流程
 
-If you believe that you have uncovered a bug, please fill out the form to the best of your ability. Do not worry if you cannot answer every detail, just fill in what you can. Contributors will ask follow-up questions if something is unclear.
-
-The most important pieces of information we need in a bug report are:
-
--   The Rundler version you are on (and that it is up to date)
--   The platform you are on (Windows, macOS, an M1 Mac or Linux)
--   Code snippets if this is happening in relation to testing or building code
--   Concrete steps to reproduce the bug
-
-In order to rule out the possibility of the bug being in your project, the code snippets should be as minimal as possible. It is better if you can reproduce the bug with a small snippet as opposed to an entire project!
-
-### Submitting a feature request
-
-When adding a feature request in the issue tracker, you will be presented with a basic form to fill out.
-
-Please include as detailed of an explanation as possible of the feature you would like, adding additional context if necessary.
-
-If you have examples of other tools that have the feature you are requesting, please include them as well.
-
-### Resolving an issue
-
-Pull requests are the way concrete changes are made to the code, documentation, and dependencies of Rundler.
-
-Even tiny pull requests, like fixing wording, are greatly appreciated. Before making a large change, it is usually a good idea to first open an issue describing the change to solicit feedback and guidance. This will increase the likelihood of the PR getting merged.
-
-Please also make sure that the following commands pass if you have changed the code:
-
-```sh
-cargo check --all
-cargo test --all --all-features
-cargo +nightly fmt -- --check
-cargo +nightly clippy --all --all-features -- -D warnings
-```
-
-If you are working in VSCOde, we recommend you install the [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer) extension, and use the following VSCode user settings:
 ```
-    "[rust]": {
-        "editor.defaultFormatter": "rust-lang.rust-analyzer",
-        "editor.formatOnSave": true
-    },
-    "rust-analyzer.rustfmt.extraArgs": [
-        "+nightly"
-    ],
-    "rust-analyzer.check.command": "clippy",
-    "rust-analyzer.files.excludeDirs": [
-      "crates/sim/contracts",
-      "crates/sim/tracer",
-      "crates/builder/proto",
-      "crates/pool/proto",
-      "test",
-    ],
+Fork → 新建分支 → 写代码 → 提交 PR → 签 CLA → Review → Merge
 ```
 
-If you are working on a larger feature, we encourage you to open up a draft pull request, to make sure that other contributors are not duplicating work.
-
-#### Adding tests
-
-If the change being proposed alters code, it is either adding new functionality to Rundler, or fixing existing, broken functionality.
-In both of these cases, the pull request should include one or more tests to ensure that Rundler does not regress in the future.
-
-#### Commits
-
-It is a recommended best practice to keep your changes as logically grouped as possible within individual commits. There is no limit to the number of commits any single pull request may have, and many contributors find it easier to review changes that are split across multiple commits.
-That said, if you have a number of commits that are "checkpoints" and don't represent a single logical change, please squash those together.
-
-We follow the [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) specification to make sure that all of our commits are formatted and properly tailored to the change that the commit is making. Please choose commit messages that correctly describe the change you are making.
-
-#### Opening the pull request
-
-From within GitHub, opening a new pull request will present you with a template that should be filled out. Please try your best at filling out the details, but feel free to skip parts if you're not sure what to put.
+- 分支命名：`feat/xxx` · `fix/xxx` · `docs/xxx`
+- Commit 规范：[Conventional Commits](https://www.conventionalcommits.org/)
+- 问题反馈：在本仓库提 Issue
 
-*Adapted from the [Reth contributing guide](https://github.com/paradigmxyz/reth/blob/main/CONTRIBUTING.md).*
+## License
 
-[dev-tg]: https://t.me/rundler
-[gh-issues]: https://github.com/alchemyplatform/rundler/issues/new/choose
+Contributions are licensed under [Apache License 2.0](LICENSE).  
+See [NOTICE](./NOTICE) · [TRADEMARK.md](./TRADEMARK.md) · [LICENSE-zh.md](./LICENSE-zh.md) · [TRADEMARK-zh.md](./TRADEMARK-zh.md) for details.
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,180 @@
+                              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 the 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 the 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 any
+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 consequential 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
+
+Copyright 2024-present MushroomDAO Contributors
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.