@orbs-network/twap 1.5.12 → 1.5.14

package/README.md

@@ -99,7 +99,7 @@ As a result of this process, an `Order` is generated and held in the `TWAP` cont
   * `maker`: order creator (`msg.sender`)
   * `exchange`: swap only on this exchange, or zero for any exchange
   * `srcToken`: input token, required
-  * `dstToken`: output token, required
+  * `dstToken`: output token, required. If zero address, will unwrap to native token on each chunk.
   * `srcAmount`: input total order amount in `srcToken`, required
   * `srcBidAmount`: input chunk size in `srcToken`, required
   * `dstMinAmount`: minimum output chunk size, in `dstToken`, required. Can be higher than market output (implies a limit order), or as low as 1 wei

package/dist/src/lib.d.ts

@@ -26,6 +26,7 @@ export declare class TWAPLib {
     status: (order: Order) => Status;
     makerBalance(token: TokenData): Promise<BN>;
     wrapNativeToken(amount: BN.Value, priorityFeePerGas?: BN.Value, maxFeePerGas?: BN.Value): Promise<any>;
+    unwrapNativeToken(amount: BN.Value, priorityFeePerGas?: BN.Value, maxFeePerGas?: BN.Value): Promise<any>;
     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>;

package/dist/src/lib.js

@@ -29,7 +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.isWrappedToken = (token) => (0, web3_candies_1.eqIgnoreCase)(token.address, this.config.wToken.address);
         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)
@@ -72,6 +72,11 @@ class TWAPLib {
             return yield this.sendTx((0, web3_candies_1.erc20)(this.config.wToken.symbol, this.config.wToken.address, this.config.wToken.decimals, web3_candies_1.iwethabi).methods.deposit(), priorityFeePerGas, maxFeePerGas, amount);
         });
     }
+    unwrapNativeToken(amount, priorityFeePerGas, maxFeePerGas) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.sendTx((0, web3_candies_1.erc20)(this.config.wToken.symbol, this.config.wToken.address, this.config.wToken.decimals, web3_candies_1.iwethabi).methods.withdraw((0, bignumber_js_1.default)(amount).toFixed(0)), priorityFeePerGas, maxFeePerGas);
+        });
+    }
     waitForConfirmation(fn) {
         return __awaiter(this, void 0, void 0, function* () {
             const nonceBefore = yield (0, web3_candies_1.web3)().eth.getTransactionCount(this.maker);
@@ -84,6 +89,8 @@ class TWAPLib {
     }
     hasAllowance(srcToken, amount) {
         return __awaiter(this, void 0, void 0, function* () {
+            if (this.isNativeToken(srcToken))
+                return true;
             const token = (0, web3_candies_1.erc20)(srcToken.symbol, srcToken.address, srcToken.decimals);
             const allowance = (0, bignumber_js_1.default)(yield token.methods.allowance(this.maker, this.config.twapAddress).call());
             return allowance.gte(amount);
@@ -96,28 +103,22 @@ class TWAPLib {
         });
     }
     validateTokens(srcToken, dstToken) {
-        if (lodash_1.default.isEqual(srcToken, dstToken))
+        if (lodash_1.default.isEqual(srcToken, dstToken) || (this.isNativeToken(srcToken) && this.isNativeToken(dstToken)))
             return TokensValidation.invalid;
-        if ((0, configs_1.isNativeAddress)(srcToken.address)) {
-            if ((0, configs_1.isNativeAddress)(dstToken.address))
-                return TokensValidation.invalid;
+        if (this.isNativeToken(srcToken)) {
             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)) {
+        if (this.isWrappedToken(srcToken) && this.isNativeToken(dstToken))
+            return TokensValidation.unwrapOnly;
+        if (this.isNativeToken(dstToken))
             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
+            return OrderInputValidation.invalidTokens;
         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))

package/package.json

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