oasisdex / oasis-direct Goto Github PK

HTML 0.33% JavaScript 85.99% CSS 13.11% Shell 0.57%

oasis-direct's Introduction

Oasis Direct

Oasis.Direct is a convenient and user friendly fully-decentralized way to change tokens, especially DAI/ETH and DAI/ERC-20 token pairs.

You don’t need to think about wrapping/unwrapping ETH (and other non ERC-20 compliant tokens), you don’t need to worry about the current liquidity on the exchange and you are always guaranteed the best price you can get from Oasis.DEX exchange.

Deployments

production
stage - auto deploy branch release/simpson

Sections in Oasis Direct Web App

Exchange
- Exchange tokens in matters of seconds. Just provide the amount you want to sell or the amount of the token you want to get. The application will automatically check the liquidity pool for orders that will fulfill yours. You receive information how much is the rate and the gas cost for the transaction in ETH.
- In order to select token, just click on the square box where the token icon is and a list with the supported tokens will appear. If you select token that is part of the trade pair, tokens will just swap.
- Another way to swap tokens is to click the arrows icon.
- To proceed with transaction, please read the Terms of Service and accept them by marking the check box.
- If given account doesn't have insufficient funds to trade an error message will be displayed.
- If given order can't be fulfilled because there aren't enough corresponding orders, there will be notification.
- Trading ETH for ERC20 Token wil require only a single transaction. You can follow the status of the transaction on Etherscan by clicking the transaction box.
- Trading ERC20 Token for ETH or ERC20 Token for ERC20 Token will require 2 transaction initially. Once you go through those 2 transaction every other time you will only a single transaction. See FAQ section for more details.
Export Trades
- Exports trade history for the given addresses in the form of a csv file.
- As many address as one want can be added.
- Only OasisDEX is supported right now but in the future we plan to support many more exchanges

FAQ

What is Oasis.Direct ?

Oasis.Direct is the most convenient, fully-decentralized way to change tokens. You don’t need to think about wrapping/unwrapping Ether or any other Ethereum token, you don’t need to worry about the current liquidity and you are always guaranteed the best available price on Oasis.DEX. Simply specify the amount that you want to trade and confirm the transaction.

Are you going to support more trading pairs in the future ?

Yes, more trading pairs will be supported in the future. In the beginning the following pair is available: DAI/ETH.

Why do I sometimes need to confirm two transactions, and sometimes only one ?

Each trading pair requires a one-time transaction per Ether address to be enabled for trading. Once that is done, all subsequent trades will require confirming just one Ethereum transaction. You just need to confirm two Ethereum transactions if it is the first time you are trading a particular pair from the new Ethereum address.

What does “Order estimation may vary” mean ?

The slippage limit value is used to create a Limit Order for your transaction. If this Limit Order cannot be immediately completely filled on Oasis.DEX, the transaction will fail. It’s impossible to guarantee that your order will succeed, since it is being matched with other orders on Oasis.DEX in real time. The fact that Oasis.Direct uses Limit Orders, rather than Market Orders, ensures that a user won’t experience unexpected slippage.

What happens if the transaction price exceeds the given threshold ? Will I still pay gas price for the transaction ?

Yes, you will still pay for gas. Bear in mind that the likelihood that your order can’t be filled is quite low, and will only occur if the price has moved in excess of the slippage limit in the time between you receiving the quote and your transaction getting mined.

Why is the “order estimation vary indicator” (threshold) different for some pairs ?

The slippage limits were decided by analyzing the volatility and book depth historically on the Oasis.Dex for the given pairs. The limit might be adjusted accordingly if the market on Oasis.DEX changes. In the future, you will be able to set the slippage limit manually according to your personal preference.

Can you list order estimation variations (thresholds) for all assets/tokens ?

Right now there is a fixed threshold of 2% for DAI/ETH pair.

What is the maximum value I can trade through Oasis.Direct ?

There is no maximum size limit. However, larger orders impact the market more, and so may be quoted poorer prices. They are also more likely to fail by exceeding the slippage limit

I want to submit a big Sell/Buy Order. Can I see how likely my order will fail due to exceeding threshold limit ?

This functionality will be included in the future release of Oasis.Direct

Why there is a minimum trading limit ?

