Merge pull request #141 from hirosystems/develop

release develop into master

Author: rafaelcr

.eslintrc.js

@@ -9,7 +9,7 @@ module.exports = {
     ecmaVersion: 2020,
     sourceType: 'module',
   },
-  ignorePatterns: ['*.config.js', 'config/*', '*.mjs', 'tests/*.js'],
+  ignorePatterns: ['*.config.js', 'config/*', '*.mjs', 'tests/*.js', 'client/*'],
   plugins: ['@typescript-eslint', 'eslint-plugin-tsdoc', 'prettier'],
   rules: {
     'prettier/prettier': 'error',

.github/workflows/new-issues.yml

@@ -0,0 +1,16 @@
+name: Add issues to API project
+
+on:
+  issues:
+    types:
+      - opened
+
+jobs:
+  add-to-project:
+    name: Add issue to project
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/add-to-project@main
+        with:
+          project-url: https://github.com/orgs/hirosystems/projects/11
+          github-token: ${{ secrets.GH_TOKEN }}

README.md

@@ -7,9 +7,12 @@ Stacks blockchain and exposes it via JSON REST API endpoints.
 
 * [Features](#features)
 * [API reference](#api-reference)
+* [Client library](#client-library)
 * [Quick start](#quick-start)
     * [System requirements](#system-requirements)
     * [Running the service](#running-the-service)
+        * [Run modes](#run-modes)
+    * [Stopping the service](#stopping-the-service)
     * [Using an image cache service](#using-an-image-cache-service)
 * [Service architecture](#service-architecture)
     * [External](#external)
@@ -46,6 +49,11 @@ Stacks blockchain and exposes it via JSON REST API endpoints.
 
 See the [Token Metadata API Reference](https://docs.hiro.so/metadata/) for more information.
 
+## Client library
+
+A TypeScript client library is available for consuming the API. See [the official
+package](https://www.npmjs.com/package/@hirosystems/token-metadata-api-client) for more information.
+
 ## Quick start
 
 ### System requirements

client/typescript.json

@@ -0,0 +1,5 @@
+{
+  "supportsES6": false,
+  "npmName": "@hirosystems/token-metadata-api-client",
+  "npmVersion": "1.0.0"
+}

client/typescript/.gitignore

@@ -0,0 +1,4 @@
+wwwroot/*.js
+node_modules
+typings
+dist

client/typescript/.swagger-codegen-ignore

@@ -0,0 +1,3 @@
+package.json
+package-lock.json
+README.md

client/typescript/.swagger-codegen/VERSION

@@ -0,0 +1 @@
+3.0.41

client/typescript/README.md

@@ -0,0 +1,19 @@
+## @hirosystems/token-metadata-api-client
+
+This is a client library for the [Token Metadata API](https://github.com/hirosystems/token-metadata-api).
+
+### Installation
+
+```
+npm install @hirosystems/token-metadata-api-client
+```
+
+### Example
+
+```typescript
+import { Configuration, TokensApi } from "@hirosystems/token-metadata-api-client";
+
+const config: Configuration = {}
+const api = new TokensApi(config);
+const result = await api.getFtMetadata('SP1H1733V5MZ3SZ9XRW9FKYGEZT0JDGEB8Y634C7R.miamicoin-token-v2');
+```