tornado-oracles/lib/feeOracleV6.js

"use strict";
var __extends = (this && this.__extends) || (function () {
    var extendStatics = function (d, b) {
        extendStatics = Object.setPrototypeOf ||
            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
        return extendStatics(d, b);
    };
    return function (d, b) {
        if (typeof b !== "function" && b !== null)
            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
        extendStatics(d, b);
        function __() { this.constructor = d; }
        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
    };
})();
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
    return new (P || (P = Promise))(function (resolve, reject) {
        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
        step((generator = generator.apply(thisArg, _arguments || [])).next());
    });
};
var __generator = (this && this.__generator) || function (thisArg, body) {
    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
    function verb(n) { return function (v) { return step([n, v]); }; }
    function step(op) {
        if (f) throw new TypeError("Generator is already executing.");
        while (g && (g = 0, op[0] && (_ = 0)), _) try {
            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
            if (y = 0, t) op = [op[0] & 2, t.value];
            switch (op[0]) {
                case 0: case 1: t = op; break;
                case 4: _.label++; return { value: op[1], done: false };
                case 5: _.label++; y = op[1]; op = [0]; continue;
                case 7: op = _.ops.pop(); _.trys.pop(); continue;
                default:
                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
                    if (t[2]) _.ops.pop();
                    _.trys.pop(); continue;
            }
            op = body.call(thisArg, _);
        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
    }
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.TornadoFeeOracleV6 = void 0;
var config_1 = require("./config");
var feeOracle_1 = require("./feeOracle");
var utils_1 = require("./utils");
var feeOracleV5_1 = require("./feeOracleV5");
/**
 * V6 version that would cover every available networks and relayers
 *
 * Ported from https://git.tornado.ws/tornadocontrib/tornado-core/src/branch/main/src/fees.ts and has been verified over time
 */
var TornadoFeeOracleV6 = /** @class */ (function (_super) {
    __extends(TornadoFeeOracleV6, _super);
    function TornadoFeeOracleV6(chainId, rpcUrl, overrideGasPrice) {
        var _this = _super.call(this, 6, chainId, rpcUrl) || this;
        _this.fallbackFeeOracle = new feeOracleV5_1.TornadoFeeOracleV5(chainId, rpcUrl);
        _this.overrideGasPrice = overrideGasPrice;
        return _this;
    }
    /**
     * Apply static 10% gasLimit premium as it wouldn't change across nodes or relayers
     */
    TornadoFeeOracleV6.prototype.getGasLimit = function (tx, type, bumpPercent) {
        if (type === void 0) { type = 'other'; }
        if (bumpPercent === void 0) { bumpPercent = 10; }
        return __awaiter(this, void 0, void 0, function () {
            var fetchedGasLimit;
            return __generator(this, function (_a) {
                switch (_a.label) {
                    case 0:
                        if (!tx || Object.keys(tx).length === 0)
                            return [2 /*return*/, this.fallbackFeeOracle.getGasLimit(tx, type, bumpPercent)];
                        return [4 /*yield*/, this.provider.estimateGas(tx)];
                    case 1:
                        fetchedGasLimit = _a.sent();
                        return [2 /*return*/, (0, utils_1.bump)(fetchedGasLimit, bumpPercent).toNumber()];
                }
            });
        });
    };
    /**
     * Apply static 30% gasPrice premium for EIP-1559 enabled networks
     *
     * Because Tornado Transactions are censored from block builders
     * it would take some time to be confirmed after when the transaction is broadcasted.
     *
     * We apply 30% premium and 56% overall premium to combat basefee spike
     * (Can spike 12.5% per block accoring to the EIP-1559 metrics https://metamask.io/1559/)
     */
    TornadoFeeOracleV6.prototype.getGasPriceParams = function (speed, bumpPercent) {
        return __awaiter(this, void 0, void 0, function () {
            return __generator(this, function (_a) {
                if (this.overrideGasPrice) {
                    return [2 /*return*/, this.overrideGasPrice];
                }
                if (typeof bumpPercent === 'undefined') {
                    bumpPercent = this.chainId === config_1.ChainId.BSC ? undefined : 30;
                }
                return [2 /*return*/, _super.prototype.getGasPriceParams.call(this, speed, bumpPercent)];
            });
        });
    };
    /**
     * Apply 20% premium from the calculated fee from UI, applies 5% fee from relayer to prevent arbitrage from refund
     */
    TornadoFeeOracleV6.prototype.calculateWithdrawalFeeViaRelayer = function (params) {
        return __awaiter(this, void 0, void 0, function () {
            var fees, premium;
            return __generator(this, function (_a) {
                switch (_a.label) {
                    case 0: return [4 /*yield*/, _super.prototype.calculateWithdrawalFeeViaRelayer.call(this, params)];
                    case 1:
                        fees = _a.sent();
                        premium = params.premium || (params.txType === 'user_withdrawal' ? 20 : 5);
                        return [2 /*return*/, (0, utils_1.bump)(fees, premium).toHexString()];
                }
            });
        });
    };
    return TornadoFeeOracleV6;
}(feeOracle_1.TornadoFeeOracle));
exports.TornadoFeeOracleV6 = TornadoFeeOracleV6;
//# sourceMappingURL=feeOracleV6.js.map