@zill-protocol/client 4.1.2

package/dist/src/conversion/index.js

@@ -0,0 +1,21 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MockEthToTokenConverter = void 0;
+__exportStar(require("./converter"), exports);
+var mock_1 = require("./mock");
+Object.defineProperty(exports, "MockEthToTokenConverter", { enumerable: true, get: function () { return mock_1.MockEthToTokenConverter; } });
+//# sourceMappingURL=index.js.map

package/dist/src/conversion/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/conversion/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,8CAA4B;AAC5B,+BAAiD;AAAxC,+GAAA,uBAAuB,OAAA"}

package/dist/src/conversion/mock.d.ts

@@ -0,0 +1,6 @@
+import { EthToTokenConverter } from "./converter";
+export declare class MockEthToTokenConverter extends EthToTokenConverter {
+    constructor();
+    weiToTargetErc20(amountWei: bigint, _targetTicker: string): Promise<bigint>;
+}
+//# sourceMappingURL=mock.d.ts.map

package/dist/src/conversion/mock.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mock.d.ts","sourceRoot":"","sources":["../../../src/conversion/mock.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAElD,qBAAa,uBAAwB,SAAQ,mBAAmB;;IAK9D,gBAAgB,CAAC,SAAS,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAG5E"}

package/dist/src/conversion/mock.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MockEthToTokenConverter = void 0;
+const converter_1 = require("./converter");
+class MockEthToTokenConverter extends converter_1.EthToTokenConverter {
+    constructor() {
+        super();
+    }
+    weiToTargetErc20(amountWei, _targetTicker) {
+        return Promise.resolve(amountWei);
+    }
+}
+exports.MockEthToTokenConverter = MockEthToTokenConverter;
+//# sourceMappingURL=mock.js.map

package/dist/src/conversion/mock.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mock.js","sourceRoot":"","sources":["../../../src/conversion/mock.ts"],"names":[],"mappings":";;;AAAA,2CAAkD;AAElD,MAAa,uBAAwB,SAAQ,+BAAmB;IAC9D;QACE,KAAK,EAAE,CAAC;IACV,CAAC;IAED,gBAAgB,CAAC,SAAiB,EAAE,aAAqB;QACvD,OAAO,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACpC,CAAC;CACF;AARD,0DAQC"}

package/dist/src/index.d.ts

@@ -0,0 +1,14 @@
+export * from "./types";
+export * from "./conversion";
+export * from "./operationRequest";
+export * from "./snapJsonRpc";
+export { NocturneClient } from "./NocturneClient";
+export { NocturneDB, GetNotesOpts } from "./NocturneDB";
+export { SyncOpts } from "./syncSDK";
+export { BundlerOpTracker } from "./OpTracker";
+export { NotEnoughGasTokensError } from "./opRequestGas";
+export { NotEnoughFundsError } from "./prepareOperation";
+export { signOperation } from "./signOperation";
+export { proveOperation } from "./proveOperation";
+export { isTerminalOpStatus, isFailedOpStatus } from "./utils";
+//# sourceMappingURL=index.d.ts.map

package/dist/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAC;AACxB,cAAc,cAAc,CAAC;AAC7B,cAAc,oBAAoB,CAAC;AACnC,cAAc,eAAe,CAAC;AAE9B,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AACxD,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AACrC,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,EAAE,uBAAuB,EAAE,MAAM,gBAAgB,CAAC;AACzD,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AACzD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC"}

package/dist/src/index.js

@@ -0,0 +1,39 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isFailedOpStatus = exports.isTerminalOpStatus = exports.proveOperation = exports.signOperation = exports.NotEnoughFundsError = exports.NotEnoughGasTokensError = exports.BundlerOpTracker = exports.NocturneDB = exports.NocturneClient = void 0;
+__exportStar(require("./types"), exports);
+__exportStar(require("./conversion"), exports);
+__exportStar(require("./operationRequest"), exports);
+__exportStar(require("./snapJsonRpc"), exports);
+var NocturneClient_1 = require("./NocturneClient");
+Object.defineProperty(exports, "NocturneClient", { enumerable: true, get: function () { return NocturneClient_1.NocturneClient; } });
+var NocturneDB_1 = require("./NocturneDB");
+Object.defineProperty(exports, "NocturneDB", { enumerable: true, get: function () { return NocturneDB_1.NocturneDB; } });
+var OpTracker_1 = require("./OpTracker");
+Object.defineProperty(exports, "BundlerOpTracker", { enumerable: true, get: function () { return OpTracker_1.BundlerOpTracker; } });
+var opRequestGas_1 = require("./opRequestGas");
+Object.defineProperty(exports, "NotEnoughGasTokensError", { enumerable: true, get: function () { return opRequestGas_1.NotEnoughGasTokensError; } });
+var prepareOperation_1 = require("./prepareOperation");
+Object.defineProperty(exports, "NotEnoughFundsError", { enumerable: true, get: function () { return prepareOperation_1.NotEnoughFundsError; } });
+var signOperation_1 = require("./signOperation");
+Object.defineProperty(exports, "signOperation", { enumerable: true, get: function () { return signOperation_1.signOperation; } });
+var proveOperation_1 = require("./proveOperation");
+Object.defineProperty(exports, "proveOperation", { enumerable: true, get: function () { return proveOperation_1.proveOperation; } });
+var utils_1 = require("./utils");
+Object.defineProperty(exports, "isTerminalOpStatus", { enumerable: true, get: function () { return utils_1.isTerminalOpStatus; } });
+Object.defineProperty(exports, "isFailedOpStatus", { enumerable: true, get: function () { return utils_1.isFailedOpStatus; } });
+//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,0CAAwB;AACxB,+CAA6B;AAC7B,qDAAmC;AACnC,gDAA8B;AAE9B,mDAAkD;AAAzC,gHAAA,cAAc,OAAA;AACvB,2CAAwD;AAA/C,wGAAA,UAAU,OAAA;AAEnB,yCAA+C;AAAtC,6GAAA,gBAAgB,OAAA;AACzB,+CAAyD;AAAhD,uHAAA,uBAAuB,OAAA;AAChC,uDAAyD;AAAhD,uHAAA,mBAAmB,OAAA;AAC5B,iDAAgD;AAAvC,8GAAA,aAAa,OAAA;AACtB,mDAAkD;AAAzC,gHAAA,cAAc,OAAA;AACvB,iCAA+D;AAAtD,2GAAA,kBAAkB,OAAA;AAAE,yGAAA,gBAAgB,OAAA"}

