Merge branch 'master' into dependabot/go_modules/github.com/gorilla/m…

…ux-1.8.1

.github/workflows/changelog-deps.yml

@@ -1,26 +1,28 @@
 name: "Automatically update changelog with dependabot"
-on: 
+on:
   pull_request:
     types: [opened, synchronize, reopened, ready_for_review, labeled, unlabeled]
 
 jobs:
   changelog-update:
     runs-on: ubuntu-latest
+
+    # TODO: feat: try to use author of the commit(s) to see if it's dependabot
+    # ${{ any(contains(commit.author.username, 'dependabot') for commit in github.event.commits) }}
     if: contains(github.event.pull_request.labels.*.name, 'dependabot')
-      # TODO: feat: try to use author of the commit(s) to see if it's dependabot
-      # ${{ any(contains(commit.author.username, 'dependabot') for commit in github.event.commits) }}
-    steps: 
+
+    steps:
       - uses: actions/checkout@v4
         with:
-          token: ${{ secrets.NIBIRU_PM }}
+          token: ${{ secrets.NIBIBOT_GIT_TOKEN }}
           # to avoid checking out the repo in a detached state
           ref: ${{ github.head_ref }}
       # Helps keep your repository up-to-date when Dependabot updates your dependencies.
       # This step updates adds a line to the  "## Unreleased" section
       - uses: dangoslen/dependabot-changelog-helper@v3
         with:
-          activationLabel: 'dependabot'
-          changelogPath: './CHANGELOG.md'
+          activationLabel: "dependabot"
+          changelogPath: "./CHANGELOG.md"
 
       - uses: stefanzweifel/git-auto-commit-action@v5
         with:

.github/workflows/proto-lint.yml

@@ -22,7 +22,7 @@ jobs:
   #     timeout-minutes: 5
   #     steps:
   #       - uses: actions/checkout@v4
-  #       - uses: bufbuild/buf-setup-action@v1.27.2
+  #       - uses: bufbuild/buf-setup-action@v1.28.0
   #       - uses: bufbuild/buf-lint-action@v1
   #         with:
   #           input: "proto"
@@ -31,7 +31,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: bufbuild/buf-setup-action@v1.27.2
+      - uses: bufbuild/buf-setup-action@v1.28.0
         with:
           github_token: ${{ github.token }}
       - uses: bufbuild/buf-breaking-action@v1

CHANGELOG.md

