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

[Upgrade][DO NOT update branch] Alpha TestNet v0.0.11 #967

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions app/upgrades.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import (
var allUpgrades = []upgrades.Upgrade{
upgrades.Upgrade_0_0_4,
upgrades.Upgrade_0_0_10,
upgrades.Upgrade_0_0_11,
}

// setUpgrades sets upgrade handlers for all upgrades and executes KVStore migration if an upgrade plan file exists.
Expand Down
99 changes: 99 additions & 0 deletions app/upgrades/v0.0.11.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
package upgrades

import (
"context"

storetypes "cosmossdk.io/store/types"
upgradetypes "cosmossdk.io/x/upgrade/types"
cosmosTypes "github.com/cosmos/cosmos-sdk/types"
"github.com/cosmos/cosmos-sdk/types/module"
"github.com/pokt-network/poktroll/app/keepers"
sessiontypes "github.com/pokt-network/poktroll/x/session/types"
tokenomicstypes "github.com/pokt-network/poktroll/x/tokenomics/types"
)

// Upgrade_0_0_11 is the upgrade handler for v0.0.11 Alpha TestNet upgrade
// Beta TestNet was launched with v0.0.11, so this upgrade is exclusively for Alpha TestNet.
// - Before: v0.0.10
// - After: v0.0.11
var Upgrade_0_0_11 = Upgrade{
PlanName: "v0.0.11",
CreateUpgradeHandler: func(mm *module.Manager,
keepers *keepers.Keepers,
configurator module.Configurator,
) upgradetypes.UpgradeHandler {

// Adds new parameters using ignite's config.yml as a reference. Assuming we don't need any other parameters.
// https://github.com/pokt-network/poktroll/compare/v0.0.10...v0.0.11-rc
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should this be -rc or just 0.1?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It should be an -rc here. We created RC release to bootstrap beta TestNet. The release must have this code (the upgrade handler) inside the binary. So we're just using the RC as a version to create a release on.

applyNewParameters := func(ctx context.Context) (err error) {
logger := cosmosTypes.UnwrapSDKContext(ctx).Logger()
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks @bryanchriswhite for the hint!

logger.Info("Starting parameter updates for v0.0.11")

// Set num_suppliers_per_session to 15
// Validate with: `poktrolld q session params --node=https://testnet-validated-validator-rpc.poktroll.com/`
sessionParams := sessiontypes.Params{
NumSuppliersPerSession: uint64(15),
}

// ALL parameters must be present when setting params.
err = keepers.SessionKeeper.SetParams(ctx, sessionParams)
if err != nil {
logger.Error("Failed to set session params", "error", err)
return err
}
logger.Info("Successfully updated session params", "new_params", sessionParams)

// Set tokenomics params. The values are based on default values for LocalNet/Beta TestNet.
// Validate with: `poktrolld q tokenomics params --node=https://testnet-validated-validator-rpc.poktroll.com/`
tokenomicsParams := tokenomicstypes.Params{
MintAllocationPercentages: tokenomicstypes.MintAllocationPercentages{
Dao: 0.1,
Proposer: 0.05,
Supplier: 0.7,
SourceOwner: 0.15,
Application: 0.0,
},
DaoRewardAddress: AlphaTestNetPnfAddress,
}

// ALL parameters must be present when setting params.
err = keepers.TokenomicsKeeper.SetParams(ctx, tokenomicsParams)
if err != nil {
logger.Error("Failed to set tokenomics params", "error", err)
return err
}
logger.Info("Successfully updated tokenomics params", "new_params", tokenomicsParams)

return
}

// The diff shows that the only new authz authorization is for the `poktroll.session.MsgUpdateParam` message.
// However, this message is already authorized for the `pokt10d07y265gmmuvt4z0w9aw880jnsr700j8yv32t` address.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this the alpha or beta PNF address

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Neither/both? This is a gov module address that persists across networks.

// See here: poktrolld q authz grants-by-granter pokt10d07y265gmmuvt4z0w9aw880jnsr700j8yv32t --node=https://shannon-testnet-grove-seed-rpc.alpha.poktroll.com
// If this upgrade would have been applied to other networks, we could have added a separate upgrade handler for each network.

// Returns the upgrade handler for v0.0.11
return func(ctx context.Context, plan upgradetypes.Plan, vm module.VersionMap) (module.VersionMap, error) {
logger := cosmosTypes.UnwrapSDKContext(ctx).Logger()
logger.Info("Starting v0.0.11 upgrade handler")

err := applyNewParameters(ctx)
if err != nil {
logger.Error("Failed to apply new parameters", "error", err)
return vm, err
}

logger.Info("Running module migrations")
vm, err = mm.RunMigrations(ctx, configurator, vm)
if err != nil {
logger.Error("Failed to run migrations", "error", err)
return vm, err
}

logger.Info("Successfully completed v0.0.11 upgrade handler")
return vm, nil
}
},
// No changes to the KVStore in this upgrade.
StoreUpgrades: storetypes.StoreUpgrades{},
}
8 changes: 3 additions & 5 deletions cmd/poktrolld/cmd/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,10 @@ type PoktrollAppConfig struct {
}

// poktrollAppConfigDefaults sets default values to render in `app.toml`.
// Checkout `customAppConfigTemplate()` for additional information about each setting.
// Checkout `customAppConfigTemplate()` for additional information about each config parameter.
func poktrollAppConfigDefaults() PoktrollAppConfig {
return PoktrollAppConfig{
Telemetry: telemetry.PoktrollTelemetryConfig{
CardinalityLevel: "medium",
},
Telemetry: telemetry.DefaultConfig(),
}
}

Expand Down Expand Up @@ -104,7 +102,6 @@ func initCometBFTConfig() *cmtcfg.Config {
// return "", nil if no custom configuration is required for the application.
// TODO_MAINNET: Reconsider values - check `app.toml` for possible options.
func initAppConfig() (string, interface{}) {
// The following code snippet is just for reference.
type CustomAppConfig struct {
serverconfig.Config `mapstructure:",squash"`
Poktroll PoktrollAppConfig `mapstructure:"poktroll"`
Expand Down Expand Up @@ -140,6 +137,7 @@ func initAppConfig() (string, interface{}) {
srvCfg.GRPC.Enable = true
srvCfg.GRPCWeb.Enable = true

// Create the custom config with both server and poktroll configs
customAppConfig := CustomAppConfig{
Config: *srvCfg,
Poktroll: poktrollAppConfigDefaults(),
Expand Down
14 changes: 14 additions & 0 deletions telemetry/defaults.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
package telemetry

// Default configuration values for telemetry
const (
// DefaultCardinalityLevel represents the default cardinality level for metrics collection
DefaultCardinalityLevel = "medium"
)

// DefaultConfig returns the default telemetry configuration
func DefaultConfig() PoktrollTelemetryConfig {
return PoktrollTelemetryConfig{
CardinalityLevel: DefaultCardinalityLevel,
}
}
23 changes: 19 additions & 4 deletions telemetry/telemetry.go
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,31 @@ import (
// Set once on initialization and remains constant during runtime.
var globalTelemetryConfig PoktrollTelemetryConfig

// PoktrollTelemetryConfig represents the telemetry protion of the custom poktroll config section in `app.toml`.
// PoktrollTelemetryConfig represents the telemetry portion of the custom poktroll config section in `app.toml`.
type PoktrollTelemetryConfig struct {
CardinalityLevel string `mapstructure:"cardinality-level"`
}

// New sets the globalTelemetryConfig for telemetry package.
func New(appOpts servertypes.AppOptions) error {
// Extract the map from appOpts.
// `poktroll.telemetry` comes from `app.toml` which is parsed into a map.
telemetryMap := appOpts.Get("poktroll.telemetry").(map[string]interface{})
// Get the poktroll config section. If it doesn't exist, use defaults
poktrollConfig := appOpts.Get("poktroll")
if poktrollConfig == nil {
globalTelemetryConfig = DefaultConfig()
return nil
}

// Try to get the telemetry subsection
poktrollMap, ok := poktrollConfig.(map[string]interface{})
if !ok {
return fmt.Errorf("invalid poktroll config format: expected map[string]interface{}, got %T", poktrollConfig)
}

telemetryMap, ok := poktrollMap["telemetry"].(map[string]interface{})
if !ok {
globalTelemetryConfig = DefaultConfig()
return nil
}

// Use mapstructure to decode the map into the struct
if err := mapstructure.Decode(telemetryMap, &globalTelemetryConfig); err != nil {
Expand Down
Loading