search

ProofSuite / OrFeed

DeFi & Distributed Data Service Aggregator
https://www.orfeed.org
Apache License 2.0
241 stars 152 forks source link

OrFeed.arb method documentation #70

Closed mikedeshazer closed 4 years ago

mikedeshazer commented 4 years ago

We are crowdsourcing something that's everyone's favorite: documentation!

In addition to being a pricing oracle, OrFeed offers the .arb method for allowing users and smart contracts to perform triangular arbitrage between several tokens and decentralized exchanges in a single transaction.

Currently, there is also a simple UI that demonstrates the basic core feature: https://www.orfeed.org/angle (in addition to a video that explains how it works).

We are seeking documentation for the README (2-3 paragraphs) that introduces the .arb functionality, explains how it works, explains how to use a flash loan example code and then use the .arb function (https://www.youtube.com/watch?v=GnIFCoHxvLg).

We will later expound on new features, like the liquidity provider parameter to further limit the amount of code people have to right for that.

Someone might have answered a question you might have in Discord: https://discord.gg/byCPVsY

gitcoinbot commented 4 years ago

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

This issue now has a funding of 0.15 ETH (29.08 USD @ $193.85/ETH) attached to it as part of the ProofSuite fund.

gitcoinbot commented 4 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 2 weeks from now. Please review their action plans below:

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

Hello. I have extensive documentation experience, including writing the official Vyper compiler exception troubleshooting documentation. I will hunter gather all pertinent info about the method and produce a concise and easy to read "Readme." Past work I have done lives at realtechwriter.com 2) ryan-gordon has been approved to start work.

I will watch the provided videos and provide some documentation on the arb function. I will open a PR for this which contains some paragraphs and a linked example. 3) rayhash has applied to start work _(Funders only: approve worker | reject worker)_.

I will study the UI and watch the provided videos and provide a detailed and easy-to-understand documentation on the arb function

Learn more on the Gitcoin Issue Details page.

mikedeshazer commented 4 years ago

@Ryan-Gordan thanks! On Gitcoin, please select "Submitted Work" and we can close this out

gitcoinbot commented 4 years ago

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

Work for 0.15 ETH (29.85 USD @ $198.97/ETH) has been submitted by:

  1. @ryan-gordon

@mikedeshazer please take a look at the submitted work:

gitcoinbot commented 4 years ago

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

The funding of 0.15 ETH (30.01 USD @ $200.06/ETH) attached to this issue has been approved & issued to @ryan-gordon.