package/dist/src/opRequestGas.d.ts

@@ -0,0 +1,20 @@
+import { Handler } from "@zill-protocol/contracts";
+import { Asset, SparseMerkleProver } from "@zill-protocol/core";
+import { NocturneDB } from "./NocturneDB";
+import { EthToTokenConverter } from "./conversion";
+import { GasAccountedOperationRequest, OperationRequest } from "./operationRequest/operationRequest";
+export interface HandleOpRequestGasDeps {
+    db: NocturneDB;
+    handlerContract: Handler;
+    gasAssets: Map<string, Asset>;
+    tokenConverter: EthToTokenConverter;
+    merkle: SparseMerkleProver;
+}
+export declare class NotEnoughGasTokensError extends Error {
+    readonly gasAssets: Asset[];
+    readonly gasEstimates: bigint[];
+    readonly gasAssetBalances: bigint[];
+    constructor(gasAssets: Asset[], gasEstimates: bigint[], gasAssetBalances: bigint[]);
+}
+export declare function handleGasForOperationRequest(deps: HandleOpRequestGasDeps, opRequest: OperationRequest, gasMultiplier: number): Promise<GasAccountedOperationRequest>;
+//# sourceMappingURL=opRequestGas.d.ts.map

package/dist/src/opRequestGas.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"opRequestGas.d.ts","sourceRoot":"","sources":["../../src/opRequestGas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,0BAA0B,CAAC;AACnD,OAAO,EACL,KAAK,EAaL,kBAAkB,EAKnB,MAAM,qBAAqB,CAAC;AAG7B,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AACnD,OAAO,EACL,4BAA4B,EAE5B,gBAAgB,EACjB,MAAM,qCAAqC,CAAC;AAoB7C,MAAM,WAAW,sBAAsB;IACrC,EAAE,EAAE,UAAU,CAAC;IACf,eAAe,EAAE,OAAO,CAAC;IACzB,SAAS,EAAE,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAC9B,cAAc,EAAE,mBAAmB,CAAC;IACpC,MAAM,EAAE,kBAAkB,CAAC;CAC5B;AAwBD,qBAAa,uBAAwB,SAAQ,KAAK;aAE9B,SAAS,EAAE,KAAK,EAAE;aAClB,YAAY,EAAE,MAAM,EAAE;aACtB,gBAAgB,EAAE,MAAM,EAAE;gBAF1B,SAAS,EAAE,KAAK,EAAE,EAClB,YAAY,EAAE,MAAM,EAAE,EACtB,gBAAgB,EAAE,MAAM,EAAE;CAK7C;AAED,wBAAsB,4BAA4B,CAChD,IAAI,EAAE,sBAAsB,EAC5B,SAAS,EAAE,gBAAgB,EAC3B,aAAa,EAAE,MAAM,GACpB,OAAO,CAAC,4BAA4B,CAAC,CAmDvC"}

package/dist/src/opRequestGas.js

