Skip to content

RabbitMQ

rindexer allows you to configure RabbitMQ to stream any data to. This goes under the contracts section of the YAML configuration file.

Find out more about RabbitMQ.

rindexer rabbitmq integration supports direct, topic and fanout exchanges. You can read more about what they do differently here.

Configuration with rindexer

rabbitmq property accepts an array of exchanges allowing you to split up the streams any way you wish.

Example

direct
name: RocketPoolETHIndexer
description: My first rindexer project
repository: https://github.com/joshstevens19/rindexer
project_type: no-code
networks:
- name: ethereum
  chain_id: 1
  rpc: https://mainnet.gateway.tenderly.co
contracts:
- name: RocketPoolETH
  details:
  - network: ethereum
    address: "0xae78736cd615f374d3085123a210448e74fc6393"
    start_block: "18600000"
    end_block: "18600181"
  abi: "./abis/RocketTokenRETH.abi.json"
  include_events:
  - Transfer
  streams: 
    rabbitmq: 
      # we advise to put this in a environment variables
      url: ${RABBITMQ_URL}
      exchanges: 
        - exchange: transfer
          #  expected one of `direct`, `topic` or `fanout`
          exchange_type: direct
          routing_key: my-routing-key
          networks: 
            - ethereum
          events: 
            - event_name: Transfer

Response

The response sent to you is already decoded and parsed into a JSON object.

  • event_name - The name of the event
  • event_data - The event data which has all the event fields decoded and the transaction information which is under transaction_information
  • network - The network the event was emitted on

For example a transfer event would look like:

{
    "event_name": "Transfer",
    "event_data": {
        "from": "0x0338ce5020c447f7e668dc2ef778025ce3982662",
        "to": "0x0338ce5020c447f7e668dc2ef778025ce3982662",
        "value": "1000000000000000000",
        "transaction_information": {
            "address": "0xae78736cd615f374d3085123a210448e74fc6393",
            "block_hash": "0x8461da7a1d4b47190a01fa6eae219be40aacffab0dd64af7259b2d404572c3d9",
            "block_number": "18718011",
            "log_index": "0",
            "network": "ethereum",
            "transaction_hash": "0x145c6705ffbf461e85d08b4a7f5850d6b52a7364d93a057722ca1194034f3ba4",
            "transaction_index": "0"
        }
    },
    "network": "ethereum"
}

url

This is the rabbitmq connection url we advise to put this in a environment variable.

rindexer.yaml
...
contracts:
- name: RocketPoolETH
  details:
  - network: ethereum
    address: "0xae78736cd615f374d3085123a210448e74fc6393"
    start_block: "18600000"
    end_block: "18600181"
  abi: "./abis/RocketTokenRETH.abi.json"
  include_events:
  - Transfer
  streams: 
    rabbitmq: 
      # we advise to put this in a environment variables
      url: ${RABBITMQ_URL}

exchanges

This is an array of exchanges you want to stream to this rabbitmq.

exchange

This is the exchange name.

standard
...
contracts:
- name: RocketPoolETH
  details:
  - network: ethereum
    address: "0xae78736cd615f374d3085123a210448e74fc6393"
    start_block: "18600000"
    end_block: "18600181"
  abi: "./abis/RocketTokenRETH.abi.json"
  include_events:
  - Transfer
  streams: 
    rabbitmq: 
      # we advise to put this in a environment variables
      url: ${RABBITMQ_URL}
      exchanges: 
          - exchange: transfer

exchange_type

This is the exchange type, you can read more about them here. rindexer supports direct, topic and fanout exchanges.

rindexer.yaml
...
contracts:
- name: RocketPoolETH
  details:
  - network: ethereum
    address: "0xae78736cd615f374d3085123a210448e74fc6393"
    start_block: "18600000"
    end_block: "18600181"
  abi: "./abis/RocketTokenRETH.abi.json"
  include_events:
  - Transfer
  streams: 
    rabbitmq: 
      # we advise to put this in a environment variables
      url: ${RABBITMQ_URL}
      exchanges: 
        - exchange: transfer
          #  expected one of `direct`, `topic` or `fanout`
          exchange_type: direct

routing_key

This is the routing key for the exchange. You do not need to provide this if you are using a fanout exchange. This is mandatory for direct and topic exchanges.

fifo
...
contracts:
- name: RocketPoolETH
  details:
  - network: ethereum
    address: "0xae78736cd615f374d3085123a210448e74fc6393"
    start_block: "18600000"
    end_block: "18600181"
  abi: "./abis/RocketTokenRETH.abi.json"
  include_events:
  - Transfer
  streams: 
    rabbitmq: 
      # we advise to put this in a environment variables
      url: ${RABBITMQ_URL}
      exchanges: 
        - exchange: transfer
          #  expected one of `direct`, `topic` or `fanout`
          exchange_type: direct
          routing_key: my-routing-key

networks

This is an array of networks you want to stream to this rabbitmq.

rindexer.yaml
...
contracts:
- name: RocketPoolETH
  details:
  - network: ethereum
    address: "0xae78736cd615f374d3085123a210448e74fc6393"
    start_block: "18600000"
    end_block: "18600181"
  abi: "./abis/RocketTokenRETH.abi.json"
  include_events:
  - Transfer
  streams: 
    rabbitmq: 
      # we advise to put this in a environment variables
      url: ${RABBITMQ_URL}
      exchanges: 
        - exchange: transfer
          #  expected one of `direct`, `topic` or `fanout`
          exchange_type: direct
          routing_key: my-routing-key
          networks: 
            - ethereum

events

This is an array of events you want to stream to this rabbitmq.

event_name

This is the name of the event you want to stream to this rabbitmq, must match the ABI event name.

