@txnlab/haystack-router 3.3.0 → 3.5.0

package/dist/index.mjs

@@ -1,5 +1,5 @@
 import { t as Logger } from "./logger-CYA908f8.mjs";
-import { Algodv2, AtomicTransactionComposer, LogicSigAccount, TransactionType, decodeUint64, decodeUnsignedTransaction, encodeAddress, getApplicationAddress, isValidAddress, makeApplicationOptInTxnFromObject, makeAssetTransferTxnWithSuggestedParamsFromObject, msgpackRawDecode, signLogicSigTransactionObject, signTransaction } from "algosdk";
+import { Algodv2, AtomicTransactionComposer, LogicSigAccount, TransactionType, decodeUint64, decodeUnsignedTransaction, encodeAddress, getApplicationAddress, isTransactionWithSigner, isValidAddress, makeApplicationOptInTxnFromObject, makeAssetTransferTxnWithSuggestedParamsFromObject, msgpackRawDecode, signLogicSigTransactionObject, signTransaction } from "algosdk";
 // src/constants.ts
 /**
 * Supported DEX protocols for swap routing
@@ -42,8 +42,24 @@ const DEFAULT_MAX_DEPTH = 4;
 const DEFAULT_AUTO_OPT_IN = false;
 /** Default debug level (no debug logging) */
 const DEFAULT_DEBUG_LEVEL = "none";
+/**
+* What a Falcon (post-quantum) signature adds to its transaction's fee, in
+* microAlgos: algod charges a transaction it signs 3 fee units instead of 1
+*/
+const FALCON_EXTRA_FEE = 2000n;
 /** Default number of rounds to wait for transaction confirmation */
 const DEFAULT_CONFIRMATION_ROUNDS = 10;
+// src/firststage.ts
+/**
+* Normalize a quote's raw First Stage object, coercing amounts to bigint
+*/
+function toSwapFirstStageQuote(firstStage) {
+	return {
+		fromTax: BigInt(firstStage.fromTax),
+		toTax: BigInt(firstStage.toTax),
+		wrapped: [...firstStage.wrapped ?? []]
+	};
+}
 // src/launch.ts
 /**
 * Normalize a quote's raw launch object, coercing amounts to bigint and
@@ -159,6 +175,15 @@ var SwapComposer = class SwapComposer {
 	signer;
 	middleware;
 	note;
+	signerType;
+	signerFeesIncluded;
+	/** Transactions the account sends whose Falcon fees the composer adds */
+	signerFeeTxns = 0;
+	/** The account's first transaction in the group, which carries them when there's no input transfer */
+	firstUserTxn;
+	/** The swap's input transfer, whose fee carries a Falcon signer's extra fees */
+	inputTxn;
+	signerFeesAdded = false;
 	inputTransactionIndex;
 	outputTransactionIndex;
 	curveTransactionIndex;
