@galacticcouncil/sdk 0.5.0 → 0.5.2

package/dist/types/index.d.ts

@@ -8,3 +8,4 @@ export * from './types';
 export * from './errors';
 export * from './consts';
 export * from './utils/bignumber';
+export * from './utils/math';

package/dist/types/types.d.ts

@@ -4,12 +4,13 @@ export type PoolAsset = {
     symbol: string;
 };
 export declare enum PoolType {
-    XYK = "XYK",
-    LBP = "LBP",
-    Stable = "Stable",
-    Omni = "Omni"
+    XYK = "Xyk",
+    LBP = "Lbp",
+    Stable = "Stableswap",
+    Omni = "Omnipool"
 }
 export declare enum PoolError {
+    UnknownError = "UnknownError",
     InsufficientTradingAmount = "InsufficientTradingAmount",
     MaxInRatioExceeded = "MaxInRatioExceeded",
     MaxOutRatioExceeded = "MaxOutRatioExceeded"
@@ -76,7 +77,7 @@ export interface Transaction {
     get<T>(): T;
 }
 export type Hop = {
-    poolType: PoolType;
+    pool: PoolType;
     poolId: string;
     assetIn: string;
     assetOut: string;

package/dist/types/utils/math.d.ts

@@ -4,13 +4,34 @@ import { BigNumber } from './bignumber';
  *
  * (|𝑉1−𝑉2| / [(𝑉1+𝑉2)/2]) × 100
  *
- * @param amount - Amount of asset in/out
- * @param decimals - Decimals of given asset
- * @param spotPrice - Spot price
- * @param calculatedAmount - Calculated amount of asset out/in
- * @returns Price impact percentage
+ * This formula calculates the percentage difference by comparing
+ * the absolute difference between the two values with their <b>average</b>.
+ *
+ * Usage: It's used when you want to find the percentage difference between
+ * two quantities where both quantities are significant.
+ *
+ * @param v1 - 1st value
+ * @param v2 - 2nd value
+ * @returns Difference between two values in relation to their average
+ */
+export declare function calculateDiffToAvg(v1: BigNumber, v2: BigNumber): BigNumber;
+/**
+ * Percentage Difference Formula (Relative Change)
+ *
+ * ((Vfin-Vref) / Vref) * 100
+ *
+ * This formula calculates the percentage difference by comparing
+ * the absolute difference between the two values with the <b>reference value</b>.
+ *
+ * Usage: This formula isn't suitable for finding percentage differences
+ * when the values being compared are not reference and final values of the
+ * same quantity.
+ *
+ * @param vFin - final value
+ * @param vRef - reference value
+ * @returns Difference between a final value and a reference value in relation to the reference value
  */
-export declare function calculatePriceImpact(amount: BigNumber, decimals: number, spotPrice: BigNumber, calculatedAmount: BigNumber): BigNumber;
+export declare function calculateDiffToRef(vFin: BigNumber, vRef: BigNumber): BigNumber;
 /**
  * The total fee paid for a ‘sell’ transaction
  * Suppose the trader is selling X for Y
@@ -22,7 +43,7 @@ export declare function calculatePriceImpact(amount: BigNumber, decimals: number
  */
 export declare function calculateSellFee(delta0Y: BigNumber, deltaY: BigNumber): BigNumber;
 /**
- * The total fee paid for a buy transaction
+ * The total fee paid for a ‘buy‘ transaction
  * Suppose the trader is buying Y using X
  *
  * fee = (deltaX / delta0X) - 1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galacticcouncil/sdk",
-  "version": "0.5.0",
+  "version": "0.5.2",
   "private": false,
   "description": "Galactic SDK",
   "author": "Pavol Noha <palo@hydradx.io>",
@@ -15,7 +15,7 @@
     "test:coverage": "jest --coverage",
     "pckg:build": "npm run cleanup && npm run build",
     "pckg:beta": "npm run pckg:build && npm publish --tag beta",
-    "pckg:release": "npm run pckg:build && npm release",
+    "pckg:release": "npm run pckg:build && standard-version --tag-prefix=''",
     "pckg:publish": "git push --follow-tags origin master && npm publish",
     "xcmgr:sync": "node ./xcmgr.sync.mjs"
   },