feat: add support to dec34 #1100

cosmic-vagabond · 2025-01-07T18:34:46Z

Description

What has Changed?

Add support to Dec34 type to handle up to 34 decimal places for price calculation using asset with high decimal precision (e.g. WETH 18 decimals)

Test results

EVM token price (0.004)

$ elysd q oracle show-price WETH
price:
  asset: WETH
  block_height: "668964"
  price: "0.004000000000000000"
  provider: elys10d07y265gmmuvt4z0w9aw880jnsr700j6z2zm3
  source: elys
  timestamp: "1736437787"

Swap estimation retrieves correct price and amount:

$ elysd q amm swap-estimation-by-denom 1$WETH $weth $usdc

amount:
  amount: "3990"
  denom: ibc/F082B65C88E4B6D5EF1DB243CDA1D331D002759E938A0F5CD3FFDC5D53B3E349
available_liquidity:
  amount: "100000000000"
  denom: ibc/F082B65C88E4B6D5EF1DB243CDA1D331D002759E938A0F5CD3FFDC5D53B3E349
discount: "0.000000000000000000"
in_route:
- pool_id: "3"
  token_out_denom: ibc/F082B65C88E4B6D5EF1DB243CDA1D331D002759E938A0F5CD3FFDC5D53B3E349
out_route: []
price_impact: "0.99999999999900259975"
slippage: "0.000099999999999999999999999999999999"
spot_price: "0.00400040004000400040004000400040004"
swap_fee: "0.002000000000000000"
weight_balance_ratio: "-0.0005001251219032960793880326679998092"

Inverse price accurate:

$ elysd q amm swap-estimation-by-denom 1$USDC $usdc $weth 
amount:
  amount: "249972500399982666971"
  denom: weth-wei
available_liquidity:
  amount: "25000000000000000000000000"
  denom: weth-wei
discount: "0.000000000000000000"
in_route:
- pool_id: "3"
  token_out_denom: weth-wei
out_route: []
price_impact: "-999990000598.9906669506950695069507"
slippage: "0.00000999940000933304930493049304930493"
spot_price: "249.975"
swap_fee: "0.000000000000000000"
weight_balance_ratio: "0"

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...

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 ! in the type prefix if API or client breaking change
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)

Deployment Notes

Are there any specific considerations to take into account when deploying these changes? This may include new dependencies, scripts that need to be executed, or any aspects that can only be evaluated in a deployed environment.

Screenshots and Videos

Please provide any relevant before and after screenshots by uploading them here. Additionally, demo videos can be highly beneficial in demonstrating the process.

…acyDec to work with decimal places less than -18

codecov · 2025-01-10T06:28:23Z

Codecov Report

Attention: Patch coverage is 40.97015% with 791 lines in your changes missing coverage. Please review.

Project coverage is 47.63%. Comparing base (bd617a1) to head (787d233).

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1100      +/-   ##
==========================================
- Coverage   48.13%   47.63%   -0.50%     
==========================================
  Files         892      897       +5     
  Lines       35069    35744     +675     
==========================================
+ Hits        16880    17028     +148     
- Misses      16931    17439     +508     
- Partials     1258     1277      +19

