@kamino-finance/klend-sdk 5.12.8 → 5.13.1

package/dist/obligation_orders/price_based.d.ts

@@ -0,0 +1,81 @@
+import Decimal from 'decimal.js';
+import { ObligationOrderAtIndex } from '../classes/obligationOrder';
+import { PublicKey } from '@solana/web3.js';
+import { OrderContext, OrderSpecification, OrderType } from './common';
+/**
+ * Creates a price-based {@link ObligationOrderAtIndex} based on the given stop-loss or take-profit specification.
+ *
+ * The returned object can then be passed directly to {@link KaminoAction.buildSetObligationOrderIxn()} to build an
+ * instruction which replaces (or cancels, if the specification is `null`) the given obligation's stop-loss or
+ * take-profit order on-chain.
+ *
+ * The given obligation is expected to be a "price-based position" - a single-debt, single-coll obligation which either
+ * deposits or borrows a stablecoin (i.e. a long or short position of some token against a stablecoin).
+ */
+export declare function createPriceBasedOrder(context: PriceBasedOrderContext, orderType: OrderType, specification: PriceBasedOrderSpecification | null): ObligationOrderAtIndex;
+/**
+ * Parses an {@link PriceBasedOrderSpecification} from the selected stop-loss or take-profit order of the given obligation.
+ *
+ * The given obligation is expected to be a "price-based position" - a single-debt, single-coll obligation which either
+ * deposits or borrows a stablecoin (i.e. a long or short position of some token against a stablecoin).
+ *
+ * The selected order is expected to be of matching type (i.e. as if it was created using the
+ * {@link createPriceBasedOrder()}).
+ */
+export declare function readPriceBasedOrder(context: PriceBasedOrderContext, orderType: OrderType): PriceBasedOrderSpecification | null;
+/**
+ * An extended {@link OrderContext} needed to interpret orders on "price-based position" obligations.
+ */
+export type PriceBasedOrderContext = OrderContext & {
+    stablecoins: SymbolOrMintAddress[];
+};
+/**
+ * A convenient multi-way of specifying a token.
+ */
+export type SymbolOrMintAddress = string | PublicKey;
+/**
+ * A high-level specification of a price-based order.
+ */
+export type PriceBasedOrderSpecification = OrderSpecification<PriceBasedOrderTrigger>;
+/**
+ * A discriminator enum for {@link PriceBasedOrderTrigger};
+ */
+export declare enum PriceBasedOrderTriggerType {
+    LongStopLoss = "LongStopLoss",
+    LongTakeProfit = "LongTakeProfit",
+    ShortStopLoss = "ShortStopLoss",
+    ShortTakeProfit = "ShortTakeProfit"
+}
+/**
+ * One of possible triggers depending on the obligation's type and the price bracket's side.
+ */
+export type PriceBasedOrderTrigger = LongStopLoss | LongTakeProfit | ShortStopLoss | ShortTakeProfit;
+/**
+ * A trigger for a stop-loss on a long position.
+ */
+export type LongStopLoss = {
+    type: PriceBasedOrderTriggerType.LongStopLoss;
+    whenCollateralPriceBelow: Decimal;
+};
+/**
+ * A trigger for a take-profit on a long position.
+ */
+export type LongTakeProfit = {
+    type: PriceBasedOrderTriggerType.LongTakeProfit;
+    whenCollateralPriceAbove: Decimal;
+};
+/**
+ * A trigger for a stop-loss on a short position.
+ */
+export type ShortStopLoss = {
+    type: PriceBasedOrderTriggerType.ShortStopLoss;
+    whenDebtPriceAbove: Decimal;
+};
+/**
+ * A trigger for a take-profit on a short position.
+ */
+export type ShortTakeProfit = {
+    type: PriceBasedOrderTriggerType.ShortTakeProfit;
+    whenDebtPriceBelow: Decimal;
+};
+//# sourceMappingURL=price_based.d.ts.map

package/dist/obligation_orders/price_based.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"price_based.d.ts","sourceRoot":"","sources":["../../src/obligation_orders/price_based.ts"],"names":[],"mappings":"AACA,OAAO,OAAO,MAAM,YAAY,CAAC;AACjC,OAAO,EAGL,sBAAsB,EAEvB,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAE5C,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAGvE;;;;;;;;;GASG;AACH,wBAAgB,qBAAqB,CACnC,OAAO,EAAE,sBAAsB,EAC/B,SAAS,EAAE,SAAS,EACpB,aAAa,EAAE,4BAA4B,GAAG,IAAI,GACjD,sBAAsB,CAQxB;AAED;;;;;;;;GAQG;AACH,wBAAgB,mBAAmB,CACjC,OAAO,EAAE,sBAAsB,EAC/B,SAAS,EAAE,SAAS,GACnB,4BAA4B,GAAG,IAAI,CAQrC;AAED;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,YAAY,GAAG;IAClD,WAAW,EAAE,mBAAmB,EAAE,CAAC;CACpC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,MAAM,GAAG,SAAS,CAAC;AAErD;;GAEG;AACH,MAAM,MAAM,4BAA4B,GAAG,kBAAkB,CAAC,sBAAsB,CAAC,CAAC;AAEtF;;GAEG;AACH,oBAAY,0BAA0B;IACpC,YAAY,iBAAiB;IAC7B,cAAc,mBAAmB;IACjC,aAAa,kBAAkB;IAC/B,eAAe,oBAAoB;CACpC;AAED;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,YAAY,GAAG,cAAc,GAAG,aAAa,GAAG,eAAe,CAAC;AAErG;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,0BAA0B,CAAC,YAAY,CAAC;IAC9C,wBAAwB,EAAE,OAAO,CAAC;CACnC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,0BAA0B,CAAC,cAAc,CAAC;IAChD,wBAAwB,EAAE,OAAO,CAAC;CACnC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,0BAA0B,CAAC,aAAa,CAAC;IAC/C,kBAAkB,EAAE,OAAO,CAAC;CAC7B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,0BAA0B,CAAC,eAAe,CAAC;IACjD,kBAAkB,EAAE,OAAO,CAAC;CAC7B,CAAC"}