@@ -0,0 +1,321 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotEnoughGasTokensError = void 0;
+exports.handleGasForOperationRequest = handleGasForOperationRequest;
+const core_1 = require("@zill-protocol/core");
+const crypto_1 = require("@zill-protocol/crypto");
+const JSON = __importStar(require("bigint-json-serialization"));
+const prepareOperation_1 = require("./prepareOperation");
+const utils_1 = require("./utils");
+// If gas asset refund is less than this amount * gasPrice denominated in the gas asset, refund will
+// not be processed and funds will be sent to bundler. This is because cost of processing would
+// outweight value of note.
+const DEFAULT_GAS_ASSET_REFUND_THRESHOLD_GAS = 600000n;
+const DUMMY_GAS_ASSET = {
+    assetType: core_1.AssetType.ERC20,
+    assetAddr: "0x0000000000000000000000000000000000000000",
+    id: core_1.ERC20_ID,
+};
+// VK corresponding to SK of 1 with minimum valid nonce
+const DUMMY_VIEWER = new crypto_1.NocturneViewer(655374300543486358510310527362452574140738137308572239595396943710924175576n, 3n);
+const DUMMY_REFUND_ADDR = DUMMY_VIEWER.generateRandomStealthAddress();
+class NotEnoughGasTokensError extends Error {
+    constructor(gasAssets, gasEstimates, gasAssetBalances) {
+        super("Not enough gas to execute operation");
+        this.gasAssets = gasAssets;
+        this.gasEstimates = gasEstimates;
+        this.gasAssetBalances = gasAssetBalances;
+        this.name = "NotEnoughGasTokensError";
+    }
+}
+exports.NotEnoughGasTokensError = NotEnoughGasTokensError;
+async function handleGasForOperationRequest(deps, opRequest, gasMultiplier) {
+    // estimate gas params for opRequest
+    console.log("estimating gas for op request");
+    const { totalGasLimit, executionGasLimit, gasPrice, usedNotes } = await getOperationRequestTrace(deps, opRequest, gasMultiplier);
+    const gasEstimatedOpRequest = {
+        ...opRequest,
+        executionGasLimit,
+        gasPrice,
+    };
+    if (opRequest?.gasPrice == 0n) {
+        // If gasPrice = 0, override dummy gas asset and don't further modify opRequest
+        console.log("returning dummy gas asset");
+        return {
+            ...gasEstimatedOpRequest,
+            gasPrice: 0n,
+            gasAsset: DUMMY_GAS_ASSET,
+            gasAssetRefundThreshold: 0n,
+            totalGasLimit,
+        };
+    }
+    else {
+        console.log(`total gas limit pre gas update: ${totalGasLimit}`);
+        // attempt to update the joinSplitRequests with gas compensation
+        // gasAsset will be `undefined` if the user's too broke to pay for gas
+        const [joinSplitRequests, gasAssetAndTicker] = await tryUpdateJoinSplitRequestsForGasEstimate(deps.gasAssets, deps.db, gasEstimatedOpRequest.joinSplitRequests, totalGasLimit, gasPrice, deps.tokenConverter, usedNotes);
+        const gasAssetRefundThreshold = await deps.tokenConverter.weiToTargetErc20(DEFAULT_GAS_ASSET_REFUND_THRESHOLD_GAS * gasPrice, gasAssetAndTicker.ticker);
+        return {
+            ...gasEstimatedOpRequest,
+            gasAssetRefundThreshold,
+            joinSplitRequests,
+            gasAsset: gasAssetAndTicker.asset,
+            totalGasLimit,
+        };
+    }
+}
+// update the joinSplitRequests to include any additional gas compensation, if needed
+// returns the updated JoinSplitRequests and the gas asset used to pay for gas if the user can afford gas
+// if the user can't afford gas, returns an empty array and undefined.
+async function tryUpdateJoinSplitRequestsForGasEstimate(gasAssets, db, joinSplitRequests, gasUnitsEstimate, gasPrice, tokenConverter, usedNotes) {
+    // group joinSplitRequests by asset address
+    const joinSplitRequestsByAsset = (0, core_1.groupByMap)(joinSplitRequests, (request) => request.asset.assetAddr);
+    const gasCompJoinSplitRequestsByAsset = (0, core_1.groupByMap)(joinSplitRequests.filter((request) => request.allowGasCompensation !== false), (request) => request.asset.assetAddr);
+    const gasEstimateWei = gasPrice * gasUnitsEstimate;
+    const gasEstimatesInGasAssets = await tokenConverter.gasEstimatesInGasAssets(gasEstimateWei, Array.from(gasAssets.keys()));
+    const [matchingGasAssets, nonMatchingGasAssets] = (0, core_1.partition)(Array.from(gasAssets.entries()), ([_, gasAsset]) => gasCompJoinSplitRequestsByAsset.has(gasAsset.assetAddr));
+    const failedGasEstimates = [];
+    const failedGasAssets = [];
+    const failedGasAssetBalances = [];
+    // attempt to find matching gas asset with enough balance
+    for (const [ticker, gasAsset] of matchingGasAssets) {
+        const totalOwnedGasAsset = await db.getBalanceForAsset(gasAsset);
+        const matchingJoinSplitRequests = gasCompJoinSplitRequestsByAsset.get(gasAsset.assetAddr);
+        if (!matchingJoinSplitRequests || matchingJoinSplitRequests.length === 0) {
+            continue;
+        }
+        const totalAmountInMatchingJoinSplitRequests = matchingJoinSplitRequests.reduce((acc, request) => {
+            return acc + (0, utils_1.getJoinSplitRequestTotalValue)(request);
+        }, 0n);
+        // if they have enough for request + gas, modify one of the requests to include the gas, and
+        // we're done
+        const estimateInGasAsset = gasEstimatesInGasAssets.get(ticker);
+        if (totalOwnedGasAsset >=
+            estimateInGasAsset + totalAmountInMatchingJoinSplitRequests) {
+            const usedNotesForGasAsset = usedNotes.get(gasAsset) ??
+                Array.from(usedNotes.entries()).find(([asset]) => core_1.AssetTrait.isSameAsset(asset, gasAsset))?.[1] ??
+                [];
+            const usedMerkleIndicesForGasAsset = new Set(usedNotesForGasAsset.map((note) => note.merkleIndex));
+            const totalValueInExistingJoinSplits = usedNotesForGasAsset.reduce((acc, note) => acc + note.value, 0n);
+            const remainingValueNeededInNewJoinSplits = totalAmountInMatchingJoinSplitRequests +
+                estimateInGasAsset -
+                totalValueInExistingJoinSplits;
+            let extraJoinSplitsGas;
+            let numExtraJoinSplits;
+            if (remainingValueNeededInNewJoinSplits > 0n) {
+                // Add enough to cover gas needed for existing joinsplits + gas for an extra joinsplits
+                const extraNotes = await (0, prepareOperation_1.gatherNotes)(db, remainingValueNeededInNewJoinSplits, gasAsset, usedMerkleIndicesForGasAsset);
+                console.log(`usedNotes: ${JSON.stringify(usedNotes)}`);
+                console.log(`need ${extraNotes.length} extra notes for gas comp`);
+                numExtraJoinSplits =
+                    Math.ceil((usedNotesForGasAsset.length + extraNotes.length) / 2) -
+                        Math.ceil(usedNotesForGasAsset.length / 2);
+                extraJoinSplitsGas =
+                    BigInt(numExtraJoinSplits) *
+                        core_1.MAX_GAS_FOR_ADDITIONAL_JOINSPLIT *
+                        gasPrice;
+                const estimateInGasAssetIncludingNewJoinSplits = estimateInGasAsset + extraJoinSplitsGas;
+                if (totalOwnedGasAsset < estimateInGasAssetIncludingNewJoinSplits) {
+                    // Don't have enough for new joinsplits gas overhead, try new asset
+                    failedGasAssets.push(gasAsset);
+                    failedGasEstimates.push(estimateInGasAssetIncludingNewJoinSplits);
+                    failedGasAssetBalances.push(totalOwnedGasAsset);
+                    continue;
+                }
+            }
+            else {
+                // otherwise we don't need any extra joinsplits because existing notes cover gas cost
+                extraJoinSplitsGas = 0n;
+                numExtraJoinSplits = 0;
+            }
+            console.log(`adding ${extraJoinSplitsGas} tokens for ${numExtraJoinSplits} extra joinsplits for gas compensation`);
+            matchingJoinSplitRequests[0].unwrapValue +=
+                estimateInGasAsset + extraJoinSplitsGas;
+            joinSplitRequestsByAsset.set(gasAsset.assetAddr, matchingJoinSplitRequests);
+            console.log(`amount to add for gas asset by modifying existing joinsplit for gas asset with ticker ${ticker}: ${estimateInGasAsset}}`, { gasAssetTicker: ticker, gasAsset, estimateInGasAsset });
+            return [
+                Array.from(joinSplitRequestsByAsset.values()).flat(),
+                { asset: gasAsset, ticker },
+            ];
+        }
+        else {
+            failedGasAssets.push(gasAsset);
+            failedGasEstimates.push(estimateInGasAsset);
+            failedGasAssetBalances.push(totalOwnedGasAsset);
+        }
+    }
+    // if we couldn't find an existing joinsplit request with a supported gas asset,
+    // attempt to make a new joinsplit request to include the gas comp
+    // iterate through each gas asset
+    for (const [ticker, gasAsset] of nonMatchingGasAssets) {
+        const estimateInGasAsset = gasEstimatesInGasAssets.get(ticker);
+        const totalOwnedGasAsset = await db.getBalanceForAsset(gasAsset);
+        if (totalOwnedGasAsset >= estimateInGasAsset) {
+            // Add enough to cover gas needed for existing joinsplits + gas for an extra joinsplits
+            const extraNotes = await (0, prepareOperation_1.gatherNotes)(db, estimateInGasAsset, gasAsset);
+            const numExtraJoinSplits = Math.ceil(extraNotes.length / 2);
+            const additionaJoinSplitGas = BigInt(numExtraJoinSplits) *
+                core_1.MAX_GAS_FOR_ADDITIONAL_JOINSPLIT *
+                gasPrice;
+            const estimateInGasAssetIncludingNewJoinSplits = estimateInGasAsset + additionaJoinSplitGas;
+            if (totalOwnedGasAsset < estimateInGasAssetIncludingNewJoinSplits) {
+                // Don't have enough for new joinsplits gas overhead, try new asset
+                failedGasAssets.push(gasAsset);
+                failedGasEstimates.push(estimateInGasAssetIncludingNewJoinSplits);
+                failedGasAssetBalances.push(totalOwnedGasAsset);
+                continue;
+            }
+            const modifiedJoinSplitRequests = joinSplitRequests.concat({
+                asset: gasAsset,
+                unwrapValue: estimateInGasAssetIncludingNewJoinSplits,
+            });
+            console.log(`amount to add for gas asset by adding a new joinsplit for gas asset with ticker ${ticker}: ${estimateInGasAssetIncludingNewJoinSplits}`, {
+                gasAssetTicker: ticker,
+                gasAsset,
+                estimateInGasAssetIncludingNewJoinSplits,
+            });
+            return [modifiedJoinSplitRequests, { asset: gasAsset, ticker }];
+        }
+        else {
+            failedGasAssets.push(gasAsset);
+            failedGasEstimates.push(estimateInGasAsset);
+            failedGasAssetBalances.push(totalOwnedGasAsset);
+        }
+    }
+    // if we get here, the user can't afford the gas
+    throw new NotEnoughGasTokensError(failedGasAssets, failedGasEstimates, failedGasAssetBalances);
+}
+// estimate gas params for opRequest
+async function getOperationRequestTrace({ handlerContract, ...deps }, opRequest, gasMultiplier) {
+    let { executionGasLimit, gasPrice } = opRequest;
+    // Simulate operation to get number of joinSplits
+    const dummyOpRequest = {
+        ...opRequest,
+        gasAssetRefundThreshold: 0n,
+        executionGasLimit: core_1.BLOCK_GAS_LIMIT,
+        refundAddr: DUMMY_REFUND_ADDR,
+        // Use 0 gas price and dummy asset for simulation
+        gasPrice: 0n,
+        gasAsset: DUMMY_GAS_ASSET,
+        totalGasLimit: core_1.BLOCK_GAS_LIMIT,
+    };
+    // prepare the request into an operation using a dummy viewer
+    const preparedOp = await (0, prepareOperation_1.prepareOperation)({ viewer: DUMMY_VIEWER, ...deps }, dummyOpRequest);
+    const usedNotes = (0, utils_1.getIncludedNotesFromOp)(preparedOp);
+    // simulate the operation
+    if (!executionGasLimit) {
+        console.log("simulating operation");
+        const result = await simulateOperation(handlerContract, preparedOp);
+        if (!result.opProcessed) {
+            throw Error("cannot estimate gas with Error: " + result.failureReason);
+        }
+        // set executionGasLimit with 20% buffer above the simulation result
+        executionGasLimit = (result.executionGas * 12n) / 10n;
+    }
+    preparedOp.executionGasLimit = executionGasLimit;
+    const totalGasLimit = (0, core_1.maxGasForOperation)(preparedOp);
+    const scale = 100;
+    const gasMultiplierScaled = BigInt(Math.floor(gasMultiplier * scale));
+    // if gasPrice is not specified, get it from RPC node
+    // NOTE: gasPrice returned in wei
+    gasPrice =
+        gasPrice ??
+            ((await handlerContract.provider.getGasPrice()).toBigInt() *
+                gasMultiplierScaled) /
+                BigInt(Math.floor(scale));
+    return {
+        totalGasLimit,
+        executionGasLimit,
+        gasPrice,
+        usedNotes,
+    };
+}
+async function simulateOperation(handlerContract, op) {
+    // We need to do staticCall, which fails if wallet is connected to a signer
+    // https://github.com/ethers-io/ethers.js/discussions/3327#discussioncomment-3539505
+    // Switching to a regular provider underlying the signer
+    if (handlerContract.signer) {
+        handlerContract = handlerContract.connect(handlerContract.provider);
+    }
+    // Fill-in the some fake proof
+    const opWithFakeProofs = fakeProvenOperation(op);
+    // Set gasPrice to 0 so that gas payment does not interfere with amount of
+    // assets unwrapped pre gas estimation
+    // ?: does this actually do anything if it's after `fakeProvenOperation` dummy provenOp?
+    op.gasPrice = 0n;
+    // Set dummy parameters which should not affect operation simulation
+    const verificationGasForOp = 0n;
+    const bundler = handlerContract.address;
+    const tellerAddress = await handlerContract._teller();
+    const result = await handlerContract.callStatic.handleOperation(
+    // TODO: fix after contract changes
+    //@ts-ignore
+    opWithFakeProofs, verificationGasForOp, bundler, {
+        from: tellerAddress,
+    });
+    const { opProcessed, failureReason, callSuccesses, callResults, verificationGas, executionGas, numRefunds, } = result;
+    return {
+        opProcessed,
+        failureReason,
+        callSuccesses,
+        callResults,
+        verificationGas: verificationGas.toBigInt(),
+        executionGas: executionGas.toBigInt(),
+        numRefunds: numRefunds.toBigInt(),
+    };
+}
+function fakeProvenOperation(op) {
+    const provenJoinSplits = op.joinSplits.map((js) => {
+        return {
+            ...js,
+            proof: [0n, 0n, 0n, 0n, 0n, 0n, 0n, 0n],
+        };
+    });
+    return core_1.OperationTrait.toSubmittable({
+        networkInfo: op.networkInfo,
+        joinSplits: provenJoinSplits,
+        refundAddr: op.refundAddr,
+        actions: op.actions,
+        refunds: op.refunds,
+        encodedGasAsset: op.encodedGasAsset,
+        gasAssetRefundThreshold: op.gasAssetRefundThreshold,
+        executionGasLimit: op.executionGasLimit,
+        gasPrice: op.gasPrice,
+        deadline: op.deadline,
+        atomicActions: op.atomicActions,
+    });
+}
+//# sourceMappingURL=opRequestGas.js.map