@@ -193,6 +218,8 @@ var SwapComposer = class SwapComposer {
 		this.signer = config.signer;
 		this.middleware = config.middleware ?? [];
 		this.note = config.note;
+		this.signerType = config.signerType ?? config.quote.signerType ?? "ed25519";
+		this.signerFeesIncluded = config.signerFeesIncluded ?? false;
 	}
 	/**
 	* Get the status of this composer's transaction group
@@ -233,6 +260,7 @@ var SwapComposer = class SwapComposer {
 			txn: transaction,
 			signer
 		});
+		this.trackSignerFee(transaction.sender, transaction);
 		return this;
 	}
 	/**
@@ -253,6 +281,8 @@ var SwapComposer = class SwapComposer {
 			...methodCall,
 			signer: methodCall.signer ?? signer
 		});
+		for (const arg of methodCall.methodArgs ?? []) if (isTransactionWithSigner(arg)) this.trackSignerFee(arg.txn.sender, arg.txn);
+		this.trackSignerFee(methodCall.sender);
 		return this;
 	}
 	/**
@@ -276,15 +306,25 @@ var SwapComposer = class SwapComposer {
 		if (this.getStatus() !== 0) throw new Error("Cannot add swap transactions when composer status is not BUILDING");
 		const beforeTxns = await this.executeMiddlewareHooks("beforeSwap");
 		if (this.atc.count() + beforeTxns.length > SwapComposer.MAX_GROUP_SIZE) throw new Error(`Adding beforeSwap transactions exceeds the maximum atomic group size of ${SwapComposer.MAX_GROUP_SIZE}`);
-		for (const txnWithSigner of beforeTxns) this.atc.addTransaction(txnWithSigner);
-		const { txns: processedTxns, inputTxnRelativeIndex, outputTxnRelativeIndex, curveTxnRelativeIndex } = await this.processSwapTransactions();
+		for (const txnWithSigner of beforeTxns) {
+			this.atc.addTransaction(txnWithSigner);
+			this.trackSignerFee(txnWithSigner.txn.sender, txnWithSigner.txn);
+		}
+		const { txns: processedTxns, apiTxns, inputTxn, inputTxnRelativeIndex, outputTxnRelativeIndex, curveTxnRelativeIndex } = await this.processSwapTransactions();
 		const afterTxns = await this.executeMiddlewareHooks("afterSwap");
 		if (this.atc.count() + processedTxns.length + afterTxns.length > SwapComposer.MAX_GROUP_SIZE) throw new Error(`Adding swap transactions exceeds the maximum atomic group size of ${SwapComposer.MAX_GROUP_SIZE}`);
 		if (inputTxnRelativeIndex !== void 0) this.inputTransactionIndex = this.atc.count() + inputTxnRelativeIndex;
 		if (outputTxnRelativeIndex !== void 0) this.outputTransactionIndex = this.atc.count() + outputTxnRelativeIndex;
 		if (curveTxnRelativeIndex !== void 0) this.curveTransactionIndex = this.atc.count() + curveTxnRelativeIndex;
-		for (const txnWithSigner of processedTxns) this.atc.addTransaction(txnWithSigner);
-		for (const txnWithSigner of afterTxns) this.atc.addTransaction(txnWithSigner);
+		for (const txnWithSigner of processedTxns) {
+			this.atc.addTransaction(txnWithSigner);
+			this.trackSignerFee(txnWithSigner.txn.sender, txnWithSigner.txn, this.signerFeesIncluded && apiTxns.has(txnWithSigner.txn));
+		}
+		this.inputTxn = inputTxn;
+		for (const txnWithSigner of afterTxns) {
+			this.atc.addTransaction(txnWithSigner);
+			this.trackSignerFee(txnWithSigner.txn.sender, txnWithSigner.txn);
+		}
 		this.swapTransactionsAdded = true;
 		return this;
 	}
@@ -312,6 +352,7 @@ var SwapComposer = class SwapComposer {
 	* ```
 	*/
 	buildGroup() {
+		this.addSignerFees();
 		return this.atc.buildGroup();
 	}
 	/**
@@ -330,6 +371,7 @@ var SwapComposer = class SwapComposer {
 	async sign() {
 		if (this.getStatus() >= 2) return this.atc.gatherSignatures();
 		if (!this.swapTransactionsAdded) await this.addSwapTransactions();
+		this.addSignerFees();
 		return await this.atc.gatherSignatures();
 	}
 	/**
@@ -349,6 +391,7 @@ var SwapComposer = class SwapComposer {
 	*/
 	async submit() {
 		if (!this.swapTransactionsAdded) await this.addSwapTransactions();
+		this.addSignerFees();
 		return await this.atc.submit(this.algodClient);
 	}
 	/**
@@ -372,6 +415,7 @@ var SwapComposer = class SwapComposer {
 	async execute(waitRounds = 10) {
 		try {
 			if (!this.swapTransactionsAdded) await this.addSwapTransactions();
+			this.addSignerFees();
 			const { txIDs, ...result } = await this.atc.execute(this.algodClient, waitRounds);
 			if (this.summaryData) {
 				if (this.inputTransactionIndex !== void 0) this.summaryData.inputTxnId = txIDs[this.inputTransactionIndex];
@@ -480,6 +524,40 @@ var SwapComposer = class SwapComposer {
 		};
 	}
 	/**
+	* Counts a transaction from sender toward a Falcon signer's extra fees
+	* (addSignerFees) when the account sends it, unless the router's fees
+	* already include it (included). Every way of adding a transaction calls
+	* it; txn is the transaction when the composer holds it (not a method call
+	* the ATC builds), which can then carry the fees.
+	*/
+	trackSignerFee(sender, txn, included = false) {
+		if (sender.toString() !== this.address) return;
+		if (txn) this.firstUserTxn ??= txn;
+		if (!included) this.signerFeeTxns++;
+	}
+	/**
+	* Adds a Falcon signer's extra fees before the group is built: a Falcon
+	* signature costs 3 fee units where an ed25519 one costs 1, and fees pool
+	* across the group, so the fee of the swap's input transfer (which already
+	* carries the router's fee budget) rises by FALCON_EXTRA_FEE for each
+	* transaction the account sends that the router's fees don't include. The
+	* account pays it, like every fee of the group. Runs once, while the group
+	* is still being built.
+	*/
+	addSignerFees() {
+		if (this.signerType !== "falcon" || this.signerFeesAdded || this.getStatus() !== 0) return;
+		if (this.signerFeeTxns > 0) {
+			const carrier = this.inputTxn ?? this.firstUserTxn;
+			if (!carrier) throw new Error(`No transaction from ${this.address} in the group to carry its Falcon signature fees`);
+			carrier.fee += FALCON_EXTRA_FEE * BigInt(this.signerFeeTxns);
+			Logger.debug("Added Falcon signature fees", {
+				transactions: this.signerFeeTxns,
+				fee: carrier.fee
+			});
+		}
+		this.signerFeesAdded = true;
+	}
+	/**
 	* Validates an Algorand address
 	*/
 	validateAddress(address) {
@@ -524,10 +602,12 @@ var SwapComposer = class SwapComposer {
 			};
 		}
 		const curveIndex = this.initLaunchSummary(decoded);
