Merge pull request #2707 from threefoldtech/development_add_tft_class

Add currency abstraction

packages/grid_client/scripts/tft.ts

@@ -0,0 +1,85 @@
+import { CurrencyModel } from "../src";
+import { currency as TFTUSDConversionService } from "../src";
+import { getClient } from "./client_loader";
+import { log } from "./utils";
+
+let currency: TFTUSDConversionService;
+
+function convertTFTtoUSD(amount) {
+  const res = currency.convertTFTtoUSD(amount);
+  log("================= Convert TFT =================");
+  log(res);
+  log("================= Convert TFT =================");
+}
+
+function convertUSDtoTFT(amount) {
+  const res = currency.convertUSDtoTFT(amount);
+  log("================= Convert USD =================");
+  log(res);
+  log("================= Convert USD =================");
+}
+
+function dailyTFT(hourlyTFT) {
+  const res = currency.dailyTFT(hourlyTFT);
+  log("================= Daily TFT =================");
+  log(res);
+  log("================= Daily TFT =================");
+}
+
+function monthlyTFT(hourlyTFT) {
+  const res = currency.monthlyTFT(hourlyTFT);
+  log("================= Monthly TFT =================");
+  log(res);
+  log("================= Monthly TFT =================");
+}
+
+function yearlyTFT(hourlyTFT) {
+  const res = currency.yearlyTFT(hourlyTFT);
+  log("================= Yearly TFT =================");
+  log(res);
+  log("================= Yearly TFT =================");
+}
+
+function dailyUSD(hourlyUSD) {
+  const res = currency.dailyUSD(hourlyUSD);
+  log("================= Daily USD =================");
+  log(res);
+  log("================= Daily USD =================");
+}
+
+function monthlyUSD(hourlyUSD) {
+  const res = currency.monthlyUSD(hourlyUSD);
+  log("================= Monthly USD =================");
+  log(res);
+  log("================= Monthly USD =================");
+}
+
+function yearlyUSD(hourlyUSD) {
+  const res = currency.yearlyUSD(hourlyUSD);
+  log("================= Yearly USD =================");
+  log(res);
+  log("================= Yearly USD =================");
+}
+async function main() {
+  const grid = await getClient();
+  const rate = await grid.tfclient.tftPrice.get();
+  const decimals = 3;
+  currency = new TFTUSDConversionService(rate, decimals);
+
+  const amount: CurrencyModel = {
+    amount: 1,
+  };
+
+  convertTFTtoUSD(amount);
+  convertUSDtoTFT(amount);
+  dailyTFT(amount);
+  monthlyTFT(amount);
+  yearlyTFT(amount);
+  dailyUSD(amount);
+  monthlyUSD(amount);
+  yearlyUSD(amount);
+
+  await grid.disconnect();
+}
+
+main();

packages/grid_client/src/client.ts

@@ -13,7 +13,7 @@ import { isExposed } from "./helpers/expose";
 import { formatErrorMessage, generateString } from "./helpers/utils";
 import * as modules from "./modules/index";
 import { appPath } from "./storage/backend";