package/dist/src/opRequestGas.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"opRequestGas.js","sourceRoot":"","sources":["../../src/opRequestGas.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0FA,oEAuDC;AAhJD,8CAmB6B;AAC7B,kDAAuE;AACvE,gEAAkD;AAQlD,yDAAmE;AACnE,mCAAgF;AAEhF,oGAAoG;AACpG,+FAA+F;AAC/F,2BAA2B;AAC3B,MAAM,sCAAsC,GAAG,OAAQ,CAAC;AAExD,MAAM,eAAe,GAAU;IAC7B,SAAS,EAAE,gBAAS,CAAC,KAAK;IAC1B,SAAS,EAAE,4CAA4C;IACvD,EAAE,EAAE,eAAQ;CACb,CAAC;AA4BF,uDAAuD;AACvD,MAAM,YAAY,GAAG,IAAI,uBAAc,CACrC,4EAA4E,EAC5E,EAAE,CACH,CAAC;AAEF,MAAM,iBAAiB,GACrB,YAAY,CAAC,4BAA4B,EAAE,CAAC;AAE9C,MAAa,uBAAwB,SAAQ,KAAK;IAChD,YACkB,SAAkB,EAClB,YAAsB,EACtB,gBAA0B;QAE1C,KAAK,CAAC,qCAAqC,CAAC,CAAC;QAJ7B,cAAS,GAAT,SAAS,CAAS;QAClB,iBAAY,GAAZ,YAAY,CAAU;QACtB,qBAAgB,GAAhB,gBAAgB,CAAU;QAG1C,IAAI,CAAC,IAAI,GAAG,yBAAyB,CAAC;IACxC,CAAC;CACF;AATD,0DASC;AAEM,KAAK,UAAU,4BAA4B,CAChD,IAA4B,EAC5B,SAA2B,EAC3B,aAAqB;IAErB,oCAAoC;IACpC,OAAO,CAAC,GAAG,CAAC,+BAA+B,CAAC,CAAC;IAC7C,MAAM,EAAE,aAAa,EAAE,iBAAiB,EAAE,QAAQ,EAAE,SAAS,EAAE,GAC7D,MAAM,wBAAwB,CAAC,IAAI,EAAE,SAAS,EAAE,aAAa,CAAC,CAAC;IAEjE,MAAM,qBAAqB,GAAiC;QAC1D,GAAG,SAAS;QACZ,iBAAiB;QACjB,QAAQ;KACT,CAAC;IAEF,IAAI,SAAS,EAAE,QAAQ,IAAI,EAAE,EAAE,CAAC;QAC9B,+EAA+E;QAC/E,OAAO,CAAC,GAAG,CAAC,2BAA2B,CAAC,CAAC;QACzC,OAAO;YACL,GAAG,qBAAqB;YACxB,QAAQ,EAAE,EAAE;YACZ,QAAQ,EAAE,eAAe;YACzB,uBAAuB,EAAE,EAAE;YAC3B,aAAa;SACd,CAAC;IACJ,CAAC;SAAM,CAAC;QACN,OAAO,CAAC,GAAG,CAAC,mCAAmC,aAAa,EAAE,CAAC,CAAC;QAEhE,gEAAgE;QAChE,sEAAsE;QACtE,MAAM,CAAC,iBAAiB,EAAE,iBAAiB,CAAC,GAC1C,MAAM,wCAAwC,CAC5C,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,EAAE,EACP,qBAAqB,CAAC,iBAAiB,EACvC,aAAa,EACb,QAAQ,EACR,IAAI,CAAC,cAAc,EACnB,SAAS,CACV,CAAC;QAEJ,MAAM,uBAAuB,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,gBAAgB,CACxE,sCAAsC,GAAG,QAAQ,EACjD,iBAAiB,CAAC,MAAM,CACzB,CAAC;QAEF,OAAO;YACL,GAAG,qBAAqB;YACxB,uBAAuB;YACvB,iBAAiB;YACjB,QAAQ,EAAE,iBAAiB,CAAC,KAAK;YACjC,aAAa;SACd,CAAC;IACJ,CAAC;AACH,CAAC;AAED,qFAAqF;AACrF,yGAAyG;AACzG,sEAAsE;AACtE,KAAK,UAAU,wCAAwC,CACrD,SAA6B,EAC7B,EAAc,EACd,iBAAqC,EACrC,gBAAwB,EACxB,QAAgB,EAChB,cAAmC,EACnC,SAAmD;IAEnD,2CAA2C;IAC3C,MAAM,wBAAwB,GAAG,IAAA,iBAAU,EACzC,iBAAiB,EACjB,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,SAAS,CACrC,CAAC;IACF,MAAM,+BAA+B,GAAG,IAAA,iBAAU,EAChD,iBAAiB,CAAC,MAAM,CACtB,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,oBAAoB,KAAK,KAAK,CACpD,EACD,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,SAAS,CACrC,CAAC;IAEF,MAAM,cAAc,GAAG,QAAQ,GAAG,gBAAgB,CAAC;IACnD,MAAM,uBAAuB,GAAG,MAAM,cAAc,CAAC,uBAAuB,CAC1E,cAAc,EACd,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAC7B,CAAC;IAEF,MAAM,CAAC,iBAAiB,EAAE,oBAAoB,CAAC,GAAG,IAAA,gBAAS,EACzD,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC,EAC/B,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,EAAE,EAAE,CAAC,+BAA+B,CAAC,GAAG,CAAC,QAAQ,CAAC,SAAS,CAAC,CAC3E,CAAC;IAEF,MAAM,kBAAkB,GAAG,EAAE,CAAC;IAC9B,MAAM,eAAe,GAAG,EAAE,CAAC;IAC3B,MAAM,sBAAsB,GAAG,EAAE,CAAC;IAElC,yDAAyD;IACzD,KAAK,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,IAAI,iBAAiB,EAAE,CAAC;QACnD,MAAM,kBAAkB,GAAG,MAAM,EAAE,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;QACjE,MAAM,yBAAyB,GAAG,+BAA+B,CAAC,GAAG,CACnE,QAAQ,CAAC,SAAS,CACnB,CAAC;QACF,IAAI,CAAC,yBAAyB,IAAI,yBAAyB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACzE,SAAS;QACX,CAAC;QAED,MAAM,sCAAsC,GAC1C,yBAAyB,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE;YAChD,OAAO,GAAG,GAAG,IAAA,qCAA6B,EAAC,OAAO,CAAC,CAAC;QACtD,CAAC,EAAE,EAAE,CAAC,CAAC;QAET,4FAA4F;QAC5F,aAAa;QACb,MAAM,kBAAkB,GAAG,uBAAuB,CAAC,GAAG,CAAC,MAAM,CAAE,CAAC;QAChE,IACE,kBAAkB;YAClB,kBAAkB,GAAG,sCAAsC,EAC3D,CAAC;YACD,MAAM,oBAAoB,GACxB,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC;gBACvB,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,EAAE,CAC/C,iBAAU,CAAC,WAAW,CAAC,KAAK,EAAE,QAAQ,CAAC,CACxC,EAAE,CAAC,CAAC,CAAC;gBACN,EAAE,CAAC;YACL,MAAM,4BAA4B,GAAG,IAAI,GAAG,CAC1C,oBAAoB,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,CACrD,CAAC;YACF,MAAM,8BAA8B,GAAG,oBAAoB,CAAC,MAAM,CAChE,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,GAAG,GAAG,IAAI,CAAC,KAAK,EAC/B,EAAE,CACH,CAAC;YACF,MAAM,mCAAmC,GACvC,sCAAsC;gBACtC,kBAAkB;gBAClB,8BAA8B,CAAC;YAEjC,IAAI,kBAA0B,CAAC;YAC/B,IAAI,kBAA0B,CAAC;YAC/B,IAAI,mCAAmC,GAAG,EAAE,EAAE,CAAC;gBAC7C,uFAAuF;gBACvF,MAAM,UAAU,GAAG,MAAM,IAAA,8BAAW,EAClC,EAAE,EACF,mCAAmC,EACnC,QAAQ,EACR,4BAA4B,CAC7B,CAAC;gBAEF,OAAO,CAAC,GAAG,CAAC,cAAc,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;gBACvD,OAAO,CAAC,GAAG,CAAC,QAAQ,UAAU,CAAC,MAAM,2BAA2B,CAAC,CAAC;gBAClE,kBAAkB;oBAChB,IAAI,CAAC,IAAI,CAAC,CAAC,oBAAoB,CAAC,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;wBAChE,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;gBAC7C,kBAAkB;oBAChB,MAAM,CAAC,kBAAkB,CAAC;wBAC1B,uCAAgC;wBAChC,QAAQ,CAAC;gBACX,MAAM,wCAAwC,GAC5C,kBAAkB,GAAG,kBAAkB,CAAC;gBAE1C,IAAI,kBAAkB,GAAG,wCAAwC,EAAE,CAAC;oBAClE,mEAAmE;oBACnE,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;oBAC/B,kBAAkB,CAAC,IAAI,CAAC,wCAAwC,CAAC,CAAC;oBAClE,sBAAsB,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;oBAChD,SAAS;gBACX,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,qFAAqF;gBACrF,kBAAkB,GAAG,EAAE,CAAC;gBACxB,kBAAkB,GAAG,CAAC,CAAC;YACzB,CAAC;YAED,OAAO,CAAC,GAAG,CACT,UAAU,kBAAkB,eAAe,kBAAkB,wCAAwC,CACtG,CAAC;YACF,yBAAyB,CAAC,CAAC,CAAC,CAAC,WAAW;gBACtC,kBAAkB,GAAG,kBAAkB,CAAC;YAC1C,wBAAwB,CAAC,GAAG,CAC1B,QAAQ,CAAC,SAAS,EAClB,yBAAyB,CAC1B,CAAC;YAEF,OAAO,CAAC,GAAG,CACT,yFAAyF,MAAM,KAAK,kBAAkB,GAAG,EACzH,EAAE,cAAc,EAAE,MAAM,EAAE,QAAQ,EAAE,kBAAkB,EAAE,CACzD,CAAC;YAEF,OAAO;gBACL,KAAK,CAAC,IAAI,CAAC,wBAAwB,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,EAAE;gBACpD,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE;aAC5B,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC/B,kBAAkB,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;YAC5C,sBAAsB,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QAClD,CAAC;IACH,CAAC;IAED,gFAAgF;IAChF,kEAAkE;IAClE,iCAAiC;IACjC,KAAK,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,IAAI,oBAAoB,EAAE,CAAC;QACtD,MAAM,kBAAkB,GAAG,uBAAuB,CAAC,GAAG,CAAC,MAAM,CAAE,CAAC;QAChE,MAAM,kBAAkB,GAAG,MAAM,EAAE,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;QAEjE,IAAI,kBAAkB,IAAI,kBAAkB,EAAE,CAAC;YAC7C,uFAAuF;YACvF,MAAM,UAAU,GAAG,MAAM,IAAA,8BAAW,EAAC,EAAE,EAAE,kBAAkB,EAAE,QAAQ,CAAC,CAAC;YACvE,MAAM,kBAAkB,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YAC5D,MAAM,qBAAqB,GACzB,MAAM,CAAC,kBAAkB,CAAC;gBAC1B,uCAAgC;gBAChC,QAAQ,CAAC;YACX,MAAM,wCAAwC,GAC5C,kBAAkB,GAAG,qBAAqB,CAAC;YAE7C,IAAI,kBAAkB,GAAG,wCAAwC,EAAE,CAAC;gBAClE,mEAAmE;gBACnE,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBAC/B,kBAAkB,CAAC,IAAI,CAAC,wCAAwC,CAAC,CAAC;gBAClE,sBAAsB,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;gBAChD,SAAS;YACX,CAAC;YAED,MAAM,yBAAyB,GAAG,iBAAiB,CAAC,MAAM,CAAC;gBACzD,KAAK,EAAE,QAAQ;gBACf,WAAW,EAAE,wCAAwC;aACtD,CAAC,CAAC;YAEH,OAAO,CAAC,GAAG,CACT,mFAAmF,MAAM,KAAK,wCAAwC,EAAE,EACxI;gBACE,cAAc,EAAE,MAAM;gBACtB,QAAQ;gBACR,wCAAwC;aACzC,CACF,CAAC;YAEF,OAAO,CAAC,yBAAyB,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC;QAClE,CAAC;aAAM,CAAC;YACN,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC/B,kBAAkB,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;YAC5C,sBAAsB,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QAClD,CAAC;IACH,CAAC;IAED,gDAAgD;IAChD,MAAM,IAAI,uBAAuB,CAC/B,eAAe,EACf,kBAAkB,EAClB,sBAAsB,CACvB,CAAC;AACJ,CAAC;AAED,oCAAoC;AACpC,KAAK,UAAU,wBAAwB,CACrC,EAAE,eAAe,EAAE,GAAG,IAAI,EAA0B,EACpD,SAA2B,EAC3B,aAAqB;IAErB,IAAI,EAAE,iBAAiB,EAAE,QAAQ,EAAE,GAAG,SAAS,CAAC;IAEhD,iDAAiD;IACjD,MAAM,cAAc,GAAiC;QACnD,GAAG,SAAS;QACZ,uBAAuB,EAAE,EAAE;QAC3B,iBAAiB,EAAE,sBAAe;QAClC,UAAU,EAAE,iBAAiB;QAC7B,iDAAiD;QACjD,QAAQ,EAAE,EAAE;QACZ,QAAQ,EAAE,eAAe;QACzB,aAAa,EAAE,sBAAe;KAC/B,CAAC;IAEF,6DAA6D;IAC7D,MAAM,UAAU,GAAG,MAAM,IAAA,mCAAgB,EACvC,EAAE,MAAM,EAAE,YAAY,EAAE,GAAG,IAAI,EAAE,EACjC,cAAc,CACf,CAAC;IACF,MAAM,SAAS,GAAG,IAAA,8BAAsB,EAAC,UAAU,CAAC,CAAC;IAErD,yBAAyB;IACzB,IAAI,CAAC,iBAAiB,EAAE,CAAC;QACvB,OAAO,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;QACpC,MAAM,MAAM,GAAG,MAAM,iBAAiB,CACpC,eAAe,EACf,UAA8B,CAC/B,CAAC;QACF,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;YACxB,MAAM,KAAK,CAAC,kCAAkC,GAAG,MAAM,CAAC,aAAa,CAAC,CAAC;QACzE,CAAC;QAED,oEAAoE;QACpE,iBAAiB,GAAG,CAAC,MAAM,CAAC,YAAY,GAAG,GAAG,CAAC,GAAG,GAAG,CAAC;IACxD,CAAC;IAED,UAAU,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;IACjD,MAAM,aAAa,GAAG,IAAA,yBAAkB,EAAC,UAAU,CAAC,CAAC;IAErD,MAAM,KAAK,GAAG,GAAG,CAAC;IAClB,MAAM,mBAAmB,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,GAAG,KAAK,CAAC,CAAC,CAAC;IACtE,qDAAqD;IACrD,iCAAiC;IACjC,QAAQ;QACN,QAAQ;YACR,CAAC,CAAC,MAAM,eAAe,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC,QAAQ,EAAE;gBACxD,mBAAmB,CAAC;gBACpB,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;IAE9B,OAAO;QACL,aAAa;QACb,iBAAiB;QACjB,QAAQ;QACR,SAAS;KACV,CAAC;AACJ,CAAC;AAED,KAAK,UAAU,iBAAiB,CAC9B,eAAwB,EACxB,EAAa;IAEb,2EAA2E;IAC3E,oFAAoF;IACpF,wDAAwD;IACxD,IAAI,eAAe,CAAC,MAAM,EAAE,CAAC;QAC3B,eAAe,GAAG,eAAe,CAAC,OAAO,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;IACtE,CAAC;IAED,8BAA8B;IAC9B,MAAM,gBAAgB,GAAG,mBAAmB,CAAC,EAAE,CAAC,CAAC;IAEjD,0EAA0E;IAC1E,sCAAsC;IACtC,wFAAwF;IACxF,EAAE,CAAC,QAAQ,GAAG,EAAE,CAAC;IAEjB,oEAAoE;IACpE,MAAM,oBAAoB,GAAG,EAAE,CAAC;IAChC,MAAM,OAAO,GAAG,eAAe,CAAC,OAAO,CAAC;IAExC,MAAM,aAAa,GAAG,MAAM,eAAe,CAAC,OAAO,EAAE,CAAC;IAEtD,MAAM,MAAM,GAAG,MAAM,eAAe,CAAC,UAAU,CAAC,eAAe;IAC7D,mCAAmC;IACnC,YAAY;IACZ,gBAAgB,EAChB,oBAAoB,EACpB,OAAO,EACP;QACE,IAAI,EAAE,aAAa;KACpB,CACF,CAAC;IACF,MAAM,EACJ,WAAW,EACX,aAAa,EACb,aAAa,EACb,WAAW,EACX,eAAe,EACf,YAAY,EACZ,UAAU,GACX,GAAG,MAAM,CAAC;IAEX,OAAO;QACL,WAAW;QACX,aAAa;QACb,aAAa;QACb,WAAW;QACX,eAAe,EAAE,eAAe,CAAC,QAAQ,EAAE;QAC3C,YAAY,EAAE,YAAY,CAAC,QAAQ,EAAE;QACrC,UAAU,EAAE,UAAU,CAAC,QAAQ,EAAE;KAClC,CAAC;AACJ,CAAC;AAED,SAAS,mBAAmB,CAC1B,EAAa;IAEb,MAAM,gBAAgB,GAAG,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE;QAChD,OAAO;YACL,GAAG,EAAE;YACL,KAAK,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC;SACxC,CAAC;IACJ,CAAC,CAAsB,CAAC;IAExB,OAAO,qBAAc,CAAC,aAAa,CAAC;QAClC,WAAW,EAAE,EAAE,CAAC,WAAW;QAC3B,UAAU,EAAE,gBAAgB;QAC5B,UAAU,EAAE,EAAE,CAAC,UAAU;QACzB,OAAO,EAAE,EAAE,CAAC,OAAO;QACnB,OAAO,EAAE,EAAE,CAAC,OAAO;QACnB,eAAe,EAAE,EAAE,CAAC,eAAe;QACnC,uBAAuB,EAAE,EAAE,CAAC,uBAAuB;QACnD,iBAAiB,EAAE,EAAE,CAAC,iBAAiB;QACvC,QAAQ,EAAE,EAAE,CAAC,QAAQ;QACrB,QAAQ,EAAE,EAAE,CAAC,QAAQ;QACrB,aAAa,EAAE,EAAE,CAAC,aAAa;KAChC,CAAC,CAAC;AACL,CAAC"}

