Class APIProvider

constructor

• new APIProvider(network): APIProvider

• Parameters

  • network: NetworkType

  Returns APIProvider

network

balance

• balance(address): Promise<bigint>

• Parameters

  • address: string

  Returns Promise<bigint>

callContract

• callContract(contract, method, data, abi): Promise<undefined | Result>

• Perform calltocontract

  Parameters

  • contract: string

    The contract address
  • method: string

    The contract method to call
  • data: any[]

    The arguments
  • abi: any[]

    The contract abi

  Returns Promise<undefined | Result>

  see Result

getEventLogs

• getEventLogs(contract): Promise<APIEventLogs>

• Get receipts from a transaction

  Parameters

  • contract: string

    transaction object

  Returns Promise<APIEventLogs>

  an APIEventLogs object

getTxReceipts

• getTxReceipts(tx, abi, contract?): Promise<TransactionReceipt[]>

• Get receipts from a transaction

  Parameters

  • tx: {
        hash160: string;
        sender: string;
        txid: string;
    }

    transaction object

    • hash160: string

    • sender: string

    • txid: string

  • abi: any[]

    The abi for the contract that was called
  • Optionalcontract: string

    the contract address, if there is one

  Returns Promise<TransactionReceipt[]>

  an array of TransactionReceipt objects

searchEventLogs

• searchEventLogs(contract, topics?, fromBlock?, toBlock?): Promise<APIEventLogs>

• Search events from a contract

  Parameters

  • contract: string

    transaction object
  • Optionaltopics: string[]

    the topics to filter by
  • fromBlock: undefined | number = 0

    the starting block height to filter by defaults to 0
  • toBlock: undefined | number = -1

    the end block height to filter by, defaults to -1 for most recent block

  Returns Promise<APIEventLogs>

  an EventLogs object

sendToContract

• sendToContract(contract, method, data, value, gasLimit, gasPrice, abi): Promise<any>

• Perform sendtocontract

  Parameters

  • contract: string

    The contract address
  • method: string

    The contract method to send to
  • data: any[]

    The arguments to use
  • value: string

    The amount to send to the contract
  • gasLimit: number

    The amount of gas units allowed
  • gasPrice: number

    The satoshi price per gas
  • abi: any[]

    The contract abi

  Returns Promise<any>

  see Result