package/dist/obligation_orders/price_based.js

@@ -0,0 +1,167 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PriceBasedOrderTriggerType = void 0;
+exports.createPriceBasedOrder = createPriceBasedOrder;
+exports.readPriceBasedOrder = readPriceBasedOrder;
+const decimal_js_1 = __importDefault(require("decimal.js"));
+const obligationOrder_1 = require("../classes/obligationOrder");
+const utils_1 = require("../utils");
+const validations_1 = require("../utils/validations");
+const common_1 = require("./common");
+const internal_1 = require("./internal");
+/**
+ * Creates a price-based {@link ObligationOrderAtIndex} based on the given stop-loss or take-profit specification.
+ *
+ * The returned object can then be passed directly to {@link KaminoAction.buildSetObligationOrderIxn()} to build an
+ * instruction which replaces (or cancels, if the specification is `null`) the given obligation's stop-loss or
+ * take-profit order on-chain.
+ *
+ * The given obligation is expected to be a "price-based position" - a single-debt, single-coll obligation which either
+ * deposits or borrows a stablecoin (i.e. a long or short position of some token against a stablecoin).
+ */
+function createPriceBasedOrder(context, orderType, specification) {
+    const positionType = resolvePositionType(context); // resolving this first has an intentional side effect of validating the obligation being compatible
+    const index = (0, internal_1.toOrderIndex)(orderType);
+    if (specification === null) {
+        return obligationOrder_1.ObligationOrderAtIndex.empty(index);
+    }
+    const condition = toOrderCondition(positionType, orderType, specification.trigger);
+    return (0, internal_1.createConditionBasedOrder)(context, condition, specification).atIndex(index);
+}
+/**
+ * Parses an {@link PriceBasedOrderSpecification} from the selected stop-loss or take-profit order of the given obligation.
+ *
+ * The given obligation is expected to be a "price-based position" - a single-debt, single-coll obligation which either
+ * deposits or borrows a stablecoin (i.e. a long or short position of some token against a stablecoin).
+ *
+ * The selected order is expected to be of matching type (i.e. as if it was created using the
+ * {@link createPriceBasedOrder()}).
+ */
+function readPriceBasedOrder(context, orderType) {
+    const positionType = resolvePositionType(context); // resolving this first has an intentional side effect of validating the obligation being compatible
+    const kaminoOrder = context.kaminoObligation.getOrders()[(0, internal_1.toOrderIndex)(orderType)];
+    if (kaminoOrder === null) {
+        return null;
+    }
+    const trigger = toTrigger(positionType, kaminoOrder.condition, orderType);
+    return (0, internal_1.readTriggerBasedOrder)(kaminoOrder, trigger);
+}
+/**
+ * A discriminator enum for {@link PriceBasedOrderTrigger};
+ */
+var PriceBasedOrderTriggerType;
+(function (PriceBasedOrderTriggerType) {
+    PriceBasedOrderTriggerType["LongStopLoss"] = "LongStopLoss";
+    PriceBasedOrderTriggerType["LongTakeProfit"] = "LongTakeProfit";
+    PriceBasedOrderTriggerType["ShortStopLoss"] = "ShortStopLoss";
+    PriceBasedOrderTriggerType["ShortTakeProfit"] = "ShortTakeProfit";
+})(PriceBasedOrderTriggerType || (exports.PriceBasedOrderTriggerType = PriceBasedOrderTriggerType = {}));
+// Only internals below:
+function toOrderCondition(positionType, orderType, trigger) {
+    switch (positionType) {
+        case PositionType.Long:
+            switch (orderType) {
+                case common_1.OrderType.StopLoss:
+                    if (trigger.type === PriceBasedOrderTriggerType.LongStopLoss) {
+                        return new obligationOrder_1.DebtCollPriceRatioAbove(invertPriceRatio(trigger.whenCollateralPriceBelow));
+                    }
+                    break;
+                case common_1.OrderType.TakeProfit:
+                    if (trigger.type === PriceBasedOrderTriggerType.LongTakeProfit) {
+                        return new obligationOrder_1.DebtCollPriceRatioBelow(invertPriceRatio(trigger.whenCollateralPriceAbove));
+                    }
+                    break;
+            }
+            break;
+        case PositionType.Short:
+            switch (orderType) {
+                case common_1.OrderType.StopLoss:
+                    if (trigger.type === PriceBasedOrderTriggerType.ShortStopLoss) {
+                        return new obligationOrder_1.DebtCollPriceRatioAbove(trigger.whenDebtPriceAbove);
+                    }
+                    break;
+                case common_1.OrderType.TakeProfit:
+                    if (trigger.type === PriceBasedOrderTriggerType.ShortTakeProfit) {
+                        return new obligationOrder_1.DebtCollPriceRatioBelow(trigger.whenDebtPriceBelow);
+                    }
+                    break;
+            }
+            break;
+    }
+    throw new Error(`a ${orderType} order on a ${positionType} position cannot use ${trigger.type} condition`);
+}
+function toTrigger(positionType, condition, orderType) {
+    switch (positionType) {
+        case PositionType.Long:
+            switch (orderType) {
+                case common_1.OrderType.StopLoss:
+                    if (condition instanceof obligationOrder_1.DebtCollPriceRatioAbove) {
+                        return {
+                            type: PriceBasedOrderTriggerType.LongStopLoss,
+                            whenCollateralPriceBelow: invertPriceRatio(condition.minDebtCollPriceRatioExclusive),
+                        };
+                    }
+                    break;
+                case common_1.OrderType.TakeProfit:
+                    if (condition instanceof obligationOrder_1.DebtCollPriceRatioBelow) {
+                        return {
+                            type: PriceBasedOrderTriggerType.LongTakeProfit,
+                            whenCollateralPriceAbove: invertPriceRatio(condition.maxDebtCollPriceRatioExclusive),
+                        };
+                    }
+                    break;
+            }
+            break;
+        case PositionType.Short:
+            switch (orderType) {
+                case common_1.OrderType.StopLoss:
+                    if (condition instanceof obligationOrder_1.DebtCollPriceRatioAbove) {
+                        return {
+                            type: PriceBasedOrderTriggerType.ShortStopLoss,
+                            whenDebtPriceAbove: condition.minDebtCollPriceRatioExclusive,
+                        };
+                    }
+                    break;
+                case common_1.OrderType.TakeProfit:
+                    if (condition instanceof obligationOrder_1.DebtCollPriceRatioBelow) {
+                        return {
+                            type: PriceBasedOrderTriggerType.ShortTakeProfit,
+                            whenDebtPriceBelow: condition.maxDebtCollPriceRatioExclusive,
+                        };
+                    }
+                    break;
+            }
+            break;
+    }
+    throw new Error(`a ${orderType} order on a ${positionType} position has an incompatible on-chain condition ${condition.constructor.name}`);
+}
+function invertPriceRatio(priceRatio) {
+    return new decimal_js_1.default(1).div(priceRatio);
+}
+var PositionType;
+(function (PositionType) {
+    PositionType["Long"] = "Long";
+    PositionType["Short"] = "Short";
+})(PositionType || (PositionType = {}));
+function resolvePositionType(context) {
+    const collateralReserveAddress = (0, validations_1.getSingleElement)(context.kaminoObligation.deposits.keys(), 'deposit');
+    const debtReserveAddress = (0, validations_1.getSingleElement)(context.kaminoObligation.borrows.keys(), 'borrow');
+    const stablecoinReserveAddresses = collectReserveAddresses(context.kaminoMarket, context.stablecoins);
+    if (stablecoinReserveAddresses.contains(collateralReserveAddress)) {
+        (0, validations_1.checkThat)(!stablecoinReserveAddresses.contains(debtReserveAddress), 'cannot resolve long vs short position from all-stablecoins obligation');
+        return PositionType.Short;
+    }
+    else {
+        (0, validations_1.checkThat)(stablecoinReserveAddresses.contains(debtReserveAddress), 'cannot resolve long vs short position from no-stablecoins obligation');
+        return PositionType.Long;
+    }
+}
+function collectReserveAddresses(kaminoMarket, symbolOrMintAddresses) {
+    return new utils_1.PublicKeySet(symbolOrMintAddresses.map((symbolOrMintAddress) => typeof symbolOrMintAddress === 'string'
+        ? kaminoMarket.getExistingReserveBySymbol(symbolOrMintAddress).address
+        : kaminoMarket.getExistingReserveByMint(symbolOrMintAddress).address));
+}
+//# sourceMappingURL=price_based.js.map

