@gearbox-protocol/sdk 16.0.0-next.17 → 16.0.0-next.19

package/dist/esm/common-utils/utils/validation/validate-open-account.js

@@ -1,17 +0,0 @@
-import { validateQuota } from "./validate-quota.js";
-//#region src/common-utils/utils/validation/validate-open-account.ts
-function validateOpenAccount(props) {
-	const { debt, creditManager, loading } = props;
-	if (loading) return { message: "loading" };
-	if (debt < creditManager.minDebt) return {
-		message: "amountLessMin",
-		amount: creditManager.minDebt
-	};
-	if (debt > creditManager.maxDebt) return {
-		message: "debtGreaterMax",
-		amount: creditManager.maxDebt
-	};
-	return validateQuota(props);
-}
-//#endregion
-export { validateOpenAccount };

package/dist/esm/common-utils/utils/validation/validate-open-account.spec.js

@@ -1,56 +0,0 @@
-import { validateOpenAccount } from "./validate-open-account.js";
-import { buildCreditManager, mockUnderlyingToken } from "../../test-utils/index.js";
-import { describe, expect, it } from "vitest";
-//#region src/common-utils/utils/validation/validate-open-account.spec.ts
-const mockCreditManager = buildCreditManager({
-	minDebt: 1000n,
-	maxDebt: 1000000n,
-	underlyingToken: mockUnderlyingToken
-});
-describe("validateOpenAccount", () => {
-	it("returns null when all conditions are met", () => {
-		const result = validateOpenAccount({
-			debt: 50000n,
-			creditManager: mockCreditManager,
-			desiredQuota: {},
-			quotaUpdate: []
-		});
-		expect(result).toBeNull();
-	});
-	it("returns loading error when loading is true", () => {
-		const result = validateOpenAccount({
-			debt: 50000n,
-			creditManager: mockCreditManager,
-			desiredQuota: {},
-			quotaUpdate: [],
-			loading: true
-		});
-		expect(result).toEqual({ message: "loading" });
-	});
-	it("returns error when debt is less than min", () => {
-		const result = validateOpenAccount({
-			debt: 500n,
-			creditManager: mockCreditManager,
-			desiredQuota: {},
-			quotaUpdate: []
-		});
-		expect(result).toEqual({
-			message: "amountLessMin",
-			amount: 1000n
-		});
-	});
-	it("returns error when debt is greater than max", () => {
-		const result = validateOpenAccount({
-			debt: 2000000n,
-			creditManager: mockCreditManager,
-			desiredQuota: {},
-			quotaUpdate: []
-		});
-		expect(result).toEqual({
-			message: "debtGreaterMax",
-			amount: 1000000n
-		});
-	});
-});
-//#endregion
-export {};

package/dist/esm/common-utils/utils/validation/validate-quota.js

@@ -1,22 +0,0 @@
-//#region src/common-utils/utils/validation/validate-quota.ts
-function validateQuota(props) {
-	const desiredQuotasList = Object.values(props.desiredQuota).filter((a) => a.balance > 0n);
-	if (desiredQuotasList.length > props.creditManager.maxEnabledTokensLength) return {
-		message: "maxQuotasLengthReached",
-		count: desiredQuotasList.length,
-		max: props.creditManager.maxEnabledTokensLength
-	};
-	if (props.quotaUpdate.length === 0 && props.throwOnZeroQuotaUpdate) return { message: "quotaShouldBeUpdated" };
-	for (const { token, balance: updateBy } of props.quotaUpdate) {
-		const quota = props.creditManager.quotas[token];
-		if (updateBy > 0 && quota) {
-			if ((quota.isActive ? quota.limit : 0n) - quota.totalQuoted < updateBy) return {
-				message: "insufficientQuota",
-				token
-			};
-		}
-	}
-	return null;
-}
-//#endregion
-export { validateQuota };

package/dist/esm/common-utils/utils/validation/validate-quota.spec.js