Components	Coverage Δ
leveragelp_transactions	`75.00% <ø> (ø)`
leveragelp_lifecycle	`82.72% <100.00%> (ø)`
leveragelp_keeper	`85.41% <ø> (ø)`
leveragelp_queries	`19.94% <20.00%> (ø)`
accountedpool_transactions	`100.00% <ø> (ø)`
accountedpool_lifecycle	`∅ <ø> (∅)`
accountedpool_queries	`81.25% <ø> (ø)`
amm_transactions	`80.28% <100.00%> (ø)`
amm_lifecycle	`90.66% <ø> (ø)`
amm_keeper	`73.59% <100.00%> (ø)`
amm_queries	`82.45% <66.66%> (ø)`
assetprofile_transactions	`76.85% <ø> (ø)`
assetprofile_lifecycle	`∅ <ø> (∅)`
assetprofile_keeper	`80.00% <ø> (ø)`
assetprofile_queries	`60.00% <ø> (ø)`
burner_transactions	`0.00% <ø> (ø)`
burner_lifecycle	`∅ <ø> (∅)`
burner_keeper	`100.00% <ø> (ø)`
burner_queries	`79.06% <ø> (ø)`
commitment_transactions	`74.63% <ø> (ø)`
commitment_lifecycle	`∅ <ø> (∅)`
commitment_keeper	`86.17% <ø> (ø)`
commitment_queries	`59.04% <ø> (ø)`
epochs_transactions	`∅ <ø> (∅)`
epochs_lifecycle	`92.00% <ø> (ø)`
epochs_keeper	`84.61% <ø> (ø)`
epochs_queries	`83.33% <ø> (ø)`
estaking_transactions	`68.93% <ø> (ø)`
estaking_lifecycle	`82.60% <ø> (ø)`
estaking_keeper	`72.80% <ø> (ø)`
estaking_queries	`62.35% <ø> (ø)`
incentive_transactions	`∅ <ø> (∅)`
incentive_lifecycle	`∅ <ø> (∅)`
incentive_keeper	`∅ <ø> (∅)`
incentive_queries	`∅ <ø> (∅)`
masterchef_transactions	`86.85% <ø> (ø)`
masterchef_lifecycle	`75.09% <72.72%> (-0.34%)`	⬇️
masterchef_keeper	`100.00% <ø> (ø)`
masterchef_queries	`38.74% <45.00%> (ø)`
oracle_transactions	`27.27% <ø> (ø)`
oracle_lifecycle	`30.00% <ø> (ø)`
oracle_keeper	`61.11% <ø> (ø)`
oracle_queries	`34.53% <ø> (ø)`
parameter_transactions	`18.86% <ø> (ø)`
parameter_lifecycle	`∅ <ø> (∅)`
parameter_keeper	`75.00% <ø> (ø)`
parameter_queries	`57.14% <ø> (ø)`
stablestake_transactions	`81.53% <ø> (ø)`
stablestake_lifecycle	`100.00% <ø> (ø)`
stablestake_keeper	`90.47% <ø> (ø)`
stablestake_queries	`100.00% <ø> (ø)`
perpetual_transactions	`76.10% <ø> (ø)`
perpetual_lifecycle	`90.90% <ø> (ø)`
perpetual_keeper	`61.68% <ø> (ø)`
perpetual_queries	`64.86% <100.00%> (ø)`
tier_transactions	`100.00% <ø> (ø)`
tier_lifecycle	`100.00% <ø> (ø)`
tier_keeper	`90.90% <ø> (ø)`
tier_queries	`79.92% <77.27%> (ø)`
tokenomics_transactions	`71.87% <ø> (ø)`
tokenomics_lifecycle	`∅ <ø> (∅)`
tokenomics_keeper	`80.00% <ø> (ø)`
tokenomics_queries	`79.06% <ø> (ø)`
transferhook_transactions	`∅ <ø> (∅)`
transferhook_lifecycle	`∅ <ø> (∅)`
transferhook_keeper	`100.00% <ø> (ø)`
transferhook_queries	`57.14% <ø> (ø)`
tradeshield_transactions	`74.29% <ø> (ø)`
tradeshield_lifecycle	`∅ <ø> (∅)`
tradeshield_keeper	`90.90% <100.00%> (ø)`
tradeshield_queries	`67.56% <ø> (ø)`

types/dec34.go

avkr003 · 2025-01-13T05:06:33Z

types/dec34.go

+	regenmath "github.com/regen-network/regen-ledger/types/v2/math"
+)
+
+type Dec34 regenmath.Dec


https://github.com/cosmos/cosmos-sdk/blob/v0.50.9/x/group/internal/math/dec.go#L14

Considering the comments above, we shall use wrapper?

@avkr003 regenmath.Dec is already a wrapper around apd.Decimal here we are essentially defining a new type that is a regenmath.Dec and therefore a wrapper of apd.Decimal as well

@cosmic-vagabond instead of using their library lets copy paste their whole file. I think they did the same from the cosmos SDK / group module or cosmos copy pasted from them. I am guessing there must some reasoning they didn't import but created own data structures (can't think of though, may be easier to migrate later or easier auditing as less exposure to external libraries)

@avkr003 this seems to be a minor change we can come back to based on our priorities, I would be happy to work on it in another PR as this one is quite big and becomes extremely difficult to maintain consider the other changes that gets added to the repo.

proto/elys/amm/tx.proto

avkr003 · 2025-01-13T05:09:51Z

types/dec34.go

+import (
+	"cosmossdk.io/math"
+	"github.com/cockroachdb/apd/v2"
+	regenmath "github.com/regen-network/regen-ledger/types/v2/math"


necessary to use regen network code? Directly use apd? cosmos in group module (example)

FYI #1100 (comment)

avkr003 · 2025-01-14T10:11:55Z

types/dec34.go

+	regenmath "github.com/regen-network/regen-ledger/types/v2/math"
+)
+
+type Dec34 regenmath.Dec


@cosmic-vagabond instead of using their library lets copy paste their whole file. I think they did the same from the cosmos SDK / group module or cosmos copy pasted from them. I am guessing there must some reasoning they didn't import but created own data structures (can't think of though, may be easier to migrate later or easier auditing as less exposure to external libraries)

avkr003 · 2025-01-15T05:35:17Z

x/amm/types/one_token_unit.go