package/dist/src/operationRequest/builder.d.ts

@@ -0,0 +1,40 @@
+import { NocturneConfig } from "@zill-protocol/config";
+import { CanonAddress, StealthAddress } from "@zill-protocol/crypto";
+import { ConfidentialPayment, OperationGasParams, OperationRequestWithMetadata, OperationRequest, UnwrapRequest, ConfidentialPaymentRequest, RefundRequest } from "./operationRequest";
+import { Action, Address, Asset } from "@zill-protocol/core";
+import { ethers } from "ethers";
+import { OperationMetadataItem } from "../types";
+export type OpRequestBuilder = OpRequestBuilderExt<BaseOpRequestBuilder>;
+export interface BuilderItemToProcess {
+    unwraps: UnwrapRequest[];
+    confidentialPayments: ConfidentialPaymentRequest[];
+    refunds: RefundRequest[];
+    actions: Action[];
+    metadatas: OperationMetadataItem[];
+}
+export type OpRequestBuilderExt<E extends BaseOpRequestBuilder> = E & {
+    use<E2 extends E>(plugin: OpRequestBuilderPlugin<E, E2>): OpRequestBuilderExt<E2>;
+};
+export interface BaseOpRequestBuilder {
+    provider: ethers.providers.JsonRpcProvider;
+    config: NocturneConfig;
+    _op: OperationRequest;
+    _builderItemsToProcess: Promise<BuilderItemToProcess>[];
+    build(): Promise<OperationRequestWithMetadata>;
+    pluginFn(pluginPromise: Promise<BuilderItemToProcess>): this;
+    __action(contractAddress: Address, encodedFunction: string): this;
+    __unwrap(asset: Asset, amountUnits: bigint): this;
+    confidentialPayment(asset: Asset, amountUnits: bigint, receiver: CanonAddress): this;
+    __refund(refund: RefundRequest): this;
+    refundAddr(addr: StealthAddress): this;
+    deadline(deadline: bigint): this;
+    gas(gasParams: OperationGasParams): this;
+    gasPrice(gasPrice: bigint): this;
+}
+export type OpRequestBuilderPlugin<E extends BaseOpRequestBuilder, E2 extends E> = (inner: OpRequestBuilderExt<E>) => OpRequestBuilderExt<E2>;
+export type UnwrapAmountAndPaymentsForAsset = {
+    unwrapAmount: bigint;
+    payments: ConfidentialPayment[];
+};
+export declare function newOpRequestBuilder(provider: ethers.providers.JsonRpcProvider, chainId: bigint, config?: NocturneConfig): OpRequestBuilderExt<BaseOpRequestBuilder>;
+//# sourceMappingURL=builder.d.ts.map

