Merge branch 'main' into feature/nodejs-docs

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,42 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: 'bug: '
+labels: bug
+assignees: ''
+
+---
+
+## Bug Report
+
+### Swaplace version
+
+<!-- Please specify the commit or tag version. -->
+
+### Current behavior
+
+<!-- Describe how the bug manifests. -->
+
+### Expected behavior
+
+<!-- Describe what the behavior would be without the bug. -->
+
+### Steps to reproduce
+
+<!--  Please explain the steps required to duplicate the issue,
+especially if you can provide a sample application. -->
+
+### Related code
+
+<!-- If you can illustrate the bug or feature request
+with an example, please provide it here. -->
+
+```sh
+insert short code snippets here
+```
+
+### Other information
+
+<!-- Could you list any other information that is relevant to your issue?
+Related issues, suggestions on how to fix, Stack Overflow links,
+forum links, etc. -->

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,6 @@
+---
+blank_issues_enabled: false
+contact_links:
+  - name: Swaplace Community Support
+    url: https://github.com/blockful-io/swaplace-contracts/discussions
+    about: Please ask and answer questions here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,35 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: 'feat:'
+labels: enhancement
+assignees: ''
+
+---
+
+## Feature Request
+
+### Describe the Feature Request
+
+<!-- A clear and concise description of the feature request.
+Please include if your feature request is related to a problem. -->
+
+### Describe Preferred Solution
+
+<!-- A clear and concise description of what you want to happen. -->
+
+### Describe Alternatives
+
+<!-- A clear and concise description of any alternative solutions or
+features you've considered. -->
+
+### Related Code
+
+<!-- If you can illustrate the bug or feature request with an
+example, please provide it here. -->
+
+### Additional Context
+
+<!-- List any other information that is relevant to your issue. Stack traces,
+related issues, suggestions on how to add, use case, Stack Overflow links,
+forum links, screenshots, OS if applicable, etc. -->

.github/ISSUE_TEMPLATE/refactor-template.md

@@ -0,0 +1,35 @@
+---
+name: Refactor Template
+about: 'Refactor '
+title: 'refactor:'
+labels: ''
+assignees: ''
+
+---
+
+## Refactor Request
+
+### Describe the Refactor Request
+
+<!-- A clear and concise description of the refactor request.
+Please include if your refactor request is related to a problem. -->
+
+### Describe Preferred Solution
+
+<!-- A clear and concise description of what you want to happen. -->
+
+### Describe Alternatives
+
+<!-- A clear and concise description of any alternative solutions or
+features you've considered. -->
+
+### Related Code
+
+<!-- If you can illustrate the bug or refactor request with an
+example, please provide it here. -->
+
+### Additional Context
+
+<!-- List any other information that is relevant to your issue. Stack traces,
+related issues, suggestions on how to add, use case, Stack Overflow links,
+forum links, screenshots, OS if applicable, etc. -->

README.md

@@ -93,4 +93,4 @@ yarn deploy <network>
 
 ## Contributing
 