-import { BackendStorage, BackendStorageType } from "./storage/backend";
+import { BackendStorageType } from "./storage/backend";
 import { KeypairType } from "./zos/deployment";
 
 class GridClient {
@@ -41,6 +41,7 @@ class GridClient {
   stellar: modules.stellar;
   blockchain: modules.blockchain;
   calculator: modules.calculator;
+  currency: modules.currency;
   utility: modules.utility;
   farmerbot: modules.farmerbot;
   farms: modules.farms;

packages/grid_client/src/helpers/validator.ts

@@ -1,9 +1,9 @@
 import { ValidationError } from "@threefold/types";
 import { plainToInstance } from "class-transformer";
-import { validate } from "class-validator";
+import { validateSync } from "class-validator";
 
-async function validateObject(obj) {
-  const errors = await validate(obj);
+function validateObject(obj) {
+  const errors = validateSync(obj);
   // errors is an array of validation errors
   if (errors.length > 0) {
     console.log("Validation failed. errors:", errors);
@@ -13,13 +13,13 @@ async function validateObject(obj) {
 // used as decorator
 function validateInput(target, propertyKey: string, descriptor: PropertyDescriptor) {
   const method = descriptor.value;
-  descriptor.value = async function (...args) {
+  descriptor.value = function (...args) {
     const types = Reflect.getMetadata("design:paramtypes", target, propertyKey);
     for (let i = 0; i < args.length; i++) {
       const input = plainToInstance(types[i], args[i], { excludeExtraneousValues: true });
-      await validateObject(input);
+      validateObject(input);
     }
-    return await method.apply(this, args);
+    return method.apply(this, args);
   };
 }
 

packages/grid_client/src/modules/index.ts

@@ -22,4 +22,5 @@ export * from "./farmerbot";
 export * from "./farms";
 export * from "./networks";
 export * from "./bridge";
+export * from "./tft";
 export * from "./base";

packages/grid_client/src/modules/models.ts

@@ -832,6 +832,10 @@ class GetActiveContractsModel {
   @Expose() @IsInt() @IsNotEmpty() @Min(1) nodeId: number;
 }
 
+class CurrencyModel {
+  @Expose() @IsNumber() @IsNotEmpty() @Min(0) amount: number; // hourly amount
+}
+
 interface GPUCardInfo {
   id: string;
   contract: number;
@@ -977,4 +981,5 @@ export {
   NodeCPUTest,
   NodeIPValidation,
   NodeIPerf,
+  CurrencyModel,
 };

packages/grid_client/src/modules/tft.ts

@@ -0,0 +1,77 @@
+import Decimal from "decimal.js";
+
+import { expose, validateInput } from "../helpers";
+import { CurrencyModel } from "./models";
+
+class TFTUSDConversionService {
+  // TFT rate: 1 TFT = x USD
+  constructor(protected rate: number, private decimals = 2) {}
+
+  get _rate() {
+    return this.rate;
+  }
+
+  @expose
+  @validateInput
+  normalizeCurrency(options: CurrencyModel): string {
+    return new Decimal(options.amount).toFixed(this.decimals);
+  }
+
+  @expose
+  @validateInput
+  convertUSDtoTFT(options: CurrencyModel): string {
+    const amount = options.amount / this.rate;
+    return this.normalizeCurrency({ amount });
+  }
+
+  @expose
+  @validateInput
+  convertTFTtoUSD(options: CurrencyModel): string {
+    const amount = options.amount * this.rate;
+    return this.normalizeCurrency({ amount });
+  }
+
+  @expose
+  @validateInput
+  dailyTFT(options: CurrencyModel): string {
+    const hours = options.amount * 24;
+    return this.normalizeCurrency({ amount: hours });
+  }
+
+  @expose
+  @validateInput
+  monthlyTFT(options: CurrencyModel): string {
+    const months = +this.dailyTFT(options) * 30;
+    return this.normalizeCurrency({ amount: months });
+  }
+
+  @expose
+  @validateInput
+  yearlyTFT(options: CurrencyModel): string {
+    const years = +this.monthlyTFT(options) * 12;
+    return this.normalizeCurrency({ amount: years });
+  }
+
+  @expose
+  @validateInput
+  dailyUSD(options: CurrencyModel): string {
+    const hours = options.amount * 24;
+    return this.normalizeCurrency({ amount: hours });
+  }
+
+  @expose
+  @validateInput
+  monthlyUSD(options: CurrencyModel): string {
+    const months = +this.dailyUSD(options) * 30;
+    return this.normalizeCurrency({ amount: months });
+  }
+
+  @expose
+  @validateInput
+  yearlyUSD(options: CurrencyModel): string {
+    const years = +this.monthlyUSD(options) * 12;
+    return this.normalizeCurrency({ amount: years });
+  }
+}
+
+export { TFTUSDConversionService as currency };