@@ -1,88 +0,0 @@
-import { validateQuota } from "./validate-quota.js";
-import { buildCreditManager, buildQuota, mockToken1, mockToken2 } from "../../test-utils/index.js";
-import { describe, expect, it } from "vitest";
-//#region src/common-utils/utils/validation/validate-quota.spec.ts
-const mockCreditManager = buildCreditManager({
-	minDebt: 1000n,
-	maxDebt: 1000000n,
-	totalDebtLimit: 5000000n,
-	totalDebt: 2000000n,
-	availableToBorrow: 3000000n,
-	quotas: {
-		[mockToken1]: buildQuota({
-			token: mockToken1,
-			limit: 1000000n,
-			totalQuoted: 500000n,
-			rate: 0n
-		}),
-		[mockToken2]: buildQuota({
-			token: mockToken2,
-			limit: 2000000n,
-			totalQuoted: 1000000n,
-			rate: 0n
-		})
-	},
-	maxEnabledTokensLength: 2
-});
-describe("validateQuota", () => {
-	it("returns null when all conditions are met", () => {
-		const result = validateQuota({
-			desiredQuota: {},
-			quotaUpdate: [],
-			creditManager: mockCreditManager,
-			throwOnZeroQuotaUpdate: false
-		});
-		expect(result).toBeNull();
-	});
-	it("returns error when max quotas length is reached", () => {
-		const result = validateQuota({
-			desiredQuota: {
-				[mockToken1]: {
-					token: mockToken1,
-					balance: 1000n
-				},
-				[mockToken2]: {
-					token: mockToken2,
-					balance: 1000n
-				}
-			},
-			quotaUpdate: [],
-			creditManager: buildCreditManager({
-				...mockCreditManager,
-				maxEnabledTokensLength: 1
-			}),
-			throwOnZeroQuotaUpdate: false
-		});
-		expect(result).toEqual({
-			message: "maxQuotasLengthReached",
-			count: 2,
-			max: 1
-		});
-	});
-	it("returns error when quota update is empty and throwOnZeroQuotaUpdate is true", () => {
-		const result = validateQuota({
-			desiredQuota: {},
-			quotaUpdate: [],
-			creditManager: mockCreditManager,
-			throwOnZeroQuotaUpdate: true
-		});
-		expect(result).toEqual({ message: "quotaShouldBeUpdated" });
-	});
-	it("returns error when quota is insufficient", () => {
-		const result = validateQuota({
-			desiredQuota: {},
-			quotaUpdate: [{
-				token: mockToken1,
-				balance: 600000n
-			}],
-			creditManager: mockCreditManager,
-			throwOnZeroQuotaUpdate: false
-		});
-		expect(result).toEqual({
-			message: "insufficientQuota",
-			token: mockToken1
-		});
-	});
-});
-//#endregion
-export {};

package/dist/esm/common-utils/utils/validation/validate-token-to-obtain.js

@@ -1,17 +0,0 @@
-//#region src/common-utils/utils/validation/validate-token-to-obtain.ts
-function validateTokenToObtain({ creditManager, targetToken }) {
-	if (Array.isArray(targetToken)) {
-		for (const asset of targetToken) if (creditManager.forbiddenTokens[asset.token]) return {
-			message: "tokenIsForbidden",
-			token: asset.token
-		};
-		return null;
-	}
-	if (targetToken !== null && creditManager.forbiddenTokens[targetToken]) return {
-		message: "tokenIsForbidden",
-		token: targetToken
-	};
-	return null;
-}
-//#endregion
-export { validateTokenToObtain };

package/dist/esm/common-utils/utils/validation/validate-token-to-obtain.spec.js

@@ -1,36 +0,0 @@
-import { validateTokenToObtain } from "./validate-token-to-obtain.js";
-import { buildCreditManager, mockToken1 } from "../../test-utils/index.js";
-import { describe, expect, it } from "vitest";
-//#region src/common-utils/utils/validation/validate-token-to-obtain.spec.ts
-const mockCreditManager = buildCreditManager({ forbiddenTokens: {} });
-describe("validateTokenToObtain", () => {
-	it("returns null when targetToken is null", () => {
-		const result = validateTokenToObtain({
-			targetToken: null,
-			creditManager: mockCreditManager
-		});
-		expect(result).toBeNull();
-	});
-	it("returns null when targetToken is not forbidden", () => {
-		const result = validateTokenToObtain({
-			targetToken: mockToken1,
-			creditManager: mockCreditManager
-		});
-		expect(result).toBeNull();
-	});
-	it("returns error when targetToken is forbidden", () => {
-		const result = validateTokenToObtain({
-			targetToken: mockToken1,
-			creditManager: buildCreditManager({
-				...mockCreditManager,
-				forbiddenTokens: { [mockToken1]: true }
-			})
-		});
-		expect(result).toEqual({
-			message: "tokenIsForbidden",
-			token: mockToken1
-		});
-	});
-});
-//#endregion
-export {};

package/dist/esm/common-utils/utils/validation/validation-types.js

@@ -1 +0,0 @@
-export {};

package/dist/types/common-utils/utils/strategies/strategy-info/get-cm-you-can-earn.spec.d.ts

@@ -1 +0,0 @@
-export {}

package/dist/types/common-utils/utils/validation/index.d.ts