-		const outputIndex = this.summaryData?.launch?.side === "buy" && curveIndex !== void 0 ? curveIndex : swapTxns.length - 1;
+		const outputIndex = this.summaryData?.launch?.side === "buy" && curveIndex !== void 0 ? curveIndex : this.findOutputTransactionIndex(decoded);
 		const outputTxnRelativeIndex = outputIndex >= 0 ? appOptIns.length + outputIndex : void 0;
 		return {
 			txns: [...appOptIns, ...swapTxns],
+			apiTxns: new Set(decoded.map(({ txn }) => txn)),
+			inputTxn,
 			inputTxnRelativeIndex: inputIndex !== void 0 ? appOptIns.length + inputIndex : void 0,
 			outputTxnRelativeIndex,
 			curveTxnRelativeIndex: curveIndex !== void 0 ? appOptIns.length + curveIndex : void 0
@@ -559,6 +639,20 @@ var SwapComposer = class SwapComposer {
 		for (let i = txns.length - 1; i >= 0; i--) if (txns[i]?.signature === false) return i;
 	}
 	/**
+	* Finds the router's last app call among the API's transactions: v4's
+	* route call or v3's finalize, which pays the output. The router's calls
+	* are the pre-signed ones. A First Stage swap ends with the user's own tax
+	* payment and First Stage calls after it, so the last transaction isn't
+	* always the router's. Falls back to the last transaction.
+	*/
+	findOutputTransactionIndex(txns) {
+		for (let i = txns.length - 1; i >= 0; i--) {
+			const t = txns[i];
+			if (t?.signature !== false && t?.txn.type === TransactionType.appl) return i;
+		}
+		return txns.length - 1;
+	}
+	/**
 	* For a launch quote, finds the user-signed curve buy or sell call and
 	* records the curve leg in summaryData. On a sell, the input amount becomes
 	* the launch tokens sold.
@@ -653,11 +747,16 @@ var SwapComposer = class SwapComposer {
 	*/
 	async executeMiddlewareHooks(hookName) {
 		const allTxns = [];
-		const quote = "createdAt" in this.quote ? this.quote : {
+		const quote = "createdAt" in this.quote ? {
+			...this.quote,
+			signerType: this.signerType
+		} : {
 			...this.quote,
 			quote: this.quote.quote === "" ? 0n : BigInt(this.quote.quote),
 			amount: 0n,
 			launch: this.quote.launch && toSwapLaunchQuote(this.quote.launch),
+			firstStage: this.quote.firstStage && toSwapFirstStageQuote(this.quote.firstStage),
+			signerType: this.signerType,
 			createdAt: Date.now()
 		};
 		const quoteContext = {
@@ -804,14 +903,14 @@ async function request(url, options) {
 * @example
 * ```typescript
 * const router = new RouterClient({
-*   apiKey: '1b72df7e-1131-4449-8ce1-29b79dd3f51e', // Free tier (60 requests/min)
+*   apiKey: 'hay_pk_4zhj33wahuxfplteyif5xpcgnm', // Free tier (60 requests/min)
 * })
 * ```
 *
 * @example
 * ```typescript
 * const router = new RouterClient({
-*   apiKey: '1b72df7e-1131-4449-8ce1-29b79dd3f51e', // Free tier (60 requests/min)
+*   apiKey: 'hay_pk_4zhj33wahuxfplteyif5xpcgnm', // Free tier (60 requests/min)
 *   apiBaseUrl: 'https://hayrouter.txnlab.dev',
 *   algodUri: 'https://mainnet-api.4160.nodely.dev/',
 *   algodToken: '',
@@ -891,8 +990,9 @@ var RouterClient = class {
 	* ```
 	*/
 	async fetchQuote(params) {
-		const { fromASAID, toASAID, amount, type = "fixed-input", disabledProtocols = [], maxGroupSize = 16, maxDepth = 4, optIn, address, slippage, _allowNonComposableSwaps = false } = params;
+		const { fromASAID, toASAID, amount, type = "fixed-input", disabledProtocols = [], maxGroupSize = 16, maxDepth = 4, optIn, address, slippage, signerType, _allowNonComposableSwaps = false } = params;
 		if (slippage !== void 0) this.validateSlippage(slippage);
+		if (signerType !== void 0 && signerType !== "ed25519" && signerType !== "falcon") throw new Error(`Invalid signerType: ${String(signerType)}. Must be 'ed25519' or 'falcon'`);
 		if (_allowNonComposableSwaps && (optIn === true || this.config.autoOptIn)) throw new Error("Cannot use _allowNonComposableSwaps with optIn or autoOptIn. When allowing non-composable swaps (Tinyman v1), you must handle asset opt-ins and opt-outs in separate transaction groups.");
 		const allDisabledProtocols = _allowNonComposableSwaps ? [...new Set(disabledProtocols)] : [.../* @__PURE__ */ new Set([...DEPRECATED_PROTOCOLS, ...disabledProtocols])];
 		let includeOptIn = optIn;
@@ -913,7 +1013,9 @@ var RouterClient = class {
 		url.searchParams.append("maxGroupSize", maxGroupSize.toString());
 		url.searchParams.append("maxDepth", maxDepth.toString());
 		if (typeof includeOptIn === "boolean") url.searchParams.append("optIn", String(includeOptIn));
+		if (address) url.searchParams.append("address", this.validateAddress(address));
 		if (slippage !== void 0) url.searchParams.append("slippage", String(slippage));
+		if (signerType === "falcon") url.searchParams.append("signerType", signerType);
 		if (this.config.referrerAddress) url.searchParams.append("referrerAddress", this.config.referrerAddress);
 		return request(url.toString(), { headers: this.authHeaders() });
 	}
@@ -1034,7 +1136,7 @@ var RouterClient = class {
 		};
 		for (const mw of this.middleware) if (await mw.shouldApply(quoteContext) && mw.adjustQuoteParams) adjustedParams = await mw.adjustQuoteParams(adjustedParams);
 		const response = await this.fetchQuote(adjustedParams);
-		const { launch, ...rest } = response;
+		const { launch, firstStage, ...rest } = response;
 		return {
 			...rest,
 			quote: response.quote === "" ? 0n : BigInt(response.quote),
@@ -1042,6 +1144,8 @@ var RouterClient = class {
 			address: params.address ?? void 0,
 			slippage: adjustedParams.slippage,
 			launch: launch && toSwapLaunchQuote(launch),
+			firstStage: firstStage && toSwapFirstStageQuote(firstStage),
+			signerType: adjustedParams.signerType ?? params.signerType ?? "ed25519",
 			createdAt: Date.now()
 		};
 	}
@@ -1095,19 +1199,23 @@ var RouterClient = class {
 	*/
 	async newSwap(config) {
 		const { quote, address, slippage, signer, note } = config;
+		const signerType = config.signerType ?? quote.signerType ?? "ed25519";
 		if (quote.launch && "createdAt" in quote && quote.slippage !== slippage) console.warn(quote.slippage === void 0 ? `Launch token quote was fetched without slippage but the swap uses ${slippage}%. Pass the same slippage to newQuote() for an accurate quoted output.` : `Launch token quote was fetched with ${quote.slippage}% slippage but the swap uses ${slippage}%. The quoted output may not match what is delivered.`);
+		const swapResponse = await this.fetchSwapTransactions({
+			quote,
+			address,
+			slippage
+		});
 		return new SwapComposer({
 			quote,
-			swapTxns: (await this.fetchSwapTransactions({
-				quote,
-				address,
-				slippage
-			})).txns,
+			swapTxns: swapResponse.txns,
 			algodClient: this.algodClient,
 			address,
 			signer,
 			middleware: this.middleware,
 			note,
+			signerType,
+			signerFeesIncluded: swapResponse.signerType === "falcon",
 			debugLevel: this.config.debugLevel
 		});
 	}
@@ -1154,7 +1262,7 @@ var RouterClient = class {
 * })
 *
 * const router = new RouterClient({
-*   apiKey: '1b72df7e-1131-4449-8ce1-29b79dd3f51e', // Free tier (60 requests/min)
+*   apiKey: 'hay_pk_4zhj33wahuxfplteyif5xpcgnm', // Free tier (60 requests/min)
 *   middleware: [autoOptOut],
 * })
 *
@@ -1210,6 +1318,6 @@ var AutoOptOutMiddleware = class {
 		}];
 	}
 };
-export { API_KEY_HEADER, AutoOptOutMiddleware, DEFAULT_ALGOD_PORT, DEFAULT_ALGOD_TOKEN, DEFAULT_ALGOD_URI, DEFAULT_API_BASE_URL, DEFAULT_AUTO_OPT_IN, DEFAULT_CONFIRMATION_ROUNDS, DEFAULT_DEBUG_LEVEL, DEFAULT_FEE_BPS, DEFAULT_MAX_DEPTH, DEFAULT_MAX_GROUP_SIZE, DEPRECATED_PROTOCOLS, HTTPError, MAX_FEE_BPS, Protocol, RouterClient, SwapComposer, SwapComposerStatus, request };
+export { API_KEY_HEADER, AutoOptOutMiddleware, DEFAULT_ALGOD_PORT, DEFAULT_ALGOD_TOKEN, DEFAULT_ALGOD_URI, DEFAULT_API_BASE_URL, DEFAULT_AUTO_OPT_IN, DEFAULT_CONFIRMATION_ROUNDS, DEFAULT_DEBUG_LEVEL, DEFAULT_FEE_BPS, DEFAULT_MAX_DEPTH, DEFAULT_MAX_GROUP_SIZE, DEPRECATED_PROTOCOLS, FALCON_EXTRA_FEE, HTTPError, MAX_FEE_BPS, Protocol, RouterClient, SwapComposer, SwapComposerStatus, request };
 
 //# sourceMappingURL=index.mjs.map