@kamino-finance/klend-sdk
Version:
Typescript SDK for interacting with the Kamino Lending (klend) protocol
205 lines • 8.87 kB
JavaScript
;
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || (function () {
var ownKeys = function(o) {
ownKeys = Object.getOwnPropertyNames || function (o) {
var ar = [];
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
return ar;
};
return ownKeys(o);
};
return function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
__setModuleDefault(result, mod);
return result;
};
})();
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.ObligationOrder = void 0;
const bn_js_1 = __importDefault(require("bn.js")); // eslint-disable-line @typescript-eslint/no-unused-vars
const borsh = __importStar(require("@coral-xyz/borsh"));
/**
* A single obligation order.
* See [Obligation::orders].
*/
class ObligationOrder {
/**
* A threshold value used by the condition (scaled [Fraction]).
* The exact meaning depends on the specific [Self::condition_type].
*
* Examples:
* - when `condition_type == 2 (UserLtvBelow)`:
* then a value of `0.455` here means that the order is active only when the obligation's
* user LTV is less than `0.455` (i.e. < 45.5%).
* - when `condition_type == 3 (DebtCollPriceRatioAbove)`:
* assuming the obligation uses BTC collateral for SOL debt, then a value of `491.3` here
* means that the order is active only when the BTC-SOL price is greater than `491.3` (i.e.
* > 491.3 SOL per BTC).
*/
conditionThresholdSf;
/**
* A configuration parameter used by the opportunity (scaled [Fraction]).
* The exact meaning depends on the specific [Self::opportunity_type].
*
* Examples:
* - when `opportunity_type == 0 (DeleverageSingleDebtAmount)`:
* Assuming the obligation uses BTC collateral for SOL debt, then a value of `1_234_000_000`
* here means that a liquidator may repay up to 1234000000 lamports (i.e. 1.234 SOL) on this
* obligation.
* Note: the special value of [Fraction::MAX] is *not* allowed in this case.
* - when `opportunity_type == 1 (DeleverageAllDebtAmount)`:
* The only allowed value in this case is [Fraction::MAX] (to emphasize that *all* debt
* should be repaid).
*/
opportunityParameterSf;
/**
* A *minimum* additional fraction of collateral transferred to the liquidator, in bps.
*
* The minimum bonus is applied exactly when the [Self::condition_threshold_sf] is met, and
* grows linearly towards the [Self::max_execution_bonus_bps].
*
* Example: a value of `50` here means 50bps == 0.5% bonus for an "LTV > 65%" order, when
* executed precisely at the moment LTV exceeds 65%.
*/
minExecutionBonusBps;
/**
* A *maximum* additional fraction of collateral transferred to the liquidator, in bps.
*
* The maximum bonus is applied at the relevant "extreme" state of the obligation, i.e.:
* - for a stop-loss condition, it is a point at which the obligation becomes liquidatable;
* - for a take-profit condition, it is a point at which obligation has 0% LTV.
*
* In non-extreme states, the actual bonus value is interpolated linearly, starting from
* [Self::min_execution_bonus_bps] (at the point specified by the order's condition).
*
* Example: a value of `300` here means 300bps == 3.0% bonus for a "debt/coll price > 140"
* order, when executed at a higher price = 200, at which the obligation's LTV happens to
* be equal to its liquidation LTV.
*/
maxExecutionBonusBps;
/**
* Serialized [ConditionType].
* The entire order is void when this is zeroed (i.e. representing [ConditionType::Never]).
*
* Example: a value of `2` here denotes `UserLtvBelow` condition type. Of course, to
* interpret this condition, we also need to take the [Self::condition_threshold_sf] into
* account.
*/
conditionType;
/**
* Serialized [OpportunityType].
*
* Example: a value of `0` here denotes `DeleverageSingleDebtAmount` opportunity. Of course, to
* interpret this opportunity, we also need to take the [Self::opportunity_parameter_sf] into
* account.
*/
opportunityType;
/**
* Internal padding.
* The fields above take up 2+2+1+1 bytes = 48 bits, which means we need 80 bits = 10 bytes to
* align with `u128`s.
*/
padding1;
/**
* End padding.
* The total size of a single instance is 8*u128 = 128 bytes.
*/
padding2;
constructor(fields) {
this.conditionThresholdSf = fields.conditionThresholdSf;
this.opportunityParameterSf = fields.opportunityParameterSf;
this.minExecutionBonusBps = fields.minExecutionBonusBps;
this.maxExecutionBonusBps = fields.maxExecutionBonusBps;
this.conditionType = fields.conditionType;
this.opportunityType = fields.opportunityType;
this.padding1 = fields.padding1;
this.padding2 = fields.padding2;
}
static layout(property) {
return borsh.struct([
borsh.u128("conditionThresholdSf"),
borsh.u128("opportunityParameterSf"),
borsh.u16("minExecutionBonusBps"),
borsh.u16("maxExecutionBonusBps"),
borsh.u8("conditionType"),
borsh.u8("opportunityType"),
borsh.array(borsh.u8(), 10, "padding1"),
borsh.array(borsh.u128(), 5, "padding2"),
], property);
}
// eslint-disable-next-line @typescript-eslint/no-explicit-any
static fromDecoded(obj) {
return new ObligationOrder({
conditionThresholdSf: obj.conditionThresholdSf,
opportunityParameterSf: obj.opportunityParameterSf,
minExecutionBonusBps: obj.minExecutionBonusBps,
maxExecutionBonusBps: obj.maxExecutionBonusBps,
conditionType: obj.conditionType,
opportunityType: obj.opportunityType,
padding1: obj.padding1,
padding2: obj.padding2,
});
}
static toEncodable(fields) {
return {
conditionThresholdSf: fields.conditionThresholdSf,
opportunityParameterSf: fields.opportunityParameterSf,
minExecutionBonusBps: fields.minExecutionBonusBps,
maxExecutionBonusBps: fields.maxExecutionBonusBps,
conditionType: fields.conditionType,
opportunityType: fields.opportunityType,
padding1: fields.padding1,
padding2: fields.padding2,
};
}
toJSON() {
return {
conditionThresholdSf: this.conditionThresholdSf.toString(),
opportunityParameterSf: this.opportunityParameterSf.toString(),
minExecutionBonusBps: this.minExecutionBonusBps,
maxExecutionBonusBps: this.maxExecutionBonusBps,
conditionType: this.conditionType,
opportunityType: this.opportunityType,
padding1: this.padding1,
padding2: this.padding2.map((item) => item.toString()),
};
}
static fromJSON(obj) {
return new ObligationOrder({
conditionThresholdSf: new bn_js_1.default(obj.conditionThresholdSf),
opportunityParameterSf: new bn_js_1.default(obj.opportunityParameterSf),
minExecutionBonusBps: obj.minExecutionBonusBps,
maxExecutionBonusBps: obj.maxExecutionBonusBps,
conditionType: obj.conditionType,
opportunityType: obj.opportunityType,
padding1: obj.padding1,
padding2: obj.padding2.map((item) => new bn_js_1.default(item)),
});
}
toEncodable() {
return ObligationOrder.toEncodable(this);
}
}
exports.ObligationOrder = ObligationOrder;
//# sourceMappingURL=ObligationOrder.js.map