@gearbox-protocol/sdk 16.2.0 → 16.3.0-next.2

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

@@ -0,0 +1,121 @@
+//#region src/model/errors/operation-errors.ts
+/** {@inheritDoc CreditManagerPausedError} */
+function creditManagerPaused(creditManager) {
+	return {
+		code: "creditManagerPaused",
+		message: `Credit manager ${creditManager} is paused.`,
+		creditManager
+	};
+}
+/** {@inheritDoc PoolPausedError} */
+function poolPaused(pool) {
+	return {
+		code: "poolPaused",
+		message: `Pool ${pool} is paused.`,
+		pool
+	};
+}
+/** {@inheritDoc MarketExpiredError} */
+function marketExpired(creditManager, expirationDate) {
+	return {
+		code: "marketExpired",
+		message: `Credit manager ${creditManager} expired at ${expirationDate}.`,
+		creditManager,
+		expirationDate
+	};
+}
+/** {@inheritDoc PoolSunsetError} */
+function poolSunset(pool) {
+	return {
+		code: "poolSunset",
+		message: `Pool ${pool} is winding down and takes no more deposits.`,
+		pool
+	};
+}
+/** {@inheritDoc InsufficientPoolLiquidityError} */
+function insufficientPoolLiquidity(args) {
+	return {
+		code: "insufficientPoolLiquidity",
+		message: `The pool cannot lend ${args.requested.value} ${args.requested.token.symbol}: ${args.available.value} left, stopped by ${args.limit}.`,
+		...args
+	};
+}
+/** {@inheritDoc DebtOutOfRangeError} */
+function debtOutOfRange(args) {
+	const { requested, minDebt, maxDebt } = args;
+	return {
+		code: "debtOutOfRange",
+		message: requested.value > maxDebt.value ? `Debt ${requested.value} exceeds maxDebt ${maxDebt.value}.` : `Debt ${requested.value} is below minDebt ${minDebt.value}.`,
+		...args
+	};
+}
+/** {@inheritDoc LeverageOutOfRangeError} */
+function leverageOutOfRange(args = {}) {
+	const { requested, min } = args;
+	return {
+		code: "leverageOutOfRange",
+		message: requested === void 0 || min === void 0 ? "The leverage asked for cannot be expressed as a plan." : `Target leverage ${requested} is below the floor of ${min}.`,
+		...args
+	};
+}
+/** {@inheritDoc InsufficientCollateralError} */
+function insufficientCollateral(args) {
+	return {
+		code: "insufficientCollateral",
+		message: `The account would end at a health factor of ${args.healthFactor}, below ${args.healthFactorThreshold}.`,
+		...args
+	};
+}
+/** {@inheritDoc ForbiddenTokenError} */
+function forbiddenToken(token) {
+	return {
+		code: "forbiddenToken",
+		message: `${token.symbol} is forbidden in this market and the operation buys more of it.`,
+		token
+	};
+}
+/** {@inheritDoc QuotaLimitReachedError} */
+function quotaLimitReached(args) {
+	const { token, requested, available } = args;
+	return {
+		code: "quotaLimitReached",
+		message: requested === void 0 ? `${token.symbol} takes no quota in this market, so it counts as no collateral.` : `${token.symbol} has ${available.value} of quota left, the operation needs ${requested.value}.`,
+		...args
+	};
+}
+/** {@inheritDoc QuotaCountExceededError} */
+function quotaCountExceeded(count, max) {
+	return {
+		code: "quotaCountExceeded",
+		message: `The account would hold ${count} quoted tokens, and the facade enables ${max} at once.`,
+		count,
+		max
+	};
+}
+/** {@inheritDoc InsufficientBalanceError} */
+function insufficientBalance(args = {}) {
+	const { required, held } = args;
+	return {
+		code: "insufficientBalance",
+		message: required === void 0 || held === void 0 ? "There is not enough to fund this operation." : `${required.value} of ${required.token.symbol} is needed and ${held.value} is held.`,
+		...args
+	};
+}
+/** {@inheritDoc InsufficientAllowanceError} */
+function insufficientAllowance(args) {
+	return {
+		code: "insufficientAllowance",
+		message: `${args.required.value} of ${args.required.token.symbol} must be approved to ${args.spender}, ${args.allowed.value} is.`,
+		...args
+	};
+}
+/** {@inheritDoc RWAOpenRequirementsError} */
+function rwaOpenRequirementsNotMet(args) {
+	return {
+		code: "rwaOpenRequirementsNotMet",
+		message: `The RWA factory still wants something from the borrower before ${args.token.symbol} can be opened on.`,
+		...args
+	};
+}
+//#endregion
+export { creditManagerPaused, debtOutOfRange, forbiddenToken, insufficientAllowance, insufficientBalance, insufficientCollateral, insufficientPoolLiquidity, leverageOutOfRange, marketExpired, poolPaused, poolSunset, quotaCountExceeded, quotaLimitReached, rwaOpenRequirementsNotMet };