rindexer.yaml
...
contracts:
- name: RocketPoolETH
  details:
  - network: ethereum
    address: "0xae78736cd615f374d3085123a210448e74fc6393"
    start_block: "18600000"
    end_block: "18600181"
  abi: "./abis/RocketTokenRETH.abi.json"
  include_events:
  - Transfer
  streams: 
    rabbitmq: 
      # we advise to put this in a environment variables
      url: ${RABBITMQ_URL}
      exchanges: 
        - exchange: transfer
          #  expected one of `direct`, `topic` or `fanout`
          exchange_type: direct
          routing_key: my-routing-key
          networks:
            - ethereum
          events: 
            - event_name: Transfer

conditions

This accepts an array of conditions you want to apply to the event data before streaming to this rabbitmq.

You may want to filter on the stream based on the event data, if the event data has not got an index on the on the solidity event you can not filter it over the logs. The conditions filter is here to help you with this, based on your ABI you can filter on the event data.

rindexer has enabled a special syntax which allows you to define on your ABI fields what you want to filter on.

  1. > - higher then (for numbers only)
  2. < - lower then (for numbers only)
  3. = - equals
  4. >= - higher then or equals (for numbers only)
  5. <= - lower then or equals (for numbers only)
  6. || - or
  7. && - and

So lets look at an example lets say i only want to get transfer events which are higher then 2000000000000000000 RETH wei

rindexer.yaml
...
contracts:
- name: RocketPoolETH
  details:
  - network: ethereum
    address: "0xae78736cd615f374d3085123a210448e74fc6393"
    start_block: "18600000"
    end_block: "18600181"
  abi: "./abis/RocketTokenRETH.abi.json"
  include_events:
  - Transfer
  streams: 
    rabbitmq: 
      # we advise to put this in a environment variables
      url: ${RABBITMQ_URL}
      exchanges: 
        - exchange: transfer
          #  expected one of `direct`, `topic` or `fanout`
          exchange_type: direct
          routing_key: my-routing-key
          networks:
            - ethereum
          events: 
            - event_name: Transfer
              conditions: 
                - "value": ">=2000000000000000000"

We use the ABI input name value to filter on the value field, you can find these names in the ABI file.

{
    "anonymous":false,
    "inputs":[
      {
        "indexed":true,
        "internalType":"address",
        "name":"from",
        "type":"address"
      },
      {
        "indexed":true,
        "internalType":"address",
        "name":"to",
        "type":"address"
      },
      {
        "indexed":false,
        "internalType":"uint256",
        "name":"value", 
        "type":"uint256"
      }
    ],
    "name":"Transfer",
    "type":"event"
}

You can use the || or && to combine conditions.

rindexer.yaml
...
contracts:
- name: RocketPoolETH
  details:
  - network: ethereum
    address: "0xae78736cd615f374d3085123a210448e74fc6393"
    start_block: "18600000"
    end_block: "18600181"
  abi: "./abis/RocketTokenRETH.abi.json"
  include_events:
  - Transfer
  streams: 
    rabbitmq: 
      # we advise to put this in a environment variables
      url: ${RABBITMQ_URL}
      exchanges: 
        - exchange: transfer
          #  expected one of `direct`, `topic` or `fanout`
          exchange_type: direct
          routing_key: my-routing-key
          networks:
            - ethereum
          events: 
            - event_name: Transfer
              conditions: 
                - "value": ">=2000000000000000000 && value <=4000000000000000000"

You can use the = to filter on other aspects like the from or to address.

rindexer.yaml
...
contracts:
- name: RocketPoolETH
  details:
  - network: ethereum
    address: "0xae78736cd615f374d3085123a210448e74fc6393"
    start_block: "18600000"
    end_block: "18600181"
  abi: "./abis/RocketTokenRETH.abi.json"
  include_events:
  - Transfer
  streams: 
    rabbitmq: 
      # we advise to put this in a environment variables
      url: ${RABBITMQ_URL}
      exchanges: 
        - exchange: transfer
          #  expected one of `direct`, `topic` or `fanout`
          exchange_type: direct
          routing_key: my-routing-key
          networks:
            - ethereum
          events: 
            - event_name: Transfer
              conditions: 
                - "from": "0x0338ce5020c447f7e668dc2ef778025ce3982662 || 0x0338ce5020c447f7e668dc2ef778025ce398266u"
                - "value": ">=2000000000000000000 || value <=4000000000000000000"

If you have a tuple and you want to get that value you just use the object notation.

For example lets say we want to only get the events for profileId from the quoteParams tuple which equals 1:

{
     "anonymous": false,
     "inputs": [
       {
         "components": [
           {
             "internalType": "uint256",
             "name": "profileId", 
             "type": "uint256"
           },
           ...
         ],
         "indexed": false,
         "internalType": "struct Types.QuoteParams",
         "name": "quoteParams", 
         "type": "tuple"
       },
       ...
     ],
     "name": "QuoteCreated", 
     "type": "event"
}
rindexer.yaml
...
contracts:
- name: RocketPoolETH
  details:
  - network: ethereum
    address: "0xae78736cd615f374d3085123a210448e74fc6393"
    start_block: "18600000"
    end_block: "18600181"
  abi: "./abis/RocketTokenRETH.abi.json"
  include_events:
  - Transfer
  streams: 
    rabbitmq: 
      # we advise to put this in a environment variables
      url: ${RABBITMQ_URL}
      exchanges: 
        - exchange: transfer
          #  expected one of `direct`, `topic` or `fanout`
          exchange_type: direct
          routing_key: my-routing-key
          networks:
            - ethereum
          events: 
            - event_name: Transfer
              conditions: 
                - "quoteParams.profileId": "=1"