-- To know more about how you can contribute [see our notion page](https://blockful.notion.site/Swaplace-Call-for-Contributors-6e4895d2a7264f679439ab2c124603fe).
+- To know more about how you can contribute [see our notion page](https://blockful.notion.site/Swaplace-Call-for-Contributors-6e4895d2a7264f679439ab2c124603fe).

docs/CODE_OF_CONDUCT.md

@@ -0,0 +1,127 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[Discord](https://discord.gg/B6uDmm7hvC) ``SUPPORT/open-a-ticket channel``.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

CONTRIBUTING.md → docs/CONTRIBUTING.md

@@ -1,6 +1,6 @@
 # Contribution Guidelines
 
-Thank you for your interest in contributing to Swaplace! The project is an open source build by the community. We are welcome any type of contribution, suggestion or improvement, no matter how small.
+Thank you for your interest in contributing to Swaplace! The project is an open-source build by the community. We welcome any type of contribution, suggestion or improvement, no matter how small.
 
 ### Contents
 
@@ -16,21 +16,21 @@ Thank you for your interest in contributing to Swaplace! The project is an open
 
 There are many ways to contribute, but here are a few steps to start:
 
-1. Fork the repository in GitHub
-2. Check if you have any issue, suggestion or improvement to work in.
+1. Fork the repository in GitHub.
+2. Check if you have any issue, suggestion or improvement to work on.
 
    - We manage all the issues using [GitHub Projects](https://github.com/orgs/blockful-io/projects/3)
 
 3. Send a message in the issue like
-   `I'm interested in this issue` or ask for more information like `Hey, can you provide more information about this ... ?`and the mantainers will assigned or provide more context about your issue. **After that, you are asigned to the issue.**
+   `I'm interested in this issue` or ask for more information such as `Hey, can you provide more information about this ... ?` The mantainers will then assign or provide more context about your issue. **After that, you are asigned to the issue.**
 
 4. If a task is already assigned but you believe you can expedite the process, feel free to comment, requesting to assist or speed up the task. Additionally, you may open a pull request directly because we prioritize both code efficiency and delivery speed. Thus, we encourage multiple individuals to review the same issues and debate together to enhance the code's security.
 
-### Congratulations ! Now you can start work in the issue and everyone knows you are assigned.
+### Congratulations ! You can now start working on the issue, and everyone is aware that you are assigned.
 
-## Opening Issue
+## Opening An Issue
 
-Before opening an issue, please check if there is no issue open. If there is, feel free to comment or suggest more details. We are always open to feedback and receptive to suggestions!
+Before opening an issue, please check if there is any issue already open. If there is, feel free to comment or suggest more details. We are always open to feedback and receptive to suggestions!
 
 - Before [creating an issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/creating-an-issue#creating-an-issue-from-a-project), check if your fork is updated.
 
@@ -50,7 +50,7 @@ Some examples below:
 
 ## Submiting Pull Requests
 
-You can resolve an issue and after that submit a pull request fixing an issue and remember to [reference that issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword#linking-a-pull-request-to-an-issue-using-a-keyword). When submit a PR, put the code below with the number of the issue you are closing
+You can resolve an issue and after that submit a pull request fixing an issue and remember to [reference that issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword#linking-a-pull-request-to-an-issue-using-a-keyword). When submitting a PR, put the code below with the number of the issue you are closing
 `Example: closes #1`
 
 ## Code Review

docs/SECURITY.md

@@ -0,0 +1,36 @@
+# Security Policy
+
+If you believe you have found a security vulnerability in the repository, please report it to us through coordinated disclosure.
+
+Please do not report security vulnerabilities through public **GitHub issues, discussions, or pull requests.**
+
+Instead, please open a ticket in ``SUPPORT/open-a-ticket channel`` on [Discord](https://discord.gg/B6uDmm7hvC).
+
+
+## Supported Versions
+
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 1.0.x   | :x: |
+
+## Reporting a Vulnerability
+
+Please include as much of the information listed below as you can to help us better understand and resolve the issue:
+
+A full description of the issue.
+The steps we will be taking to remedy the issue.
+The patch(es), if any, that will be applied to contract.
+The type of issue or type of vulnerability.
+Full paths of source file(s) related to the manifestation of the issue
+The location of the affected source code (tag/branch/commit or direct URL)
+Any special configuration required to reproduce the issue
+Step-by-step instructions to reproduce the issue
+Proof-of-concept or exploit code (if possible)
+Impact of the issue, including how an attacker might exploit the issue
+
+Tell them where to go, how often they can expect to get an update on a
+reported vulnerability, what to expect if the vulnerability is accepted or
+declined, etc.
+
+Please reach out to us ! Your contribution makes all the difference.

hardhat.config.ts

@@ -68,7 +68,7 @@ const config: HardhatUserConfig = {
   },
   defaultNetwork: "hardhat",
   docgen: {
-    outputDir: "docs",
+    outputDir: "docs/solidity-docgen",
     pages: "files",
   },
   gasReporter: {