Update Readme & Refactor

Author: DaevMithran

pricefeeder/price-feeder.toml

@@ -16,12 +16,12 @@ tmrpc_endpoint = "http://localhost:26657"
 enable-hostname = true
 enable-hostname-label = true
 enable-service-label = true
-# This will not be enabled if default telemetry is already enabled in the cheqd app config
+# This will not be enabled if default telemetry is already enabled in the dm app config
 # and the pricefeeder is not running as a separate process (i.e., it is running within the app binary).
 # Pricefeeder metrics will still be recorded regardless.
 enabled = true
-global-labels = [["chain_id", "cheqd"]]
-# This service-name will not be used if default telemetry is already enabled in the cheqd app config
+global-labels = [["chain_id", "dmchain"]]
+# This service-name will not be used if default telemetry is already enabled in the dm app config
 # and the pricefeeder is not running as a separate process (i.e., it is running within the app binary).
 service-name = "price-feeder"
 prometheus-retention-time = 100

util/ptr.go

@@ -5,12 +5,12 @@ import (
 )
 
 const (
-	CheqExponent     = 9
+	DmExponent       = 9
 	UsdScaleExponent = 6
 )
 
 var (
-	CheqScale    = sdkmath.NewIntWithDecimal(1, CheqExponent)
+	DmScale      = sdkmath.NewIntWithDecimal(1, DmExponent)
 	UsdScale     = sdkmath.NewIntWithDecimal(1, UsdScaleExponent)
 	UsdFrom18To6 = sdkmath.NewInt(1_000_000_000_000)
 	UsdExponent  = sdkmath.NewIntWithDecimal(1, 18)

x/oracle/README.md

@@ -1,3 +1,96 @@
-# Example Module
+# Oracle Module
 
-This is a module base generated with [`spawn`](https://github.com/rollchains/spawn).
+## Abstract
+
+This module is a **fork of `ojo-network/x/oracle`**, refactored to utilize the **Cosmos SDK Collections** framework for state management. This ensures type-safety, improved performance through native binary codecs, and a more maintainable schema definition.
+
+## Contents
+
+1. **[Concepts](https://www.google.com/search?q=%23concepts)**
+2. **[State & Collections](https://www.google.com/search?q=%23state--collections)**
+3. **[End Block](https://www.google.com/search?q=%23end-block)**
+4. **[Messages](https://www.google.com/search?q=%23messages)**
+5. **[Events](https://www.google.com/search?q=%23events)**
+6. **[Parameters](https://www.google.com/search?q=%23params)**
+
+## Concepts
+
+### Voting Procedure
+
+The Oracle module obtains consensus via a **Commit-Reveal scheme** over a `VotePeriod`.
+
+* **Prevote and Vote**:
+* `MsgAggregateExchangeRatePrevote`: A SHA256 hash of the rates.
+* `MsgAggregateExchangeRateVote`: The salt and actual rates to reveal the previous period's commitment.
+
+
+* **Vote Tally**: At the end of `VotePeriod`, the module verifies hashes and calculates the **Median** exchange rate. Rates receiving less than `VoteThreshold` power are deleted.
+* **Ballot Rewards**: Winners (those within the `RewardBand`) are rewarded from the reward pool. In this fork, the `ValidatorRewardSet` is cached to optimize reward distribution across the `SlashWindow`.
+
+### Slashing
+
+Validators must maintain a `MinValidPerWindow` (e.g., 5%) success rate. Failure to vote on **all** assets in the `AcceptList` or voting outside the `RewardBand` results in a "miss." If the threshold is not met by the end of a `SlashWindow`, the validator is slashed and jailed.
+
+## State & Collections
+
+This module utilizes `cosmossdk.io/collections` for all on-chain storage. This removes manual byte-prefixing and Protobuf wrapping (e.g., `gogotypes.UInt64Value`) in favor of type-safe Maps and Items.
+
+### Exchange Rates
+
+Stored as a `math.LegacyDec`.
+
+* `ExchangeRates`: `Map<string, math.LegacyDec>`
+* `HistoricPrices`: `Map<Pair<string, uint64>, math.LegacyDec>` (Denom + BlockHeight)
+
+### Validator Management
+
+* **FeederDelegation**: Maps a validator operator to a proxy "feeder" account.
+* `FeederDelegations`: `Map<sdk.ValAddress, sdk.AccAddress>`
+
+
+* **MissCounter**: Tracks missed vote periods.
+* `MissCounters`: `Map<sdk.ValAddress, uint64>`
+
+
+* **ValidatorRewardSet**: A singleton storing the active validators eligible for rewards.
+* `ValidatorRewardSet`: `Item<types.ValidatorRewardSet>`
+
+
+
+### Voting State
+
+* **AggregateExchangeRatePrevote**: `Map<sdk.ValAddress, types.AggregateExchangeRatePrevote>`
+* **AggregateExchangeRateVote**: `Map<sdk.ValAddress, types.AggregateExchangeRateVote>`
+
+### Price Averages (dmchain specific)
+
+The `dmchain` fork includes native support for computed averages:
+
+* `Averages`: `Map<Pair<string, string>, math.LegacyDec>` (Denom + AvgType, e.g., "SMA", "EMA")
+
+## End Block
+
+At the end of every `VotePeriod`:
+
+1. **Purge**: Expired exchange rates are cleared.
+2. **Organize**: Votes are grouped into ballots by denomination.
+3. **Tally**:
+* Calculate the **Median** and **Standard Deviation**.
+* Define the winners within the `RewardBand`.
+
+
+4. **Record**: Update `ExchangeRates` and compute `Averages` (SMA/EMA/WMA).
+5. **Slash/Reward**: Increment `MissCounters`, distribute rewards to `ValidatorRewardSet`, and jail underperforming validators at the end of the `SlashWindow`.
+6. **Cleanup**: Clear previous period votes and prevotes.
+
+## Messages
+
+The module supports the standard Ojo Oracle message set, including:
+
+* `MsgAggregateExchangeRatePrevote`
+* `MsgAggregateExchangeRateVote`
+* `MsgDelegateFeedConsent`
+
+## Params
+
+Parameters are managed via the standard `Params` struct, typically updated via governance. Keys include `VotePeriod`, `VoteThreshold`, `RewardBand`, `SlashWindow`, and the `AcceptList` (denominations to provide prices for).

x/oracle/client/cli/query.go

@@ -74,11 +74,11 @@ func GetCmdQueryAggregateVote() *cobra.Command {
 		Long: strings.TrimSpace(`
 Query outstanding oracle aggregate vote.
 
-$ cheqd-noded query oracle aggregate-votes
+$ simd query oracle aggregate-votes
 
 Or, you can filter with voter address
 
-$ cheqd-noded query oracle aggregate-votes cheqdvaloper...
+$ simd query oracle aggregate-votes cheqdvaloper...
 `),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			clientCtx, err := client.GetClientQueryContext(cmd)
@@ -116,11 +116,11 @@ func GetCmdQueryAggregatePrevote() *cobra.Command {
 		Long: strings.TrimSpace(`
 Query outstanding oracle aggregate prevotes.
 
-$ cheqd-noded query oracle aggregate-prevotes
+$ simd query oracle aggregate-prevotes
 
 Or, can filter with voter address
 
-$ cheqd-noded query oracle aggregate-prevotes cheqdvaloper...
+$ simd query oracle aggregate-prevotes cheqdvaloper...
 `),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			clientCtx, err := client.GetClientQueryContext(cmd)
@@ -158,7 +158,7 @@ func GetCmdQueryExchangeRates() *cobra.Command {
 Query the current exchange rates of assets based on USD.
 You can find the current list of active denoms by running
 
-$ cheqd-noded query oracle exchange-rates
+$ simd query oracle exchange-rates
 `),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			clientCtx, err := client.GetClientQueryContext(cmd)
@@ -185,7 +185,7 @@ func GetCmdQueryExchangeRate() *cobra.Command {
 		Long: strings.TrimSpace(`
 Query the current exchange rates of an asset based on USD.
 
-$ cheqd-noded query oracle exchange-rate ATOM
+$ simd query oracle exchange-rate ATOM
 `),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			clientCtx, err := client.GetClientQueryContext(cmd)

x/oracle/types/codec.go

@@ -27,16 +27,16 @@ func init() {
 // RegisterLegacyAminoCodec registers the necessary x/oracle interfaces and concrete types
 // on the provided LegacyAmino codec. These types are used for Amino JSON serialization.
 func RegisterLegacyAminoCodec(cdc *codec.LegacyAmino) {
-	cdc.RegisterConcrete(&MsgAggregateExchangeRatePrevote{}, "cheqd/oracle/MsgAggregateExchangeRatePrevote", nil)
-	cdc.RegisterConcrete(&MsgAggregateExchangeRateVote{}, "cheqd/oracle/MsgAggregateExchangeRateVote", nil)
-	cdc.RegisterConcrete(&MsgDelegateFeedConsent{}, "cheqd/oracle/MsgDelegateFeedConsent", nil)
-	cdc.RegisterConcrete(&MsgLegacyGovUpdateParams{}, "cheqd/oracle/MsgLegacyGovUpdateParams", nil)
-	cdc.RegisterConcrete(&MsgGovUpdateParams{}, "cheqd/oracle/MsgGovUpdateParams", nil)
-	cdc.RegisterConcrete(&MsgGovAddDenoms{}, "cheqd/oracle/MsgGovAddDenoms", nil)
-	cdc.RegisterConcrete(&MsgGovRemoveCurrencyPairProviders{}, "cheqd/oracle/MsgGovRemoveCurrencyPairProviders", nil)
+	cdc.RegisterConcrete(&MsgAggregateExchangeRatePrevote{}, "dmchain/oracle/MsgAggregateExchangeRatePrevote", nil)
+	cdc.RegisterConcrete(&MsgAggregateExchangeRateVote{}, "dmchain/oracle/MsgAggregateExchangeRateVote", nil)
+	cdc.RegisterConcrete(&MsgDelegateFeedConsent{}, "dmchain/oracle/MsgDelegateFeedConsent", nil)
+	cdc.RegisterConcrete(&MsgLegacyGovUpdateParams{}, "dmchain/oracle/MsgLegacyGovUpdateParams", nil)
+	cdc.RegisterConcrete(&MsgGovUpdateParams{}, "dmchain/oracle/MsgGovUpdateParams", nil)
+	cdc.RegisterConcrete(&MsgGovAddDenoms{}, "dmchain/oracle/MsgGovAddDenoms", nil)
+	cdc.RegisterConcrete(&MsgGovRemoveCurrencyPairProviders{}, "dmchain/oracle/MsgGovRemoveCurrencyPairProviders", nil)
 	cdc.RegisterConcrete(
 		&MsgGovRemoveCurrencyDeviationThresholds{},
-		"cheqd/oracle/MsgGovRemoveCurrencyDeviationThresholds",
+		"dmchain/oracle/MsgGovRemoveCurrencyDeviationThresholds",
 		nil,
 	)
 }

x/oracle/types/currency_pair_providers_test.go

@@ -36,38 +36,38 @@ func TestCurrencyPairProvidersString(t *testing.T) {
 
 func TestCurrencyPairProvidersEqual(t *testing.T) {
 	cpp1 := CurrencyPairProviders{
-		BaseDenom:  "CHEQ",
+		BaseDenom:  "DM",
 		QuoteDenom: "USD",
 		Providers: []string{
 			"binance",
 			"coinbase",
 		},
 	}
 	cpp2 := CurrencyPairProviders{
-		BaseDenom:  "CHEQ",
+		BaseDenom:  "DM",
 		QuoteDenom: "USD",
 		Providers: []string{
 			"binance",
 			"coinbase",
 		},
 	}
 	cpp3 := CurrencyPairProviders{
-		BaseDenom:  "CHEQ",
+		BaseDenom:  "DM",
 		QuoteDenom: "ATOM",
 		Providers: []string{
 			"binance",
 			"coinbase",
 		},
 	}
 	cpp4 := CurrencyPairProviders{
-		BaseDenom:  "CHEQ",
+		BaseDenom:  "DM",
 		QuoteDenom: "USD",
 		Providers: []string{
 			"binance",
 		},
 	}
 	cpp5 := CurrencyPairProviders{
-		BaseDenom:  "CHEQ",
+		BaseDenom:  "DM",
 		QuoteDenom: "ATOM",
 		Providers: []string{
 			"binance",

x/oracle/types/params_test.go

@@ -304,7 +304,7 @@ func TestAddDefaultRB(t *testing.T) {
 	p := DefaultRewardBands()
 	p.AddDefault("foo")
 	require.Equal(t, p.String(),
-		"symbol_denom: CHEQ\nreward_band: \"0.020000000000000000\"\n\n"+
+		"symbol_denom: DM\nreward_band: \"0.020000000000000000\"\n\n"+
 			"symbol_denom: USDT\nreward_band: \"0.020000000000000000\"\n\n"+
 			"symbol_denom: USDC\nreward_band: \"0.020000000000000000\"\n\n"+
 			"symbol_denom: foo\nreward_band: \"0.020000000000000000\"")