+	sdkmath "cosmossdk.io/math"
+)
+
+func OneTokenUnit(decimal uint64) sdkmath.Int {


The function name isn't obvious. It's returning 10^6 or 10^18 or based on right? Rename to GetPowerOfTen (basically exactly what it does)

#1100 (comment)

feat: add support to dec34

087c83b

cosmic-vagabond had a problem deploying to coverage January 7, 2025 18:34 — with GitHub Actions Failure

cosmic-vagabond mentioned this pull request Jan 7, 2025

fix(amm): support 18 decimals assets #1099

Closed

18 tasks

refactor: refactor modules to support dec34

4f10b2e

cosmic-vagabond had a problem deploying to coverage January 8, 2025 07:33 — with GitHub Actions Failure

refactor: remaining module updated to support dec64 and updated ToLeg…

cb44e75

…acyDec to work with decimal places less than -18

cosmic-vagabond had a problem deploying to coverage January 8, 2025 15:33 — with GitHub Actions Failure

test: fix tests

6b2e2aa

cosmic-vagabond had a problem deploying to coverage January 8, 2025 15:51 — with GitHub Actions Failure

test: fix tests

341f82e

cosmic-vagabond had a problem deploying to coverage January 8, 2025 17:56 — with GitHub Actions Failure

cosmic-vagabond added 2 commits January 8, 2025 19:42

test: fix tests

8c11b8b

test: fix tests

b039bec

cosmic-vagabond had a problem deploying to coverage January 8, 2025 18:59 — with GitHub Actions Failure

fix(types): quoint64 operation

0bd8b4c

cosmic-vagabond had a problem deploying to coverage January 8, 2025 19:11 — with GitHub Actions Failure

feat: add pow function to dec34 interface

b85187b

cosmic-vagabond had a problem deploying to coverage January 9, 2025 07:26 — with GitHub Actions Failure

Merge branch 'main' into feat/add-support-to-dec34

9ae688b

cosmic-vagabond had a problem deploying to coverage January 9, 2025 07:26 — with GitHub Actions Failure

cosmic-vagabond requested review from amityadav0, avkr003 and 99adarsh January 9, 2025 07:27

cosmic-vagabond marked this pull request as ready for review January 9, 2025 07:27

refactor: pow

58c9688

cosmic-vagabond had a problem deploying to coverage January 9, 2025 14:57 — with GitHub Actions Failure

test: fix tests

19ecfdc

cosmic-vagabond temporarily deployed to coverage January 9, 2025 15:29 — with GitHub Actions Inactive

refactor: move decimal normalization away from price functions

4333e09

cosmic-vagabond temporarily deployed to coverage January 10, 2025 06:21 — with GitHub Actions Inactive

avkr003 requested changes Jan 13, 2025

View reviewed changes

types/dec34.go Outdated Show resolved Hide resolved

types/dec34.go Outdated Show resolved Hide resolved

avkr003 requested changes Jan 13, 2025

View reviewed changes

test(dec34): panics if wrong inputs

b3be8c2

cosmic-vagabond had a problem deploying to coverage January 14, 2025 04:36 — with GitHub Actions Failure

Merge branch 'main' into feat/add-support-to-dec34

469a186

cosmic-vagabond had a problem deploying to coverage January 14, 2025 04:39 — with GitHub Actions Failure

Merge branch 'main' into feat/add-support-to-dec34

7f867fd

cosmic-vagabond had a problem deploying to coverage January 15, 2025 05:05 — with GitHub Actions Failure

Merge branch 'main' into feat/add-support-to-dec34

1c0a41c

cosmic-vagabond had a problem deploying to coverage January 15, 2025 05:09 — with GitHub Actions Failure

test(perpetual): fix tests

a009a3a

cosmic-vagabond had a problem deploying to coverage January 15, 2025 05:16 — with GitHub Actions Failure

avkr003 requested changes Jan 15, 2025

View reviewed changes

cosmic-vagabond added 2 commits January 15, 2025 06:41

test: debug

afebdaf

feat(dec34): add ceil method

9e96166

cosmic-vagabond had a problem deploying to coverage January 15, 2025 06:22 — with GitHub Actions Failure

test(perpetual): fix tests

787d233

cosmic-vagabond temporarily deployed to coverage January 15, 2025 06:37 — with GitHub Actions Inactive

Merge branch 'main' into feat/add-support-to-dec34

943726d

cosmic-vagabond deployed to coverage January 17, 2025 14:29 — with GitHub Actions Active

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add support to dec34 #1100

feat: add support to dec34 #1100

cosmic-vagabond commented Jan 7, 2025 •

edited

Loading

codecov bot commented Jan 10, 2025 •

edited

Loading

avkr003 Jan 13, 2025

cosmic-vagabond Jan 14, 2025

avkr003 Jan 14, 2025

cosmic-vagabond Jan 15, 2025

avkr003 Jan 13, 2025

cosmic-vagabond Jan 15, 2025

avkr003 Jan 14, 2025

avkr003 Jan 15, 2025

cosmic-vagabond Jan 15, 2025

feat: add support to dec34 #1100

Are you sure you want to change the base?

feat: add support to dec34 #1100

Conversation

cosmic-vagabond commented Jan 7, 2025 • edited Loading

Description

What has Changed?

Test results

Author Checklist

Reviewers Checklist

Deployment Notes

Screenshots and Videos

codecov bot commented Jan 10, 2025 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cosmic-vagabond commented Jan 7, 2025 •

edited

Loading

codecov bot commented Jan 10, 2025 •

edited

Loading