As the gas cost for a transaction is fixed and doesn’t depend on the amount you want to trade, the bigger amount, the less (percentage-wise) you pay for gas. Minimum trade sizes were introduced to make sure that the total transaction cost is minimal with respect to the traded amount. Currently the minimum trade sizes are:

30 DAI
0.03 ETH

Note that both buy and sell amounts of a transaction need to be above the minimum trade size.

You said Oasis.Direct is fee-less. Do I still need to cover gas cost ?

Yes, even though there are no fees, you still need to cover the gas cost of the transaction. The gas price is estimated according to the current transaction details. To learn more about gas and why it is needed for Ethereum transactions, check this excellent guide.

Why does the transaction confirmation takes so long? What can I do to speed it up ?

Oasis.Direct is powered by fully decentralized, on-chain Smart Contracts. The transaction confirmation time depends on the current state of the Ethereum blockchain. You can increase the speed of confirmation by increasing the gas price for your transaction - please refer to this guide that explains all the mechanics of the gas price and its effect on the speed of transactions.

Development

Starting the app

yarn
yarn start

E2E tests

First, make sure you have app and oasis-localnode already running. Then run all cypress tests:

yarn cypress:run

To develop:

yarn cypress:dev

If you're trying to debug test failure on CI visit Cypress Dashboard

CI

Sometimes, you might want to update localnode version used in tests. There is a LOCALNODE_SHA in .circleci/config.yml. This SHA should match top of the master branch in localnode repository.

Env variables

OASIS_GANACHE_COMPATIBILITY=1                # optional, if enabled we are gonna adjust gas estimations
OASIS_HIDE_MKR=1                             # optional

oasis-direct's People

Contributors

Stargazers

Watchers

Forkers

peculiarity luke7211 krzkaczor dogecrypto d-xo kwadraxx aman-mahalgavan hexonaut oasiscommunity arkadiuszsz mrabino1 leibniz137 dappnode

oasis-direct's Issues

Inputfields should not get emptied after a user clicked on the switch icon or picked another currency

oasis.direct mobile mockup

Hey guys,

I am finished up the first design mockups for oasis.direct on mobile.

Starter Page

Finalize Page

Calculating gas cost is triggered on each new digit entered

i.e. Scenario
0. Open dev tools.

Enter for sell token - 0.1
Put the cursor in front of the 1.
Start putting 0's.
Observe how many times Calculating gas cost is called.

Every time we change a digit ( remove / add ) gas calculation is triggered.

Implement a debounce function for the input.

make the oasis direct logo clickable

add disclaimer to the landingpage

Oasis.direct 2 - Requirement List

Hey guys,

I want to define the requirements/task for the next version of oasis.direct. The whole requirement plan is not written in stone so I would like to have more input from the whole oasis team. All those changes will be worked on after we moved the base project to a redux/react version which @peculiarity is started to work on.

oasis.direct widget requirements:

Including an interface/page to let the user set their own gas price and threshold limit (via exact price or percentage limit)
Native mobile widget implementation
Implementing an automatic way of dealing with the threshold for specific pairs. If the Ethereum network is clogged (which means it is harder to do market making), we should increase the threshold.

oasis.direct website requirement:

adding two new dashboard like widgets which are showing DAI markets and a 24 Hour Statistic of the oasis contract.
add an interace which shows the wallet address of the user
add an interface where the user can lookup their balances of each token asset.
add an indicator for connectivity.
add a transfer page

metamask version 3.13.7 is introducing errors

button border wrong color

current:

should:

bg: #448AFF
border: #3E7BE6

capitalise "registration"

Oasis Direct 2 - Design

Changes:

Change Price to Approx. Price
Add Price Slippage
Reposition the Gas Price and change from ETH to USD value.
Add the balance for each Asset Picker
Added advanced Settings Button
Insufficent funds warning message will now be shown beneath the order informations. With that people can now check prices without having actually the balance on their wallet.

Measurements:od-settings.zip
Settings Icon:

Not Connected Page Install Button should open in a new tab

Indicate the user that the arrow is actually a button

Disclaimer box should have a different behaviour

changes:

the whole box should not be clickable anymore
if you click on Terms and Condition a new tab should open up (link will coming soon)
Terms and Condition should have the color #448AFF