@@ -1,12 +0,0 @@
-import { isZeroBalance } from "./is-zero-balance.js";
-import { ValidateBalanceProps, ValidateBalanceResult, validateBalance } from "./validate-balance.js";
-import { ValidateBalancesProps, validateBalances } from "./validate-balances.js";
-import { ValidateCreditManagerProps, ValidateCreditManagerResult, validateCreditManager } from "./validate-credit-manager.js";
-import { MIN_HF_LIMITED, ValidateHFProps, ValidateHFResult, validateHF } from "./validate-hf.js";
-import { ValidateQuotaProps, ValidateQuotaResult, validateQuota } from "./validate-quota.js";
-import { ValidateOpenAccountProps, ValidateOpenAccountResult, validateOpenAccount } from "./validate-open-account.js";
-import { ValidateOpenAccountPoolQuotaStatusResult, validateOpenAccountPoolQuotaStatus } from "./validate-open-account-pool-quota-status.js";
-import { ValidateOpenAccountPoolStatusProps, ValidateOpenAccountPoolStatusResult, validateOpenAccountPoolStatus } from "./validate-open-account-pool-status.js";
-import { ValidateTokenToObtainProps, ValidateTokenToObtainResult, validateTokenToObtain } from "./validate-token-to-obtain.js";
-import { FlattenUnion } from "./validation-types.js";
-export { FlattenUnion, MIN_HF_LIMITED, ValidateBalanceProps, ValidateBalanceResult, ValidateBalancesProps, ValidateCreditManagerProps, ValidateCreditManagerResult, ValidateHFProps, ValidateHFResult, ValidateOpenAccountPoolQuotaStatusResult, ValidateOpenAccountPoolStatusProps, ValidateOpenAccountPoolStatusResult, ValidateOpenAccountProps, ValidateOpenAccountResult, ValidateQuotaProps, ValidateQuotaResult, ValidateTokenToObtainProps, ValidateTokenToObtainResult, isZeroBalance, validateBalance, validateBalances, validateCreditManager, validateHF, validateOpenAccount, validateOpenAccountPoolQuotaStatus, validateOpenAccountPoolStatus, validateQuota, validateTokenToObtain };

package/dist/types/common-utils/utils/validation/is-zero-balance.d.ts

@@ -1,4 +0,0 @@
-//#region src/common-utils/utils/validation/is-zero-balance.d.ts
-declare function isZeroBalance(balance: bigint | undefined): boolean;
-//#endregion
-export { isZeroBalance };

package/dist/types/common-utils/utils/validation/validate-balance.d.ts

@@ -1,25 +0,0 @@
-import { Address } from "viem";
-//#region src/common-utils/utils/validation/validate-balance.d.ts
-interface ValidateBalanceProps {
-  amount: bigint;
-  tokenAddress: Address;
-  maxAmount: bigint | undefined;
-  zeroCheck?: boolean;
-  single?: boolean;
-}
-type ValidateBalanceResult = {
-  message: "unknownToken";
-  token: Address;
-} | {
-  message: "insufficientFunds";
-  token: Address;
-} | {
-  message: "zeroBalance";
-  token: Address;
-} | {
-  message: "enterAmount";
-  token: Address;
-};
-declare function validateBalance({ amount, tokenAddress, maxAmount, zeroCheck, single }: ValidateBalanceProps): ValidateBalanceResult | null;
-//#endregion
-export { ValidateBalanceProps, ValidateBalanceResult, validateBalance };

package/dist/types/common-utils/utils/validation/validate-balance.spec.d.ts

@@ -1 +0,0 @@
-export {}

package/dist/types/common-utils/utils/validation/validate-balances.d.ts

@@ -1,13 +0,0 @@
-import { Asset } from "../../../onchain/base/types.js";
-import "../../../onchain/index.js";
-import { ValidateBalanceResult } from "./validate-balance.js";
-import { Address } from "viem";
-//#region src/common-utils/utils/validation/validate-balances.d.ts
-interface ValidateBalancesProps {
-  balances: Record<Address, bigint>;
-  assets: Array<Asset>;
-  zeroCheck?: boolean;
-}
-declare function validateBalances({ balances, assets, zeroCheck }: ValidateBalancesProps): ValidateBalanceResult | null;
-//#endregion
-export { ValidateBalancesProps, validateBalances };

package/dist/types/common-utils/utils/validation/validate-balances.spec.d.ts

@@ -1 +0,0 @@
-export {}

package/dist/types/common-utils/utils/validation/validate-credit-manager.d.ts

