Skip to content

Latest commit

 

History

History
98 lines (89 loc) · 4.33 KB

ROADMAP.md

File metadata and controls

98 lines (89 loc) · 4.33 KB
Raw

Roadmap

First release

  • v1.0.1-alpha

    • Logging with log levels
    • Improved stdout output
    • Timestamps for setting start, end and interval options
    • Review concurrency model - The problem with the current concurrency model is that when the max number of workers is reached, it waits until all goroutines in that batch finish before starting another batch. This is not what we want, since some goroutines can take disproportionate amounts of time and thus block the program from collecting more data. - Fixed with "go.uber.org/ratelimit" package. We can now define a max number of requests per second.
    • Working DB output
    • Ability to call methods when logs occur, and not just at a random interval. This would make it easier for some use cases. The DSL syntax will be defining a method block inside of an event block. NOTE: method calls are at the block level (happen at the end of a block, while events are on the transaction level)
    • Filter lists
      • Example: when one of these evaluates to false, don't proceed to transform or save. This should also be a top-level block. It's like an SQL WHERE clause.
        filter = [
      _reserve0 != 0,
      _reserve1 != 0
  ]
    • Standalone events (not emitted from a certain contract) - Example: if we want every ERC20 transfer, we don't want to define the event in a contract block but as a top-level block.
    • transform blocks, which are contract level blocks to define and transform variables to be used later in the top-level save blocks
    • save block should be a top-level block so that we can do cross-contract operations
      • This only works for results that happen at the same time, i.e. method calls
    • Variables
    • Schema validation
    • Add loops 
        loop {
    items = ["arbitrum", "ethereum", "polygon"]

    query loop_query {
      chain = item

      ...
    }
  }
    • Custom helper functions
      • balance()
      • token_balance()
    • Add more context variables: tx_index, block_hash
    • Major update of Documentation
      • Standalone domain
      • Advanced features
        • custom functions
      • More schema examples
    • Refactor + error handling and reliability

  • v1.1.0-alpha

    • Subcommand for getting ABIs from etherscan and the like

    • Custom function definitions (like #DEFINE) that can be used elsewhere. Could be useful for defining a custom on-chain price method for example. It would be executed at the block it gets called at.

    • CLI options for

      • log parts
      • schema path
      • output path

    • Updated BlockByTimestamp algo

    • Updated SmartFilterLogs algo

    • Transaction monitoring

      • You would be able to filter historical transactions based on certain predicates: value thresholds, sender and receiver addresses, gas prices and amounts, or certain method calls or inputs.

    • Mempool monitoring

      • You would be able to monitor mempool transactions and save them based on a predicate. Same as above.

    • Different stream output option for latency-sensitive operations (like mempool monitoring): i.e. Websocket, SSE

      • Latency sensitive operations would probably also need different evaluation options. I think evaluating everything in the save block might take some time, would need to benchmark that. An option is to just not have a save block and stream everything as-is, let the application take care of decoding.

    • JSON output

    • Events: full transaction context (tx_sender, tx_receiver)

    • Algorithm for determining event range (start big, if we get error, read range and modify)

    • Generalized SQL output (MySQL, SQL Server)

    • Aggregation operations like group by, sum, avg

    • Unverified methods and events

    • Cross-chain address monitoring

    • More custom functions:

      • is_contract(addr)

    • Custom templates:

      • uniswapv2
      • uniswapv3
      • compound
      • aave
      • makerdao

    • Refactor

Later

  • v1.2.0-beta
    • Transaction simulation at certain times / events
    • Python library
    • JavaScript / TypeScript library

Notes