README.md

DeversiFi Trustless Data

Constantly wait for new blocks and sync Fill events.

Currently saves data into 3 collections

• Blocks
• Transactions
• Events ( currently 'Fill' events)

Data Structures are documented on the models folder

Example endpoints

• /api/v1/block/8232895

  • Return information for block #8232895

• /api/v1/transaction/0x6a502fab01e83e41b1f0dba0448800ccee7e8a379823b938ecf6e12e5491a110

  • Return information for transaction hash: 0x6a502fab01e83e41b1f0dba0448800ccee7e8a379823b938ecf6e12e5491a110

• /api/v1/event/0x6a502fab01e83e41b1f0dba0448800ccee7e8a379823b938ecf6e12e5491a110-45

  • Return information for event id: 0x6a502fab01e83e41b1f0dba0448800ccee7e8a379823b938ecf6e12e5491a110-45

• /api/v1/events/maker/0xf63246f4df508eba748df25daa8bd96816a668ba

  • Return all events where maker address is 0xf63246f4df508eba748df25daa8bd96816a668ba

• /api/v1/events/maker/0xf63246f4df508eba748df25daa8bd96816a668ba?startDate=1565097982081&endDate=1565184391511

  • Return all events where maker address is 0xf63246f4df508eba748df25daa8bd96816a668ba
  • Providing startDate unix timestamp in millieconds ) for Tue Aug 06 2019 14:26:18 GMT+0100
  • Providing endDate unix timestamp in millieconds ) for Wed Aug 07 2019 14:26:28 GMT+0100

• /api/v1/events/taker/0x61b9898c9b60a159fc91ae8026563cd226b7a0c1

  • Return all events where taker address is 0x61b9898c9b60a159fc91ae8026563cd226b7a0c1

• /api/v1/events/taker/0x61b9898c9b60a159fc91ae8026563cd226b7a0c1?startDate=1565097982081&endDate=1565184391511

  • Return all events where taker address is 0x61b9898c9b60a159fc91ae8026563cd226b7a0c1
  • Providing startDate unix timestamp in millieconds ) for Tue Aug 06 2019 14:26:18 GMT+0100
  • Providing endDate unix timestamp in millieconds ) for Wed Aug 07 2019 14:26:28 GMT+0100

• /api/v1/tokenRanking/ETH

  • Return all time volume ranking quoted in ETH

• /api/v1/tokenRanking/ETH?startDate=1565097982081&endDate=1565184391511

  • Return volume ranking quoted in ETH
  • Providing startDate unix timestamp in millieconds ) for Tue Aug 06 2019 14:26:18 GMT+0100
  • Providing endDate unix timestamp in millieconds ) for Wed Aug 07 2019 14:26:28 GMT+0100

• /api/v1/USDRanking

  • Return all time volume ranking ( for all tokens together ) quoted in USD

• /api/v1/USDRanking?startDate=1565097982081&endDate=1565184391511

  • Return volume ranking ( for all tokens together ) quoted in USD
  • Providing startDate unix timestamp in millieconds ) for Tue Aug 06 2019 14:26:18 GMT+0100
  • Providing endDate unix timestamp in millieconds ) for Wed Aug 07 2019 14:26:28 GMT+0100

• /api/v1/24HoursVolume/2019/08/01

  • Return last 24 hours volume for 01/08/2019
  • Cached for 24 hours

• /api/v1/last24HoursVolume

  • Return last 24 hours volume for all tokens
  • Return last 24 hours USD Worth ( counting both sides of each trade)
  • Cached for 1 minute

• /api/v1/30DaysVolume/0xf63246f4df508eba748df25daa8bd96816a668ba

  • Return last 30 days volume for 0xf63246f4df508eba748df25daa8bd96816a668ba
  • Cached for 60 minutes

Example reports

• TODO - Improve caching logic for all endpoints, perhaps even save some data such as

  • 24 hours volume for past days permanetly

• TODO - Write better tests for all endpoins

• TODO - Custom error page

Developing

1. npm run develop

Note: you should update .env file with your own INFURA web3 provider address

Testing

1. npm run test:watch

Once you update tests you must delete ./tests/fixtures and run tests again.

Once the tests are ran once the HTTP requests will be cached and the tests will run offline using the recorded HTTP responses found on ./tests/fixtures

You can also deploy your own version to heroku