@@ -1,13 +0,0 @@
-//#region src/common-utils/utils/validation/validate-credit-manager.d.ts
-interface ValidateCreditManagerProps {
-  creditManager: {
-    isPaused: boolean;
-  };
-  allowPausedCm?: boolean;
-}
-interface ValidateCreditManagerResult {
-  message: "paused";
-}
-declare function validateCreditManager({ creditManager, allowPausedCm }: ValidateCreditManagerProps): ValidateCreditManagerResult | null;
-//#endregion
-export { ValidateCreditManagerProps, ValidateCreditManagerResult, validateCreditManager };

package/dist/types/common-utils/utils/validation/validate-credit-manager.spec.d.ts

@@ -1 +0,0 @@
-export {}

package/dist/types/common-utils/utils/validation/validate-hf.d.ts

@@ -1,12 +0,0 @@
-//#region src/common-utils/utils/validation/validate-hf.d.ts
-declare const MIN_HF_LIMITED = 10100n;
-interface ValidateHFProps {
-  hf: number | undefined;
-  hfCheck?: boolean;
-}
-interface ValidateHFResult {
-  message: "hfTooLow";
-}
-declare function validateHF({ hf, hfCheck }: ValidateHFProps): ValidateHFResult | null;
-//#endregion
-export { MIN_HF_LIMITED, ValidateHFProps, ValidateHFResult, validateHF };

package/dist/types/common-utils/utils/validation/validate-hf.spec.d.ts

@@ -1 +0,0 @@
-export {}

package/dist/types/common-utils/utils/validation/validate-open-account-pool-quota-status.d.ts

@@ -1,10 +0,0 @@
-import { CreditManagerSlice } from "../strategies/strategy-info/types.js";
-import { Address } from "viem";
-//#region src/common-utils/utils/validation/validate-open-account-pool-quota-status.d.ts
-interface ValidateOpenAccountPoolQuotaStatusResult {
-  message: "insufficientQuota";
-  token: Address;
-}
-declare function validateOpenAccountPoolQuotaStatus(targetToken: Address, creditManager: Pick<CreditManagerSlice, "quotas">, amountToBorrow: bigint): ValidateOpenAccountPoolQuotaStatusResult | null;
-//#endregion
-export { ValidateOpenAccountPoolQuotaStatusResult, validateOpenAccountPoolQuotaStatus };

package/dist/types/common-utils/utils/validation/validate-open-account-pool-quota-status.spec.d.ts

@@ -1 +0,0 @@
-export {}

package/dist/types/common-utils/utils/validation/validate-open-account-pool-status.d.ts

@@ -1,26 +0,0 @@
-import { CreditManagerSlice, PoolSlice } from "../strategies/strategy-info/types.js";
-import { ValidateOpenAccountPoolQuotaStatusResult } from "./validate-open-account-pool-quota-status.js";
-import { Address } from "viem";
-//#region src/common-utils/utils/validation/validate-open-account-pool-status.d.ts
-interface ValidateOpenAccountPoolStatusProps {
-  creditManager: Pick<CreditManagerSlice, "minDebt" | "totalDebtLimit" | "totalDebt" | "availableToBorrow" | "quotas">;
-  pool: Pick<PoolSlice, "totalDebtLimit" | "totalBorrowed"> | undefined | null;
-  debt: bigint;
-  targetToken: Address | null;
-}
-type ValidateOpenAccountPoolStatusResult = {
-  message: "insufficientDebtLimit";
-  amount: bigint;
-  solutionAmount?: bigint;
-} | {
-  message: "insufficientPoolDebtLimit";
-  amount: bigint;
-  solutionAmount?: bigint;
-} | {
-  message: "insufficientPoolLiquidity";
-  amount: bigint;
-  solutionAmount?: bigint;
-} | ValidateOpenAccountPoolQuotaStatusResult;
-declare function validateOpenAccountPoolStatus(props: ValidateOpenAccountPoolStatusProps): ValidateOpenAccountPoolStatusResult | null;
-//#endregion
-export { ValidateOpenAccountPoolStatusProps, ValidateOpenAccountPoolStatusResult, validateOpenAccountPoolStatus };

package/dist/types/common-utils/utils/validation/validate-open-account-pool-status.spec.d.ts

@@ -1 +0,0 @@
-export {}

package/dist/types/common-utils/utils/validation/validate-open-account.d.ts