package/dist/esm/{onchain/market/oracle/errors.js → model/errors/oracle-errors.js}

@@ -1,4 +1,4 @@
-//#region src/onchain/market/oracle/errors.ts
+//#region src/model/errors/oracle-errors.ts
 /**
 * Builds an {@link UnpriceableTokenError} for `token`.
 **/

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

@@ -0,0 +1,97 @@
+//#region src/model/errors/prepare-errors.ts
+/** {@inheritDoc UnsupportedCollateralTokenError} */
+function unsupportedCollateralToken(token) {
+	return {
+		code: "unsupportedCollateralToken",
+		message: `This flow does not accept ${token.symbol}.`,
+		token
+	};
+}
+/** {@inheritDoc UnsupportedTokenPairError} */
+function unsupportedTokenPair(args = {}) {
+	const { from, to } = args;
+	return {
+		code: "unsupportedTokenPair",
+		message: from === void 0 ? "No route exists between these two tokens." : to === void 0 ? `No route exists out of ${from.symbol}.` : `No route exists from ${from.symbol} to ${to.symbol}.`,
+		...args
+	};
+}
+/** {@inheritDoc NoDelayedRouteError} */
+function noDelayedRoute(token) {
+	return {
+		code: "noDelayedRoute",
+		message: token === void 0 ? "This request cannot be served as a delayed redemption." : `${token.symbol} cannot be served as a delayed redemption.`,
+		...token === void 0 ? {} : { token }
+	};
+}
+/** {@inheritDoc MultipleDelayedWithdrawalsError} */
+function multipleDelayedWithdrawals(token, venues) {
+	return {
+		code: "multipleDelayedWithdrawals",
+		message: `${token.symbol} has ${venues} redemption venues and none was named.`,
+		token,
+		venues
+	};
+}
+/** {@inheritDoc WithdrawalInProgressError} */
+function withdrawalInProgress(inFlight) {
+	return {
+		code: "withdrawalInProgress",
+		message: `A redemption of ${inFlight.token.symbol} is already in flight on the account.`,
+		inFlight
+	};
+}
+/** {@inheritDoc NoRecordedIntentError} */
+function noRecordedIntent() {
+	return {
+		code: "noRecordedIntent",
+		message: "The claim names no operation to resume."
+	};
+}
+/** {@inheritDoc NoStrategyTargetCollateralError} */
+function noStrategyTargetCollateral(creditManager) {
+	return {
+		code: "noStrategyTargetCollateral",
+		message: `Credit manager ${creditManager} has no strategy target collateral, and none was named.`,
+		creditManager
+	};
+}
+/** {@inheritDoc CreditAccountNotFoundError} */
+function creditAccountNotFound(creditAccount) {
+	return {
+		code: "creditAccountNotFound",
+		message: `Credit account not found: ${creditAccount}.`,
+		creditAccount
+	};
+}
+/** {@inheritDoc CreditAccountNotEmptyError} */
+function creditAccountNotEmpty(creditAccount) {
+	return {
+		code: "creditAccountNotEmpty",
+		message: `Credit account ${creditAccount} carries debt or quotas.`,
+		creditAccount
+	};
+}
+/** {@inheritDoc EmptyOpenTakesNothingError} */
+function emptyOpenTakesNothing() {
+	return {
+		code: "emptyOpenTakesNothing",
+		message: "An empty opening takes no collateral, no account to reuse and no leverage."
+	};
+}
+/**
+* {@inheritDoc UnexpectedFailureError}
+*
+* Takes what was thrown, whatever that is: a `throw` is not obliged to raise an
+* `Error`, and `cause` promises one.
+**/
+function unexpectedFailure(thrown, action = "prepare this operation") {
+	const cause = thrown instanceof Error ? thrown : new Error(String(thrown));
+	return {
+		code: "unexpectedFailure",
+		message: `The SDK could not ${action}: ${cause.message}`,
+		cause
+	};
+}
+//#endregion
+export { creditAccountNotEmpty, creditAccountNotFound, emptyOpenTakesNothing, multipleDelayedWithdrawals, noDelayedRoute, noRecordedIntent, noStrategyTargetCollateral, unexpectedFailure, unsupportedCollateralToken, unsupportedTokenPair, withdrawalInProgress };

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