package/dist/obligation_orders/price_based.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"price_based.js","sourceRoot":"","sources":["../../src/obligation_orders/price_based.ts"],"names":[],"mappings":";;;;;;AAwBA,sDAYC;AAWD,kDAWC;AAzDD,4DAAiC;AACjC,gEAKoC;AACpC,oCAAwC;AAExC,sDAAmE;AACnE,qCAAuE;AACvE,yCAA4F;AAE5F;;;;;;;;;GASG;AACH,SAAgB,qBAAqB,CACnC,OAA+B,EAC/B,SAAoB,EACpB,aAAkD;IAElD,MAAM,YAAY,GAAG,mBAAmB,CAAC,OAAO,CAAC,CAAC,CAAC,oGAAoG;IACvJ,MAAM,KAAK,GAAG,IAAA,uBAAY,EAAC,SAAS,CAAC,CAAC;IACtC,IAAI,aAAa,KAAK,IAAI,EAAE,CAAC;QAC3B,OAAO,wCAAsB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAC7C,CAAC;IACD,MAAM,SAAS,GAAG,gBAAgB,CAAC,YAAY,EAAE,SAAS,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC;IACnF,OAAO,IAAA,oCAAyB,EAAC,OAAO,EAAE,SAAS,EAAE,aAAa,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AACrF,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,mBAAmB,CACjC,OAA+B,EAC/B,SAAoB;IAEpB,MAAM,YAAY,GAAG,mBAAmB,CAAC,OAAO,CAAC,CAAC,CAAC,oGAAoG;IACvJ,MAAM,WAAW,GAAG,OAAO,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC,IAAA,uBAAY,EAAC,SAAS,CAAC,CAAC,CAAC;IAClF,IAAI,WAAW,KAAK,IAAI,EAAE,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IACD,MAAM,OAAO,GAAG,SAAS,CAAC,YAAY,EAAE,WAAW,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IAC1E,OAAO,IAAA,gCAAqB,EAAC,WAAW,EAAE,OAAO,CAAC,CAAC;AACrD,CAAC;AAmBD;;GAEG;AACH,IAAY,0BAKX;AALD,WAAY,0BAA0B;IACpC,2DAA6B,CAAA;IAC7B,+DAAiC,CAAA;IACjC,6DAA+B,CAAA;IAC/B,iEAAmC,CAAA;AACrC,CAAC,EALW,0BAA0B,0CAA1B,0BAA0B,QAKrC;AAuCD,wBAAwB;AAExB,SAAS,gBAAgB,CACvB,YAA0B,EAC1B,SAAoB,EACpB,OAA+B;IAE/B,QAAQ,YAAY,EAAE,CAAC;QACrB,KAAK,YAAY,CAAC,IAAI;YACpB,QAAQ,SAAS,EAAE,CAAC;gBAClB,KAAK,kBAAS,CAAC,QAAQ;oBACrB,IAAI,OAAO,CAAC,IAAI,KAAK,0BAA0B,CAAC,YAAY,EAAE,CAAC;wBAC7D,OAAO,IAAI,yCAAuB,CAAC,gBAAgB,CAAC,OAAO,CAAC,wBAAwB,CAAC,CAAC,CAAC;oBACzF,CAAC;oBACD,MAAM;gBACR,KAAK,kBAAS,CAAC,UAAU;oBACvB,IAAI,OAAO,CAAC,IAAI,KAAK,0BAA0B,CAAC,cAAc,EAAE,CAAC;wBAC/D,OAAO,IAAI,yCAAuB,CAAC,gBAAgB,CAAC,OAAO,CAAC,wBAAwB,CAAC,CAAC,CAAC;oBACzF,CAAC;oBACD,MAAM;YACV,CAAC;YACD,MAAM;QACR,KAAK,YAAY,CAAC,KAAK;YACrB,QAAQ,SAAS,EAAE,CAAC;gBAClB,KAAK,kBAAS,CAAC,QAAQ;oBACrB,IAAI,OAAO,CAAC,IAAI,KAAK,0BAA0B,CAAC,aAAa,EAAE,CAAC;wBAC9D,OAAO,IAAI,yCAAuB,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;oBACjE,CAAC;oBACD,MAAM;gBACR,KAAK,kBAAS,CAAC,UAAU;oBACvB,IAAI,OAAO,CAAC,IAAI,KAAK,0BAA0B,CAAC,eAAe,EAAE,CAAC;wBAChE,OAAO,IAAI,yCAAuB,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;oBACjE,CAAC;oBACD,MAAM;YACV,CAAC;YACD,MAAM;IACV,CAAC;IACD,MAAM,IAAI,KAAK,CAAC,KAAK,SAAS,eAAe,YAAY,wBAAwB,OAAO,CAAC,IAAI,YAAY,CAAC,CAAC;AAC7G,CAAC;AAED,SAAS,SAAS,CAChB,YAA0B,EAC1B,SAAyB,EACzB,SAAoB;IAEpB,QAAQ,YAAY,EAAE,CAAC;QACrB,KAAK,YAAY,CAAC,IAAI;YACpB,QAAQ,SAAS,EAAE,CAAC;gBAClB,KAAK,kBAAS,CAAC,QAAQ;oBACrB,IAAI,SAAS,YAAY,yCAAuB,EAAE,CAAC;wBACjD,OAAO;4BACL,IAAI,EAAE,0BAA0B,CAAC,YAAY;4BAC7C,wBAAwB,EAAE,gBAAgB,CAAC,SAAS,CAAC,8BAA8B,CAAC;yBACrF,CAAC;oBACJ,CAAC;oBACD,MAAM;gBACR,KAAK,kBAAS,CAAC,UAAU;oBACvB,IAAI,SAAS,YAAY,yCAAuB,EAAE,CAAC;wBACjD,OAAO;4BACL,IAAI,EAAE,0BAA0B,CAAC,cAAc;4BAC/C,wBAAwB,EAAE,gBAAgB,CAAC,SAAS,CAAC,8BAA8B,CAAC;yBACrF,CAAC;oBACJ,CAAC;oBACD,MAAM;YACV,CAAC;YACD,MAAM;QACR,KAAK,YAAY,CAAC,KAAK;YACrB,QAAQ,SAAS,EAAE,CAAC;gBAClB,KAAK,kBAAS,CAAC,QAAQ;oBACrB,IAAI,SAAS,YAAY,yCAAuB,EAAE,CAAC;wBACjD,OAAO;4BACL,IAAI,EAAE,0BAA0B,CAAC,aAAa;4BAC9C,kBAAkB,EAAE,SAAS,CAAC,8BAA8B;yBAC7D,CAAC;oBACJ,CAAC;oBACD,MAAM;gBACR,KAAK,kBAAS,CAAC,UAAU;oBACvB,IAAI,SAAS,YAAY,yCAAuB,EAAE,CAAC;wBACjD,OAAO;4BACL,IAAI,EAAE,0BAA0B,CAAC,eAAe;4BAChD,kBAAkB,EAAE,SAAS,CAAC,8BAA8B;yBAC7D,CAAC;oBACJ,CAAC;oBACD,MAAM;YACV,CAAC;YACD,MAAM;IACV,CAAC;IACD,MAAM,IAAI,KAAK,CACb,KAAK,SAAS,eAAe,YAAY,oDAAoD,SAAS,CAAC,WAAW,CAAC,IAAI,EAAE,CAC1H,CAAC;AACJ,CAAC;AAED,SAAS,gBAAgB,CAAC,UAAmB;IAC3C,OAAO,IAAI,oBAAO,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;AACxC,CAAC;AAED,IAAK,YAGJ;AAHD,WAAK,YAAY;IACf,6BAAa,CAAA;IACb,+BAAe,CAAA;AACjB,CAAC,EAHI,YAAY,KAAZ,YAAY,QAGhB;AAED,SAAS,mBAAmB,CAAC,OAA+B;IAC1D,MAAM,wBAAwB,GAAG,IAAA,8BAAgB,EAAC,OAAO,CAAC,gBAAgB,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,SAAS,CAAC,CAAC;IACvG,MAAM,kBAAkB,GAAG,IAAA,8BAAgB,EAAC,OAAO,CAAC,gBAAgB,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,QAAQ,CAAC,CAAC;IAC/F,MAAM,0BAA0B,GAAG,uBAAuB,CAAC,OAAO,CAAC,YAAY,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;IACtG,IAAI,0BAA0B,CAAC,QAAQ,CAAC,wBAAwB,CAAC,EAAE,CAAC;QAClE,IAAA,uBAAS,EACP,CAAC,0BAA0B,CAAC,QAAQ,CAAC,kBAAkB,CAAC,EACxD,uEAAuE,CACxE,CAAC;QACF,OAAO,YAAY,CAAC,KAAK,CAAC;IAC5B,CAAC;SAAM,CAAC;QACN,IAAA,uBAAS,EACP,0BAA0B,CAAC,QAAQ,CAAC,kBAAkB,CAAC,EACvD,sEAAsE,CACvE,CAAC;QACF,OAAO,YAAY,CAAC,IAAI,CAAC;IAC3B,CAAC;AACH,CAAC;AAED,SAAS,uBAAuB,CAC9B,YAA0B,EAC1B,qBAA4C;IAE5C,OAAO,IAAI,oBAAY,CACrB,qBAAqB,CAAC,GAAG,CAAC,CAAC,mBAAmB,EAAE,EAAE,CAChD,OAAO,mBAAmB,KAAK,QAAQ;QACrC,CAAC,CAAC,YAAY,CAAC,0BAA0B,CAAC,mBAAmB,CAAC,CAAC,OAAO;QACtE,CAAC,CAAC,YAAY,CAAC,wBAAwB,CAAC,mBAAmB,CAAC,CAAC,OAAO,CACvE,CACF,CAAC;AACJ,CAAC"}