@@ -1,25 +0,0 @@
-import { Asset } from "../../../onchain/base/types.js";
-import { CreditManagerSlice } from "../strategies/strategy-info/types.js";
-import "../../../onchain/index.js";
-import { ValidateQuotaResult } from "./validate-quota.js";
-import { Address } from "viem";
-//#region src/common-utils/utils/validation/validate-open-account.d.ts
-interface ValidateOpenAccountProps {
-  debt: bigint;
-  creditManager: Pick<CreditManagerSlice, "minDebt" | "maxDebt" | "underlyingToken" | "quotas" | "maxEnabledTokensLength">;
-  desiredQuota: Record<Address, Asset>;
-  quotaUpdate: Array<Asset>;
-  loading?: boolean;
-}
-type ValidateOpenAccountResult = {
-  message: "loading";
-} | {
-  message: "amountLessMin";
-  amount: bigint;
-} | {
-  message: "debtGreaterMax";
-  amount: bigint;
-} | ValidateQuotaResult;
-declare function validateOpenAccount(props: ValidateOpenAccountProps): ValidateOpenAccountResult | null;
-//#endregion
-export { ValidateOpenAccountProps, ValidateOpenAccountResult, validateOpenAccount };

package/dist/types/common-utils/utils/validation/validate-open-account.spec.d.ts

@@ -1 +0,0 @@
-export {}

package/dist/types/common-utils/utils/validation/validate-quota.d.ts

@@ -1,24 +0,0 @@
-import { Asset } from "../../../onchain/base/types.js";
-import { CreditManagerSlice } from "../strategies/strategy-info/types.js";
-import "../../../onchain/index.js";
-import { Address } from "viem";
-//#region src/common-utils/utils/validation/validate-quota.d.ts
-interface ValidateQuotaProps {
-  desiredQuota: Record<Address, Asset>;
-  quotaUpdate: Array<Asset>;
-  creditManager: Pick<CreditManagerSlice, "quotas" | "maxEnabledTokensLength">;
-  throwOnZeroQuotaUpdate?: boolean;
-}
-type ValidateQuotaResult = {
-  message: "maxQuotasLengthReached";
-  count: number;
-  max: number;
-} | {
-  message: "quotaShouldBeUpdated";
-} | {
-  message: "insufficientQuota";
-  token: Address;
-};
-declare function validateQuota(props: ValidateQuotaProps): ValidateQuotaResult | null;
-//#endregion
-export { ValidateQuotaProps, ValidateQuotaResult, validateQuota };

package/dist/types/common-utils/utils/validation/validate-quota.spec.d.ts

@@ -1 +0,0 @@
-export {}

package/dist/types/common-utils/utils/validation/validate-token-to-obtain.d.ts

@@ -1,17 +0,0 @@
-import { Asset } from "../../../onchain/base/types.js";
-import "../../../onchain/index.js";
-import { Address } from "viem";
-//#region src/common-utils/utils/validation/validate-token-to-obtain.d.ts
-interface ValidateTokenToObtainProps {
-  targetToken: Address | Array<Asset> | null;
-  creditManager: {
-    forbiddenTokens: Record<Address, boolean>;
-  };
-}
-interface ValidateTokenToObtainResult {
-  message: "tokenIsForbidden";
-  token: Address;
-}
-declare function validateTokenToObtain({ creditManager, targetToken }: ValidateTokenToObtainProps): ValidateTokenToObtainResult | null;
-//#endregion
-export { ValidateTokenToObtainProps, ValidateTokenToObtainResult, validateTokenToObtain };

package/dist/types/common-utils/utils/validation/validate-token-to-obtain.spec.d.ts

@@ -1 +0,0 @@
-export {}

package/dist/types/common-utils/utils/validation/validation-types.d.ts

@@ -1,10 +0,0 @@
-//#region src/common-utils/utils/validation/validation-types.d.ts
-type AllKeys<T> = T extends unknown ? keyof T : never;
-type IsKeyInAll<T, K extends PropertyKey> = T extends unknown ? K extends keyof T ? true : false : never;
-type IsKeyRequired<T, K extends PropertyKey> = T extends unknown ? K extends keyof T ? object extends Pick<T, K> ? false : true : false : never;
-type RequiredKeys<T, K = AllKeys<T>> = K extends PropertyKey ? true extends IsKeyInAll<T, K> ? true extends IsKeyRequired<T, K> ? false extends IsKeyRequired<T, K> ? never : K : never : never : never;
-type OptionalKeys<T, K = AllKeys<T>> = K extends PropertyKey ? K extends RequiredKeys<T> ? never : K : never;
-type ValueForKey<T, K extends PropertyKey> = T extends { [P in K]?: infer V; } ? V : never;
-type FlattenUnion<T> = { [K in RequiredKeys<T>]: ValueForKey<T, K>; } & { [K in OptionalKeys<T>]?: ValueForKey<T, K>; };
-//#endregion
-export { FlattenUnion };