@@ -0,0 +1,11 @@
+//#region src/model/errors/preview-errors.ts
+/** {@inheritDoc MalformedTransactionError} */
+function malformedTransaction(detail, cause) {
+	return {
+		code: "malformedTransaction",
+		message: `The transaction could not be replayed: ${detail}`,
+		...cause ? { cause } : {}
+	};
+}
+//#endregion
+export { malformedTransaction };

package/dist/esm/model/index.js

@@ -7,12 +7,19 @@ import { FILTER_ALL, isFilterSet } from "./filters.js";
 import { booleanParamSchema, encodeFlag, filterAllSchema, filterable } from "./filters.schema.js";
 import { curatorNameSchema, curatorSchema } from "./curators.schema.js";
 import { delayedReceivedAssetSchema, instantReceivedAssetSchema, liquidatableAccountFilterSchema, liquidatableAccountSchema, liquidationApprovalSchema, liquidationDetailsSchema, liquidationPositionSchema, receivedAssetSchema } from "./liquidations.schema.js";
+import { KYC_PROTOCOLS, KYC_REGISTRATION_LINKS, RWA_FACTORY_SECURITIZE, RWA_FACTORY_TYPES, SECURITIZE_REGISTER_VAULT_TYPES } from "./rwa.js";
+import { kycProtocolSchema, kycRequirementSchema } from "./rwa.schema.js";
 import { apyBreakdownSchema, opportunityBaseSchema, opportunityDetailSchema, opportunityFilterQueryParamsSchema, opportunityFilterQuerySchema, opportunityFilterSchema, opportunityKeySchema, opportunityKindSchema, opportunitySchema, opportunityTotalsSchema, pointRewardsSchema, pointsProgramSchema, poolOpportunityDetailSchema, poolOpportunityKeySchema, poolOpportunitySchema, priceFeedDataSchema, priceFeedSummarySchema, quotaAssetSchema, rateCurvePointSchema, rateCurveSchema, rewardsSchema, strategyOpportunityDetailSchema, strategyOpportunityKeySchema, strategyOpportunitySchema, tokenRewardsSchema } from "./opportunities.schema.js";
 import { borrowRateBreakdownSchema, pnlBreakdownSchema, pointsProgramPnLSchema, pointsRewardsPnLSchema, poolPositionKeySchema, poolPositionSchema, positionCollateralSchema, positionFilterQueryParamsSchema, positionFilterQuerySchema, positionFilterSchema, positionKeySchema, positionKindSchema, positionSchema, positionTransactionKindSchema, positionTransactionSchema, positionsTotalsSchema, rewardsPnLSchema, strategyPositionKeySchema, strategyPositionSchema, tokenQuotaRateSchema, tokenRewardsPnLSchema } from "./positions.schema.js";
 import { ANALYTICS_POSITIONS_DEFAULT_LIMIT, ANALYTICS_POSITIONS_MAX_LIMIT, analyticsChartQueryOptionsSchema, analyticsChartQueryParamsSchema, analyticsChartQuerySchema, analyticsPositionListOptionsSchema, analyticsPositionListQueryParamsSchema, analyticsPositionListQuerySchema, analyticsPositionPageSchema, analyticsPositionSchema, analyticsPositionSortFieldSchema, analyticsSortDirectionSchema } from "./analytics.schema.js";
 import "./curators.js";
 import "./delayed-intents.js";
