Add OKX exchange integration #5328

anukul · 2022-12-31T01:34:27Z

Added integration for asset balances, trades and deposits & withdrawals

Screen.Recording.2022-12-31.at.6.50.51.AM.mov

Note:

Used a throwaway account for exchange fixture, since all queries must be authenticated with API credentials (including list of assets)
Only populated a small subset of assets (those also found in other exchange mappings), would prefer to discuss before moving further on this.

CLAassistant · 2022-12-31T01:34:31Z

All committers have signed the CLA.

codecov · 2022-12-31T13:59:22Z

Codecov Report

Merging #5328 (bf46f35) into develop (ba336d3) will increase coverage by 0.05%.
The diff coverage is 100.00%.

@@             Coverage Diff             @@
##           develop    #5328      +/-   ##
===========================================
+ Coverage    70.96%   71.01%   +0.05%     
===========================================
  Files          980      983       +3     
  Lines        73490    74062     +572     
  Branches      9039     9170     +131     
===========================================
+ Hits         52150    52593     +443     
- Misses       19737    19866     +129     
  Partials      1603     1603

Flag	Coverage Δ
frontend_integration	`60.46% <100.00%> (+0.35%)`	⬆️
frontend_unit	`58.90% <100.00%> (+0.16%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
.../components/settings/api-keys/ExchangeKeysForm.vue	`79.16% <ø> (ø)`
rotkehlchen/db/schema.py	`100.00% <ø> (ø)`
rotkehlchen/exchanges/constants.py	`100.00% <ø> (ø)`
rotkehlchen/types.py	`90.42% <ø> (ø)`
frontend/app/src/types/exchanges.ts	`100.00% <100.00%> (ø)`
frontend/app/src/types/trades.ts	`98.66% <100.00%> (+0.03%)`	⬆️
rotkehlchen/assets/converters.py	`75.95% <100.00%> (ø)`
rotkehlchen/db/upgrades/v35_v36.py	`82.56% <100.00%> (ø)`
frontend/app/src/composables/balances.ts	`51.28% <0.00%> (-41.58%)`	⬇️
frontend/app/src/store/balances/breakdown.ts	`34.90% <0.00%> (-29.81%)`	⬇️
... and 44 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

yabirgb

Thanks for the contribution. I checked the backend and someone else will check the frontend. Can you also add an entry in the docs/changelog file saying that support for OKX was added? Also wrote a question in discord (priv) about the tests

rotkehlchen/assets/converters.py

rotkehlchen/exchanges/okx.py

rotkehlchen/tests/exchanges/test_okx.py

yabirgb · 2022-12-31T14:29:55Z

Also @anukul linting is failing. Check it before pushing

LefterisJP · 2023-01-01T21:01:53Z

Hey @anukul I am not reviewing yet but just a note. We don't merge develop back to the branch. Instead we always rebase feature branches on top of develop.

Also make commits that do one big thing, but not so small as 1 commit per lint error or suggestion aplication.

lukicenturi · 2023-01-02T09:32:15Z

The frontend part is okay.

yabirgb

Thanks @anukul, left some minor comments

docs/changelog.rst

rotkehlchen/exchanges/okx.py

rotkehlchen/tests/fixtures/exchanges/okx.py

LefterisJP

Hey @anukul thanks a lot for such a nice and big PR. Left some comments/questions.

rotkehlchen/db/schema.py

rotkehlchen/exchanges/okx.py

LefterisJP · 2023-01-04T10:19:21Z

rotkehlchen/exchanges/okx.py

+        else:
+            raise AssertionError(f'Unexpected {self.name} endpoint type: {endpoint}')


You should remove the else branch. Turn the last elif to else. And at the start of the else code branch add an `assert endpoint == 'withdrawals', 'only case left, should be withdrawals'

Why?

We use type checking for a reason

assertions are fine for debugging and in production since we produce optimized code they are removed. But raise AssertionError() is not.

rotkehlchen/exchanges/okx.py

LefterisJP

Left some more things that need changing

rotkehlchen/db/upgrades/v35_v36.py

rotkehlchen/exchanges/okx.py

LefterisJP

Two more small comments

LefterisJP · 2023-01-10T12:43:01Z

rotkehlchen/exchanges/okx.py

+        data = self._api_query_list(endpoint='balance')
+        try:
+            currencies_data = data[0]['details']
+        except (IndexError, KeyError, TypeError) as e:


continuing the TypeError discussion do you see the problem here?

Such a TypeError would read: "TypeError: string indices must be integers"

Which would translate to: "OKX balance API request failed due to unexpected response TypeError: string indices must be integers".

