feat(perp): Make the collateral denom a stateful collections.Item

CHANGELOG.md

@@ -47,6 +47,7 @@ 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 
@@ -785,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/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 @@
 	}
 	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)
+}

x/common/error.go

@@ -4,6 +4,9 @@
 	"errors"
 	"fmt"
 	"runtime/debug"
+
+	grpccodes "google.golang.org/grpc/codes"
+	grpcstatus "google.golang.org/grpc/status"
 )
 
 // TryCatch is an implementation of the try-catch block from languages like C++ and JS.
@@ -180,3 +183,7 @@
 	}
 	return CombineErrors(errs...)
 }
+
+func ErrNilMsg() error {
+	return grpcstatus.Errorf(grpccodes.InvalidArgument, "nil msg")
+}

x/common/testutil/cli/network.go

@@ -42,6 +42,8 @@ import (
 	stakingtypes "github.com/cosmos/cosmos-sdk/x/staking/types"
 	"google.golang.org/grpc"
 
+	perpV2types "github.com/NibiruChain/nibiru/x/perp/v2/types"
+
 	"github.com/NibiruChain/nibiru/x/common/denoms"
 
 	"github.com/NibiruChain/nibiru/app"
@@ -174,6 +176,7 @@ func BuildNetworkConfig(appGenesis app.GenesisState) Config {
 		BondedTokens:      sdk.TokensFromConsensusPower(100, sdk.DefaultPowerReduction),
 		StartingTokens: sdk.NewCoins(
 			sdk.NewCoin(denoms.NUSD, sdk.TokensFromConsensusPower(1e12, sdk.DefaultPowerReduction)),
+			sdk.NewCoin(perpV2types.TestingCollateralDenomNUSD, sdk.TokensFromConsensusPower(1e12, sdk.DefaultPowerReduction)),
 			sdk.NewCoin(denoms.NIBI, sdk.TokensFromConsensusPower(1e12, sdk.DefaultPowerReduction)),
 			sdk.NewCoin(denoms.USDC, sdk.TokensFromConsensusPower(1e12, sdk.DefaultPowerReduction)),
 		),

x/common/testutil/genesis/perp_genesis.go

@@ -122,6 +122,7 @@ func AddPerpV2Genesis(gen app.GenesisState) app.GenesisState {
 		Amms:               ammsv2,
 		Positions:          []perpv2types.GenesisPosition{},
 		ReserveSnapshots:   []perpv2types.ReserveSnapshot{},
+		CollateralDenom:    perpv2types.TestingCollateralDenomNUSD,
 	}
 
 	gen[perpv2types.ModuleName] = app.MakeEncodingConfig().Marshaler.

x/common/testutil/testapp/testapp.go

@@ -17,6 +17,7 @@ import (
 	"github.com/NibiruChain/nibiru/x/common/denoms"
 	epochstypes "github.com/NibiruChain/nibiru/x/epochs/types"
 	inflationtypes "github.com/NibiruChain/nibiru/x/inflation/types"
+	"github.com/NibiruChain/nibiru/x/perp/v2/types"
 )
 
 // NewNibiruTestAppAndContext creates an 'app.NibiruApp' instance with an
@@ -34,6 +35,8 @@ func NewNibiruTestAppAndContext() (*app.NibiruApp, sdk.Context) {
 	app.OracleKeeper.SetPrice(ctx, asset.Registry.Pair(denoms.BTC, denoms.NUSD), sdk.NewDec(20000))
 	app.OracleKeeper.SetPrice(ctx, "xxx:yyy", sdk.NewDec(20000))
 
+	app.PerpKeeperV2.Collateral.Set(ctx, types.TestingCollateralDenomNUSD)
+
 	return app, ctx
 }