Source: block_explorer.js

  1. /**
  2.  * This module provides functions for creating URLs for Blockstream's
  3.  * [block explorer]{@link https://blockstream.info}.
  4.  *
  5.  * This module does NOT provide implementations of HTTP requests which
  6.  * fetch data from these URLs.
  7.  * 
  8.  * @module block_explorer
  9.  */
  11. import {TESTNET} from "./networks";
  13. const BASE_URL_MAINNET = 'https://blockstream.info';
  14. const BASE_URL_TESTNET = 'https://blockstream.info/testnet';
  16. function blockExplorerBaseURL(network) {
  17.   return (network === TESTNET ? BASE_URL_TESTNET : BASE_URL_MAINNET);
  18. }
  20. /**
  21.  * Returns the block explorer URL for the given path and network.
  22.  * 
  23.  * @param {string} path - the explorer path
  24.  * @param {module:networks.NETWORKS} network - bitcoin network
  25.  * @returns {string} the block explorer url
  26.  * @example
  27.  * import {MAINNET, TESTNET, blockExplorerURL} from "unchained-bitcoin";
  28.  * const path = "/block/00000000000000000011341d69792271766e4683e29b3ea169eacc59bde10a57";
  29.  * console.log(blockExplorerURL(path, MAINNET)) // https://blockstream.info/block/00000000000000000011341d69792271766e4683e29b3ea169eacc59bde10a57
  30.  * console.log(blockExplorerURL(path, TESTNET)) // https://blockstream.info/block/testnet/00000000000000000011341d69792271766e4683e29b3ea169eacc59bde10a57
  31.  */
  32. export function blockExplorerURL(path, network) {
  33.   return `${blockExplorerBaseURL(network)}${path}`;
  34. }
  36. /**
  37.  * Returns the block explorer API URL for the given path and network.
  38.  * 
  39.  * @param {string} path - the API path
  40.  * @param {module:networks.NETWORKS} network - bitcoin network
  41.  * @returns {string} the full block explorer url
  42.  * @example
  43.  * import {MAINNET, TESTNET, blockExplorerAPIURL} from "unchained-bitcoin";
  44.  * const path = "/tx/1814a10fb22e9551a17a94a1e68971e19b4f59eaf1689e0af85b97929b3b9ae0";
  45.  * console.log(blockExplorerAPIURL(path, MAINNET)); // https://blockstream.info/api/tx/1814a10fb22e9551a17a94a1e68971e19b4f59eaf1689e0af85b97929b3b9ae0
  46.  * console.log(blockExplorerAPIURL(path, TESTNET)); // https://blockstream.info/testnet/api/tx/1814a10fb22e9551a17a94a1e68971e19b4f59eaf1689e0af85b97929b3b9ae0
  47.  */
  48. export function blockExplorerAPIURL(path, network) {
  49.   return `${blockExplorerBaseURL(network)}/api${path}`;
  50. }
  52. /**
  53.  * Return the block explorer URL for the given transaction ID and network.
  54.  * 
  55.  * @param {string} txid - the transaction id
  56.  * @param {module:networks.NETWORKS} network - bitcoin network
  57.  * @returns {string} the full transaction URL
  58.  * @example
  59.  * import {MAINNET, TESTNET, blockExplorerTransactionURL} from "unchained-bitcoin";
  60.  * const txid = "1814a10fb22e9551a17a94a1e68971e19b4f59eaf1689e0af85b97929b3b9ae0";
  61.  * console.log(blockExplorerTransactionURL(txid, MAINNET)); // https://blockstream.info/tx/1814a10fb22e9551a17a94a1e68971e19b4f59eaf1689e0af85b97929b3b9ae0
  62.  * console.log(blockExplorerTransactionURL(txid, TESTNET)); // https://blockstream.info/testnet/tx/1814a10fb22e9551a17a94a1e68971e19b4f59eaf1689e0af85b97929b3b9ae0
  63.  */
  64. export function blockExplorerTransactionURL(txid, network) {
  65.   return blockExplorerURL(`/tx/${txid}`, network);
  66. }
  68. /**
  69.  * Return the block explorer URL for the given address and network.
  70.  * 
  71.  * @param {string} address - the address
  72.  * @param {module:networks.NETWORKS} network - bitcoin network
  73.  * @returns {string} full URL for address lookup
  74.  * @example
  75.  * import {MAINNET, TESTNET, blockExplorerAddressURL} from "unchained-bitcoin";
  76.  * const address = "39YqNoLULDpbjmeCTdGJ42DQhrQLzRcMdX";
  77.  * console.log(blockExplorerAddressURL(address, MAINNET)); // https://blockstream.info/address/39YqNoLULDpbjmeCTdGJ42DQhrQLzRcMdX
  78.  * console.log(blockExplorerAddressURL(address, TESTNET)); // https://blockstream.info/testnet/address/39YqNoLULDpbjmeCTdGJ42DQhrQLzRcMdX
  79.  */
  80. export function blockExplorerAddressURL(address, network) {
  81.   return blockExplorerURL(`/address/${address}`, network);
  82. }