chore: add repo meta (#33)

Co-authored-by: Vasile Gabriel Marian <[email protected]>

.env.example

@@ -1,4 +1,4 @@
 PRIVATE_KEY=
 BUNDLER_URL=https://bundler.biconomy.io/api/v2/80001/nJPK7B3ru.dd7f7861-190d-41bd-af80-6877f74b8f44
 PAYMASTER_URL=https://paymaster.biconomy.io/api/v1/80001/-2BFRwRlJ.8afbc010-edcf-46b3-8713-77639655f2dd
-CHAIN_ID=80001
+CHAIN_ID=80001

.github/ISSUE_TEMPLATE/1_general_issue.yml

@@ -0,0 +1,26 @@
+name: 💡 General Inquiry & Suggestions
+description: Share general questions or suggestions that don't fit other categories
+title: "[GENERAL] "
+labels: ["question", "enhancement"]
+body:
+  - type: markdown
+    attributes:
+      value: "Got a question or suggestion? We're all ears!"
+  - type: textarea
+    attributes:
+      label: Inquiry or Suggestion
+      description: What would you like to share with us?
+      placeholder: "I'm wondering about..."
+    validations:
+      required: false
+  - type: input
+    attributes:
+      label: Relevant Links or References
+      description: Optionally, add any relevant links or references.
+      placeholder: "e.g., https://github.com/example"
+  - type: checkboxes
+    attributes:
+      label: Code of Conduct
+      options:
+        - label: I agree to follow this project's Code of Conduct.
+          required: true

.github/ISSUE_TEMPLATE/2_bug_report.yml

@@ -0,0 +1,71 @@
+name: 🐛 Bug Report & Test Failures
+description: Report unexpected behaviors or failing tests
+title: "[BUG] "
+labels: ["bug", "help wanted"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report! The more info you provide, the more we can help you.
+
+  - type: checkboxes
+    attributes:
+      label: Is there an existing issue for this?
+      description: Please search to see if an issue already exists for the bug you encountered.
+      options:
+        - label: I have searched the existing issues
+          required: true
+
+  - type: input
+    attributes:
+      label: Package Version
+      description: What version of the SDK are you using?
+      placeholder: 0.1.0
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Current Behavior
+      description: A concise description of what you're experiencing.
+    validations:
+      required: false
+
+  - type: textarea
+    attributes:
+      label: Expected Behavior
+      description: A concise description of what you expected to happen.
+    validations:
+      required: false
+
+  - type: textarea
+    attributes:
+      label: Steps To Reproduce
+      description: Steps or code snippets to reproduce the behavior.
+    validations:
+      required: false
+
+  - type: textarea
+    attributes:
+      label: Package.json (or lockfile) content
+      description: Packages used in your project. This will help us understand the environment you are working in, and check if there are dependencies that might be causing the issue.
+    validations:
+      required: false
+
+  - type: input
+    attributes:
+      label: Link to Minimal Reproducible Example (StackBlitz, CodeSandbox, GitHub repo etc.)
+      description: |
+        This makes investigating issues and helping you out significantly easier! For most issues, you will likely get asked to provide one so why not add one now :)
+    validations:
+      required: false
+
+  - type: textarea
+    attributes:
+      label: Anything else?
+      description: |
+        Browser info? Screenshots? Anything that will give us more context about the issue you are encountering!
+
+        Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/3_feature_request.yml

@@ -0,0 +1,31 @@
+name: ✨ Feature Requests & Performance Improvements
+description: Suggest a new feature or performance enhancement
+title: "[FEATURE] "
+labels: ["enhancement", "good first issue"]
+body:
+  - type: markdown
+    attributes:
+      value: "Your suggestions inspire us to improve. Share your ideas below!"
+  - type: input
+    attributes:
+      label: Feature or Improvement Description
+      description: Describe the feature or improvement you're suggesting.
+      placeholder: "e.g., Add support for platform Z."
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Benefits & Outcomes
+      description: Explain the benefits of your suggestion and the expected outcomes.
+      placeholder: "This improvement will improve performance by 30%..."
+  - type: input
+    attributes:
+      label: Any References?
+      description: Provide links or references to similar features or standards.
+      placeholder: "EIP-1234, https://github.com/example"
+  - type: checkboxes
+    attributes:
+      label: Code of Conduct
+      options:
+        - label: I agree to follow this project's Code of Conduct.
+          required: true

.github/ISSUE_TEMPLATE/4_security_report.yml

@@ -0,0 +1,31 @@
+name: 🔒 Security Pre-Screening
+description: Pre-screening for security-related reports
+title: "[SECURITY PRE-SCREEN] "
+labels: ["security", "triage needed"]
+body:
+  - type: markdown
+    attributes:
+      value: "Security is our top priority. If you've discovered a potential security issue that is **critical or high** in nature and could affect our deployed contracts, **please do not report it here.** Instead, email us directly at [email protected] for a confidential review. For all other security-related inquiries that do not pose an immediate risk to our deployed contracts, please proceed."
+  - type: checkboxes
+    attributes:
+      label: Security Level Acknowledgement
+      options:
+        - label: "I understand this issue will be public. It is NOT critical or high risk and does not endanger deployed contracts."
+          required: true
+  - type: input
+    attributes:
+      label: Overview
+      description: Provide a summary of the non-critical security concern or question.
+      placeholder: "e.g., Questions about the audit process."
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Additional Details
+      description: Offer more detail on your concern or question.
+      placeholder: "Provide any additional context..."
+  - type: input
+    attributes:
+      label: Suggestions for Mitigation
+      description: (Optional) Suggest ways to address the concern.
+      placeholder: "Potential mitigation steps include..."

.github/ISSUE_TEMPLATE/5_document_improvement.yml

@@ -0,0 +1,33 @@
+name: 📚 Documentation Improvement
+description: Propose improvements or report issues with documentation
+title: "[DOCS] "
+labels: ["documentation"]
+body:
+  - type: markdown
+    attributes:
+      value: "Help us enhance our documentation for everyone."
+  - type: input
+    attributes:
+      label: Documentation Page/Section
+      description: Which page or section are you referring to?
+      placeholder: "e.g., README.md, TSDoc guidelines."
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Suggested Improvements
+      description: Detail the improvements or corrections needed.
+      placeholder: "The section on XYZ could clarify..."
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: Additional Comments
+      description: Any other comments or suggestions?
+      placeholder: "Consider adding examples for..."
+  - type: checkboxes
+    attributes:
+      label: Code of Conduct
+      options:
+        - label: I agree to follow this project's Code of Conduct.
+          required: true

.github/ISSUE_TEMPLATE/6_build_deployment_issue.yml

@@ -0,0 +1,33 @@
+name: 🛠 Build & Deployment Issues
+description: Report issues related to building or deploying smart contracts
+title: "[BUILD/DEPLOY] "
+labels: ["bug", "help wanted"]
+body:
+  - type: markdown
+    attributes:
+      value: "Help us identify build or deployment problems to improve our processes."
+  - type: input
+    attributes:
+      label: Issue Summary
+      description: Briefly describe the issue encountered.
+      placeholder: "e.g., Failed to deploy contract due to..."
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Error Logs & Messages
+      description: Provide any error logs or messages seen.
+      placeholder: "Error: Failed to..."
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: Environment & Tools
+      description: Mention the tools and environment where the issue occurred.
+      placeholder: "e.g., Truffle v5.3, Rinkeby testnet"
+  - type: checkboxes
+    attributes:
+      label: Code of Conduct
+      options:
+        - label: I agree to follow this project's Code of Conduct.
+          required: true

.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -0,0 +1,22 @@
+## Pull Request for Smart Contract Improvement
+
+**Describe your changes:**
+
+<!-- Briefly describe what you're changing or fixing. -->
+
+**Link any related issues:**
+
+<!-- Link any related issues here. -->
+
+**Testing:**
+
+<!-- Describe how the changes were tested. Include steps if applicable. -->
+
+**Note:** Please ensure all tests and lint checks pass before requesting a review. If there are any errors, fix them prior to submission.
+
+**Checklist:**
+
+- [ ] I have performed a self-review of my own code.
+- [ ] I have added tests that prove my fix is effective or that my feature works.
+- [ ] I have made corresponding changes to the documentation, if applicable.
+- [ ] My changes generate no new warnings or errors.

.github/workflows/coverage.yml

@@ -29,4 +29,11 @@ jobs:
           json-summary-path	: ./coverage/coverage-summary.json
           json-final-path: './coverage/coverage-final.json'
           vite-config-path: ./tests/vitest.config.ts
-          github-token: ${{ secrets.GITHUB_TOKEN }}
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Upload coverage reports to Codecov
+        uses: codecov/[email protected]
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          verbose: true
+          slug: bcnmy/sdk

CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project 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 by contacting the project team at [email protected] or [email protected]. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other project leadership members.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Biconomy
+
+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.