@@ -47,6 +47,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * [#1620](https://github.com/NibiruChain/nibiru/pull/1620) - Token factory transaction messages for Mint and Burn
 * [#1573](https://github.com/NibiruChain/nibiru/pull/1573) - feat(perp): Close markets and compute settlement price
 * [#1632](https://github.com/NibiruChain/nibiru/pull/1632) - feat(perp): Add settle position transaction
+* [#1656](https://github.com/NibiruChain/nibiru/pull/1656) - feat(perp): Make the collateral denom a stateful collections.Item
+* [#1670](https://github.com/NibiruChain/nibiru/pull/1670) - feat(inflation): Make inflation polynomial
 
 ### State Machine Breaking 
 
@@ -71,7 +73,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Dependencies
 - Bump `github.com/prometheus/client_golang` from 1.16.0 to 1.17.0 ([#1605](https://github.com/NibiruChain/nibiru/pull/1605))
-- Bump `bufbuild/buf-setup-action` from 1.26.1 to 1.27.2 ([#1624](https://github.com/NibiruChain/nibiru/pull/1624), [#1641](https://github.com/NibiruChain/nibiru/pull/1641), [#1654](https://github.com/NibiruChain/nibiru/pull/1654))
+- Bump `bufbuild/buf-setup-action` from 1.26.1 to 1.28.0 ([#1624](https://github.com/NibiruChain/nibiru/pull/1624), [#1641](https://github.com/NibiruChain/nibiru/pull/1641), [#1654](https://github.com/NibiruChain/nibiru/pull/1654), [#1671](https://github.com/NibiruChain/nibiru/pull/1671))
 - Bump `stefanzweifel/git-auto-commit-action` from 4 to 5 ([#1625](https://github.com/NibiruChain/nibiru/pull/1625))
 - Bump `github.com/CosmWasm/wasmvm` from 1.4.0 to 1.5.0 ([#1629](https://github.com/NibiruChain/nibiru/pull/1629), [#1657](https://github.com/NibiruChain/nibiru/pull/1657))
 - Bump `google.golang.org/grpc` from 1.58.2 to 1.59.0 ([#1633](https://github.com/NibiruChain/nibiru/pull/1633), [#1643](https://github.com/NibiruChain/nibiru/pull/1643))
@@ -784,4 +786,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Testing
 
 * [#695](https://github.com/NibiruChain/nibiru/pull/695) Add `OpenPosition` integration tests.
-* [#692](https://github.com/NibiruChain/nibiru/pull/692) Add test coverage for Perp MsgServer methods.
+* [#692](https://github.com/NibiruChain/nibiru/pull/692) Add test coverage for Perp MsgServer methods.

app/keepers.go

@@ -364,13 +364,14 @@ func (app *NibiruApp) InitKeepers(
 		appCodec, keys[epochstypes.StoreKey],
 	)
 
+	app.SudoKeeper = keeper.NewKeeper(
+		appCodec, keys[sudotypes.StoreKey],
+	)
+
 	app.PerpKeeperV2 = perpkeeper.NewKeeper(
 		appCodec, keys[perptypes.StoreKey],
 		app.AccountKeeper, app.BankKeeper, app.OracleKeeper, app.EpochsKeeper,
-	)
-
-	app.SudoKeeper = keeper.NewKeeper(
-		appCodec, keys[sudotypes.StoreKey],
+		app.SudoKeeper,
 	)
 
 	app.InflationKeeper = inflationkeeper.NewKeeper(

proto/nibiru/inflation/v1/genesis.proto

@@ -23,14 +23,23 @@ message Params {
   // inflation_enabled is the parameter that enables inflation and halts
   // increasing the skipped_epochs
   bool inflation_enabled = 1;
-  // exponential_calculation takes in the variables to calculate exponential
+  // polynomial_factors takes in the variables to calculate polynomial
   // inflation
-  ExponentialCalculation exponential_calculation = 2
-      [ (gogoproto.nullable) = false ];
+  repeated string polynomial_factors = 2[
+    (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec",
+    (gogoproto.nullable) = false
+  ];
   // inflation_distribution of the minted denom
   InflationDistribution inflation_distribution = 3
       [ (gogoproto.nullable) = false ];
   // epochs_per_period is the number of epochs that must pass before a new
   // period is created
   uint64 epochs_per_period = 4;
+
+  // periods_per_year is the number of periods that occur in a year
+  uint64 periods_per_year = 5;
+
+  // max_period is the maximum number of periods that have inflation being 
+  // paid off. After this period, inflation will be disabled.
+  uint64 max_period = 6;
 }

proto/nibiru/inflation/v1/inflation.proto

@@ -28,25 +28,3 @@ message InflationDistribution {
     (gogoproto.nullable) = false
   ];
 }
-
-// ExponentialCalculation holds factors to calculate exponential inflation on
-// each period. Calculation reference:
-// periodProvision = exponentialDecay
-// f(x)            = a * (1 - r) ^ x + c
-message ExponentialCalculation {
-  // a defines the initial value
-  string a = 1 [
-    (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec",
-    (gogoproto.nullable) = false
-  ];
-  // r defines the reduction factor
-  string r = 2 [
-    (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec",
-    (gogoproto.nullable) = false
-  ];
-  // c defines the parameter for long term inflation
-  string c = 3 [
-    (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec",
-    (gogoproto.nullable) = false
-  ];
-}

proto/nibiru/perp/v2/genesis.proto

@@ -2,9 +2,9 @@ syntax = "proto3";
 
 package nibiru.perp.v2;
 
-import "gogoproto/gogo.proto";
-import "google/api/annotations.proto";
 import "cosmos/base/v1beta1/coin.proto";
+import "google/api/annotations.proto";
+import "gogoproto/gogo.proto";
 import "nibiru/perp/v2/state.proto";
 
 option go_package = "github.com/NibiruChain/nibiru/x/perp/v2/types";
@@ -33,6 +33,9 @@ message GenesisState {
     ];
   }
 
+  // For testing purposes, we allow the collateral to be set at genesis
+  string collateral_denom = 11;
+
   repeated TraderVolume trader_volumes = 7 [ (gogoproto.nullable) = false ];
 
   message Discount {
@@ -81,4 +84,4 @@ message GenesisPosition {
   uint64 version = 2;
 
   Position position = 3 [ (gogoproto.nullable) = false ];
-}
+}

proto/nibiru/perp/v2/tx.proto

@@ -28,6 +28,9 @@ service Msg {
 
   rpc DonateToEcosystemFund(MsgDonateToEcosystemFund)
       returns (MsgDonateToEcosystemFundResponse) {}
+
+  rpc ChangeCollateralDenom(MsgChangeCollateralDenom)
+      returns (MsgChangeCollateralDenomResponse) {}
 }
 
 // -------------------------- Settle Position --------------------------
@@ -328,3 +331,14 @@ message MsgDonateToEcosystemFund {
 }
 
 message MsgDonateToEcosystemFundResponse {}
+
+// -----------------------  MsgChangeCollateralDenom -----------------------
+
+// MsgChangeCollateralDenom: Changes the collateral denom for the module.
+// [Admin] Only callable by sudoers.
+message MsgChangeCollateralDenom {
+  string sender = 1;
+  string new_denom = 2;
+}
+
+message MsgChangeCollateralDenomResponse {}

wasmbinding/exec_perp_test.go

@@ -52,7 +52,7 @@ func (s *TestSuitePerpExecutor) SetupSuite() {
 	})
 	coins := sdk.NewCoins(
 		sdk.NewCoin(denoms.NIBI, sdk.NewInt(1_000_000)),
-		sdk.NewCoin(denoms.NUSD, sdk.NewInt(420_000*69)),
+		sdk.NewCoin(perpv2types.TestingCollateralDenomNUSD, sdk.NewInt(420_000*69)),
 		sdk.NewCoin(denoms.USDT, sdk.NewInt(420_000*69)),
 	)
 	s.NoError(testapp.FundAccount(nibiru.BankKeeper, ctx, sender, coins))
@@ -66,6 +66,7 @@ func (s *TestSuitePerpExecutor) SetupSuite() {
 	s.exec = &wasmbinding.ExecutorPerp{
 		PerpV2: nibiru.PerpKeeperV2,
 	}
+	s.nibiru.PerpKeeperV2.Collateral.Set(s.ctx, perpv2types.TestingCollateralDenomNUSD)
 	s.NoError(testapp.FundAccount(nibiru.BankKeeper, ctx, s.contractPerp, coins))
 
 	s.OnSetupEnd()
@@ -79,7 +80,8 @@ func (s *TestSuitePerpExecutor) OnSetupEnd() {
 // Happy path coverage of MarketOrder, AddMargin, RemoveMargin, and ClosePosition
 func (s *TestSuitePerpExecutor) TestOpenAddRemoveClose() {
 	pair := asset.MustNewPair(s.happyFields.Pair)
-	margin := sdk.NewCoin(denoms.NUSD, sdk.NewInt(69))
+
+	margin := sdk.NewCoin(perpv2types.TestingCollateralDenomNUSD, sdk.NewInt(69))
 	incorrectMargin := sdk.NewCoin(denoms.USDT, sdk.NewInt(69))
 
 	for _, err := range []error{
@@ -243,7 +245,7 @@ func (s *TestSuitePerpExecutor) DoInsuranceFundWithdrawTest(
 		s.nibiru.BankKeeper,
 		s.ctx,
 		perpv2types.PerpEFModuleAccount,
-		sdk.NewCoins(sdk.NewCoin(denoms.NUSD, sdk.NewInt(420))),
+		sdk.NewCoins(sdk.NewCoin(perpv2types.TestingCollateralDenomNUSD, sdk.NewInt(420))),
 	)
 	s.NoError(err)
 
@@ -330,7 +332,7 @@ func (s *TestSuitePerpExecutor) DoSetMarketEnabledTest(
 }
 
 func (s *TestSuitePerpExecutor) TestSadPath_InsuranceFundWithdraw() {
-	fundsToWithdraw := sdk.NewCoin(denoms.NUSD, sdk.NewInt(69_000))
+	fundsToWithdraw := sdk.NewCoin(perpv2types.TestingCollateralDenomNUSD, sdk.NewInt(69_000))
 
 	err := s.DoInsuranceFundWithdrawTest(fundsToWithdraw.Amount, s.contractDeployer)
 	s.Error(err)
@@ -339,7 +341,7 @@ func (s *TestSuitePerpExecutor) TestSadPath_InsuranceFundWithdraw() {
 func (s *TestSuitePerpExecutor) TestSadPaths_InvalidPair() {
 	sadPair := asset.Pair("ftt:ust:doge")
 	pair := sadPair
-	margin := sdk.NewCoin(denoms.NUSD, sdk.NewInt(69))
+	margin := sdk.NewCoin(perpv2types.TestingCollateralDenomNUSD, sdk.NewInt(69))
 
 	for _, err := range []error{
 		s.DoMarketOrderTest(pair),

wasmbinding/exec_test.go

@@ -98,9 +98,11 @@ func (s *TestSuiteExecutor) SetupSuite() {
 		ChainID: "nibiru-wasmnet-1",
 		Time:    time.Now().UTC(),
 	})
+	nibiru.PerpKeeperV2.Collateral.Set(ctx, perpv2types.TestingCollateralDenomNUSD)
+
 	coins := sdk.NewCoins(
 		sdk.NewCoin(denoms.NIBI, sdk.NewInt(10_000_000)),
-		sdk.NewCoin(denoms.NUSD, sdk.NewInt(420_000*69)),
+		sdk.NewCoin(perpv2types.TestingCollateralDenomNUSD, sdk.NewInt(420_000*69)),
 	)
 
 	s.NoError(testapp.FundAccount(nibiru.BankKeeper, ctx, sender, coins))
@@ -110,6 +112,7 @@ func (s *TestSuiteExecutor) SetupSuite() {
 	s.ctx = ctx
 	s.keeper = TestOnlySudoKeeper{Keeper: s.nibiru.SudoKeeper}
 	s.wasmKeeper = wasmkeeper.NewDefaultPermissionKeeper(nibiru.WasmKeeper)
+	s.nibiru.PerpKeeperV2.Collateral.Set(s.ctx, perpv2types.TestingCollateralDenomNUSD)
 
 	s.contractPerp = ContractMap[wasmbin.WasmKeyPerpBinding]
 	s.contractController = ContractMap[wasmbin.WasmKeyController]
@@ -126,10 +129,10 @@ func (s *TestSuiteExecutor) OnSetupEnd() {
 
 func (s *TestSuiteExecutor) TestOpenAddRemoveClose() {
 	pair := asset.MustNewPair(s.happyFields.Pair)
-	margin := sdk.NewCoin(denoms.NUSD, sdk.NewInt(69))
+	margin := sdk.NewCoin(perpv2types.TestingCollateralDenomNUSD, sdk.NewInt(69))
 
 	coins := sdk.NewCoins(
-		margin.Add(sdk.NewCoin(denoms.NUSD, sdk.NewInt(1_000))),
+		margin.Add(sdk.NewCoin(perpv2types.TestingCollateralDenomNUSD, sdk.NewInt(1_000))),
 	)
 	s.NoError(testapp.FundAccount(s.nibiru.BankKeeper, s.ctx, s.contractPerp, coins))
 
@@ -466,7 +469,7 @@ func (s *TestSuiteExecutor) TestInsuranceFundWithdraw() {
 		s.nibiru.BankKeeper,
 		s.ctx,
 		perpv2types.PerpEFModuleAccount,
-		sdk.NewCoins(sdk.NewCoin(denoms.NUSD, sdk.NewInt(420))),
+		sdk.NewCoins(sdk.NewCoin(perpv2types.TestingCollateralDenomNUSD, sdk.NewInt(420))),
 	)
 	s.NoError(err)
 	s.keeper.SetSudoContracts(

wasmbinding/querier_perp_test.go

@@ -94,7 +94,7 @@ func (s *TestSuitePerpQuerier) SetupSuite() {
 	})
 	coins := sdk.NewCoins(
 		sdk.NewCoin(denoms.NIBI, sdk.NewInt(10_000_000)),
-		sdk.NewCoin(denoms.NUSD, sdk.NewInt(1_420_000)),
+		sdk.NewCoin(perpv2types.TestingCollateralDenomNUSD, sdk.NewInt(1_420_000)),
 	)
 	s.NoError(testapp.FundAccount(nibiru.BankKeeper, ctx, sender, coins))
 

x/common/address.go

@@ -1,6 +1,7 @@
 package common
 
 import (
+	"github.com/NibiruChain/collections"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 )
 
@@ -20,3 +21,13 @@ func StringsToAddrs(strs ...string) []sdk.AccAddress {
 	}
 	return addrs
 }
+
+// TODO: (realu) Move to collections library
+var StringValueEncoder collections.ValueEncoder[string] = stringValueEncoder{}
+
+type stringValueEncoder struct{}
+
+func (a stringValueEncoder) Encode(value string) []byte    { return []byte(value) }
+func (a stringValueEncoder) Decode(b []byte) string        { return string(b) }
+func (a stringValueEncoder) Stringify(value string) string { return value }
+func (a stringValueEncoder) Name() string                  { return "string" }

x/common/address_test.go

@@ -3,6 +3,7 @@ package common_test
 import (
 	"testing"
 
+	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
 	"github.com/NibiruChain/nibiru/x/common"
@@ -17,3 +18,25 @@ func TestAddress(t *testing.T) {
 		require.EqualValues(t, addrs, addrsOut)
 	})
 }
+
+func TestStringValueEncoder(t *testing.T) {
+	encoder := common.StringValueEncoder
+	tests := []struct {
+		given string
+	}{
+		{"hello"},
+		{"12345"},
+		{""},
+		{testutil.AccAddress().String()},
+	}
+
+	for _, tc := range tests {
+		t.Run(tc.given, func(t *testing.T) {
+			want := tc.given
+			encoded := encoder.Encode(tc.given)
+			got := encoder.Decode(encoded)
+			assert.Equal(t, want, got)
+			assert.Equal(t, want, encoder.Stringify(got))
+		})
+	}
+}

x/common/constants.go

@@ -1,7 +1,15 @@
 package common
 
+import sdk "github.com/cosmos/cosmos-sdk/types"
+
 const (
 	TreasuryPoolModuleAccount = "treasury_pool"
 	// TO_MICRO: multiplier for converting between units and micro-units.
 	TO_MICRO = int64(1_000_000)
+
+	NibiruTeam = "nibi1l8dxzwz9d4peazcqjclnkj2mhvtj7mpnkqx85mg0ndrlhwrnh7gskkzg0v"
 )
+
+func NibiruTeamAddr() sdk.AccAddress {
+	return sdk.MustAccAddressFromBech32(NibiruTeam)
+}