Merge pull request #182 from hirosystems/develop

release v0.5.0

.github/CONTRIBUTING.md

@@ -0,0 +1,19 @@
+# Contributing
+
+Thank you for considering contributing to this product! We welcome any contributions, whether it's bug fixes, new features, or improvements to the existing codebase.
+
+### Your First Pull Request
+
+Working on your first Pull Request? You can learn how from this free video series:
+
+[How to Contribute to an Open Source Project on GitHub](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github)
+
+To help you get familiar with our contribution process, we have a list of [good first issues](../../issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) that contain bugs that have a relatively limited scope. This is a great place to get started.
+
+If you decide to fix an issue, please be sure to check the comment thread in case somebody is already working on a fix. If nobody is working on it at the moment, please leave a comment stating that you intend to work on it so other people don’t accidentally duplicate your effort.
+
+If somebody claims an issue but doesn’t follow up for more than two weeks, it’s fine to take it over but you should still leave a comment. **Issues won't be assigned to anyone outside the core team**.
+
+### Contribution Prerequisites
+
+... 🚧 Work in progress 🚧 ...

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,42 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: 'Bug'
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+Transaction ID 
+Address 
+Block#  
+Time stamp
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots or consol.log to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here: 

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,4 @@
+contact_links:
+  - name: Ask the community
+    url: https://discord.gg/KrqnVg8D
+    about: Ask and discuss questions with other Stacks community developers.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,23 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: 'enhancement'
+
+---
+
+**Please review the existing enhancement issues at the link below before creating a new one to ensure you do not create a duplicate request.** 
+If you see an [existing enhancement issues](https://github.com/blockstack/explorer/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement) please comment on the issue or upvote the issue with a :thumbsup:
+
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,19 @@
+### Description
+
+<!-- Describe the bug this PR fixes or the feature it adds. Link to any related issues and PRs -->
+
+#### Breaking change?
+
+<!-- If applicable, list the APIs/functionality which this PR breaks -->
+
+### Example
+
+<!-- If applicable, add an example on how this improves the application -->
+
+---
+
+### Checklist
+
+- [ ] All tests pass
+- [ ] Tests added in this PR (if applicable)
+

README.md

@@ -22,6 +22,9 @@ Stacks blockchain and exposes it via JSON REST API endpoints.
         * [Job Queue](#job-queue)
             * [Process Smart Contract Job](#process-smart-contract-job)
             * [Process Token Job](#process-token-job)
+* [Bugs and Feature Requests](#bugs-and-feature-requests)
+* [Contribute](#contribute)
+* [Community](#community)
 
 ## Features
 
@@ -218,3 +221,34 @@ to save it into the local database for API endpoints to return.
 If a `429` (Too Many Requests) status code is returned by a hostname used to fetch metadata, the
 service will cease all further requests to it until a reasonable amount of time has passed or until
 the time specified by the host in a `Retry-After` response header.
+
+## Bugs and feature requests
+
+If you encounter a bug or have a feature request, we encourage you to follow the steps below:
+
+ 1. **Search for existing issues:** Before submitting a new issue, please search [existing and closed issues](../../issues) to check if a similar problem or feature request has already been reported.
+ 1. **Open a new issue:** If it hasn't been addressed, please [open a new issue](../../issues/new/choose). Choose the appropriate issue template and provide as much detail as possible, including steps to reproduce the bug or a clear description of the requested feature.
+ 1. **Evaluation SLA:** Our team reads and evaluates all the issues and pull requests. We are avaliable Monday to Friday and we make a best effort to respond within 7 business days.
+
+Please **do not** use the issue tracker for personal support requests or to ask for the status of a transaction. You'll find help at the [#support Discord channel](https://discord.gg/SK3DxdsP).
+
+
+## Contribute
+
+Development of this product happens in the open on GitHub, and we are grateful to the community for contributing bugfixes and improvements. Read below to learn how you can take part in improving the product.
+
+### Code of Conduct
+Please read our [Code of conduct](../../../.github/blob/main/CODE_OF_CONDUCT.md) since we expect project participants to adhere to it. 
+
+### Contributing Guide
+Read our [contributing guide](.github/CONTRIBUTING.md) to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes.
+
+## Community
+
+Join our community and stay connected with the latest updates and discussions:
+
+- [Join our Discord community chat](https://discord.gg/ZQR6cyZC) to engage with other users, ask questions, and participate in discussions.
+
+- [Visit hiro.so](https://www.hiro.so/) for updates and subcribing to the mailing list.
+
+- Follow [Hiro on Twitter.](https://twitter.com/hirosystems)

client/typescript/api.ts

@@ -4,7 +4,7 @@
  * Token Metadata API
  * Service that indexes metadata for every SIP-009, SIP-010, and SIP-013 Token in the Stacks blockchain and exposes it via REST API endpoints.
  *
- * OpenAPI spec version: v0.3.0
+ * OpenAPI spec version: v0.4.0
  * 
  *
  * NOTE: This file is auto generated by the swagger code generator program.
@@ -268,6 +268,12 @@ export interface FtBasicMetadataResponse {
      * @memberof FtBasicMetadataResponse
      */
     sender_address: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof FtBasicMetadataResponse
+     */
+    contract_principal: string;
 }
 /**
  * 
@@ -478,14 +484,18 @@ export interface NotFoundErrorResponse {
  * @export
  * @interface Order
  */
-export interface Order {
+export enum Order {
+  asc = 'asc',
+  desc = 'desc',
 }
 /**
  * 
  * @export
  * @interface OrderBy
  */
-export interface OrderBy {
+export enum OrderBy {
+  name = 'name',
+  symbol = 'symbol',
 }
 /**
  * 

client/typescript/api_test.spec.ts

@@ -2,7 +2,7 @@
  * Token Metadata API
  * Service that indexes metadata for every SIP-009, SIP-010, and SIP-013 Token in the Stacks blockchain and exposes it via REST API endpoints.
  *
- * OpenAPI spec version: v0.3.0
+ * OpenAPI spec version: v0.4.0
  * 
  *
  * NOTE: This file is auto generated by the swagger code generator program.

client/typescript/configuration.ts

@@ -3,7 +3,7 @@
  * Token Metadata API
  * Service that indexes metadata for every SIP-009, SIP-010, and SIP-013 Token in the Stacks blockchain and exposes it via REST API endpoints.
  *
- * OpenAPI spec version: v0.3.0
+ * OpenAPI spec version: v0.4.0
  * 
  *
  * NOTE: This file is auto generated by the swagger code generator program.

client/typescript/index.ts

@@ -3,7 +3,7 @@
  * Token Metadata API
  * Service that indexes metadata for every SIP-009, SIP-010, and SIP-013 Token in the Stacks blockchain and exposes it via REST API endpoints.
  *
- * OpenAPI spec version: v0.3.0
+ * OpenAPI spec version: v0.4.0
  * 
  *
  * NOTE: This file is auto generated by the swagger code generator program.

client/typescript/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hirosystems/token-metadata-api-client",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "Client for @hirosystems/token-metadata-api",
   "author": "Hiro Systems PBC <engineering@hiro.so> (https://hiro.so)",
   "keywords": [

docs/feature-guides/metadata-api.md

@@ -0,0 +1,24 @@
+---
+title: API-Metadata features
+---
+
+## Features
+
+Following are the features of Token-Metadata API:
+
+* Complete [SIP-016](https://github.com/stacksgov/sips/blob/main/sips/sip-016/sip-016-token-metadata.md) metadata ingestion for
+    * [SIP-009](https://github.com/stacksgov/sips/blob/main/sips/sip-009/sip-009-nft-standard.md)
+      Non-Fungible Tokens
+    * [SIP-010](https://github.com/stacksgov/sips/blob/main/sips/sip-010/sip-010-fungible-token-standard.md)
+      Fungible Tokens
+    * [SIP-013](https://github.com/stacksgov/sips/blob/main/sips/sip-013/sip-013-semi-fungible-token-standard.md)
+      Semi-Fungible Tokens
+* Automatic metadata refreshes via [SIP-019](https://github.com/stacksgov/sips/pull/72)
+  notifications
+* Metadata localization support
+* Metadata fetching via `http:`, `https:`, `data:` URIs. Also supported via customizable gateways:
+    * IPFS
+    * Arweave
+* Easy to use REST JSON endpoints with ETag caching.=
+* Prometheus metrics for job queue status, contract and token counts, API performance, etc
+* Image cache/CDN support