package/dist/src/operationRequest/builder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"builder.d.ts","sourceRoot":"","sources":["../../../src/operationRequest/builder.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EAEf,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACrE,OAAO,EACL,mBAAmB,EACnB,kBAAkB,EAClB,4BAA4B,EAC5B,gBAAgB,EAChB,aAAa,EACb,0BAA0B,EAC1B,aAAa,EACd,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACL,MAAM,EACN,OAAO,EACP,KAAK,EAGN,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,EAAqB,qBAAqB,EAAE,MAAM,UAAU,CAAC;AAGpE,MAAM,MAAM,gBAAgB,GAAG,mBAAmB,CAAC,oBAAoB,CAAC,CAAC;AAEzE,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,aAAa,EAAE,CAAC;IACzB,oBAAoB,EAAE,0BAA0B,EAAE,CAAC;IACnD,OAAO,EAAE,aAAa,EAAE,CAAC;IACzB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,SAAS,EAAE,qBAAqB,EAAE,CAAC;CACpC;AAGD,MAAM,MAAM,mBAAmB,CAAC,CAAC,SAAS,oBAAoB,IAAI,CAAC,GAAG;IAEpE,GAAG,CAAC,EAAE,SAAS,CAAC,EACd,MAAM,EAAE,sBAAsB,CAAC,CAAC,EAAE,EAAE,CAAC,GACpC,mBAAmB,CAAC,EAAE,CAAC,CAAC;CAC5B,CAAC;AAGF,MAAM,WAAW,oBAAoB;IACnC,QAAQ,EAAE,MAAM,CAAC,SAAS,CAAC,eAAe,CAAC;IAC3C,MAAM,EAAE,cAAc,CAAC;IAEvB,GAAG,EAAE,gBAAgB,CAAC;IACtB,sBAAsB,EAAE,OAAO,CAAC,oBAAoB,CAAC,EAAE,CAAC;IAExD,KAAK,IAAI,OAAO,CAAC,4BAA4B,CAAC,CAAC;IAI/C,QAAQ,CAAC,aAAa,EAAE,OAAO,CAAC,oBAAoB,CAAC,GAAG,IAAI,CAAC;IAK7D,QAAQ,CAAC,eAAe,EAAE,OAAO,EAAE,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAOlE,QAAQ,CAAC,KAAK,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAIlD,mBAAmB,CACjB,KAAK,EAAE,KAAK,EACZ,WAAW,EAAE,MAAM,EACnB,QAAQ,EAAE,YAAY,GACrB,IAAI,CAAC;IAIR,QAAQ,CAAC,MAAM,EAAE,aAAa,GAAG,IAAI,CAAC;IAKtC,UAAU,CAAC,IAAI,EAAE,cAAc,GAAG,IAAI,CAAC;IAIvC,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAMjC,GAAG,CAAC,SAAS,EAAE,kBAAkB,GAAG,IAAI,CAAC;IACzC,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;CAClC;AAMD,MAAM,MAAM,sBAAsB,CAChC,CAAC,SAAS,oBAAoB,EAC9B,EAAE,SAAS,CAAC,IACV,CAAC,KAAK,EAAE,mBAAmB,CAAC,CAAC,CAAC,KAAK,mBAAmB,CAAC,EAAE,CAAC,CAAC;AAI/D,MAAM,MAAM,+BAA+B,GAAG;IAC5C,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,mBAAmB,EAAE,CAAC;CACjC,CAAC;AAIF,wBAAgB,mBAAmB,CACjC,QAAQ,EAAE,MAAM,CAAC,SAAS,CAAC,eAAe,EAC1C,OAAO,EAAE,MAAM,EACf,MAAM,CAAC,EAAE,cAAc,GACtB,mBAAmB,CAAC,oBAAoB,CAAC,CA8O3C"}