-import "./errors.js";
+import { creditAccountFrozen, liquidatorNotEligible, notEmergencyLiquidator } from "./errors/liquidation-errors.js";
+import { creditManagerPaused, debtOutOfRange, forbiddenToken, insufficientAllowance, insufficientBalance, insufficientCollateral, insufficientPoolLiquidity, leverageOutOfRange, marketExpired, poolPaused, poolSunset, quotaCountExceeded, quotaLimitReached, rwaOpenRequirementsNotMet } from "./errors/operation-errors.js";
+import { unpriceableTokenError } from "./errors/oracle-errors.js";
+import { creditAccountNotEmpty, creditAccountNotFound, emptyOpenTakesNothing, multipleDelayedWithdrawals, noDelayedRoute, noRecordedIntent, noStrategyTargetCollateral, unexpectedFailure, unsupportedCollateralToken, unsupportedTokenPair, withdrawalInProgress } from "./errors/prepare-errors.js";
+import { malformedTransaction } from "./errors/preview-errors.js";
+import "./errors/index.js";
 import { matchesLiquidatableAccountFilter } from "./liquidations.js";
 import "./notices.js";
 import { noticeKindSchema, noticeSchema } from "./notices.schema.js";
@@ -22,7 +29,7 @@ import { asEstimated } from "./previews.js";
 import "./primitives.js";
 import "./response.js";
 import { chainFailedSchema, chainMetadataSchema, chainSucceededSchema, dataSourceSchema, responseMetadataSchema, responseSchema } from "./response.schema.js";
