https://github.com/theoephraim/cosmos-scavenger-api

https://github.com/theoephraim/cosmos-scavenger-api

Last synced: 29 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/theoephraim/cosmos-scavenger-api
• Owner: theoephraim
• Created: 2020-02-16T20:13:37.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-12-06T16:13:29.000Z (almost 2 years ago)
• Last Synced: 2024-04-15T00:16:54.103Z (7 months ago)
• Language: JavaScript
• Size: 393 KB
• Stars: 4
• Watchers: 1
• Forks: 1
• Open Issues: 11
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Cosmos Scavenger Sidechain REST api

This is a rest api to expose the data of the [scavenger hunt sidechain](https://tutorials.cosmos.network/eth-denver/) from ETHDenver2020.

## Instructions

First you must set up the ebcli following the tutorial above and make sure its accessible on your machine's PATH.

The run the api:

- `npm install` to install dependencies

- `npm run dev` runs the api, watches files, lints and restarts on changes

It's exposed on http://localhost:4444

There are 4 endpoints

- `http://localhost:4444/scavenges` - lists all riddles

- `http://localhost:4444/scavenges/:id` - lists info about a specific riddle, with the id being the solution hash

- `http://localhost:4444/scavengers` - lists all scavengers, sorted by total rewards won

- `http://localhost:4444/scavengers/:id` - lists same info about a single scavenger

both list endpoints accept `limit` and `offset` params