@qryio/eosio-ship-scanner

EOSIO SHiP Scanner

eosio-ship-scanner is a TypeScript/JavaScript component that helps receiving and parsing decoded actions and rows sent by the EOSIO State History Plugin (SHiP)

Runtime Requirements

The following is required to run it:

• An EOSIO node configured to run with:
  • State History Plugin (SHiP)
  • Chain API Plugin
  • Http Plugin
• A redis database

Usage

The basic usage is:

import { SHiPEventEmitter } from '@qryio/eosio-ship-scanner'

const emitter = new SHiPEventEmitter({
    eosioHost: 'eosio-host',
    shipPort:  8080,
    rpcPort:   8888,
    batchSize: 10
}, {
    host: 'redis-host'
})

emitter.on('action', action => {
    // process action (block and trace)
})

emitter.on('row', row => {
    // process row in table delta
})

// blocks until it starts following head
await emitter.start()

License

Code and documentation released under Apache License 2.0