diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..66df7d5 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1 @@ +* @maestro-org/Metaprotocols \ No newline at end of file diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..29c3ec5 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,34 @@ +Thank you for contributing to Maestro! We appreciate your effort and dedication to improving this project. To ensure that your contribution is in line with the project's guidelines and can be reviewed efficiently, please fill out the template below. + +Remember to follow our [Contributing Guide](CONTRIBUTING.md) before submitting your pull request. + +## Summary + +Please provide a brief, concise summary of the changes in your pull request. Explain the problem you are trying to solve and the solution you have implemented. + +## Type of Change + +Please mark the relevant option(s) for your pull request: + +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New registry entry (non-breaking change which adds functionality) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] Code refactoring (improving code quality without changing its behavior) +- [ ] Documentation update (adding or updating documentation related to the project) + +## Checklist + +Please ensure that your pull request meets the following criteria: + +- [ ] I have read the [Contributing Guide](CONTRIBUTING.md) +- [ ] My code follows the project's coding style and best practices +- [ ] My code is appropriately commented and includes relevant documentation +- [ ] I have added tests to cover my changes +- [ ] All new and existing tests pass +- [ ] I have updated the documentation, if necessary + +## Additional Information + +If you have any additional information or context to provide, such as screenshots, relevant issues, or other details, please include them here. + diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e43b0f9 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +.DS_Store diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..10b0bbc --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,128 @@ +# 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 +support@gomaestro.org. +All complaints will be reviewed and investigated promptly and fairly. + +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. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..aa6ae5d --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,30 @@ +# Contributing to Maestro + +Welcome! We're happy to have you join our community and contribute to the most powerful Dapp Developer Platform on Cardano! + +To learn more about Maestro [here](https://docs.gomaestro.org/)! + +## Opening Issues + +Use an [existing template](https://github.com/maestro-org/bitcoin-metaprotocols-registry/issues/new/choose) to: +- Report a bug +- Update the docs +- Request a new feature + +Accompany your issue with one or more of the following labels: +- `Contract`: something related to a new contract +- `Bug`: something is broken in the library's codebase +- `Chore`: something needs to be updated, like a dependency +- `Docs`: something in the documentation needs to be updated +- `Feature`: something new would be a nice addition to the library +- `Vulnerability`: something is vulnerability and needs attention from security +- `Spike`: something new needs to be explored + +## Opening Pull Requests +After opening a pull request, please take the following steps: +- Ensure your PR has one or more corresponding issues (see above) +- [Link your PR](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) to those issues +- Wait for a review and/or approval from one of the code owners +- Merge and celebrate with some nice tunes! 🎼🎼🎼 + +The team will do their best to help you get your PRs merged as soon as humanly possible! diff --git a/README.md b/README.md index 3cae394..c91ad5e 100644 --- a/README.md +++ b/README.md @@ -1 +1,50 @@ -# bitcoin-metaprotocol-registry \ No newline at end of file +

+ + Maestro Logo + +

Bitcoin Metaprotocols Registry

+

+ + + + + + + + + + + + + + + +

+

+ +Registry to house metadata about Bitcoin metaprotocol assets. + +## Contributing + +Simply add metadata for a particular metaprotocol using the template defined for each metaprotocol. If a template needs to be updated, you can open a PR for that as well. + +## Ordinals Collections Metadata +| Field | Type | Description | +|------------------|----------|-----------------------------------------------------------------------------| +| `name` | String | The name of the metaprotocol asset. | +| `description` | String | A brief description of the metaprotocol asset. | +| `avatar` | String | URL to an image representing the metaprotocol asset. | +| `tags` | Array | A list of tags associated with the metaprotocol asset. | +| `socials` | Object | Social media links related to the metaprotocol asset. | +| `socials.x` | String | Link to the Twitter profile. | +| `socials.discord`| String | Link to the Discord server. | +| `socials.youtube`| String | Link to the YouTube channel. | +| `socials.github` | String | Link to the GitHub repository. | +| `socials.website`| String | Link to the official website. | +| `sat_range` | Object | The range of satoshis associated with the metaprotocol asset. | +| `sat_range.min` | Number | The minimum satoshi value in the range. | +| `sat_range.max` | Number | The maximum satoshi value in the range. | +| `inscription_ids`| Array | A list of inscription IDs associated with the metaprotocol asset. | + +# TODOs +- [ ] Reference the Maestro Ordinals API when available diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..c80f9f8 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,7 @@ +# Security Policy + +## Reporting a Vulnerability + +Please report a Vulnerability with the built-in Github functionality in the *Security* tab : https://github.com/maestro-org/bitcoin-metaprotocols-registry/security/advisories + +More info here : https://docs.github.com/en/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability diff --git a/ordinals-collections/meta_template.json b/ordinals-collections/meta_template.json new file mode 100644 index 0000000..effd052 --- /dev/null +++ b/ordinals-collections/meta_template.json @@ -0,0 +1,19 @@ +{ + "name": "", + "description": "", + "avatar": "", + "tags": [], + "socials": { + "x": "", + "discord": "", + "youtube": "", + "github": "", + "website": "" + }, + "sat_range": + { + "min": 0, + "max": 0 + }, + "inscription_ids": [] +} diff --git a/ordinals-collections/pizzaninjas/meta.json b/ordinals-collections/pizzaninjas/meta.json new file mode 100644 index 0000000..cb68bc6 --- /dev/null +++ b/ordinals-collections/pizzaninjas/meta.json @@ -0,0 +1,20 @@ +{ + "name": "", + "description": "", + "avatar": "", + "tags": [], + "socials": { + "x": "ninjalerts", + "discord": "ninjalerts", + "website": "https://ninjalerts.gitbook.io/" + }, + "sat_range": + { + "min": 56122947, + "max": 56275803 + }, + "inscription_ids": [ + "650fe4b0abc458836ef869906afbed7c306b1f948a4b3e9412812a7f83900033i124", + "fd9e4f52b0017d11e5e0541c252505a62b8d89a3412cfeca584aadedffe2d77bi49" + ] +}