Skip to content

Latest commit

 

History

History
79 lines (54 loc) · 4.82 KB

README.md

File metadata and controls

79 lines (54 loc) · 4.82 KB
Raw

POR_INDEXER

2.1.13 v3

This document was generated automatically. Please see README Generator for more info.

Known Issues

Dependencies

The por-indexer external adapter is strongly dependent on a synced bitcoin-por-indexer service and will not be functional without it.

Follow this deployment documentation to set up a bitcoin-por-indexer service. Note that sync time may take weeks in certain cases.

MAX_PAYLOAD_SIZE_LIMIT configuration

The MAX_PAYLOAD_SIZE_LIMIT environment variable is used for controlling the maximum size of the incoming request body that the EA can handle. If you decide to customize this value it's essential to ensure that any reverse proxy or web server in front of the EA, such as Nginx, is also configured with a corresponding limit. This alignment prevents scenarios where Nginx rejects a request for exceeding its payload size limit before it reaches the EA.

Environment Variables

Required? Name Description Type Options Default
BITCOIN_MAINNET_POR_INDEXER_URL Indexer URL for Bitcoin mainnet string ``
BITCOIN_TESTNET_POR_INDEXER_URL Indexer URL for Bitcoin testnet string ``
DOGECOIN_MAINNET_POR_INDEXER_URL Indexer URL for Dogecoin mainnet string ``
DOGECOIN_TESTNET_POR_INDEXER_URL Indexer URL for Dogecoin testnet string ``
BACKGROUND_EXECUTE_MS The amount of time the background execute should sleep before performing the next request number 10000

Data Provider Rate Limits

There are no rate limits for this adapter.

Input Parameters

Required? Name Description Type Options Default
endpoint The endpoint to use string balance, index balance

Balance Endpoint

Supported names for this endpoint are: balance, index.

Input Params

Required? Name Aliases Description Type Options Default Depends On Not Valid With
✅ addresses result An array of addresses to get the balances of (as an object with string address as an attribute) object[]
✅ addresses.address an address to get the balance of string
✅ addresses.network The name of the target network protocol string bitcoin, dogecoin
✅ addresses.chainId The name of the target chain string mainnet, testnet
minConfirmations Number of blocks that must have been confirmed after the point against which the balance is checked. number

Example

Request:

{
  "data": {
    "endpoint": "balance",
    "addresses": [
      {
        "address": "bc1qlh50jpjrrlcuy6sslrucksjg22h6e0d65ken6sc54exfkrln932snwg523",
        "chainId": "mainnet",
        "network": "bitcoin"
      }
    ],
    "minConfirmations": 0
  }
}

MIT License