We won't have any information as to what went wrong or which attribute it is that failed for us.

I think it's much better if you check that data[0] is a dict here and if not raise a RemoteError saying that the "details" key of the OKX balances response was not a dict as expected, and even include the raw response so it can be studied in the logs.

What we usually do with this is:

Put as few info as needed in the RemoteError as this is usually propagated high up, caught by the API and shown to the user.

At the same time log an error, with the raw response data so that when we study the logs of the user we can see both the error and the raw response and figure out what happened.

You missed to do (2).

Logging the error containing the raw response so we, the developers, can debug it.

rotkehlchen/exchanges/okx.py

LefterisJP

Left a small comment you forgot, but can also be added in another PR.

Other than that looks good. So will merge.

The single failing test is timeout due to ethereum remote node query

gitpoap-bot · 2023-01-11T08:58:21Z

Congrats, your important contribution to this open-source project has earned you a GitPOAP!

GitPOAP: 2023 rotki Contributor:

Head to gitpoap.io & connect your GitHub account to mint!

Learn more about GitPOAPs here.

anukul temporarily deployed to test December 31, 2022 13:56 — with GitHub Actions Inactive

yabirgb reviewed Dec 31, 2022

View reviewed changes

anukul requested a review from yabirgb January 1, 2023 09:34

anukul temporarily deployed to test January 1, 2023 21:04 — with GitHub Actions Inactive

yabirgb reviewed Jan 2, 2023

View reviewed changes

LefterisJP mentioned this pull request Jan 3, 2023

Add support for ByBit #3810

Closed

anukul requested a review from yabirgb January 3, 2023 12:01

anukul temporarily deployed to test January 3, 2023 14:11 — with GitHub Actions Inactive

LefterisJP reviewed Jan 4, 2023

View reviewed changes

anukul requested review from LefterisJP and removed request for yabirgb January 10, 2023 06:56

anukul temporarily deployed to test January 10, 2023 10:45 — with GitHub Actions Inactive

LefterisJP reviewed Jan 10, 2023

View reviewed changes

anukul requested a review from LefterisJP January 10, 2023 11:48

LefterisJP reviewed Jan 10, 2023

View reviewed changes

add okx

bf46f35

anukul requested a review from LefterisJP January 11, 2023 06:38

LefterisJP approved these changes Jan 11, 2023

View reviewed changes

LefterisJP merged commit 1b3f1ff into rotki:develop Jan 11, 2023

anukul deleted the okx branch January 12, 2023 10:07

yabirgb mentioned this pull request Jan 23, 2023

OKEx support #784

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add OKX exchange integration #5328

Add OKX exchange integration #5328

anukul commented Dec 31, 2022

CLAassistant commented Dec 31, 2022 •

edited

codecov bot commented Dec 31, 2022 •

edited

yabirgb left a comment

yabirgb commented Dec 31, 2022

LefterisJP commented Jan 1, 2023 •

edited

lukicenturi commented Jan 2, 2023

yabirgb left a comment

LefterisJP left a comment

LefterisJP Jan 4, 2023

LefterisJP left a comment

LefterisJP left a comment

LefterisJP Jan 10, 2023

LefterisJP Jan 11, 2023

LefterisJP left a comment

gitpoap-bot bot commented Jan 11, 2023

		else:
		raise AssertionError(f'Unexpected {self.name} endpoint type: {endpoint}')

Add OKX exchange integration #5328

Add OKX exchange integration #5328

Conversation

anukul commented Dec 31, 2022

CLAassistant commented Dec 31, 2022 • edited

codecov bot commented Dec 31, 2022 • edited

Codecov Report

yabirgb left a comment

Choose a reason for hiding this comment

yabirgb commented Dec 31, 2022

LefterisJP commented Jan 1, 2023 • edited

lukicenturi commented Jan 2, 2023

yabirgb left a comment

Choose a reason for hiding this comment

LefterisJP left a comment

Choose a reason for hiding this comment

LefterisJP Jan 4, 2023

Choose a reason for hiding this comment

LefterisJP left a comment

Choose a reason for hiding this comment

LefterisJP left a comment

Choose a reason for hiding this comment

LefterisJP Jan 10, 2023

Choose a reason for hiding this comment

LefterisJP Jan 11, 2023

Choose a reason for hiding this comment

LefterisJP left a comment

Choose a reason for hiding this comment

gitpoap-bot bot commented Jan 11, 2023

CLAassistant commented Dec 31, 2022 •

edited

codecov bot commented Dec 31, 2022 •

edited

LefterisJP commented Jan 1, 2023 •

edited