Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/max-tonny8/ordinals_api_bitcoin

This project is to inscribe ordinals to use ordinals api.
https://github.com/max-tonny8/ordinals_api_bitcoin

docker express mongodb mongoose nodejs ordinals reactjs tailwindcss typescript vercel

Last synced: about 1 month ago
JSON representation

This project is to inscribe ordinals to use ordinals api.

Awesome Lists containing this project

README 

        



* [Features](#features)

* [API Reference](#api-reference)

* [Quick Start](#quick-start)

    * [System Requirements](#system-requirements)

    * [Running the API](#running-the-api)

    * [Run Modes](#run-modes)

    * [Stopping the API](#stopping-the-api)

* [Bugs and Feature Requests](#bugs-and-feature-requests)

* [Contribute](#contribute)

* [Community](#community)



***



# Features



* Inscription endpoints

    * Genesis block and transaction information

    * Transfer history

    * Transfers per block

    * Current location and ownership information

    * Blessed and cursed inscriptions

* BRC-20 endpoints

    * Full token deploy, mint and transfer history

    * Activities per token and per address

    * Address balances

* Satoshi ordinal notation endpoints

* ETag cache support

* Run modes for auto-scaling



# API Reference



See the [Ordinals API Reference](https://docs.hiro.so/ordinals/) for more

information.



# Quick Start



## System Requirements



The Ordinals API has hard dependencies on other systems.

Before you start, you'll need to have access to:



1. An [Ordhook node](https://github.com/hirosystems/ordhook) with a fully

   indexed Ordinals database.

1. A local writeable Postgres database for data storage.

   * We recommended a 1TB volume size here.



## Running the API



1. Clone the repo.



1. Create an `.env` file and specify the appropriate values to configure the local

API server, postgres DB and Ordhook node reachability.



1. Build the app (NodeJS v18+ is required)

    ```

    npm install

    npm run build

    ```



1. Start the service

    ```

    npm run start

    ```



### Run Modes



To better support auto-scaling server configurations, this service supports

three run modes specified by the `RUN_MODE` environment variable:



* `default`: Runs all background jobs and the API server. Use this when you're

  running this service only on one instance. This is the default mode.

* `readonly`: Runs only the API server. Use this in an auto-scaled cluster when

  you have multiple `readonly` instances and just one `writeonly` instance. This

  mode needs a `writeonly` instance to continue populating the DB.

* `writeonly`: Use one of these in an auto-scaled environment so you can

  continue consuming new inscriptions. Use in conjunction with multiple

  `readonly` instances as explained above.



### Stopping the API



When shutting down, you should always prefer to send the `SIGINT` signal instead

of `SIGKILL` so the service has time to finish any pending background work and

all dependencies are gracefully disconnected.



# 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

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.