package/dist/utils/validations.d.ts

@@ -0,0 +1,5 @@
+export declare function checkThat(evaluationResult: boolean, message?: string): void;
+export declare function checkDefined<T>(value: T | undefined, message?: string): T;
+export declare function checkNotNull<T>(value: T | null, message?: string): T;
+export declare function getSingleElement<T>(iterable: Iterable<T>, nameWithinMessage?: string): T;
+//# sourceMappingURL=validations.d.ts.map

package/dist/utils/validations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validations.d.ts","sourceRoot":"","sources":["../../src/utils/validations.ts"],"names":[],"mappings":"AAAA,wBAAgB,SAAS,CAAC,gBAAgB,EAAE,OAAO,EAAE,OAAO,GAAE,MAA8B,GAAG,IAAI,CAIlG;AAED,wBAAgB,YAAY,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,SAAS,EAAE,OAAO,GAAE,MAA0B,GAAG,CAAC,CAG5F;AAED,wBAAgB,YAAY,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,GAAE,MAAqB,GAAG,CAAC,CAGlF;AAED,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,iBAAiB,GAAE,MAAkB,GAAG,CAAC,CAcnG"}

package/dist/utils/validations.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkThat = checkThat;
+exports.checkDefined = checkDefined;
+exports.checkNotNull = checkNotNull;
+exports.getSingleElement = getSingleElement;
+function checkThat(evaluationResult, message = 'precondition failed') {
+    if (!evaluationResult) {
+        throw new Error(message);
+    }
+}
+function checkDefined(value, message = 'value undefined') {
+    checkThat(value !== undefined, message);
+    return value;
+}
+function checkNotNull(value, message = 'value null') {
+    checkThat(value !== null, message);
+    return value;
+}
+function getSingleElement(iterable, nameWithinMessage = 'element') {
+    const nothingReturnedMarker = {};
+    let single = nothingReturnedMarker;
+    for (const element of iterable) {
+        if (single === nothingReturnedMarker) {
+            single = element;
+        }
+        else {
+            throw new Error(`exactly one ${nameWithinMessage} expected, but multiple found`);
+        }
+    }
+    if (single === nothingReturnedMarker) {
+        throw new Error(`exactly one ${nameWithinMessage} expected, but none found`);
+    }
+    return single;
+}
+//# sourceMappingURL=validations.js.map