-import { isSDKError, safeValue, sdkErr, sdkOk } from "./result.js";
+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, POOL_OPPORTUNITY_CHART_METRICS, POOL_POSITION_CHART_METRICS, PROTOCOL_CHART_METRICS, 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, curatorNameSchema, curatorSchema, dataSourceSchema, delayedReceivedAssetSchema, encodeFlag, filterAllSchema, filterable, instantReceivedAssetSchema, isFilterSet, isSDKError, leverageSchema, liquidatableAccountFilterSchema, liquidatableAccountSchema, liquidationApprovalSchema, liquidationDetailsSchema, liquidationPositionId, liquidationPositionSchema, matchesLiquidatableAccountFilter, matchesOpportunityFilter, matchesPositionFilter, noticeKindSchema, noticeSchema, offchainOnly, onchainOnly, opportunityBaseSchema, opportunityDetailSchema, opportunityFilterQueryParamsSchema, opportunityFilterQuerySchema, opportunityFilterSchema, opportunityId, opportunityKeySchema, opportunityKindSchema, opportunitySchema, opportunityTotalsSchema, pnlBreakdownSchema, pointRewardsSchema, pointsProgramPnLSchema, pointsProgramSchema, pointsRewardsPnLSchema, poolOpportunityChartMetricSchema, poolOpportunityDetailSchema, poolOpportunityId, poolOpportunityKeySchema, poolOpportunitySchema, poolPositionChartMetricSchema, poolPositionId, poolPositionKeySchema, poolPositionSchema, positionClaimableWithdrawalSchema, positionCollateralSchema, positionFilterQueryParamsSchema, positionFilterQuerySchema, positionFilterSchema, positionId, positionKeySchema, positionKindSchema, positionPendingWithdrawalSchema, positionSchema, positionTransactionKindSchema, positionTransactionSchema, positionWithdrawalsSchema, positionsTotalsSchema, priceFeedDataSchema, priceFeedSummarySchema, protocolChartMetricSchema, quotaAssetSchema, rateCurvePointSchema, rateCurveSchema, receivedAssetSchema, responseMetadataSchema, responseSchema, rewardsPnLSchema, rewardsSchema, safeValue, sdkErr, sdkOk, strategyOpportunityChartMetricSchema, strategyOpportunityDetailSchema, strategyOpportunityId, strategyOpportunityKeySchema, strategyOpportunitySchema, strategyPositionChartMetricSchema, strategyPositionId, strategyPositionKeySchema, strategyPositionSchema, timestampSchema, tokenAmountSchema, tokenQuotaRateSchema, tokenRewardsPnLSchema, tokenRewardsSchema, tokenSchema, tolerance, txCallSchema, underlyingTokenSchema, withdrawalOutputAmountSchema };
+export { ANALYTICS_POSITIONS_DEFAULT_LIMIT, ANALYTICS_POSITIONS_MAX_LIMIT, CHART_METRIC_UNITS, CHART_RANGES, CHART_UNAVAILABLE_CODES, FILTER_ALL, KYC_PROTOCOLS, KYC_REGISTRATION_LINKS, POOL_OPPORTUNITY_CHART_METRICS, POOL_POSITION_CHART_METRICS, PROTOCOL_CHART_METRICS, RWA_FACTORY_SECURITIZE, RWA_FACTORY_TYPES, 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, emptyOpenTakesNothing, encodeFlag, filterAllSchema, filterable, forbiddenToken, instantReceivedAssetSchema, insufficientAllowance, insufficientBalance, insufficientCollateral, insufficientPoolLiquidity, isFilterSet, kycProtocolSchema, 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, responseMetadataSchema, responseSchema, rewardsPnLSchema, rewardsSchema, rwaOpenRequirementsNotMet, 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/model/opportunities.schema.js

@@ -4,6 +4,7 @@ import { amountSchema, assetTypeSchema, bpsSchema, chainIdSchema, leverageSchema
 import { isFilterSet } from "./filters.js";
 import { booleanParamSchema, encodeFlag, filterable } from "./filters.schema.js";
 import { curatorSchema } from "./curators.schema.js";
+import { kycRequirementSchema } from "./rwa.schema.js";
 import { z } from "zod/v4";
 //#region src/model/opportunities.schema.ts
 /**
@@ -214,7 +215,8 @@ const poolOpportunityDetailSchema = z.object({
 const strategyOpportunityDetailSchema = z.object({
 	...strategyOpportunitySchema.shape,
 	rateCurve: rateCurveSchema,
-	priceFeeds: priceFeedSummarySchema
+	priceFeeds: priceFeedSummarySchema,
+	kyc: kycRequirementSchema.nullable().optional()
 });
 /**
 * {@link OpportunityDetail}

package/dist/esm/model/positions.js

@@ -60,7 +60,7 @@ function positionId(position) {
 * A condition that does not apply to a position's kind keeps the row rather
 * than dropping it: `isZeroDebt` says nothing about a pool position, and
 * `underlyingType` says nothing about a liquidation position, which is
-* denominated in whatever its withdrawal pays out.
+* denominated in whatever its withdrawal settles in.
 *
 * @param position - Row to test.
 * @param filter - Conditions to test against. An absent filter matches

package/dist/esm/model/result.js

@@ -22,12 +22,5 @@ function sdkErr(error) {
 		error
 	};
 }
-/**
-* Narrows a {@link SDKReturn} to its failure half. Trivial over `ok`, but it
-* names the intent at call sites that would otherwise read `!r.ok`.
-**/
-function isSDKError(answer) {
-	return !answer.ok;
-}
 //#endregion
-export { isSDKError, safeValue, sdkErr, sdkOk };
+export { safeValue, sdkErr, sdkOk };

package/dist/esm/model/rwa.js

@@ -0,0 +1,48 @@
+//#region src/model/rwa.ts
+/**
+* Discriminant of the Securitize RWA factory contract type.
+**/
+const RWA_FACTORY_SECURITIZE = "RWA_FACTORY::SECURITIZE";
+/**
+* Discriminated union of all known RWA factory contract type strings.
+**/
+const RWA_FACTORY_TYPES = [RWA_FACTORY_SECURITIZE];
+/**
+* EIP-712 type schema for the `RegisterVault` message expected by Securitize's
+* VaultRegistrar. Matches the contract's `RegisterVault` typehash field order.
+**/
+const SECURITIZE_REGISTER_VAULT_TYPES = { RegisterVault: [
+	{
+		name: "investor",
+		type: "address"
+	},
+	{
+		name: "operator",
+		type: "address"
+	},
+	{
+		name: "token",
+		type: "address"
+	},
+	{
+		name: "nonce",
+		type: "uint256"
+	},
+	{
+		name: "deadline",
+		type: "uint256"
+	}
+] };
+/**
+* KYC providers a strategy may be gated by
+**/
+const KYC_PROTOCOLS = ["securitize", "midas"];
+/**
+* Hardcoded registration URLs for each {@link KycProtocol}.
+**/
+const KYC_REGISTRATION_LINKS = {
+	securitize: "https://securitize.io/",
+	midas: "https://form.typeform.com/to/DqZaw6kr"
+};
+//#endregion
+export { KYC_PROTOCOLS, KYC_REGISTRATION_LINKS, RWA_FACTORY_SECURITIZE, RWA_FACTORY_TYPES, SECURITIZE_REGISTER_VAULT_TYPES };

package/dist/esm/model/rwa.schema.js

@@ -0,0 +1,18 @@
+import { tokenSchema } from "./primitives.schema.js";
+import { KYC_PROTOCOLS } from "./rwa.js";
+import { z } from "zod/v4";
+//#region src/model/rwa.schema.ts
+/**
+* {@link ./rwa.js#KycProtocol}
+**/
+const kycProtocolSchema = z.enum(KYC_PROTOCOLS);
+/**
+* {@link ./rwa.js#KycRequirement}
+**/
+const kycRequirementSchema = z.object({
+	protocol: kycProtocolSchema,
+	token: tokenSchema.optional(),
+	registrationLink: z.string()
+});
+//#endregion
+export { kycProtocolSchema, kycRequirementSchema };

package/dist/esm/offchain/opportunities/OffchainOpportunities.js

@@ -35,7 +35,7 @@ var OffchainOpportunities = class extends AbstractOffchainNamespace {
 	/**
 	* {@inheritDoc IOffchainOpportunities.getStrategy}
 	**/
-	async getStrategy(key) {
+	async getStrategy(key, _wallet) {
 		return this.get({
 			path: this.#strategyPath(key),
 			schema: strategyOpportunityDetailSchema

package/dist/esm/onchain/accounts/CreditAccountsServiceV310.js

@@ -1,3 +1,5 @@
+import { iBaseRewardPoolAbi } from "../../abi/iBaseRewardPool.js";
+import { ierc4626AdapterAbi } from "../../abi/ierc4626Adapter.js";
 import { AP_REWARDS_COMPRESSOR } from "../constants/address-provider.js";
 import { ADDRESS_0X0 } from "../constants/addresses.js";
 import { MAX_UINT256 } from "../constants/math.js";
@@ -8,8 +10,6 @@ import "../base/index.js";
 import { AccountBotsService } from "./bots/AccountBotsService.js";
 import "./bots/index.js";
 import { rewardsCompressorAbi } from "../../abi/compressors/rewardsCompressor.js";
-import { iBaseRewardPoolAbi } from "../../abi/iBaseRewardPool.js";
-import { ierc4626AdapterAbi } from "../../abi/ierc4626Adapter.js";
 import { expectedBalanceDeltas } from "../market/credit/expectedBalanceDeltas.js";
 import "../market/index.js";
 import { CreditAccountCompressor } from "./credit-account-compressor/CreditAccountCompressor.js";

package/dist/esm/onchain/accounts/index.js

@@ -6,7 +6,6 @@ import { CreditAccountCompressor } from "./credit-account-compressor/CreditAccou
 import "./credit-account-compressor/index.js";
 import { CreditAccountsServiceV310 } from "./CreditAccountsServiceV310.js";
 import { isPhantomToken } from "./intents/utils/pick-token.js";
-import { borrowable } from "./intents/guards.js";
 import { fetchCreditAccountSlice, toCreditAccountSlice } from "./intents/utils/credit-account-slice.js";
 import { calcDefaultQuota, calcQuotaUpdate, calcRecommendedQuota, roundUpQuota } from "./quota-utils.js";
 import { CreditAccountOperationsService } from "./intents/index.js";
@@ -26,4 +25,4 @@ import { toWithdrawalStatus } from "./withdrawal-compressor/types.js";
 import { WithdrawalCompressorV313Contract } from "./withdrawal-compressor/WithdrawalCompressorV313Contract.js";
 import { createWithdrawalCompressor } from "./withdrawal-compressor/createWithdrawalCompressor.js";
 import "./withdrawal-compressor/index.js";
-export { AbstractWithdrawalCompressorContract, AccountBotsService, CreditAccountCompressor, CreditAccountCompressorV310Contract, CreditAccountOperationsService, CreditAccountsServiceV310, DELAYED_INTENT_TYPES, DELAYED_INTENT_VERSION, LIQUIDATION_APPROVAL_BUFFER, LIQUIDATION_COMPRESSOR_V313_ADDRESS, LiquidationsService, MultichainLiquidationsService, PeripheryCompressorV310Contract, RedemptionLoggerV310Contract, WithdrawalCompressorV310Contract, WithdrawalCompressorV311Contract, WithdrawalCompressorV313Contract, borrowable, calcDefaultQuota, calcQuotaUpdate, calcRecommendedQuota, createRedemptionLogger, createWithdrawalCompressor, decodeDelayedIntent, encodeDelayedIntent, fetchCreditAccountSlice, getWithdrawalCompressorAddress, iCreditAccountAbi, isPhantomToken, roundUpQuota, toClaimableWithdrawal, toCreditAccountSlice, toPendingWithdrawal, toRequestableWithdrawal, toWithdrawalStatus };
+export { AbstractWithdrawalCompressorContract, AccountBotsService, CreditAccountCompressor, CreditAccountCompressorV310Contract, CreditAccountOperationsService, CreditAccountsServiceV310, DELAYED_INTENT_TYPES, DELAYED_INTENT_VERSION, LIQUIDATION_APPROVAL_BUFFER, LIQUIDATION_COMPRESSOR_V313_ADDRESS, LiquidationsService, MultichainLiquidationsService, PeripheryCompressorV310Contract, RedemptionLoggerV310Contract, WithdrawalCompressorV310Contract, WithdrawalCompressorV311Contract, WithdrawalCompressorV313Contract, calcDefaultQuota, calcQuotaUpdate, calcRecommendedQuota, createRedemptionLogger, createWithdrawalCompressor, decodeDelayedIntent, encodeDelayedIntent, fetchCreditAccountSlice, getWithdrawalCompressorAddress, iCreditAccountAbi, isPhantomToken, roundUpQuota, toClaimableWithdrawal, toCreditAccountSlice, toPendingWithdrawal, toRequestableWithdrawal, toWithdrawalStatus };

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

@@ -1,6 +1,13 @@
-import { MIN_HEALTH_FACTOR_FACADE, checkBorrowLimit, checkCollateralised, checkCreditManagerPaused, checkForbiddenToken, checkMarketExpired, checkQuotaLimit } from "../../validation/checks.js";
-import { raise } from "../../validation/refusal.js";
-import { toToken } from "../../validation/token.js";
+import { MIN_HEALTH_FACTOR_FACADE } from "../../validation/helpers/health-factor-limits.js";
+import { toToken } from "../../validation/helpers/token.js";
+import { checkBorrowLimit } from "../../validation/checks/checkBorrowLimit.js";
+import { checkCollateralised } from "../../validation/checks/checkCollateralised.js";
+import { checkCreditManagerPaused } from "../../validation/checks/checkCreditManagerPaused.js";
+import { checkForbiddenToken } from "../../validation/checks/checkForbiddenToken.js";
+import { checkMarketExpired } from "../../validation/checks/checkMarketExpired.js";
+import { checkQuotaLimit } from "../../validation/checks/checkQuotaLimit.js";
+import { raise } from "../../validation/raise.js";
+import "../../validation/index.js";
 import { eq } from "./utils/common.js";
 import { isPhantomToken } from "./utils/pick-token.js";
 //#region src/onchain/accounts/intents/guards.ts
@@ -34,44 +41,15 @@ function assertMarketOperable(suite) {
 		expirationDate: suite.creditFacade.expirationDate
 	}), `${creditManager} expired at ${suite.creditFacade.expirationDate}`);
 }
-/**
-* What the pool will hand this manager in one transaction: the tightest of its
-* free liquidity, the manager's remaining debt limit and the per-block cap the
-* facade puts on a single borrow. A zero multiplier switches borrowing off
-* outright, which reads here as nothing being available.
-*/
-function borrowable(suite) {
-	const { pool } = suite.market.pool;
-	const { maxDebtPerBlockMultiplier, maxDebt } = suite.creditFacade;
-	if (maxDebtPerBlockMultiplier === 0) return {
-		limit: 0n,
-		binding: "facadePerBlockCap"
-	};
-	const available = pool.creditManagerDebtParams.get(suite.creditManager.address)?.available;
-	return [
-		{
-			limit: pool.availableLiquidity,
-			binding: "poolAvailableLiquidity"
-		},
-		{
-			limit: maxDebt * BigInt(maxDebtPerBlockMultiplier),
-			binding: "facadePerBlockCap"
-		},
-		...available === void 0 ? [] : [{
-			limit: available,
-			binding: "managerDebtAvailable"
-		}]
-	].reduce((a, b) => b.limit < a.limit ? b : a);
-}
 /** The pool has to be able to lend what the plan means to draw. */
 function assertCanBorrow(sdk, suite, amount) {
-	const { limit, binding } = borrowable(suite);
+	const { value, limit } = suite.maxBorrowAmount();
 	raise(checkBorrowLimit({
 		requested: amount,
-		available: limit,
-		binding,
+		available: value,
+		limit,
 		underlying: toToken(sdk, suite.market.pool.underlying)
-	}), `borrow: ${amount} exceeds what the pool can lend now (${limit})`);
+	}), `borrow: ${amount} exceeds what the pool can lend now (${value})`);
 }
 /**
 * What the account is allowed to end up holding more of than it started with.
@@ -87,13 +65,12 @@ function assertCanBorrow(sdk, suite, amount) {
 */
 function assertGrowthAllowed(args) {
 	const { sdk, suite, market, before, after } = args;
-	const forbidden = suite.forbiddenTokens;
 	const underlying = market.pool.underlying;
 	for (const { token, balance } of after) {
 		if (balance <= (before.find((a) => eq(a.token, token))?.balance ?? 0n)) continue;
 		raise(checkForbiddenToken({
 			token: toToken(sdk, token),
-			isForbidden: forbidden.some((f) => eq(f, token))
+			isForbidden: suite.isForbidden(token)
 		}), `${token} is forbidden in this market and the plan buys more of it`);
 		if (eq(token, underlying) || isPhantomToken(sdk, token)) continue;
 		if (!market.pool.pqk.hasActiveQuota(token)) raise(checkQuotaLimit({
@@ -109,19 +86,20 @@ function assertGrowthAllowed(args) {
 * and reverts if the collateral does not cover it, so a plan that lands the
 * account below water is refused here.
 *
-* The bar is the facade's own `1.0`, because this guard answers one question:
-* would the transaction revert. It is deliberately not `MIN_HF_LIMITED`, and
-* the three bars in this codebase are three different jobs:
+* The threshold is the facade's own `1.0`, because this guard answers one
+* question: would the transaction revert. It is deliberately not
+* `MIN_HF_LIMITED`, and the three thresholds in this codebase are three
+* different jobs:
 *
 * - here, `1.0` — what the facade enforces, so what a plan must clear to land;
 * - `maxWithdrawCollateral` sizes at `MIN_HF_LIMITED + 2` — a *sizing* helper
-*   leaving headroom, which is not the same as a validity check;
+*   leaving a margin, which is not the same as a validity check;
 * - a form refuses at or below `MIN_HF_LIMITED` (`MIN_HEALTH_FACTOR_FORM`).
 *
 * Raising this one to `MIN_HF_LIMITED` was tried and reverted: it made
 * `maxWithdraw` hand back a ceiling this guard then refused, and it blocked
 * small top-ups of an account sitting in `[1.0, 1.01)` — the very operations
-* that rescue it. A form wanting the stricter bar has `validateHF`.
+* that rescue it. A form wanting the stricter threshold has `validateHF`.
 *
 * Note that a position already underwater cannot be nursed back one step at a
 * time — the check is on where the transaction ends, not on whether it
@@ -134,24 +112,23 @@ function assertGrowthAllowed(args) {
 * still be refused on-chain after passing here.
 */
 function assertCollateralised(healthFactorBps, safePrices) {
-	const required = MIN_HEALTH_FACTOR_FACADE;
+	const healthFactorThreshold = MIN_HEALTH_FACTOR_FACADE;
 	raise(checkCollateralised({
 		healthFactor: healthFactorBps,
-		required,
+		healthFactorThreshold,
 		safePrices
-	}), `the account would end at a health factor of ${healthFactorBps}, below ${required}`);
+	}), `the account would end at a health factor of ${healthFactorBps}, below ${healthFactorThreshold}`);
 }
 /**
 * A quota can only be raised as far as the market still has room for: past the
 * token's limit the keeper takes nothing more, whoever is asking.
 */
-function assertQuotaHeadroom(sdk, market, increases) {
+function assertQuotaAvailable(sdk, market, increases) {
 	const underlying = market.pool.underlying;
+	const { pqk } = market.pool;
 	for (const { token, balance } of increases) {
-		if (balance <= 0n) continue;
-		const quota = market.pool.pqk.quotas.get(token);
-		if (!quota) continue;
-		const left = quota.limit - quota.totalQuoted;
+		if (balance <= 0n || !pqk.quotas.has(token)) continue;
+		const left = pqk.quotaAvailable(token);
 		raise(checkQuotaLimit({
 			token: toToken(sdk, token),
 			requested: balance,
@@ -161,4 +138,4 @@ function assertQuotaHeadroom(sdk, market, increases) {
 	}
 }
 //#endregion
-export { assertCanBorrow, assertCollateralised, assertGrowthAllowed, assertMarketOperable, assertQuotaHeadroom, borrowable };
+export { assertCanBorrow, assertCollateralised, assertGrowthAllowed, assertMarketOperable, assertQuotaAvailable };