bch-js/src/bch-js.js

/*
  This is the primary library file for bch-js. This file combines all the other
  libraries in order to create the BCHJS class.

  The primary server used has switched to fullstack.cash. Go there to sign up
  for an account that gives you increased rate limits.
*/

// bch-api mainnet.
// const DEFAULT_REST_API = "http://localhost:3000/v5/"

// Global npm libraries
import axios from 'axios'
import {
  createSigner,
  withPaymentInterceptor,
  createPaymentHeader,
  selectPaymentRequirements
} from 'x402-bch-axios'

// local deps
import BitcoinCash from './bitcoincash.js'
import Crypto from './crypto.js'
import Util from './util.js'
import Blockchain from './blockchain.js'
import Control from './control.js'
import Generating from './generating.js'
import Mining from './mining.js'
import RawTransactions from './raw-transactions.js'
import Mnemonic from './mnemonic.js'
import Address from './address.js'
import HDNode from './hdnode.js'
import TransactionBuilder from './transaction-builder.js'
import ECPair from './ecpair.js'
import Script from './script.js'
import Price from './price.js'
import Schnorr from './schnorr.js'
import SLP from './slp/slp.js'
import Encryption from './encryption.js'
import Utxo from './utxo.js'
import Transaction from './transaction.js'
import DSProof from './dsproof.js'
import Ecash from './ecash.js'

// Indexers
import Electrumx from './electrumx.js'
import PsfSlpIndexer from './psf-slp-indexer.js'

class BCHJS {
  constructor (config) {
    // Try to retrieve the REST API URL from different sources.
    if (config && config.restURL && config.restURL !== '') {
      this.restURL = config.restURL
    } else if (process.env.RESTURL && process.env.RESTURL !== '') {
      this.restURL = process.env.RESTURL
    } else {
      throw new Error(
        'REST API URL is required. Provide config.restURL or set the RESTURL environment variable.'
      )
    }

    // Normalize restURL to always have a trailing slash
    if (!this.restURL.endsWith('/')) {
      this.restURL = this.restURL + '/'
    }

    // Retrieve the Bearer token for simple token authentication.
    this.bearerToken = '' // default value.
    if (config && config.bearerToken && config.bearerToken !== '') {
      this.bearerToken = config.bearerToken
    } else if (process.env.BCHJSBEARERTOKEN && process.env.BCHJSBEARERTOKEN !== '') {
      this.bearerToken = process.env.BCHJSBEARERTOKEN
    }

    // Generate the authentication token for the authorization header.
    this.authToken = ''
    if (this.bearerToken) {
      this.authToken = `Bearer ${this.bearerToken}`
    }

    // x402 payment configuration
    // If a WIF private key is provided, enable x402 automatic payment handling
    this.wif = ''
    if (config && config.wif && config.wif !== '') {
      this.wif = config.wif
    } else if (process.env.BCHJSWIF && process.env.BCHJSWIF !== '') {
      this.wif = process.env.BCHJSWIF
    }

    // Most TXs cost about 250 sats. So we'll set the default to 25000 sats,
    // so the mining fee is 1% of the transaction.
    this.paymentAmountSats = (config && config.paymentAmountSats) || 25000

    // BCH server URL for x402 payments (separate from REST API server)
    // This is used when broadcasting payment transactions to the blockchain
    if (config && config.bchServerURL && config.bchServerURL !== '') {
      this.bchServerURL = config.bchServerURL
    } else if (process.env.BCHJSBCHSERVERURL && process.env.BCHJSBCHSERVERURL !== '') {
      this.bchServerURL = process.env.BCHJSBCHSERVERURL
    } else {
      this.bchServerURL = 'https://bch.fullstack.cash/v6'
    }

    const libConfig = {
      restURL: this.restURL,
      authToken: this.authToken
    }

    // If WIF is provided, create an axios instance with x402 payment interceptor
    // Otherwise, let sub-modules use their own axios import for backwards compatibility
    if (this.wif) {
      let axiosInstance = axios.create({
        baseURL: this.restURL,
        headers: {
          authorization: this.authToken
        }
      })

      const signer = createSigner(this.wif, this.paymentAmountSats)
      axiosInstance = withPaymentInterceptor(
        axiosInstance,
        signer,
        {
          apiType: 'rest-api',
          bchServerURL: this.bchServerURL
        }
      )

      libConfig.axios = axiosInstance
    }

    // ElectrumX indexer
    this.Electrumx = new Electrumx(libConfig)

    // Populate Full Node
    this.Control = new Control(libConfig)
    this.Mining = new Mining(libConfig)
    this.RawTransactions = new RawTransactions(libConfig)

    // Populate utility functions
    this.Address = new Address(libConfig)
    this.BitcoinCash = new BitcoinCash(this.Address)
    this.Blockchain = new Blockchain(libConfig)
    this.Crypto = Crypto
    this.ECPair = ECPair
    this.ECPair.setAddress(this.Address)
    this.encryption = new Encryption(libConfig)
    this.Generating = new Generating(libConfig)
    this.HDNode = new HDNode(this.Address)
    this.Mnemonic = new Mnemonic(this.Address)
    this.Price = new Price(libConfig)
    this.Script = new Script()
    this.TransactionBuilder = TransactionBuilder
    this.TransactionBuilder.setAddress(this.Address)
    this.Util = new Util(libConfig)
    this.Schnorr = new Schnorr(libConfig)

    this.SLP = new SLP(libConfig)
    this.SLP.HDNode = this.HDNode

    this.Utxo = new Utxo(libConfig)
    this.Transaction = new Transaction(libConfig)

    this.DSProof = new DSProof(libConfig)
    this.eCash = new Ecash()

    this.PsfSlpIndexer = new PsfSlpIndexer(libConfig)

    // Expose x402 helper functions for advanced use cases
    this.x402 = {
      createSigner,
      withPaymentInterceptor,
      createPaymentHeader,
      selectPaymentRequirements
    }
  }
}

export default BCHJS