search

diadata-org / diadata

DIAdata.org platform
https://diadata.org
Other
230 stars 128 forks source link

Rewrite instructions for writing an exchange scraper #537

Closed jppade closed 2 years ago

jppade commented 2 years ago

Update the instructions for writing an exchange scraper in the DIA Documentation: https://docs.diadata.org/documentation/tutorials/exchangescrapers By reading the instructions a contributor not familiar with our codebase should be able to:

  1. Write an exchange scraper adhering to the existing scraper structure
  2. Test the scraper by running it locally

Ideally you add a test environment through a docker-compose file.

gitcoinbot commented 2 years ago

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

This issue now has a funding of 200.0 USDC (200.0 USD @ $1.0/USDC) attached to it as part of the diadata-org fund.

gitcoinbot commented 2 years ago

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

Work has been started.

These users each claimed they can complete the work by 1 month, 1 week ago. Please review their action plans below:

1) theperfectpunk has applied to start work _(Funders only: approve worker | reject worker)_.

I have experience working with scrapers. I can get this done quickly. 2) fix-bot has applied to start work _(Funders only: approve worker | reject worker)_.

Strong scraping experience with wide range of techniques, including browser aided-programming 3) janus has applied to start work _(Funders only: approve worker | reject worker)_.

I have worked before for this client. I have done a few scraping already for the client. I knew vividly what is need to get started. 4) dezmerritt75 has applied to start work _(Funders only: approve worker | reject worker)_.

I will rewrite and correct any and all mistakes. 5) hhio618 has been approved to start work.

I already did this here: https://github.com/diadata-org/diadata/pull/536

Learn more on the Gitcoin Issue Details page.

Dezmerritt75 commented 2 years ago

type APIScraper interface { io.Closer // ScrapePair returns a PairScraper that continuously scrapes trades for a // single pair from this APIScraper ScrapePair(pair dia.Pair) (PairScraper, error) // FetchAvailablePairs returns a list with all available trade pairs (usually // fetched from an exchange's API) FetchAvailablePairs() (pairs []dia.Pair, err error) // Channel returns a channel that can be used to receive trades Channel() chan dia.Trade }type APIScraper interface { io.Closer // ScrapePair returns a PairScraper that continuously scrapes trades for a // single pair from this APIScraper ScrapePair(pair dia.Pair) (PairScraper, error) // FetchAvailablePairs returns a list with all available trade pairs (usually // fetched from an exchange's API) FetchAvailablePairs() (pairs []dia.Pair, err error) // Channel returns a channel that can be used to receive trades Channel() chan dia.Trade }go run collector.go -exchange MySource

gitcoinbot commented 2 years ago

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

Work for 200.0 USDC (200.0 USD @ $1.0/USDC) has been submitted by:

  1. @hhio618

@jppade please take a look at the submitted work:

gitcoinbot commented 2 years ago

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

The funding of 200.0 USDC (200.0 USD @ $1.0/USDC) attached to this issue has been approved & issued to @hhio618.

gitcoinbot commented 2 years ago

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

The funding of 200.0 USDC (200.0 USD @ $1.0/USDC) attached to this issue has been approved & issued to @hhio618.