feat: tokenconverter

sunriselayer · May 21, 2024 · 4a19112 · 4a19112
1 parent 5ae328c
commit 4a19112
Show file tree

Hide file tree

Showing 7 changed files with 60 additions and 62 deletions.
diff --git a/api/sunrise/tokenconverter/params.pulsar.go b/api/sunrise/tokenconverter/params.pulsar.go
diff --git a/proto/sunrise/tokenconverter/params.proto b/proto/sunrise/tokenconverter/params.proto
@@ -15,7 +15,7 @@ message Params {
 
   string denom_gov_token = 1;
   string denom_fee_token = 2;
-  string supply_cap_fee_token = 3 [
+  string max_supply_fee_token = 3 [
     (cosmos_proto.scalar)  = "cosmos.Int",
     (gogoproto.customtype) = "cosmossdk.io/math.Int",
     (gogoproto.nullable)   = false,

diff --git a/x/tokenconverter/README.md b/x/tokenconverter/README.md
@@ -1,9 +1,9 @@
 # tokenconverter
 
-This module is for converting `SRG` to `SR` token.
+This module is for converting `SSR` to `SR` token.
 
 $$
-  \text{OutputSR} = \text{InputSSR} \times \min\left(1, \frac{\text{CurrentSupplySR}}{\text{CurrentSupplySSR}} \right) \ \text{if} \ \text{CurrentSupplySR} + \text{OutputSR} \le \text{MaxSupplySR}
+  \text{OutputSR} = \text{InputSSR} \times \min\left(1, \frac{\text{MaxSupplySR}}{\text{CurrentSupplySSR}} \right) \ \text{if} \ \text{CurrentSupplySR} + \text{OutputSR} \le \text{MaxSupplySR}
 $$
 
 ## Ante Handler

diff --git a/x/tokenconverter/keeper/calculation.go b/x/tokenconverter/keeper/calculation.go
@@ -12,21 +12,19 @@ import (
 func (k Keeper) CalculateAmountOutFeeToken(ctx context.Context, amountInGovToken math.Int) math.Int {
 	params := k.GetParams(ctx)
 
-	supplyFee := k.bankKeeper.GetSupply(ctx, params.DenomFeeToken)
 	supplyGov := k.bankKeeper.GetSupply(ctx, params.DenomGovToken)
 
-	output := types.CalculateAmountOutFeeToken(supplyFee.Amount, supplyGov.Amount, amountInGovToken)
+	output := types.CalculateAmountOutFeeToken(params.MaxSupplyFeeToken, supplyGov.Amount, amountInGovToken)
 
 	return output
 }
 
 func (k Keeper) CalculateAmountInGovToken(ctx context.Context, amountOutFeeToken math.Int) math.Int {
 	params := k.GetParams(ctx)
 
-	supplyFee := k.bankKeeper.GetSupply(ctx, params.DenomFeeToken)
 	supplyGov := k.bankKeeper.GetSupply(ctx, params.DenomGovToken)
 
-	input := types.CalculateAmountInGovToken(supplyFee.Amount, supplyGov.Amount, amountOutFeeToken)
+	input := types.CalculateAmountInGovToken(params.MaxSupplyFeeToken, supplyGov.Amount, amountOutFeeToken)
 
 	return input
 }
@@ -45,8 +43,8 @@ func (k Keeper) Convert(ctx context.Context, amountInGovToken math.Int, amountOu
 
 	supplyFee := k.bankKeeper.GetSupply(ctx, params.DenomFeeToken)
 
-	if supplyFee.Amount.Add(amountOutFeeToken).GT(params.SupplyCapFeeToken) {
-		return types.ErrExceedsSupplyCap
+	if supplyFee.Amount.Add(amountOutFeeToken).GT(params.MaxSupplyFeeToken) {
+		return types.ErrExceedsMaxSupply
 	}
 
 	if err := k.bankKeeper.SendCoinsFromAccountToModule(ctx, address, types.ModuleName, sdk.NewCoins(govToken)); err != nil {

diff --git a/x/tokenconverter/types/errors.go b/x/tokenconverter/types/errors.go
@@ -11,7 +11,7 @@ var (
 	ErrInvalidSigner = sdkerrors.Register(ModuleName, 1100, "expected gov account as only signer for proposal message")
 	ErrSample        = sdkerrors.Register(ModuleName, 1101, "sample error")
 
-	ErrExceedsSupplyCap = sdkerrors.Register(ModuleName, 1111, "exceeds supply cap")
+	ErrExceedsMaxSupply = sdkerrors.Register(ModuleName, 1111, "exceeds max supply")
 
 	ErrInsufficientAmountOut = sdkerrors.Register(ModuleName, 1121, "insufficient amount out")
 	ErrExceededAmountIn      = sdkerrors.Register(ModuleName, 1122, "exceeded amount in")

diff --git a/x/tokenconverter/types/params.pb.go b/x/tokenconverter/types/params.pb.go
diff --git a/x/tokenconverter/types/types.go b/x/tokenconverter/types/types.go
@@ -4,8 +4,8 @@ import (
 	"cosmossdk.io/math"
 )
 
-func ratio(supplyFeeToken math.Int, supplyGovToken math.Int) math.LegacyDec {
-	feeDec := math.LegacyNewDecFromInt(supplyFeeToken)
+func ratio(maxSupplyFeeToken math.Int, supplyGovToken math.Int) math.LegacyDec {
+	feeDec := math.LegacyNewDecFromInt(maxSupplyFeeToken)
 	govDec := math.LegacyNewDecFromInt(supplyGovToken)
 	ratio := feeDec.Quo(govDec)
 
@@ -17,14 +17,14 @@ func ratio(supplyFeeToken math.Int, supplyGovToken math.Int) math.LegacyDec {
 
 }
 
-func CalculateAmountOutFeeToken(supplyFeeToken math.Int, supplyGovToken math.Int, amountInGovToken math.Int) math.Int {
-	ratio := ratio(supplyFeeToken, supplyGovToken)
+func CalculateAmountOutFeeToken(maxSupplyFeeToken math.Int, supplyGovToken math.Int, amountInGovToken math.Int) math.Int {
+	ratio := ratio(maxSupplyFeeToken, supplyGovToken)
 
 	return ratio.MulInt(amountInGovToken).TruncateInt()
 }
 
-func CalculateAmountInGovToken(supplyFeeToken math.Int, supplyGovToken math.Int, amountOutFeeToken math.Int) math.Int {
-	ratio := ratio(supplyFeeToken, supplyGovToken)
+func CalculateAmountInGovToken(maxSupplyFeeToken math.Int, supplyGovToken math.Int, amountOutFeeToken math.Int) math.Int {
+	ratio := ratio(maxSupplyFeeToken, supplyGovToken)
 
 	return math.LegacyOneDec().Quo(ratio).MulInt(amountOutFeeToken).TruncateInt()
 }