Add commentt

dydxprotocol · Oct 3, 2024 · 0465101 · 0465101
1 parent 46c33fe
commit 0465101
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/protocol/x/clob/keeper/clob_pair.go b/protocol/x/clob/keeper/clob_pair.go
@@ -34,6 +34,11 @@ func clobPairKey(
 	return lib.Uint32ToKey(id.ToUint32())
 }
 
+// (Same behavior as old `CreatePerpetualClobPair`) creates the
+// objects in state and in-memory.
+// This function should ONLY be used to initialize genesis state
+// or test setups.
+// Regular CLOB logic should use `CreatePerpetualClobPair` instead.
 func (k Keeper) CreatePerpetualClobPairAndMemStructs(
 	ctx sdk.Context,
 	clobPairId uint32,