Naphthalene Possum Management

    web3-parse-receipt-events

    1.0.2 • Public • Published

    web3-parse-receipt-events

    Build Status Code Style

    Parse Web3 receipt events from specific contracts.

    When using web3.eth.sendTransaction or when calling a contract method with contract.methods.someFunction().send(), not all the evnents are parsed in the returned receipt. In the first case, none are and in the second, only the events from the called contract are parsed. So when other events from i.e. contracts called internally by someFunction(), those have to be parsed manually.

    This library helps doing so by taking the original receipt and the contract ABI, address whose events are to be parsed.

    Note: The provided receipt is mutated but keeping full compatibility with the Web3 receipt format as defined in Contract#_executeMethod and Contract#_decodeEventABI functions.

    Installation

    npm install web3-parse-receipt-events

    Usage

    const package = require('web3-parse-receipt-events')
    const Web3 = require('web3')
    
    const web3 = new Web3()
    web3.eth.getTransactionReceipt(hash)
      .then(receipt => parseReceiptEvents(contractAbi, contractAddress, receipt))
      .then(console.log)
    // Will print a receipt and events from the specfied contract properly parsed.

    API

    parseReceiptEvents(abi, address, receipt) ⇒ TransactionReceipt

    Parse receipt events of the given contract.

    Web3 only parses the events of the contract that is returning the receipt. If there are additional events logged by other contracts that were called during the execution of the transaction, those will not be parsed automatically. For those cases, additional parsing effort is required.

    Returns: TransactionReceipt - The patched receipt.

    Param Type Description
    abi Array.<AbiItem> The ABI of the contract.
    address string The address of the contract.
    receipt TransactionReceipt The receipt to parse.

    License

    MIT

    Install

    npm i web3-parse-receipt-events

    DownloadsWeekly Downloads

    133

    Version

    1.0.2

    License

    MIT

    Unpacked Size

    8.19 kB

    Total Files

    5

    Last publish

    Collaborators

    • gabmontes