-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #314 from Concordium/Energy-to-ccd
Convenience functions issue #272
- Loading branch information
Showing
14 changed files
with
573 additions
and
40 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
137 changes: 137 additions & 0 deletions
137
concordium-sdk/src/main/java/com/concordium/sdk/CurrencyConverter.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,137 @@ | ||
| package com.concordium.sdk; | ||
|
|
||
| import com.concordium.sdk.requests.smartcontracts.Energy; | ||
| import com.concordium.sdk.responses.chainparameters.ChainParameters; | ||
| import com.concordium.sdk.transactions.CCDAmount; | ||
| import com.concordium.sdk.types.ConversionResult; | ||
| import com.concordium.sdk.types.UInt64; | ||
|
|
||
| import static com.concordium.sdk.types.ConversionResult.*; | ||
|
|
||
| /** | ||
| * Utility class for converting between {@link CCDAmount}, {@link Energy} and Euros. | ||
| * Represents converted values using {@link ConversionResult} to ensure precision. | ||
| */ | ||
| public class CurrencyConverter { | ||
|
|
||
| /** | ||
| * Converts {@link Energy} to euro using exchange rate from the provided {@link ChainParameters}. | ||
| * | ||
| * @param energy {@link Energy} to convert. | ||
| * @param parameters {@link ChainParameters} with exchange rate used for conversion. | ||
| * @return {@link ConversionResult} corresponding to the euro value of {@link Energy}. | ||
| */ | ||
| public static ConversionResult<EUR> energyToEuro(Energy energy, ChainParameters parameters) { | ||
| ConversionResult<NRG> energyFraction = from(energy.getValue(), UInt64.from(1)); | ||
| return energyToEuro(energyFraction, parameters); | ||
| } | ||
|
|
||
| /** | ||
| * Converts {@link ConversionResult} representing {@link Energy} to euro using exchange rate from the provided {@link ChainParameters}. | ||
| * | ||
| * @param energy {@link ConversionResult} representing an amount of {@link Energy} to convert. | ||
| * @param parameters {@link ChainParameters} with exchange rate used for conversion. | ||
| * @return {@link ConversionResult} corresponding to the euro value of {@link Energy}. | ||
| */ | ||
| public static ConversionResult<EUR> energyToEuro(ConversionResult<NRG> energy, ChainParameters parameters) { | ||
| ConversionResult<ConversionRate> euroPerEnergy = from(parameters.getEuroPerEnergy()); | ||
| return energy.mult(euroPerEnergy); | ||
| } | ||
|
|
||
| /** | ||
| * Converts {@link Energy} to micro CCD using exchange rate from the provided {@link ChainParameters}. | ||
| * | ||
| * @param energy {@link Energy} to convert. | ||
| * @param parameters {@link ChainParameters} with exchange rate used for conversion. | ||
| * @return {@link ConversionResult} corresponding to the micro CCD value of {@link Energy}. | ||
| */ | ||
| public static ConversionResult<microCCD> energyToMicroCCD(Energy energy, ChainParameters parameters) { | ||
| ConversionResult<NRG> energyFraction = from(energy.getValue(), UInt64.from(1)); | ||
| return energyToMicroCCD(energyFraction, parameters); | ||
| } | ||
|
|
||
| /** | ||
| * Converts {@link ConversionResult} representing {@link Energy} to micro CCD using exchange rate from the provided {@link ChainParameters}. | ||
| * | ||
| * @param energy {@link ConversionResult} representing an amount of {@link Energy} to convert. | ||
| * @param parameters {@link ChainParameters} with exchange rate used for conversion. | ||
| * @return {@link ConversionResult} corresponding to the micro CCD value of {@link Energy}. | ||
| */ | ||
| public static ConversionResult<microCCD> energyToMicroCCD(ConversionResult<NRG> energy, ChainParameters parameters) { | ||
| ConversionResult<EUR> euros = energyToEuro(energy, parameters); | ||
| return euroToMicroCCD(euros, parameters); | ||
| } | ||
|
|
||
| /** | ||
| * Converts {@link CCDAmount} to euros using exchange rate from the provided {@link ChainParameters}. | ||
| * | ||
| * @param ccdAmount {@link CCDAmount} to convert. | ||
| * @param parameters {@link ChainParameters} with exchange rate used for conversion. | ||
| * @return {@link ConversionResult} corresponding to the euro value of {@link CCDAmount}. | ||
| */ | ||
| public static ConversionResult<EUR> microCCDToEuro(CCDAmount ccdAmount, ChainParameters parameters) { | ||
| ConversionResult<microCCD> ccd = from(ccdAmount.getValue(), UInt64.from(1)); | ||
| return microCCDToEuro(ccd, parameters); | ||
| } | ||
|
|
||
| /** | ||
| * Converts {@link ConversionResult} representing {@link CCDAmount} to euros using exchange rate from the provided {@link ChainParameters}. | ||
| * | ||
| * @param ccd {@link ConversionResult} representing {@link CCDAmount} to convert. | ||
| * @param parameters {@link ChainParameters} with exchange rate used for conversion. | ||
| * @return {@link ConversionResult} corresponding to the euro value of {@link CCDAmount}. | ||
| */ | ||
| public static ConversionResult<EUR> microCCDToEuro(ConversionResult<microCCD> ccd, ChainParameters parameters) { | ||
| ConversionResult<ConversionRate> microCCDPerEuro = from(parameters.getMicroCCDPerEuro()); | ||
| return ccd.div(microCCDPerEuro); | ||
| } | ||
|
|
||
| /** | ||
| * Converts {@link CCDAmount} to energy using exchange rate from the provided {@link ChainParameters}. | ||
| * | ||
| * @param ccdAmount{@link CCDAmount} to convert. | ||
| * @param parameters {@link ChainParameters} with exchange rate used for conversion. | ||
| * @return {@link ConversionResult} corresponding to the energy value of {@link CCDAmount}. | ||
| */ | ||
| public static ConversionResult<NRG> ccdToEnergy(CCDAmount ccdAmount, ChainParameters parameters) { | ||
| ConversionResult<microCCD> ccd = from(ccdAmount.getValue(), UInt64.from(1)); | ||
| return ccdToEnergy(ccd, parameters); | ||
| } | ||
|
|
||
| /** | ||
| * Converts {@link ConversionResult} representing {@link CCDAmount} to energy using exchange rate from the provided {@link ChainParameters}. | ||
| * | ||
| * @param ccdAmount {@link ConversionResult} representing {@link CCDAmount} to convert. | ||
| * @param parameters {@link ChainParameters} with exchange rate used for conversion. | ||
| * @return {@link ConversionResult} corresponding to the energy value of {@link CCDAmount}. | ||
| */ | ||
| public static ConversionResult<NRG> ccdToEnergy(ConversionResult<microCCD> ccdAmount, ChainParameters parameters) { | ||
| ConversionResult<EUR> euros = microCCDToEuro(ccdAmount, parameters); | ||
| return euroToEnergy(euros, parameters); | ||
| } | ||
|
|
||
| /** | ||
| * Converts {@link ConversionResult} representing an amount of euros to micro CCD using exchange rate from the provided {@link ChainParameters}. | ||
| * | ||
| * @param euros {@link ConversionResult} representing amount of euros to convert. | ||
| * @param parameters {@link ChainParameters} with exchange rate used for conversion. | ||
| * @return {@link ConversionResult} corresponding to the micro CCD value of the input. | ||
| */ | ||
| public static ConversionResult<microCCD> euroToMicroCCD(ConversionResult<EUR> euros, ChainParameters parameters) { | ||
| ConversionResult<ConversionRate> microCCDPerEuro = from(parameters.getMicroCCDPerEuro()); | ||
| return euros.mult(microCCDPerEuro); | ||
| } | ||
|
|
||
| /** | ||
| * Converts {@link ConversionResult} representing an amount of euros to energy using exchange rate from the provided {@link ChainParameters}. | ||
| *† | ||
| * @param euros {@link ConversionResult} representing amount of euros to convert. | ||
| * @param parameters {@link ChainParameters} with exchange rate used for conversion. | ||
| * @return {@link ConversionResult} corresponding to the energy value of the input. | ||
| */ | ||
| public static ConversionResult<NRG> euroToEnergy(ConversionResult<EUR> euros, ChainParameters parameters) { | ||
| ConversionResult<ConversionRate> euroPerEnergy = from(parameters.getEuroPerEnergy()); | ||
| return euros.div(euroPerEnergy); | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.