@gearbox-protocol/sdk 16.4.0-next.1 → 16.4.0-next.11

package/dist/esm/dev/kycUtils.js

@@ -4,23 +4,12 @@ import { OnchainSDK } from "../onchain/OnchainSDK.js";
 import "../onchain/index.js";
 import { iDSRegistryServiceAbi } from "../abi/rwa/iDSRegistryService.js";
 import { iDSTokenAbi } from "../abi/rwa/iDSToken.js";
+import { collectMidasGateways } from "./midasUtils.js";
 import { midasGatewayAbi } from "./withdrawalAbi.js";
 import { isAddressEqual, parseAbi, parseEther, zeroAddress } from "viem";
 import { privateKeyToAccount } from "viem/accounts";
 //#region src/dev/kycUtils.ts
 /**
-* Writes to a contract, mines a block and waits for the receipt
-*/
-async function writeAndWait(anvil, params) {
-	const hash = await anvil.writeContract(params);
-	await anvil.mine({ blocks: 1 });
-	await anvil.waitForTransactionReceipt({
-		hash,
-		pollingInterval: 100
-	});
-	return hash;
-}
-/**
 * Resolves the account that performs the DS registry writes: either the admin
 * private key, or the admin address impersonated on the fork
 */
@@ -98,36 +87,39 @@ async function registerSecuritizeInvestor(props) {
 		const { account, release } = await useSecuritizeAdmin(props);
 		try {
 			if (!investorExists) {
-				await writeAndWait(anvil, {
+				await anvil.writeContractSync({
 					account,
 					chain: anvil.chain,
 					address: registryService,
 					abi: iDSRegistryServiceAbi,
 					functionName: "registerInvestor",
-					args: [investorId, investorId]
+					args: [investorId, investorId],
+					throwOnReceiptRevert: true
 				});
 				logger?.debug(`Registered investor "${investorId}"`);
 			}
-			await writeAndWait(anvil, {
+			await anvil.writeContractSync({
 				account,
 				chain: anvil.chain,
 				address: registryService,
 				abi: iDSRegistryServiceAbi,
 				functionName: "addWallet",
-				args: [investor, investorId]
+				args: [investor, investorId],
+				throwOnReceiptRevert: true
 			});
 			logger?.debug(`Added wallet ${investor} for investor "${investorId}"`);
 			try {
-				await writeAndWait(anvil, {
+				await anvil.writeContractSync({
 					account,
 					chain: anvil.chain,
 					address: registryService,
 					abi: iDSRegistryServiceAbi,
 					functionName: "setCountry",
-					args: [investorId, "US"]
+					args: [investorId, "US"],
+					throwOnReceiptRevert: true
 				});
 				logger?.debug(`Set country for investor "${investorId}" to "US"`);
-				await writeAndWait(anvil, {
+				await anvil.writeContractSync({
 					account,
 					chain: anvil.chain,
 					address: registryService,
@@ -139,7 +131,8 @@ async function registerSecuritizeInvestor(props) {
 						BigInt(APPROVED),
 						MAX_UINT256,
 						"fake proof"
-					]
+					],
+					throwOnReceiptRevert: true
 				});
 				logger?.debug(`Set attributes for investor "${investorId}"`);
 			} catch (e) {
@@ -241,13 +234,14 @@ async function greenlistMidasGateway(props) {
 				logger?.debug(`midas: ${account} already has role ${role}`);
 				continue;
 			}
-			await writeAndWait(anvil, {
+			await anvil.writeContractSync({
 				account: admin,
 				chain: anvil.chain,
 				address: accessControl,
 				abi: iMidasAccessControlAbi,
 				functionName: "grantRole",
-				args: [role, account]
+				args: [role, account],
+				throwOnReceiptRevert: true
 			});
 			logger?.debug(`midas: granted role ${role} to ${account}`);
 		}
@@ -294,16 +288,6 @@ async function findMidasGateway(props) {
 	return candidates[index];
 }
 /**
-* Collects the target contracts of all Midas gateway adapters of the loaded
-* credit managers, same as the foundry tests do with
-* `ICreditConfiguratorV3.allowedAdapters`
-*/
-function collectMidasGateways(sdk) {
-	const gateways = new AddressSet();
-	for (const cm of sdk.marketRegister.creditManagers) for (const adapter of cm.creditManager.adapters.values()) if (adapter.contractType === "ADAPTER::MIDAS_GATEWAY") gateways.add(adapter.targetContract);
-	return gateways.asArray();
-}
-/**
 * Registers a wallet as an investor (fake KYC) in every Securitize DSToken and
 * every Midas gateway of the markets loaded by `sdk`.
 *
@@ -361,4 +345,4 @@ async function registerRWAInvestor(props) {
 	};
 }
 //#endregion
-export { greenlistMidasGateway, registerMidasInvestor, registerRWAInvestor, registerSecuritizeInvestor, writeAndWait };
+export { greenlistMidasGateway, registerMidasInvestor, registerRWAInvestor, registerSecuritizeInvestor };

package/dist/esm/dev/midasUtils.js

@@ -1,5 +1,7 @@
-import { writeAndWait } from "./kycUtils.js";
-import { parseAbi, parseEther } from "viem";
+import { AddressSet } from "../onchain/utils/AddressSet.js";
+import { MidasGatewayAdapterContract } from "../onchain/market/adapters/contracts/MidasGatewayAdapterContract.js";
+import "../onchain/index.js";
+import { parseAbi, parseEther, toFunctionSelector } from "viem";
 //#region src/dev/midasUtils.ts
 /**
 * Midas vaults inherit their own `Pausable`, whose global pause is guarded by
@@ -9,14 +11,24 @@ const iMidasPausableVaultAbi = parseAbi([
 	"function paused() external view returns (bool)",
 	"function pause() external",
 	"function unpause() external",
+	"function fnPaused(bytes4 fn) external view returns (bool)",
+	"function pauseFn(bytes4 fn) external",
+	"function unpauseFn(bytes4 fn) external",
 	"function pauseAdminRole() external view returns (bytes32)",
 	"function accessControl() external view returns (address)"
 ]);
 const iMidasAccessControlAbi = parseAbi(["function hasRole(bytes32 role, address account) external view returns (bool)", "function grantRole(bytes32 role, address account) external"]);
 /**
-* Unpauses a globally paused Midas issuance vault on an anvil fork, so that
-* `depositInstant` stops reverting with `Pausable: paused`, and returns a
-* callback that restores the original pause state.
+* Selector for `DepositVault.depositInstant(address,uint256,uint256,bytes32)`,
+* the 4-arg mint Gearbox adapters encode. Distinct from the custom-recipient
+* overload.
+*/
+const DEPOSIT_INSTANT_SELECTOR = toFunctionSelector("depositInstant(address,uint256,uint256,bytes32)");
+/**
+* Unpauses a Midas issuance vault on an anvil fork so that `depositInstant`
+* stops reverting with `Pausable: paused` (global) or `Pausable: fn paused`
+* (per-selector), and returns a callback that restores the original pause
+* state of each layer that was cleared.
 *
 * Impersonates `admin` and grants it `pauseAdminRole()` when missing, same as
 * `greenlistMidasGateway` does with the greenlist roles. The grant is not
@@ -24,11 +36,20 @@ const iMidasAccessControlAbi = parseAbi(["function hasRole(bytes32 role, address
 */
 async function unpauseMidasIssuanceVault(props) {
 	const { anvil, vault, admin, logger } = props;
-	if (!await anvil.readContract({
-		address: vault,
-		abi: iMidasPausableVaultAbi,
-		functionName: "paused"
-	})) {
+	const [paused, depositInstantPaused] = await anvil.multicall({
+		allowFailure: false,
+		contracts: [{
+			address: vault,
+			abi: iMidasPausableVaultAbi,
+			functionName: "paused"
+		}, {
+			address: vault,
+			abi: iMidasPausableVaultAbi,
+			functionName: "fnPaused",
+			args: [DEPOSIT_INSTANT_SELECTOR]
+		}]
+	});
+	if (!paused && !depositInstantPaused) {
 		logger?.debug(`midas: issuance vault ${vault} is not paused`);
 		return async () => {};
 	}
@@ -50,7 +71,7 @@ async function unpauseMidasIssuanceVault(props) {
 		functionName: "hasRole",
 		args: [pauseAdminRole, admin]
 	});
-	logger?.debug(`midas: unpausing issuance vault ${vault} as ${admin}, access control ${accessControl}, pause admin role ${pauseAdminRole}`);
+	logger?.debug(`midas: unpausing issuance vault ${vault} as ${admin}, access control ${accessControl}, pause admin role ${pauseAdminRole}` + (paused ? ", global" : "") + (depositInstantPaused ? ", depositInstant" : ""));
 	await anvil.impersonateAccount({ address: admin });
 	try {
 		await anvil.setBalance({
@@ -58,22 +79,33 @@ async function unpauseMidasIssuanceVault(props) {
 			value: parseEther("100")
 		});
 		if (!isPauseAdmin) {
-			await writeAndWait(anvil, {
+			await anvil.writeContractSync({
 				account: admin,
 				chain: anvil.chain,
 				address: accessControl,
 				abi: iMidasAccessControlAbi,
 				functionName: "grantRole",
-				args: [pauseAdminRole, admin]
+				args: [pauseAdminRole, admin],
+				throwOnReceiptRevert: true
 			});
 			logger?.debug(`midas: granted pause admin role to ${admin}`);
 		}
-		await writeAndWait(anvil, {
+		if (paused) await anvil.writeContractSync({
+			account: admin,
+			chain: anvil.chain,
+			address: vault,
+			abi: iMidasPausableVaultAbi,
+			functionName: "unpause",
+			throwOnReceiptRevert: true
+		});
+		if (depositInstantPaused) await anvil.writeContractSync({
 			account: admin,
 			chain: anvil.chain,
 			address: vault,
 			abi: iMidasPausableVaultAbi,
-			functionName: "unpause"
+			functionName: "unpauseFn",
+			args: [DEPOSIT_INSTANT_SELECTOR],
+			throwOnReceiptRevert: true
 		});
 	} finally {
 		await anvil.stopImpersonatingAccount({ address: admin });
@@ -89,12 +121,22 @@ async function unpauseMidasIssuanceVault(props) {
 				address: admin,
 				value: parseEther("100")
 			});
-			await writeAndWait(anvil, {
+			if (paused) await anvil.writeContractSync({
+				account: admin,
+				chain: anvil.chain,
+				address: vault,
+				abi: iMidasPausableVaultAbi,
+				functionName: "pause",
+				throwOnReceiptRevert: true
+			});
+			if (depositInstantPaused) await anvil.writeContractSync({
 				account: admin,
 				chain: anvil.chain,
 				address: vault,
 				abi: iMidasPausableVaultAbi,
-				functionName: "pause"
+				functionName: "pauseFn",
+				args: [DEPOSIT_INSTANT_SELECTOR],
+				throwOnReceiptRevert: true
 			});
 		} catch (e) {
 			logger?.warn(`midas: failed to pause issuance vault ${vault} back: ${e}`);
@@ -103,5 +145,25 @@ async function unpauseMidasIssuanceVault(props) {
 		}
 	};
 }
+function* midasGatewayAdapters(sdk) {
+	for (const cm of sdk.marketRegister.creditManagers) for (const adapter of cm.creditManager.adapters.values()) if (adapter instanceof MidasGatewayAdapterContract) yield adapter;
+}
+/**
+* Target contracts of all Midas gateway adapters of the loaded credit managers,
+* same as the foundry tests do with `ICreditConfiguratorV3.allowedAdapters`
+*/
+function collectMidasGateways(sdk) {
+	const gateways = new AddressSet();
+	for (const adapter of midasGatewayAdapters(sdk)) gateways.add(adapter.targetContract);
+	return gateways.asArray();
+}
+/**
+* mTokens of all Midas gateway adapters of the loaded credit managers
+*/
+function collectMidasMTokens(sdk) {
+	const mTokens = new AddressSet();
+	for (const adapter of midasGatewayAdapters(sdk)) mTokens.add(adapter.mToken);
+	return mTokens.asArray();
+}
 //#endregion
-export { unpauseMidasIssuanceVault };
+export { collectMidasGateways, collectMidasMTokens, unpauseMidasIssuanceVault };

package/dist/esm/dev/securitizeUtils.js

@@ -2,7 +2,7 @@ import { AddressSet } from "../onchain/utils/AddressSet.js";
 import { OnchainSDK } from "../onchain/OnchainSDK.js";
 import "../onchain/index.js";
 import { iDSTokenAbi } from "../abi/rwa/iDSToken.js";
-import { registerSecuritizeInvestor, writeAndWait } from "./kycUtils.js";
+import { registerSecuritizeInvestor } from "./kycUtils.js";
 import { erc20Abi, isAddressEqual, parseAbi, zeroAddress } from "viem";
 import { privateKeyToAccount } from "viem/accounts";
 //#region src/dev/securitizeUtils.ts
@@ -64,7 +64,7 @@ async function issueDSTokens(props) {
 		const { timestamp } = await anvil.getBlock();
 		const issuanceTime = timestamp - lockPeriod - 1n;
 		try {
-			const hash = await writeAndWait(anvil, {
+			const receipt = await anvil.writeContractSync({
 				account,
 				chain: anvil.chain,
 				address: token,
@@ -77,14 +77,15 @@ async function issueDSTokens(props) {
 					0n,
 					"",
 					0n
-				]
+				],
+				throwOnReceiptRevert: true
 			});
 			logger?.debug({
 				issuanceTime,
 				investor,
 				amount
 			}, "issueTokensCustom successful");
-			return hash;
+			return receipt.transactionHash;
 		} catch (e) {
 			logger?.debug(`issueTokensCustom failed: ${e}`);
 		}
@@ -93,14 +94,15 @@ async function issueDSTokens(props) {
 		investor,
 		amount
 	}, "Falling back to issueTokens");
-	return writeAndWait(anvil, {
+	return (await anvil.writeContractSync({
 		account,
 		chain: anvil.chain,
 		address: token,
 		abi: iDSTokenAbi,
 		functionName: "issueTokens",
-		args: [investor, amount]
-	});
+		args: [investor, amount],
+		throwOnReceiptRevert: true
+	})).transactionHash;
 }
 /**
 * Resolves unique compliance configuration services of `tokens`: several
@@ -160,13 +162,14 @@ async function enableDSTokenBackDating(props) {
 			continue;
 		}
 		logger?.info(`Allowing back-dating on ${service}`);
-		await writeAndWait(anvil, {
+		await anvil.writeContractSync({
 			account,
 			chain: anvil.chain,
 			address: service,
 			abi: iDSComplianceConfigurationServiceAbi,
 			functionName: "setDisallowBackDating",
-			args: [false]
+			args: [false],
+			throwOnReceiptRevert: true
 		});
 		toRestore.push(service);
 	}
@@ -176,13 +179,14 @@ async function enableDSTokenBackDating(props) {
 		for (const service of services) {
 			logger?.info(`Disallowing back-dating on ${service}`);
 			try {
-				await writeAndWait(anvil, {
+				await anvil.writeContractSync({
 					account,
 					chain: anvil.chain,
 					address: service,
 					abi: iDSComplianceConfigurationServiceAbi,
 					functionName: "setDisallowBackDating",
-					args: [true]
+					args: [true],
+					throwOnReceiptRevert: true
 				});
 			} catch (e) {
 				logger?.warn(`Failed to restore disallowBackDating on ${service}: ${e}`);

package/dist/esm/dev/withdrawalUtils.js

@@ -204,18 +204,15 @@ async function fulfillMidasRedeemer(anvil, redeemer, logger) {
 		address: MIDAS_VAULT_ADMIN,
 		value: parseEther("100")
 	});
-	const hash = await anvil.writeContract({
+	await anvil.writeContractSync({
 		chain: anvil.chain,
 		address: midasRedemptionVault,
 		account: MIDAS_VAULT_ADMIN,
 		abi: iMidasRedemptionVaultExtAbi,
 		functionName: "safeApproveRequest",
-		args: [requestId, mTokenRate]
+		args: [requestId, mTokenRate],
+		throwOnReceiptRevert: true
 	});
-	if ((await anvil.waitForTransactionReceipt({
-		hash,
-		pollingInterval: 100
-	})).status !== "success") throw new Error(`midas: safeApproveRequest tx ${hash} reverted`);
 	await anvil.stopImpersonatingAccount({ address: MIDAS_VAULT_ADMIN });
 }
 /**

package/dist/esm/model/errors/index.js

@@ -1,7 +1,7 @@
 import "./base.js";
 import { creditAccountFrozen, liquidatorNotEligible, notEmergencyLiquidator } from "./liquidation-errors.js";
-import { creditManagerPaused, debtOutOfRange, forbiddenToken, insufficientAllowance, insufficientBalance, insufficientCollateral, insufficientPoolLiquidity, leverageOutOfRange, marketExpired, poolPaused, poolSunset, quotaCountExceeded, quotaLimitReached, reservePriceLimited, rwaOpenRequirementsNotMet } from "./operation-errors.js";
+import { accountNotMidasGreenlisted, creditManagerPaused, debtOutOfRange, forbiddenToken, insufficientAllowance, insufficientBalance, insufficientCollateral, insufficientPoolLiquidity, leverageOutOfRange, marketExpired, poolPaused, poolSunset, quotaCountExceeded, quotaLimitReached, reservePriceLimited, rwaOpenRequirementsNotMet } from "./operation-errors.js";
 import { unpriceableTokenError } from "./oracle-errors.js";
 import { creditAccountNotEmpty, creditAccountNotFound, multipleDelayedWithdrawals, noDelayedRoute, noRecordedIntent, noStrategyTargetCollateral, unexpectedFailure, unsupportedCollateralToken, unsupportedTokenPair, withdrawalInProgress } from "./prepare-errors.js";
 import { malformedTransaction } from "./preview-errors.js";
-export { creditAccountFrozen, creditAccountNotEmpty, creditAccountNotFound, creditManagerPaused, debtOutOfRange, forbiddenToken, insufficientAllowance, insufficientBalance, insufficientCollateral, insufficientPoolLiquidity, leverageOutOfRange, liquidatorNotEligible, malformedTransaction, marketExpired, multipleDelayedWithdrawals, noDelayedRoute, noRecordedIntent, noStrategyTargetCollateral, notEmergencyLiquidator, poolPaused, poolSunset, quotaCountExceeded, quotaLimitReached, reservePriceLimited, rwaOpenRequirementsNotMet, unexpectedFailure, unpriceableTokenError, unsupportedCollateralToken, unsupportedTokenPair, withdrawalInProgress };
+export { accountNotMidasGreenlisted, creditAccountFrozen, creditAccountNotEmpty, creditAccountNotFound, creditManagerPaused, debtOutOfRange, forbiddenToken, insufficientAllowance, insufficientBalance, insufficientCollateral, insufficientPoolLiquidity, leverageOutOfRange, liquidatorNotEligible, malformedTransaction, marketExpired, multipleDelayedWithdrawals, noDelayedRoute, noRecordedIntent, noStrategyTargetCollateral, notEmergencyLiquidator, poolPaused, poolSunset, quotaCountExceeded, quotaLimitReached, reservePriceLimited, rwaOpenRequirementsNotMet, unexpectedFailure, unpriceableTokenError, unsupportedCollateralToken, unsupportedTokenPair, withdrawalInProgress };

package/dist/esm/model/errors/operation-errors.js

@@ -125,5 +125,13 @@ function rwaOpenRequirementsNotMet(args) {
 		...args
 	};
 }
+/** {@inheritDoc AccountNotMidasGreenlistedError} */
+function accountNotMidasGreenlisted(args) {
+	return {
+		code: "accountNotMidasGreenlisted",
+		message: `The credit account is not Midas-greenlisted for ${args.token.symbol}.`,
+		...args
+	};
+}
 //#endregion
-export { creditManagerPaused, debtOutOfRange, forbiddenToken, insufficientAllowance, insufficientBalance, insufficientCollateral, insufficientPoolLiquidity, leverageOutOfRange, marketExpired, poolPaused, poolSunset, quotaCountExceeded, quotaLimitReached, reservePriceLimited, rwaOpenRequirementsNotMet };
+export { accountNotMidasGreenlisted, creditManagerPaused, debtOutOfRange, forbiddenToken, insufficientAllowance, insufficientBalance, insufficientCollateral, insufficientPoolLiquidity, leverageOutOfRange, marketExpired, poolPaused, poolSunset, quotaCountExceeded, quotaLimitReached, reservePriceLimited, rwaOpenRequirementsNotMet };

package/dist/esm/model/index.js

@@ -15,7 +15,7 @@ import { ANALYTICS_POSITIONS_DEFAULT_LIMIT, ANALYTICS_POSITIONS_MAX_LIMIT, analy
 import "./curators.js";
 import "./delayed-intents.js";
 import { creditAccountFrozen, liquidatorNotEligible, notEmergencyLiquidator } from "./errors/liquidation-errors.js";
-import { creditManagerPaused, debtOutOfRange, forbiddenToken, insufficientAllowance, insufficientBalance, insufficientCollateral, insufficientPoolLiquidity, leverageOutOfRange, marketExpired, poolPaused, poolSunset, quotaCountExceeded, quotaLimitReached, reservePriceLimited, rwaOpenRequirementsNotMet } from "./errors/operation-errors.js";
+import { accountNotMidasGreenlisted, creditManagerPaused, debtOutOfRange, forbiddenToken, insufficientAllowance, insufficientBalance, insufficientCollateral, insufficientPoolLiquidity, leverageOutOfRange, marketExpired, poolPaused, poolSunset, quotaCountExceeded, quotaLimitReached, reservePriceLimited, rwaOpenRequirementsNotMet } from "./errors/operation-errors.js";
 import { unpriceableTokenError } from "./errors/oracle-errors.js";
 import { creditAccountNotEmpty, creditAccountNotFound, multipleDelayedWithdrawals, noDelayedRoute, noRecordedIntent, noStrategyTargetCollateral, unexpectedFailure, unsupportedCollateralToken, unsupportedTokenPair, withdrawalInProgress } from "./errors/prepare-errors.js";
 import { malformedTransaction } from "./errors/preview-errors.js";
@@ -32,4 +32,4 @@ import { chainFailedSchema, chainMetadataSchema, chainSucceededSchema, dataSourc
 import { safeValue, sdkErr, sdkOk } from "./result.js";
 import "./withdrawals.js";
 import { positionClaimableWithdrawalSchema, positionPendingWithdrawalSchema, positionWithdrawalsSchema, withdrawalOutputAmountSchema } from "./withdrawals.schema.js";
-export { ANALYTICS_POSITIONS_DEFAULT_LIMIT, ANALYTICS_POSITIONS_MAX_LIMIT, CHART_METRIC_UNITS, CHART_RANGES, CHART_UNAVAILABLE_CODES, FILTER_ALL, KYC_REGISTRATION_LINKS, POOL_OPPORTUNITY_CHART_METRICS, POOL_POSITION_CHART_METRICS, PROTOCOL_CHART_METRICS, RWA_FACTORY_SECURITIZE, RWA_FACTORY_TYPES, RWA_PROTOCOLS, SECURITIZE_REGISTER_VAULT_TYPES, STRATEGY_OPPORTUNITY_CHART_METRICS, STRATEGY_POSITION_CHART_METRICS, STRATEGY_POSITION_COLLATERAL_ERROR, amountSchema, analyticsChartQueryOptionsSchema, analyticsChartQueryParamsSchema, analyticsChartQuerySchema, analyticsPositionListOptionsSchema, analyticsPositionListQueryParamsSchema, analyticsPositionListQuerySchema, analyticsPositionPageSchema, analyticsPositionSchema, analyticsPositionSortFieldSchema, analyticsSortDirectionSchema, apyBreakdownSchema, asEstimated, assetTypeSchema, backendPreferred, booleanParamSchema, borrowRateBreakdownSchema, bpsSchema, chainFailedSchema, chainIdSchema, chainMetadataSchema, chainSucceededSchema, chartBundleSchemaFor, chartDenominationSchema, chartMetricSchema, chartQueryCodec, chartQueryParamsSchema, chartQuerySchema, chartRangeSchema, chartSeriesSchema, chartValueSchema, chartWindowSchema, compareTagOf, creditAccountFrozen, creditAccountNotEmpty, creditAccountNotFound, creditManagerPaused, curatorNameSchema, curatorSchema, dataSourceSchema, debtOutOfRange, delayedReceivedAssetSchema, encodeFlag, filterAllSchema, filterable, forbiddenToken, instantReceivedAssetSchema, insufficientAllowance, insufficientBalance, insufficientCollateral, insufficientPoolLiquidity, isFilterSet, kycRequirementSchema, leverageOutOfRange, leverageSchema, liquidatableAccountFilterSchema, liquidatableAccountSchema, liquidationApprovalSchema, liquidationDetailsSchema, liquidationPositionId, liquidationPositionSchema, liquidatorNotEligible, malformedTransaction, marketExpired, matchesLiquidatableAccountFilter, matchesOpportunityFilter, matchesPositionFilter, multipleDelayedWithdrawals, noDelayedRoute, noRecordedIntent, noStrategyTargetCollateral, notEmergencyLiquidator, noticeKindSchema, noticeSchema, offchainOnly, onchainOnly, opportunityBaseSchema, opportunityDetailSchema, opportunityFilterQueryParamsSchema, opportunityFilterQuerySchema, opportunityFilterSchema, opportunityId, opportunityKeySchema, opportunityKindSchema, opportunitySchema, opportunityTotalsSchema, pnlBreakdownSchema, pointRewardsSchema, pointsProgramPnLSchema, pointsProgramSchema, pointsRewardsPnLSchema, poolOpportunityChartMetricSchema, poolOpportunityDetailSchema, poolOpportunityId, poolOpportunityKeySchema, poolOpportunitySchema, poolPaused, poolPositionChartMetricSchema, poolPositionId, poolPositionKeySchema, poolPositionSchema, poolSunset, positionClaimableWithdrawalSchema, positionCollateralSchema, positionFilterQueryParamsSchema, positionFilterQuerySchema, positionFilterSchema, positionId, positionKeySchema, positionKindSchema, positionPendingWithdrawalSchema, positionSchema, positionTransactionKindSchema, positionTransactionSchema, positionWithdrawalsSchema, positionsTotalsSchema, priceFeedDataSchema, priceFeedSummarySchema, protocolChartMetricSchema, quotaAssetSchema, quotaCountExceeded, quotaLimitReached, rateCurvePointSchema, rateCurveSchema, receivedAssetSchema, reservePriceLimited, responseMetadataSchema, responseSchema, rewardsPnLSchema, rewardsSchema, rwaOpenRequirementsNotMet, rwaProtocolSchema, safeValue, sdkErr, sdkOk, strategyOpportunityChartMetricSchema, strategyOpportunityDetailSchema, strategyOpportunityId, strategyOpportunityKeySchema, strategyOpportunitySchema, strategyPositionChartMetricSchema, strategyPositionId, strategyPositionKeySchema, strategyPositionSchema, timestampSchema, tokenAmountSchema, tokenQuotaRateSchema, tokenRewardsPnLSchema, tokenRewardsSchema, tokenSchema, tolerance, txCallSchema, underlyingTokenSchema, unexpectedFailure, unpriceableTokenError, unsupportedCollateralToken, unsupportedTokenPair, withdrawalInProgress, withdrawalOutputAmountSchema };
+export { ANALYTICS_POSITIONS_DEFAULT_LIMIT, ANALYTICS_POSITIONS_MAX_LIMIT, CHART_METRIC_UNITS, CHART_RANGES, CHART_UNAVAILABLE_CODES, FILTER_ALL, KYC_REGISTRATION_LINKS, POOL_OPPORTUNITY_CHART_METRICS, POOL_POSITION_CHART_METRICS, PROTOCOL_CHART_METRICS, RWA_FACTORY_SECURITIZE, RWA_FACTORY_TYPES, RWA_PROTOCOLS, SECURITIZE_REGISTER_VAULT_TYPES, STRATEGY_OPPORTUNITY_CHART_METRICS, STRATEGY_POSITION_CHART_METRICS, STRATEGY_POSITION_COLLATERAL_ERROR, accountNotMidasGreenlisted, amountSchema, analyticsChartQueryOptionsSchema, analyticsChartQueryParamsSchema, analyticsChartQuerySchema, analyticsPositionListOptionsSchema, analyticsPositionListQueryParamsSchema, analyticsPositionListQuerySchema, analyticsPositionPageSchema, analyticsPositionSchema, analyticsPositionSortFieldSchema, analyticsSortDirectionSchema, apyBreakdownSchema, asEstimated, assetTypeSchema, backendPreferred, booleanParamSchema, borrowRateBreakdownSchema, bpsSchema, chainFailedSchema, chainIdSchema, chainMetadataSchema, chainSucceededSchema, chartBundleSchemaFor, chartDenominationSchema, chartMetricSchema, chartQueryCodec, chartQueryParamsSchema, chartQuerySchema, chartRangeSchema, chartSeriesSchema, chartValueSchema, chartWindowSchema, compareTagOf, creditAccountFrozen, creditAccountNotEmpty, creditAccountNotFound, creditManagerPaused, curatorNameSchema, curatorSchema, dataSourceSchema, debtOutOfRange, delayedReceivedAssetSchema, encodeFlag, filterAllSchema, filterable, forbiddenToken, instantReceivedAssetSchema, insufficientAllowance, insufficientBalance, insufficientCollateral, insufficientPoolLiquidity, isFilterSet, kycRequirementSchema, leverageOutOfRange, leverageSchema, liquidatableAccountFilterSchema, liquidatableAccountSchema, liquidationApprovalSchema, liquidationDetailsSchema, liquidationPositionId, liquidationPositionSchema, liquidatorNotEligible, malformedTransaction, marketExpired, matchesLiquidatableAccountFilter, matchesOpportunityFilter, matchesPositionFilter, multipleDelayedWithdrawals, noDelayedRoute, noRecordedIntent, noStrategyTargetCollateral, notEmergencyLiquidator, noticeKindSchema, noticeSchema, offchainOnly, onchainOnly, opportunityBaseSchema, opportunityDetailSchema, opportunityFilterQueryParamsSchema, opportunityFilterQuerySchema, opportunityFilterSchema, opportunityId, opportunityKeySchema, opportunityKindSchema, opportunitySchema, opportunityTotalsSchema, pnlBreakdownSchema, pointRewardsSchema, pointsProgramPnLSchema, pointsProgramSchema, pointsRewardsPnLSchema, poolOpportunityChartMetricSchema, poolOpportunityDetailSchema, poolOpportunityId, poolOpportunityKeySchema, poolOpportunitySchema, poolPaused, poolPositionChartMetricSchema, poolPositionId, poolPositionKeySchema, poolPositionSchema, poolSunset, positionClaimableWithdrawalSchema, positionCollateralSchema, positionFilterQueryParamsSchema, positionFilterQuerySchema, positionFilterSchema, positionId, positionKeySchema, positionKindSchema, positionPendingWithdrawalSchema, positionSchema, positionTransactionKindSchema, positionTransactionSchema, positionWithdrawalsSchema, positionsTotalsSchema, priceFeedDataSchema, priceFeedSummarySchema, protocolChartMetricSchema, quotaAssetSchema, quotaCountExceeded, quotaLimitReached, rateCurvePointSchema, rateCurveSchema, receivedAssetSchema, reservePriceLimited, responseMetadataSchema, responseSchema, rewardsPnLSchema, rewardsSchema, rwaOpenRequirementsNotMet, rwaProtocolSchema, safeValue, sdkErr, sdkOk, strategyOpportunityChartMetricSchema, strategyOpportunityDetailSchema, strategyOpportunityId, strategyOpportunityKeySchema, strategyOpportunitySchema, strategyPositionChartMetricSchema, strategyPositionId, strategyPositionKeySchema, strategyPositionSchema, timestampSchema, tokenAmountSchema, tokenQuotaRateSchema, tokenRewardsPnLSchema, tokenRewardsSchema, tokenSchema, tolerance, txCallSchema, underlyingTokenSchema, unexpectedFailure, unpriceableTokenError, unsupportedCollateralToken, unsupportedTokenPair, withdrawalInProgress, withdrawalOutputAmountSchema };

package/dist/esm/onchain/accounts/intents/borrow.js

@@ -0,0 +1,137 @@
+import { insufficientBalance } from "../../../model/errors/operation-errors.js";
+import { unsupportedCollateralToken } from "../../../model/errors/prepare-errors.js";
+import "../../../model/index.js";
+import { toToken } from "../../validation/helpers/token.js";
+import { IntentPreviewError } from "../../validation/raise.js";
+import "../../validation/index.js";
+import { eq, toTargetDecimals } from "./utils/common.js";
+import { assertCanBorrow, assertCollateralised, assertGrowthAllowed, assertMarketOperable, assertQuotaAvailable } from "./guards.js";
+import { assertDebtLimits } from "./math.js";
+import { unopenedAccountSlice } from "./utils/credit-account-slice.js";
+import { collectPriceImpact } from "./utils/price-impact.js";
+import { getQuotasForUpdate } from "./utils/quotas-for-update.js";
+import { createRouterPaths } from "./utils/router-path.js";
+import "./utils/index.js";
+//#region src/onchain/accounts/intents/borrow.ts
+/**
+* Builds the state a borrow would leave behind.
+*
+* The debt is named rather than derived: a borrow asks for an amount, where an
+* opening asks for a leverage and lets the collateral decide. Everything the
+* loan pays out leaves the account, so the collateral alone backs it — which
+* is what makes the health factor here a straight function of the two amounts.
+*
+* Produces no operation list, as opening never does: the caller hands the
+* numbers and the calls to `sdk.accounts.openCA`, with `withdrawToken` set to
+* the payout.
+*/
+async function buildBorrowState(props) {
+	const { sdk, creditManager, collateralAmount, borrowAmount, slippage = 0, quotaReserve, creditAccount: existing } = props;
+	const suite = sdk.marketRegister.findCreditManager(creditManager);
+	const market = sdk.marketRegister.findByCreditManager(creditManager);
+	assertMarketOperable(suite);
+	const underlying = market.pool.underlying.toLowerCase();
+	const collateralToken = props.collateralToken.toLowerCase();
+	const borrowToken = props.borrowToken.toLowerCase();
+	const convert = (from, to, amount) => market.priceOracle.safeConvert(from, to, amount).value;
+	if (eq(collateralToken, borrowToken)) throw new IntentPreviewError(unsupportedCollateralToken(toToken(sdk, collateralToken)), "borrow: the payout token cannot also be the collateral");
+	const rwaAsset = sdk.tokensMeta.rwaUnderlyings.get(underlying)?.asset?.toLowerCase();
+	const unwrapsPayout = !!rwaAsset && eq(borrowToken, rwaAsset);
+	if (rwaAsset && eq(borrowToken, underlying)) throw new IntentPreviewError(unsupportedCollateralToken(toToken(sdk, borrowToken)), `borrow: ${underlying} cannot leave the account, ask for the payout in ${rwaAsset}`);
+	if (collateralAmount <= 0n) throw new IntentPreviewError(insufficientBalance(), "borrow: no collateral supplied");
+	if (borrowAmount <= 0n) throw new IntentPreviewError(insufficientBalance(), "borrow: nothing to borrow");
+	const margin = convert(collateralToken, underlying, collateralAmount);
+	if (margin <= 0n) throw new IntentPreviewError(insufficientBalance(), "borrow: collateral is worth nothing in underlying");
+	const debt = eq(borrowToken, underlying) ? borrowAmount : unwrapsPayout ? toTargetDecimals(borrowAmount, borrowToken, underlying, sdk) : convert(borrowToken, underlying, borrowAmount);
+	assertDebtLimits(sdk, debt, suite.creditFacade, underlying);
+	assertCanBorrow(sdk, suite, debt);
+	const account = existing ?? unopenedAccountSlice({
+		creditManager,
+		creditFacade: suite.creditFacade.address,
+		underlying
+	});
+	const leg = eq(borrowToken, underlying) || unwrapsPayout ? void 0 : await createRouterPaths({
+		sdk,
+		creditAccount: account,
+		slippage
+	}).swap({
+		tokenIn: underlying,
+		tokenOut: borrowToken,
+		amount: debt,
+		keep: eq(collateralToken, underlying) ? collateralAmount : 0n
+	});
+	const unwrap = unwrapsPayout ? await sdk.accounts.assembleRWAUnwrapCalls(debt, creditManager) : void 0;
+	if (unwrapsPayout && !unwrap) throw new Error(`borrow: no unwrap calls found for ${borrowToken}`);
+	const assets = [{
+		token: collateralToken,
+		balance: collateralAmount
+	}];
+	const quotaIncrease = borrowCollateralQuota({
+		sdk,
+		creditManager,
+		assets,
+		quotaReserve
+	});
+	assertGrowthAllowed({
+		sdk,
+		suite,
+		market,
+		before: [],
+		after: assets
+	});
+	assertQuotaAvailable(sdk, market, quotaIncrease);
+	const snapshot = {
+		creditManager,
+		assets,
+		quotas: quotaIncrease,
+		totalDebt: debt,
+		totalValue: margin
+	};
+	const projection = sdk.positions.projection(snapshot, { availableLiquidityChange: -debt });
+	assertCollateralised(projection.safeHealthFactor, true);
+	const priced = (token, balance) => market.priceOracle.toTokenAmount(token, balance);
+	const payout = unwrapsPayout ? toTargetDecimals(debt, underlying, borrowToken, sdk) : leg ? leg.amount : debt;
+	return {
+		...projection,
+		currentPrice: sdk.positions.currentPrice(snapshot),
+		executionCost: void 0,
+		priceImpact: await collectPriceImpact(leg?.probe ? [leg.probe] : [], {
+			totalValue: margin,
+			netValue: margin - debt,
+			toUnderlying: (from, amount) => convert(from, underlying, amount)
+		}),
+		collateral: priced(collateralToken, collateralAmount),
+		borrowed: priced(borrowToken, payout),
+		minBorrowed: priced(borrowToken, leg ? leg.minAmount : payout),
+		slippage,
+		quotaIncrease,
+		calls: leg ? [...leg.calls] : unwrap ?? [],
+		creditAccount: existing?.creditAccount
+	};
+}
+/**
+* Quota a borrow buys for its collateral on an account that holds none yet.
+*
+* Shared with `maxBorrow`, because a quota short of the collateral's weighted
+* value is what caps the loan: the two have to read the same number or the
+* ceiling one offers is one the other refuses.
+*
+* @param props - {@link BorrowCollateralQuotaProps}
+**/
+function borrowCollateralQuota({ sdk, creditManager, assets, quotaReserve }) {
+	const suite = sdk.marketRegister.findCreditManager(creditManager);
+	const market = sdk.marketRegister.findByCreditManager(creditManager);
+	return getQuotasForUpdate({
+		assetsBefore: [],
+		assetsAfter: assets,
+		initialQuotas: [],
+		quotaReserve,
+		underlyingToken: market.pool.underlying,
+		liquidationThresholds: suite.creditManager.liquidationThresholds,
+		quotas: market.pool.pqk.quotas,
+		maxDebt: suite.creditFacade.maxDebt,
+		convert: (from, to, amount) => market.priceOracle.safeConvert(from, to, amount).value
+	}).quotaIncrease;
+}
+//#endregion
+export { borrowCollateralQuota, buildBorrowState };

package/dist/esm/onchain/accounts/intents/{collateral-money.js → collateral-valuation.js}

@@ -2,9 +2,9 @@ import { BigIntMath } from "../../utils/bigint-math.js";
 import { PERCENTAGE_FACTOR } from "../../constants/math.js";
 import "../../utils/index.js";
 import { eq } from "./utils/common.js";
-//#region src/onchain/accounts/intents/collateral-money.ts
-/** {@inheritDoc CollateralMoney} */
-function collateralMoney(creditAccount, sdk) {
+//#region src/onchain/accounts/intents/collateral-valuation.ts
+/** {@inheritDoc CollateralValuation} */
+function collateralValuation(creditAccount, sdk) {
 	const { market, creditManager } = sdk.marketRegister.findCreditManager(creditAccount.creditManager);
 	const { priceOracle } = market;
 	const { pqk } = market.pool;
@@ -20,21 +20,21 @@ function collateralMoney(creditAccount, sdk) {
 	const lt = (token) => BigInt(creditManager.liquidationThresholds.get(token) ?? 0);
 	const checkedUsd = (holding) => eq(holding.token, underlying) ? mainUsd(holding.token, holding.balance) ?? 0n : priceOracle.safeConvertMinUSD(holding.token, holding.balance).value;
 	/** A quota is underlying-denominated, and a closed market backs nothing. */
-	const quotaMoney = (holding) => pqk.hasActiveQuota(holding.token) ? (mainUsd(underlying, holding.quota) ?? 0n) * PERCENTAGE_FACTOR : 0n;
+	const quotaValue = (holding) => pqk.hasActiveQuota(holding.token) ? (mainUsd(underlying, holding.quota) ?? 0n) * PERCENTAGE_FACTOR : 0n;
 	const weigh = (holding) => {
 		const weighted = checkedUsd(holding) * lt(holding.token);
 		if (holding.quota === 0n) return weighted;
-		return BigIntMath.min(quotaMoney(holding), weighted);
+		return BigIntMath.min(quotaValue(holding), weighted);
 	};
 	return {
 		underlying,
 		counts: (holding) => holding.balance > 10n && (!masked || (holding.mask & creditAccount.enabledTokensMask) !== 0n),
 		weigh,
-		quotaMoney,
+		quotaValue,
 		mainUsd,
 		checkedUsd,
 		lt
 	};
 }
 //#endregion
-export { collateralMoney };
+export { collateralValuation };