added docs

CODE_OF_CONDUCT.md

@@ -0,0 +1,93 @@
+# Contributor Covenant 3.0 Code of Conduct
+
+## Our Pledge
+
+We pledge to make our community welcoming, safe, and equitable for all.
+
+We are committed to fostering an environment that respects and promotes the dignity, rights, and contributions of all individuals, regardless of characteristics including race, ethnicity, caste, color, age, physical characteristics, neurodiversity, disability, sex or gender, gender identity or expression, sexual orientation, language, philosophy or religion, national or social origin, socio-economic position, level of education, or other status. The same privileges of participation are extended to everyone who participates in good faith and in accordance with this Covenant.
+
+## Encouraged Behaviors
+
+While acknowledging differences in social norms, we all strive to meet our community's expectations for positive behavior. We also understand that our words and actions may be interpreted differently than we intend based on culture, background, or native language.
+
+With these considerations in mind, we agree to behave mindfully toward each other and act in ways that center our shared values, including:
+
+1. Respecting the **purpose of our community**, our activities, and our ways of gathering.
+2. Engaging **kindly and honestly** with others.
+3. Respecting **different viewpoints** and experiences.
+4. **Taking responsibility** for our actions and contributions.
+5. Gracefully giving and accepting **constructive feedback**.
+6. Committing to **repairing harm** when it occurs.
+7. Behaving in other ways that promote and sustain the **well-being of our community**.
+
+## Restricted Behaviors
+
+We agree to restrict the following behaviors in our community. Instances, threats, and promotion of these behaviors are violations of this Code of Conduct.
+
+1. **Harassment.** Violating explicitly expressed boundaries or engaging in unnecessary personal attention after any clear request to stop.
+2. **Character attacks.** Making insulting, demeaning, or pejorative comments directed at a community member or group of people.
+3. **Stereotyping or discrimination.** Characterizing anyone’s personality or behavior on the basis of immutable identities or traits.
+4. **Sexualization.** Behaving in a way that would generally be considered inappropriately intimate in the context or purpose of the community.
+5. **Violating confidentiality**. Sharing or acting on someone's personal or private information without their permission.
+6. **Endangerment.** Causing, encouraging, or threatening violence or other harm toward any person or group.
+7. Behaving in other ways that **threaten the well-being** of our community.
+
+### Other Restrictions
+
+1. **Misleading identity.** Impersonating someone else for any reason, or pretending to be someone else to evade enforcement actions.
+2. **Failing to credit sources.** Not properly crediting the sources of content you contribute.
+3. **Promotional materials**. Sharing marketing or other commercial content in a way that is outside the norms of the community.
+4. **Irresponsible communication.** Failing to responsibly present content which includes, links or describes any other restricted behaviors.
+
+## Reporting an Issue
+
+Tensions can occur between community members even when they are trying their best to collaborate. Not every conflict represents a code of conduct violation, and this Code of Conduct reinforces encouraged behaviors and norms that can help avoid conflicts and minimize harm.
+
+When an incident does occur, it is important to report it promptly. To report a possible violation, please use one of the following **confidential channels**:
+
+1. **Email — [support@intmax.io](mailto:support@intmax.io)**
+
+   - Reaches the core Moderation Team directly.
+
+2. **Support Portal - [submit a support ticket](https://intmaxhelp.zendesk.com/hc/en-gb/requests/new)**
+
+   - Use our Support Portal for sensitive or confidential issues. Your report will be handled privately by the Moderation Team.
+
+Please include as much relevant detail as possible (time, location, participants, links, screenshots, or logs). Moderators will acknowledge your report within **24 hours** and provide a status update within **seven days**. All reports are handled confidentially.
+
+Community Moderators take reports of violations seriously and will make every effort to respond in a timely manner. They will investigate all reports of code of conduct violations, reviewing messages, logs, and recordings, or interviewing witnesses and other participants. Community Moderators will keep investigation and enforcement actions as transparent as possible while prioritizing safety and confidentiality. In order to honor these values, enforcement actions are carried out in private with the involved parties, but communicating to the whole community may be part of a mutually agreed upon resolution.
+
+## Addressing and Repairing Harm
+
+If an investigation by the Community Moderators finds that this Code of Conduct has been violated, the following enforcement ladder may be used to determine how best to repair harm, based on the incident's impact on the individuals involved and the community as a whole. Depending on the severity of a violation, lower rungs on the ladder may be skipped.
+
+1. Warning
+   1. Event: A violation involving a single incident or series of incidents.
+   2. Consequence: A private, written warning from the Community Moderators.
+   3. Repair: Examples of repair include a private written apology, acknowledgement of responsibility, and seeking clarification on expectations.
+2. Temporarily Limited Activities
+   1. Event: A repeated incidence of a violation that previously resulted in a warning, or the first incidence of a more serious violation.
+   2. Consequence: A private, written warning with a time-limited cooldown period designed to underscore the seriousness of the situation and give the community members involved time to process the incident. The cooldown period may be limited to particular communication channels or interactions with particular community members.
+   3. Repair: Examples of repair may include making an apology, using the cooldown period to reflect on actions and impact, and being thoughtful about re-entering community spaces after the period is over.
+3. Temporary Suspension
+   1. Event: A pattern of repeated violation which the Community Moderators have tried to address with warnings, or a single serious violation.
+   2. Consequence: A private written warning with conditions for return from suspension. In general, temporary suspensions give the person being suspended time to reflect upon their behavior and possible corrective actions.
+   3. Repair: Examples of repair include respecting the spirit of the suspension, meeting the specified conditions for return, and being thoughtful about how to reintegrate with the community when the suspension is lifted.
+4. Permanent Ban
+   1. Event: A pattern of repeated code of conduct violations that other steps on the ladder have failed to resolve, or a violation so serious that the Community Moderators determine there is no way to keep the community safe with this person as a member.
+   2. Consequence: Access to all community spaces, tools, and communication channels is removed. In general, permanent bans should be rarely used, should have strong reasoning behind them, and should only be resorted to if working through other remedies has failed to change the behavior.
+   3. Repair: There is no possible repair in cases of this severity.
+
+This enforcement ladder is intended as a guideline. It does not limit the ability of Community Managers to use their discretion and judgment, in keeping with the best interests of our community.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public or other spaces. Examples of representing our community include using an official email address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Attribution
+
+This Code of Conduct is adapted from the Contributor Covenant, version 3.0, permanently available at [https://www.contributor-covenant.org/version/3/0/](https://www.contributor-covenant.org/version/3/0/).
+
+Contributor Covenant is stewarded by the Organization for Ethical Source and licensed under CC BY-SA 4.0. To view a copy of this license, visit [https://creativecommons.org/licenses/by-sa/4.0/](https://creativecommons.org/licenses/by-sa/4.0/)
+
+For answers to common questions about Contributor Covenant, see the FAQ at [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). Translations are provided at [https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations). Additional enforcement and community guideline resources can be found at [https://www.contributor-covenant.org/resources](https://www.contributor-covenant.org/resources). The enforcement ladder was inspired by the work of [Mozilla’s code of conduct team](https://github.com/mozilla/inclusion).

CONTRIBUTING.md

@@ -0,0 +1,172 @@
+# How to Contribute
+
+> *We scale Ethereum without sacrificing privacy. You can help.*
+
+Thank you for your interest in improving **INTMAX2-Function**, the zero-knowledge roll-up function service developed by the Internet Maximalism community. Whether you spot a typo, design a new feature, or help triage issues, your contribution makes the project stronger. This guide explains how to participate effectively and respectfully.
+
+---
+
+## Why read these guidelines?
+
+Following the steps below shows respect for the maintainers’ time and helps us review your work quickly. In return, we will do our best to respond promptly, give constructive feedback, and merge high-quality changes.
+
+---
+
+## What kinds of contributions are welcome?
+
+* **Code** — Rust/TypeScript/Go changes that improve functionality, performance, or security of the function services.
+* **Documentation** — Tutorials, API references, FAQs, diagrams, or translations.
+* **Testing & QA** — Bug reports, reproducible test cases, and adding automated tests.
+* **Dev UX** — Build scripts, Dockerfiles, CI/CD, developer tools.
+* **Community support** — Answering questions on Discord, writing blog posts, or recording demo videos.
+
+---
+
+## Contributions we are *not* looking for
+
+* **End-user support requests** — Please open a ticket at [intmaxhelp.zendesk.com](https://intmaxhelp.zendesk.com/hc/en-gb/requests/new) instead of the GitHub issue tracker.
+* **Exchange listing questions / price talk** — Off-topic for this repository.
+* **Security disclosures in public issues** — See the security section below.
+
+---
+
+## Ground rules
+
+* Be respectful, inclusive, and patient — read and follow our [Code of Conduct](./CODE_OF_CONDUCT.md).
+* Discuss large changes in an issue *before* starting work.
+* All code must pass format and test checks.
+* Write tests for all new modules and functions.
+* Keep PRs focused: one feature or bug-fix per pull request.
+* Never commit secrets, private keys, or user data.
+
+---
+
+## Your first contribution
+
+Newcomers are welcome! Look for issues labeled **`good first issue`** or **`help wanted`**:
+[https://github.com/InternetMaximalism/intmax2-function/issues?q=is%3Aopen+label%3A%22good+first+issue%22](https://github.com/InternetMaximalism/intmax2-function/issues?q=is%3Aopen+label%3A%22good+first+issue%22)
+
+If you’re unsure, ask in **#dev-general** on our [Discord](https://discord.gg/TGMctchPR6).
+
+For a gentle introduction, consider improving docs or adding small tests.
+
+---
+
+## Getting started (Workflow)
+
+1. **Fork** the repo: [https://github.com/InternetMaximalism/intmax2-function](https://github.com/InternetMaximalism/intmax2-function) and clone your fork.
+
+2. **Create a branch**:
+   ```bash
+   git checkout -b feat/short-description
+   ```
+
+3. **Set up the environment**
+   Copy `.env.example` files to `.env` and edit as needed:
+
+   ```bash
+   cp .env.example .env
+   # Edit .env to match your local configuration
+   ```
+
+4. **Install dependencies**:
+
+   ```bash
+   yarn
+   ```
+
+5. **Build shard modules**:
+
+   ```bash
+   yarn build:shard
+   ```
+
+6. **Run the test suite** to ensure your environment is healthy:
+
+   ```bash
+   yarn format
+   yarn test
+   ```
+
+7. **Commit** using [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/):
+
+   * `feat: add deposit-function handler`
+   * `fix(api): handle zero-gas meta-tx edge-case`
+
+8. **Push** and **open a Pull Request** against `dev` (not `main`).
+
+9. Complete the PR checklist; a maintainer will review within **5 business days**.
+
+---
+
+### Obvious fixes
+
+Typo or whitespace fixes that don’t change functionality can be submitted without opening an issue first.
+
+---
+
+## Bug reports
+
+If something isn’t working:
+
+1. Search existing issues first.
+2. Open a **new issue** with the template and include:
+
+   * Commit hash / Docker image tag
+   * OS and architecture (e.g. Ubuntu 22.04 x86-64)
+   * Steps to reproduce (commands, transaction hashes, etc.)
+   * Expected vs. actual behavior
+   * Logs / screenshots when possible
+
+---
+
+### Security vulnerabilities
+
+Do **not** open a public issue. Email **[support@intmax.io](mailto:support@intmax.io)** with details and we will coordinate a responsible disclosure.
+
+---
+
+## Feature requests & improvements
+
+Open an issue describing:
+
+* **What problem** you are solving and who benefits
+* **Proposed solution** (API sketch, UX flow, or pseudocode)
+* **Alternatives** you considered
+
+A maintainer will discuss scope and alignment with the project roadmap before anyone starts coding.
+
+---
+
+## Code review process
+
+* At least **two approvals** from core maintainers are required.
+* CI must be green before merging.
+* The PR author (or a maintainer) should **squash-merge** once reviews pass.
+* Inactive PRs with no activity for **30 days** may be closed — feel free to reopen when ready.
+
+---
+
+## Community & support
+
+* **Discord**: [https://discord.gg/TGMctchPR6](https://discord.gg/TGMctchPR6) (`#dev-general`)
+* **GitHub Discussions**: [https://github.com/InternetMaximalism/intmax2-function/discussions](https://github.com/InternetMaximalism/intmax2-function/discussions)
+* **Support portal (private)**: [intmaxhelp.zendesk.com](https://intmaxhelp.zendesk.com/hc/en-gb/requests/new)
+
+---
+
+## Coding, commit, and label conventions
+
+| Area         | Convention                                                                                |
+| ------------ | ----------------------------------------------------------------------------------------- |
+| Rust         | `cargo fmt`, forbid warnings in CI                                                        |
+| TypeScript   | `eslint --max-warnings=0`, `prettier --check`                                             |
+| Go           | `go fmt`, `golangci-lint run`                                                             |
+| Commits      | **Conventional Commits** (`feat:`, `fix:`, `chore:` …)                                    |
+| Issue labels | `bug`, `enhancement`, `good first issue`, `help wanted`, `security`, `docs`, `discussion` |
+
+---
+
+### Thanks
+
+INTMAX2-Function exists because of contributors like **you**. We appreciate your time and effort to make private, scalable blockchain infrastructure a reality.

LICENSE

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