package/dist/utils/validations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validations.js","sourceRoot":"","sources":["../../src/utils/validations.ts"],"names":[],"mappings":";;AAAA,8BAIC;AAED,oCAGC;AAED,oCAGC;AAED,4CAcC;AA9BD,SAAgB,SAAS,CAAC,gBAAyB,EAAE,UAAkB,qBAAqB;IAC1F,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACtB,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC;IAC3B,CAAC;AACH,CAAC;AAED,SAAgB,YAAY,CAAI,KAAoB,EAAE,UAAkB,iBAAiB;IACvF,SAAS,CAAC,KAAK,KAAK,SAAS,EAAE,OAAO,CAAC,CAAC;IACxC,OAAO,KAAU,CAAC;AACpB,CAAC;AAED,SAAgB,YAAY,CAAI,KAAe,EAAE,UAAkB,YAAY;IAC7E,SAAS,CAAC,KAAK,KAAK,IAAI,EAAE,OAAO,CAAC,CAAC;IACnC,OAAO,KAAU,CAAC;AACpB,CAAC;AAED,SAAgB,gBAAgB,CAAI,QAAqB,EAAE,oBAA4B,SAAS;IAC9F,MAAM,qBAAqB,GAAG,EAAE,CAAC;IACjC,IAAI,MAAM,GAAW,qBAAqB,CAAC;IAC3C,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;QAC/B,IAAI,MAAM,KAAK,qBAAqB,EAAE,CAAC;YACrC,MAAM,GAAG,OAAO,CAAC;QACnB,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,eAAe,iBAAiB,+BAA+B,CAAC,CAAC;QACnF,CAAC;IACH,CAAC;IACD,IAAI,MAAM,KAAK,qBAAqB,EAAE,CAAC;QACrC,MAAM,IAAI,KAAK,CAAC,eAAe,iBAAiB,2BAA2B,CAAC,CAAC;IAC/E,CAAC;IACD,OAAO,MAAW,CAAC;AACrB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kamino-finance/klend-sdk",
-  "version": "5.12.8",
+  "version": "5.13.1",
   "description": "Typescript SDK for interacting with the Kamino Lending (klend) protocol",
   "repository": {
     "type": "git",

package/src/classes/action.ts

@@ -78,7 +78,7 @@ import { Reserve } from '../idl_codegen/accounts';
 import { VanillaObligation } from '../utils/ObligationType';
 import { PROGRAM_ID } from '../lib';
 import { Scope } from '@kamino-finance/scope-sdk';
-import { KaminoObligationOrder } from './obligationOrder';
+import { ObligationOrderAtIndex } from './obligationOrder';
 
 export type ActionType =
   | 'deposit'
@@ -390,8 +390,10 @@ export class KaminoAction {
     extraComputeBudget: number = 1_000_000, // if > 0 then adds the ixn
     includeAtaIxns: boolean = true, // if true it includes create and close wsol and token atas,
     requestElevationGroup: boolean = false, // to be requested *before* the deposit
-    includeUserMetadata: boolean = true, // if true it includes user metadata
-    createLookupTable: boolean = true,
+    initUserMetadata: { skipInitialization: boolean; skipLutCreation: boolean } = {
+      skipInitialization: false,
+      skipLutCreation: false,
+    },
     referrer: PublicKey = PublicKey.default,
     currentSlot: number = 0,
     overrideElevationGroupRequest: number | undefined = undefined // if set, when an elevationgroup request is made, it will use this value
@@ -416,11 +418,10 @@ export class KaminoAction {
       'deposit',
       includeAtaIxns,
       requestElevationGroup,
-      includeUserMetadata,
       addInitObligationForFarm,
       useV2Ixs,
       scopeRefreshConfig,
-      createLookupTable,
+      initUserMetadata,
       undefined,
       overrideElevationGroupRequest
     );
@@ -457,8 +458,10 @@ export class KaminoAction {
     extraComputeBudget: number = 1_000_000, // if > 0 then adds the ixn
     includeAtaIxns: boolean = true, // if true it includes create and close wsol and token atas,
     requestElevationGroup: boolean = false,
-    includeUserMetadata: boolean = true, // if true it includes user metadata
-    createLookupTable: boolean = true,
+    initUserMetadata: { skipInitialization: boolean; skipLutCreation: boolean } = {
+      skipInitialization: false,
+      skipLutCreation: false,
+    },
     referrer: PublicKey = PublicKey.default,
     currentSlot: number = 0,
     overrideElevationGroupRequest: number | undefined = undefined // if set, when an elevationgroup request is made, it will use this value
@@ -494,11 +497,10 @@ export class KaminoAction {
       'borrow',
       includeAtaIxns,
       requestElevationGroup,
-      includeUserMetadata,
       addInitObligationForFarm,
       useV2Ixs,
       scopeRefreshConfig,
-      createLookupTable,
+      initUserMetadata,
       undefined,
       overrideElevationGroupRequest
     );
@@ -547,9 +549,8 @@ export class KaminoAction {
       requestElevationGroup,
       false,
       addInitObligationForFarm,
-      false,
       scopeRefreshConfig,
-      false
+      { skipInitialization: true, skipLutCreation: true }
     );
     axn.addDepositReserveLiquidityIx();
     axn.addRefreshFarmsCleanupTxnIxsToCleanupIxs();
@@ -591,9 +592,8 @@ export class KaminoAction {
       requestElevationGroup,
       false,
       addInitObligationForFarm,
-      false,
       scopeRefreshConfig,
-      false
+      { skipInitialization: true, skipLutCreation: true }
     );
     axn.addRedeemReserveCollateralIx();
     axn.addRefreshFarmsCleanupTxnIxsToCleanupIxs();
@@ -611,8 +611,10 @@ export class KaminoAction {
     extraComputeBudget: number = 1_000_000, // if > 0 then adds the ixn
     includeAtaIxns: boolean = true, // if true it includes create and close wsol and token atas
     requestElevationGroup: boolean = false,
-    includeUserMetadata: boolean = true, // if true it includes user metadata
-    createLookupTable: boolean = true,
+    initUserMetadata: { skipInitialization: boolean; skipLutCreation: boolean } = {
+      skipInitialization: false,
+      skipLutCreation: false,
+    },
     referrer: PublicKey = PublicKey.default,
     currentSlot: number = 0
   ) {
@@ -636,11 +638,10 @@ export class KaminoAction {
       'depositCollateral',
       includeAtaIxns,
       requestElevationGroup,
-      includeUserMetadata,
       addInitObligationForFarm,
       useV2Ixs,
       scopeRefreshConfig,
-      createLookupTable
+      initUserMetadata
     );
     if (useV2Ixs) {
       axn.addDepositObligationCollateralIxV2();
@@ -664,8 +665,10 @@ export class KaminoAction {
     extraComputeBudget: number = 1_000_000, // if > 0 then adds the ixn
     includeAtaIxns: boolean = true, // if true it includes create and close wsol and token atas,
     requestElevationGroup: boolean = false,
-    includeUserMetadata: boolean = true, // if true it includes user metadata,
-    createLookupTable: boolean = true,
+    initUserMetadata: { skipInitialization: boolean; skipLutCreation: boolean } = {
+      skipInitialization: false,
+      skipLutCreation: false,
+    },
     referrer: PublicKey = PublicKey.default,
     currentSlot: number = 0
   ) {
@@ -705,11 +708,10 @@ export class KaminoAction {
       'deposit',
       includeAtaIxns,
       requestElevationGroup,
-      includeUserMetadata,
       addInitObligationForFarmForDeposit,
       useV2Ixs,
       undefined,
-      createLookupTable,
+      initUserMetadata,
       twoTokenAction
     );
 
@@ -756,8 +758,10 @@ export class KaminoAction {
     extraComputeBudget: number = 1_000_000, // if > 0 then adds the ixn
     includeAtaIxns: boolean = true, // if true it includes create and close wsol and token atas,
     requestElevationGroup: boolean = false,
-    includeUserMetadata: boolean = true, // if true it includes user metadata,
-    createLookupTable: boolean = true,
+    initUserMetadata: { skipInitialization: boolean; skipLutCreation: boolean } = {
+      skipInitialization: false,
+      skipLutCreation: false,
+    },
     referrer: PublicKey = PublicKey.default
   ) {
     const axn = await KaminoAction.initializeMultiTokenAction(
@@ -783,11 +787,10 @@ export class KaminoAction {
       'depositAndWithdraw',
       includeAtaIxns,
       requestElevationGroup,
-      includeUserMetadata,
       addInitObligationForFarm,
       true,
       scopeRefreshConfig,
-      createLookupTable,
+      initUserMetadata,
       twoTokenAction
     );
     const withdrawCollateralAmount = axn.getWithdrawCollateralAmount(axn.outflowReserve!, axn.outflowAmount!);
@@ -809,8 +812,10 @@ export class KaminoAction {
     extraComputeBudget: number = 1_000_000, // if > 0 then adds the ixn
     includeAtaIxns: boolean = true, // if true it includes create and close wsol and token atas,
     requestElevationGroup: boolean = false,
-    includeUserMetadata: boolean = true, // if true it includes user metadata,
-    createLookupTable: boolean = true,
+    initUserMetadata: { skipInitialization: boolean; skipLutCreation: boolean } = {
+      skipInitialization: false,
+      skipLutCreation: false,
+    },
     referrer: PublicKey = PublicKey.default
   ) {
     const axn = await KaminoAction.initializeMultiTokenAction(
@@ -836,11 +841,10 @@ export class KaminoAction {
       'repayAndWithdrawV2',
       includeAtaIxns,
       requestElevationGroup,
-      includeUserMetadata,
       addInitObligationForFarm,
       true,
       scopeRefreshConfig,
-      createLookupTable,
+      initUserMetadata,
       twoTokenAction
     );
     const withdrawCollateralAmount = axn.getWithdrawCollateralAmount(axn.outflowReserve!, axn.outflowAmount!);
@@ -863,8 +867,10 @@ export class KaminoAction {
     extraComputeBudget: number = 1_000_000, // if > 0 then adds the ixn
     includeAtaIxns: boolean = true, // if true it includes create and close wsol and token atas,
     requestElevationGroup: boolean = false,
-    includeUserMetadata: boolean = true, // if true it includes user metadata,
-    createLookupTable: boolean = true,
+    initUserMetadata: { skipInitialization: boolean; skipLutCreation: boolean } = {
+      skipInitialization: false,
+      skipLutCreation: false,
+    },
     referrer: PublicKey = PublicKey.default
   ) {
     const axn = await KaminoAction.initializeMultiTokenAction(
@@ -891,11 +897,10 @@ export class KaminoAction {
       'repay',
       includeAtaIxns,
       requestElevationGroup,
-      includeUserMetadata,
       addInitObligationForFarmForRepay,
       useV2Ixs,
       undefined,
-      createLookupTable,
+      initUserMetadata,
       twoTokenAction
     );
 
@@ -941,8 +946,10 @@ export class KaminoAction {
     extraComputeBudget: number = 1_000_000, // if > 0 then adds the ixn
     includeAtaIxns: boolean = true, // if true it includes create and close wsol and token atas,
     requestElevationGroup: boolean = false, // to be requested *after* the withdraw
-    includeUserMetadata: boolean = true, // if true it includes user metadata
-    createLookupTable: boolean = true,
+    initUserMetadata: { skipInitialization: boolean; skipLutCreation: boolean } = {
+      skipInitialization: false,
+      skipLutCreation: false,
+    },
     referrer: PublicKey = PublicKey.default,
     currentSlot: number = 0,
     overrideElevationGroupRequest?: number,
@@ -974,11 +981,10 @@ export class KaminoAction {
       'withdraw',
       includeAtaIxns,
       requestElevationGroup,
-      includeUserMetadata,
       addInitObligationForFarm,
       useV2Ixs,
       scopeRefreshConfig,
-      createLookupTable,
+      initUserMetadata,
       false,
       overrideElevationGroupRequest
     );
@@ -1023,8 +1029,10 @@ export class KaminoAction {
     extraComputeBudget: number = 1_000_000,
     includeAtaIxns: boolean = true,
     requestElevationGroup: boolean = false,
-    includeUserMetadata: boolean = true,
-    createLookupTable: boolean = true,
+    initUserMetadata: { skipInitialization: boolean; skipLutCreation: boolean } = {
+      skipInitialization: false,
+      skipLutCreation: false,
+    },
     referrer: PublicKey = PublicKey.default
   ) {
     const axn = await KaminoAction.initialize(
@@ -1048,11 +1056,10 @@ export class KaminoAction {
       'repay',
       includeAtaIxns,
       requestElevationGroup,
-      includeUserMetadata,
       addInitObligationForFarm,
       useV2Ixs,
       scopeRefreshConfig,
-      createLookupTable
+      initUserMetadata
     );
     if (useV2Ixs) {
       await axn.addRepayIxV2();
@@ -1078,8 +1085,10 @@ export class KaminoAction {
     extraComputeBudget: number = 1_000_000, // if > 0 then adds the ixn
     includeAtaIxns: boolean = true, // if true it includes create and close wsol and token atas, and creates all other token atas if they don't exist
     requestElevationGroup: boolean = false,
-    includeUserMetadata: boolean = true, // if true it includes user metadata
-    createLookupTable: boolean = true,
+    initUserMetadata: { skipInitialization: boolean; skipLutCreation: boolean } = {
+      skipInitialization: false,
+      skipLutCreation: false,
+    },
     referrer: PublicKey = PublicKey.default,
     maxAllowedLtvOverridePercent: number = 0,
     currentSlot: number = 0
@@ -1107,11 +1116,10 @@ export class KaminoAction {
       'liquidate',
       includeAtaIxns,
       requestElevationGroup,
-      includeUserMetadata,
       addInitObligationForFarm,
       useV2Ixs,
       scopeRefreshConfig,
-      createLookupTable
+      initUserMetadata
     );
     if (useV2Ixs) {
       await axn.addLiquidateIxV2(maxAllowedLtvOverridePercent);
@@ -1165,11 +1173,13 @@ export class KaminoAction {
   static buildSetObligationOrderIxn(
     kaminoMarket: KaminoMarket,
     obligation: KaminoObligation,
-    index: number,
-    order: KaminoObligationOrder | null
+    orderAtIndex: ObligationOrderAtIndex
   ): TransactionInstruction {
     return setObligationOrder(
-      { index, order: order !== null ? order.toState() : KaminoObligationOrder.NULL_STATE },
+      {
+        index: orderAtIndex.index,
+        order: orderAtIndex.orderState(),
+      },
       {
         lendingMarket: kaminoMarket.getAddress(),
         obligation: obligation.obligationAddress,
@@ -2674,19 +2684,18 @@ export class KaminoAction {
     action: ActionType,
     includeAtaIxns: boolean,
     requestElevationGroup: boolean,
-    includeUserMetadata: boolean,
     addInitObligationForFarm: boolean,
     useV2Ixs: boolean,
     scopeRefreshConfig: ScopePriceRefreshConfig | undefined,
-    createLookupTable: boolean,
+    initUserMetadata: { skipInitialization: boolean; skipLutCreation: boolean },
     twoTokenAction: boolean = false,
     overrideElevationGroupRequest?: number
   ) {
     if (!['mint', 'redeem'].includes(action)) {
       const [, ownerUserMetadata] = await this.kaminoMarket.getUserMetadata(this.owner);
-      if (!ownerUserMetadata && includeUserMetadata) {
+      if (!ownerUserMetadata && !initUserMetadata.skipInitialization) {
         let lookupTable: PublicKey = PublicKey.default;
-        if (createLookupTable) {
+        if (!initUserMetadata.skipLutCreation) {
           const [createLutIx, lookupTableAddress] = await createLookupTableIx(
             this.kaminoMarket.getConnection(),
             this.owner