Change message - transaction is taking longer

Tax Exporter Wireframes

Requirements:

Oasis should be the default Exchange
Etherdelta and 0x are disabled until we are adding the functionality
After the user clicked on the button Create Report, it is not possible for him to start the process again while the exporter is in process.

What's the fifth paremeter in the offer function?

I'm working on a market making bot for OasisDex, I notice that when placing an order via oasisdex, there is a fifth parameter (uint256 pos)?

It seems it's not required as orders are accepted without it but I assume it serves a purpose? Do I need it or can it be safely ignored?

Rounding/Inputfield Issue

FAQ Design

Measurements: faq-measurements.zip

CSV file with information about past trades

Export all past trades since fromBlock:5172142 into csv file so that @luke7211 can create a nice summary of current traffic coming from Oasis Direct

Adblockers can cause Export Trades to fail

Export Trades seems to be making XHR requests to https://oasisdex.github.io/oasis-dex-script/maker-otc-*.trades.json which fail when uBlock is active. This causes the UI to replace the Generate Report button with a spinner which never expires.

Remove popup which appears if someone clicks on balances

Remove popup events :

currency picker button and inputfields are not properly aligned

Confirmed/Pending status should be a hyperlink to etherscan

Currently: just plain text

Should be: hyperlink to etherscan for specific transaction

Landing page - Adding Navigation

Changes:

Adding Navigation for the Tax Exporter and Exchange

Measurements: od-landing-v2.zip

If you pick MKR as deposit currency, it should not be visible in the currency picker view

add hover to currency picker

Filled Inputfields should be truncated to 5 decimals

Currently: DEPOSIT & RECEIVE Inputfield shows numbers with 18 decimals
Should be: DEPOSIT & RECEIVE Inputfield shows numbers with 5 decimals

Redesign close button

while clicking on the switching button sometimes the name of the right asset is getting selected

Make ETH/DAI the default pair

Market System Warning message not properly styled

Currently:

should look like:

When selling 0.03 ETH worth of MKR transaction fails with misleading MM comment

When you trade MKR-ETH and type 0.03 in the ETH box the MKR amount is below 0.03. Transaction will fail but with a very misleading error messagage leading user to believe that 1% threshold has been broken. This is repeatable.

Input fields getting cleared

Enter some amount in the pay token input field
Use one of the token pickers to select a token
The token picker is opened but instead of selecting a new token, just close the picker
The input fields are cleared.

Expected behavior: The input fields shouldn't be cleared if no token was selected

widget redesign v2

I have updated the recent oasis.direct design mockup with the help of the team feedback:

changes:

legal agreement information box with checkbox added
replaced order information from the bottom to the top
added token description to the picker
changed the price to show the base/quote currency
renamed "fee" to simple "gas cost"
changed the widget size to 470 w 420 h

"Choose which Assets to trade" decapitalise Assets

Notification about completing conversion

This is a feature suggestion on top of #50

It would be fantastic if at the end of conversion process the widget did javascript code of window.postMessage({type: 'oasis-direct.conversionCompleted', ...}, '*'). This would allow the nesting party to trigger it's own logic after conversion and integrate oasis.direct widget more smoothly.

Redesign DAI logo

currently:

should be filled like MKR:

every token should have a defined minimum value for trading

While testing oasis.direct on the mobile ethereum client cypher I am realising that it doesn`t make sense to give the user the possibility to exchange 0,0001 DAI. We need to define a min value for each token which is traded on oasis.direct.

For the first release we are going to have tokens with min value:

ETH 0,03 ETH
MKR 0,03 MKR
DAI 30 DAI

Recalculation of price after prolonged period of user's inactivity

When user is idle for a long time, the market may have moved substantially increasing the risk that the threshold of 1% (or whatever) will not be met. It will be useful if the price was automatically updated every 60 seconds

Transaction execution error on gas cost calculation

Tested only on KOVAN so far

Create new (fresh) account
1 Get some MKR token ( https://oasisdex.com)
Go to oasis.direct
Select MKR -> ETH trading pair
Gas calculation throws an error in the dev console and the Gas cost loading spinner keeps on spinning. (error: Uncaught (in promise) Error: Error: Transaction execution error. )

Tried with DAI and it worked fine.