Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(oracle): historical iterator #1573

Merged
merged 2 commits into from
Nov 11, 2022
Merged

Conversation

robert-zaremba
Copy link
Member

Description

Historical prices stored in the x/oracle module can collide. More specifically, if we have tokens where one denom is a prefix of another token denom (eg ETH and ETHW), then an iterator for ETH will also return prices for ETHW as well and calculate the prices totally wrong. This is obviously a bug.


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title
  • added ! to the type prefix if API or client breaking change
  • added appropriate labels to the PR
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

@robert-zaremba robert-zaremba requested review from a team as code owners November 10, 2022 23:11
@robert-zaremba robert-zaremba changed the title Robert/fix historical iterator fix(oracle) historical iterator Nov 10, 2022
@codecov-commenter
Copy link

Codecov Report

Merging #1573 (e41edea) into main (3aafb9b) will increase coverage by 0.11%.
The diff coverage is 71.87%.

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #1573      +/-   ##
==========================================
+ Coverage   52.08%   52.20%   +0.11%     
==========================================
  Files          72       73       +1     
  Lines        7092     7103      +11     
==========================================
+ Hits         3694     3708      +14     
+ Misses       3125     3122       -3     
  Partials      273      273              
Impacted Files Coverage Δ
x/oracle/types/keys.go 45.71% <0.00%> (+3.60%) ⬆️
util/bytes.go 100.00% <100.00%> (ø)
x/oracle/keeper/historic_price.go 93.93% <100.00%> (+0.12%) ⬆️

x/oracle/types/keys.go Show resolved Hide resolved
@robert-zaremba robert-zaremba changed the title fix(oracle) historical iterator fix(oracle): historical iterator Nov 11, 2022
@mergify mergify bot merged commit 8355670 into main Nov 11, 2022
@mergify mergify bot deleted the robert/fix-historical-iterator branch November 11, 2022 11:32
@robert-zaremba
Copy link
Member Author

Lets do this same renaming for the other oracle key constructor functions in another pr +1

I didn't update the other functions, because that would be API breaking against what is already released. I guess nobody else is doing it so probably we are good to make that PR.

mergify bot pushed a commit that referenced this pull request Nov 12, 2022
## Description

Follow up on #1573
Cleanup store key prefix functions.
 
---

### Author Checklist

_All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues._

I have...

- [ ] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [ ] added `!` to the type prefix if API or client breaking change
- [ ] added appropriate labels to the PR
- [ ] targeted the correct branch (see [PR Targeting](https://github.com/umee-network/umee/blob/main/CONTRIBUTING.md#pr-targeting))
- [ ] provided a link to the relevant issue or specification
- [ ] added a changelog entry to `CHANGELOG.md`
- [ ] included comments for [documenting Go code](https://blog.golang.org/godoc)
- [ ] updated the relevant documentation or specification
- [ ] reviewed "Files changed" and left comments if necessary
- [ ] confirmed all CI checks have passed

### Reviewers Checklist

_All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items._

I have...

- [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [ ] confirmed all author checklist items have been addressed
- [ ] reviewed state machine logic
- [ ] reviewed API design and naming
- [ ] reviewed documentation is accurate
- [ ] reviewed tests and test coverage
- [ ] manually tested (if applicable)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants