@orbs-network/twap 1.5.11-0 → 1.5.12

package/dist/src/lib.d.ts

@@ -13,6 +13,7 @@ export declare class TWAPLib {
     constructor(config: Config, maker: string, provider?: any);
     dstAmount: (srcToken: TokenData, dstToken: TokenData, srcAmount: BN.Value, srcUsdMarket: BN.Value, dstUsdMarket: BN.Value, limitDstPriceFor1Src: BN.Value, isMarketOrder: boolean) => BN;
     isNativeToken: (token: TokenData) => boolean;
+    isWrappedToken: (token: TokenData) => boolean;
     isValidChain: (chainId: number) => boolean;
     maxPossibleChunks: (srcToken: TokenData, srcAmount: BN.Value, srcUsd: BN.Value) => number;
     srcChunkAmount: (srcAmount: BN.Value, totalChunks: BN.Value) => BN;
@@ -28,6 +29,7 @@ export declare class TWAPLib {
     waitForConfirmation<T>(fn: () => Promise<T>): Promise<T>;
     hasAllowance(srcToken: TokenData, amount: BN.Value): Promise<boolean>;
     approve(srcToken: TokenData, amount: BN.Value, priorityFeePerGas?: BN.Value, maxFeePerGas?: BN.Value): Promise<void>;
+    validateTokens(srcToken: TokenData, dstToken: TokenData): TokensValidation;
     validateOrderInputs(srcToken: TokenData, dstToken: TokenData, srcAmount: BN.Value, srcChunkAmount: BN.Value, dstMinChunkAmountOut: BN.Value, deadline: BN.Value, fillDelaySeconds: BN.Value, srcUsd: BN.Value): OrderInputValidation;
     submitOrder(srcToken: TokenData, dstToken: TokenData, srcAmount: BN.Value, srcChunkAmount: BN.Value, dstMinChunkAmountOut: BN.Value, deadline: number, fillDelaySeconds: number, srcUsd: BN.Value, priorityFeePerGas?: BN.Value, maxFeePerGas?: BN.Value): Promise<number>;
     getOrder(id: number): Promise<Order>;
@@ -71,7 +73,7 @@ export declare enum Status {
 }
 export declare enum OrderInputValidation {
     valid = "valid",
-    equalTokens = "equalTokens",
+    invalidTokens = "invalidTokens",
     invalidSrcAmount = "invalidSrcAmount",
     invalidSrcChunkAmount = "invalidSrcChunkAmount",
     invalidDstMinChunkAmountOut = "invalidDstMinChunkAmountOut",
@@ -80,3 +82,11 @@ export declare enum OrderInputValidation {
     invalidSrcUsd = "invalidSrcUsd",
     invalidSmallestSrcChunkUsd = "invalidSmallestSrcChunkUsd"
 }
+export declare enum TokensValidation {
+    valid = "valid",
+    invalid = "invalid",
+    wrapOnly = "wrapOnly",
+    unwrapOnly = "unwrapOnly",
+    wrapAndOrder = "wrapAndOrder",
+    dstTokenZero = "dstTokenZero"
+}

package/dist/src/lib.js

@@ -12,7 +12,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OrderInputValidation = exports.Status = exports.TWAPLib = exports.lensAbi = exports.twapAbi = void 0;
+exports.TokensValidation = exports.OrderInputValidation = exports.Status = exports.TWAPLib = exports.lensAbi = exports.twapAbi = void 0;
 const configs_1 = require("./configs");
 const web3_1 = __importDefault(require("web3"));
 const bignumber_js_1 = __importDefault(require("bignumber.js"));
@@ -29,6 +29,7 @@ class TWAPLib {
         this.provider = provider;
         this.dstAmount = (srcToken, dstToken, srcAmount, srcUsdMarket, dstUsdMarket, limitDstPriceFor1Src, isMarketOrder) => (0, web3_candies_1.convertDecimals)(isMarketOrder ? (0, bignumber_js_1.default)(srcAmount).times(srcUsdMarket).div(dstUsdMarket) : (0, bignumber_js_1.default)(srcAmount).times(limitDstPriceFor1Src), srcToken.decimals, dstToken.decimals).integerValue(bignumber_js_1.default.ROUND_FLOOR);
         this.isNativeToken = (token) => (0, configs_1.isNativeAddress)(token.address);
+        this.isWrappedToken = (token) => (0, web3_candies_1.eqIgnoreCase)(token.address, this.config.wToken.address); //TODO
         this.isValidChain = (chainId) => chainId === this.config.chainId;
         this.maxPossibleChunks = (srcToken, srcAmount, srcUsd) => bignumber_js_1.default.max(1, (0, bignumber_js_1.default)(srcAmount).div((0, bignumber_js_1.default)(10).pow(srcToken.decimals).div(srcUsd).times(this.config.minChunkSizeUsd)))
             .integerValue(bignumber_js_1.default.ROUND_FLOOR)
@@ -94,9 +95,29 @@ class TWAPLib {
             yield this.sendTx(token.methods.approve(this.config.twapAddress, amount.toString()), priorityFeePerGas, maxFeePerGas);
         });
     }
-    validateOrderInputs(srcToken, dstToken, srcAmount, srcChunkAmount, dstMinChunkAmountOut, deadline, fillDelaySeconds, srcUsd) {
+    validateTokens(srcToken, dstToken) {
         if (lodash_1.default.isEqual(srcToken, dstToken))
-            return OrderInputValidation.equalTokens;
+            return TokensValidation.invalid;
+        if ((0, configs_1.isNativeAddress)(srcToken.address)) {
+            if ((0, configs_1.isNativeAddress)(dstToken.address))
+                return TokensValidation.invalid;
+            if (this.isWrappedToken(dstToken))
+                return TokensValidation.wrapOnly;
+            return TokensValidation.wrapAndOrder;
+        }
+        if (this.isWrappedToken(srcToken)) {
+            if ((0, configs_1.isNativeAddress)(dstToken.address))
+                return TokensValidation.unwrapOnly;
+            return TokensValidation.valid;
+        }
+        if ((0, configs_1.isNativeAddress)(dstToken.address)) {
+            return TokensValidation.dstTokenZero;
+        }
+        return TokensValidation.valid;
+    }
+    validateOrderInputs(srcToken, dstToken, srcAmount, srcChunkAmount, dstMinChunkAmountOut, deadline, fillDelaySeconds, srcUsd) {
+        if (this.validateTokens(srcToken, dstToken) !== TokensValidation.valid)
+            return OrderInputValidation.invalidTokens; // TODO
         if ((0, bignumber_js_1.default)(srcAmount).lte(0))
             return OrderInputValidation.invalidSrcAmount;
         if ((0, bignumber_js_1.default)(srcChunkAmount).lte(0) || (0, bignumber_js_1.default)(srcChunkAmount).gt(srcAmount))
@@ -199,7 +220,7 @@ var Status;
 var OrderInputValidation;
 (function (OrderInputValidation) {
     OrderInputValidation["valid"] = "valid";
-    OrderInputValidation["equalTokens"] = "equalTokens";
+    OrderInputValidation["invalidTokens"] = "invalidTokens";
     OrderInputValidation["invalidSrcAmount"] = "invalidSrcAmount";
     OrderInputValidation["invalidSrcChunkAmount"] = "invalidSrcChunkAmount";
     OrderInputValidation["invalidDstMinChunkAmountOut"] = "invalidDstMinChunkAmountOut";
@@ -208,3 +229,12 @@ var OrderInputValidation;
     OrderInputValidation["invalidSrcUsd"] = "invalidSrcUsd";
     OrderInputValidation["invalidSmallestSrcChunkUsd"] = "invalidSmallestSrcChunkUsd";
 })(OrderInputValidation = exports.OrderInputValidation || (exports.OrderInputValidation = {}));
+var TokensValidation;
+(function (TokensValidation) {
+    TokensValidation["valid"] = "valid";
+    TokensValidation["invalid"] = "invalid";
+    TokensValidation["wrapOnly"] = "wrapOnly";
+    TokensValidation["unwrapOnly"] = "unwrapOnly";
+    TokensValidation["wrapAndOrder"] = "wrapAndOrder";
+    TokensValidation["dstTokenZero"] = "dstTokenZero";
+})(TokensValidation = exports.TokensValidation || (exports.TokensValidation = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@orbs-network/twap",
-  "version": "1.5.11-0",
+  "version": "1.5.12",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/orbs-network/twap.git"