NodeChain EN
  • NodeChain
  • Learn
    • About NodeChain
    • Infrastructure
      • Connector
        • Wrapper APIs
      • Nodes
      • Startup script
    • License
    • Ecosystem
      • Supported APIs
      • Integrations
      • Acknowledgments
  • Develop
    • Quick start
      • Initial setup
      • Using command-line script
        • Commands
    • How-to
      • Run tests locally
      • Lint automatically with hooks
      • Integrate a new Blockchain/API
      • Connect to a public node
    • Wrapper API definition file
    • Contributing
  • Reference
    • API Reference
      • Admin
      • General Endpoints
      • REST Wrapper API
        • Bitcoin Cash
        • Bitcoin
        • Ethereum
          • ERC-20
      • JSON-RPC Wrapper API
        • Bitcoin Cash
        • Bitcoin
        • Ethereum
          • ERC-20
      • Real-Time Wrapper API
        • Bitcoin
        • Ethereum
Powered by GitBook
On this page
  1. Develop

Wrapper API definition file

Inside the connector's folder, there is a file called availableCurrencies.json. This file contains the definition of each one of the Wrapper APIs.

The availableCurrencies.json file defines all the information necessary to raise the API corresponding to a currency.

Looks like this:

[
  {
    "name": "bitcoin",
    "token": "btc",
    "networks": {
      "regtest": {
        "services": ["bitcoincore", "electrs", "electrum"],
        "dockerComposePath": "docker-compose/regtest/btc.yml",
        "configurable": [
          "bitcoincoreRpcEndpoint",
          "electrumRpcEndpoint",
          "bitcoincoreZmqEndpoint",
          "bitcoinAddressCallbackHost",
          "electrsEndpoint"
        ]
      },
      "testnet": {
        "services": ["bitcoincore", "electrs", "electrum"],
        "dockerComposePath": "docker-compose/testnet/btc.yml",
        "configurable": [
          "bitcoincoreRpcEndpoint",
          "electrumRpcEndpoint",
          "bitcoincoreZmqEndpoint",
          "bitcoinAddressCallbackHost",
          "electrsEndpoint"
        ]
      },
      "mainnet": {
        "services": ["bitcoincore", "electrs", "electrum"],
        "dockerComposePath": "docker-compose/mainnet/btc.yml",
        "configurable": [
          "bitcoincoreRpcEndpoint",
          "electrumRpcEndpoint",
          "bitcoincoreZmqEndpoint",
          "bitcoinAddressCallbackHost",
          "electrsEndpoint"
        ]
      }
    }
  },
  ... MORE WRAPPER API DEFINITIONS HERE ...
]

This file needs to be modified in case you want to integrate a new Wrapper API in NodeChain.

PreviousConnect to a public nodeNextContributing

Last updated 3 years ago