@0dotxyz/p0-ts-sdk 1.0.0 → 1.0.1

package/README.md

@@ -1,12 +1,15 @@
 # Project 0 TypeScript SDK
 
-[![npm version](https://img.shields.io/npm/v/@0dotxyz/p0-ts-sdk.svg)](https://www.npmjs.com/package/@0dotxyz/p0-ts-sdk)
-[![npm downloads](https://img.shields.io/npm/dm/@0dotxyz/p0-ts-sdk.svg)](https://www.npmjs.com/package/@0dotxyz/p0-ts-sdk)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-[![TypeScript](https://img.shields.io/badge/TypeScript-5.5-blue.svg)](https://www.typescriptlang.org/)
+[![npm version](https://img.shields.io/npm/v/@0dotxyz/p0-ts-sdk.svg?style=flat-square)](https://www.npmjs.com/package/@0dotxyz/p0-ts-sdk)
+[![npm downloads](https://img.shields.io/npm/dm/@0dotxyz/p0-ts-sdk.svg?style=flat-square)](https://www.npmjs.com/package/@0dotxyz/p0-ts-sdk)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square)](https://opensource.org/licenses/MIT)
+[![TypeScript](https://img.shields.io/badge/TypeScript-5.5-blue.svg?style=flat-square)](https://www.typescriptlang.org/)
+[![GitHub](https://img.shields.io/badge/GitHub-0dotxyz%2Fp0--ts--sdk-181717.svg?style=flat-square&logo=github)](https://github.com/0dotxyz/p0-ts-sdk)
 
 A modern, type-safe TypeScript SDK for interacting with the P0 Protocol on Solana. Lend, borrow, and manage leveraged DeFi positions with a clean, developer-friendly API.
 
+📖 **[Read the Full Documentation](https://docs.0.xyz/docs/typescript-sdk/getting-started)**
+
 ## Features
 
 - 🔒 **Type-safe**: Full TypeScript support with comprehensive type definitions

package/dist/{dto-farm.types-D9Q3c7Q7.d.cts → dto-farm.types-DvTDZThL.d.cts}

@@ -1,6 +1,6 @@
-import { BN, BorshCoder, Provider, Program } from '@coral-xyz/anchor';
+import { BorshCoder, Provider, Program } from '@coral-xyz/anchor';
+import BN from 'bn.js';
 import { PublicKey } from '@solana/web3.js';
-import BN$1 from 'bn.js';
 
 declare const SWITCHBOARD_ONDEMANDE_PRICE_PRECISION = 18;
 interface CurrentResult {
@@ -47,7 +47,7 @@ declare function decodeSwitchboardPullFeedData(data: Buffer): PullFeedAccountDat
 
 interface LastUpdateFields {
     /** Last slot when updated */
-    slot: BN$1;
+    slot: BN;
     /** True when marked stale, false when slot updated */
     stale: number;
     /** Status of the prices used to calculate the last update */
@@ -55,8 +55,8 @@ interface LastUpdateFields {
     placeholder: Array<number>;
 }
 interface BigFractionBytesFields {
-    value: Array<BN$1>;
-    padding: Array<BN$1>;
+    value: Array<BN>;
+    padding: Array<BN>;
 }
 
 interface LastUpdateJSON {
@@ -75,7 +75,7 @@ interface BigFractionBytesJSON {
 
 interface ReserveRaw {
     /** Version of the reserve */
-    version: BN$1;
+    version: BN;
     /** Last slot when supply and rates updated */
     lastUpdate: LastUpdateFields;
     /** Lending market address */
@@ -84,20 +84,20 @@ interface ReserveRaw {
     farmDebt: PublicKey;
     /** Reserve liquidity */
     liquidity: ReserveLiquidityFields;
-    reserveLiquidityPadding: Array<BN$1>;
+    reserveLiquidityPadding: Array<BN>;
     /** Reserve collateral */
     collateral: ReserveCollateralFields;
-    reserveCollateralPadding: Array<BN$1>;
+    reserveCollateralPadding: Array<BN>;
     /** Reserve configuration values */
     config: ReserveConfigFields;
-    configPadding: Array<BN$1>;
-    borrowedAmountOutsideElevationGroup: BN$1;
+    configPadding: Array<BN>;
+    borrowedAmountOutsideElevationGroup: BN;
     /**
      * Amount of token borrowed in lamport of debt asset in the given
      * elevation group when this reserve is part of the collaterals.
      */
-    borrowedAmountsAgainstThisReserveInElevationGroups: Array<BN$1>;
-    padding: Array<BN$1>;
+    borrowedAmountsAgainstThisReserveInElevationGroups: Array<BN>;
+    padding: Array<BN>;
 }
 interface ReserveLiquidityFields {
     /** Reserve liquidity mint address */
@@ -107,49 +107,49 @@ interface ReserveLiquidityFields {
     /** Reserve liquidity fee collection address */
     feeVault: PublicKey;
     /** Reserve liquidity available */
-    availableAmount: BN$1;
+    availableAmount: BN;
     /** Reserve liquidity borrowed (scaled fraction) */
-    borrowedAmountSf: BN$1;
+    borrowedAmountSf: BN;
     /** Reserve liquidity market price in quote currency (scaled fraction) */
-    marketPriceSf: BN$1;
+    marketPriceSf: BN;
     /** Unix timestamp of the market price (from the oracle) */
-    marketPriceLastUpdatedTs: BN$1;
+    marketPriceLastUpdatedTs: BN;
     /** Reserve liquidity mint decimals */
-    mintDecimals: BN$1;
+    mintDecimals: BN;
     /**
      * Timestamp when the last refresh reserve detected that the liquidity amount is above the deposit cap. When this threshold is crossed, then redemptions (auto-deleverage) are enabled.
      * If the threshold is not crossed, then the timestamp is set to 0
      */
-    depositLimitCrossedTimestamp: BN$1;
+    depositLimitCrossedTimestamp: BN;
     /**
      * Timestamp when the last refresh reserve detected that the borrowed amount is above the borrow cap. When this threshold is crossed, then redemptions (auto-deleverage) are enabled.
      * If the threshold is not crossed, then the timestamp is set to 0
      */
-    borrowLimitCrossedTimestamp: BN$1;
+    borrowLimitCrossedTimestamp: BN;
     /** Reserve liquidity cumulative borrow rate (scaled fraction) */
     cumulativeBorrowRateBsf: BigFractionBytesFields;
     /** Reserve cumulative protocol fees (scaled fraction) */
-    accumulatedProtocolFeesSf: BN$1;
+    accumulatedProtocolFeesSf: BN;
     /** Reserve cumulative referrer fees (scaled fraction) */
-    accumulatedReferrerFeesSf: BN$1;
+    accumulatedReferrerFeesSf: BN;
     /** Reserve pending referrer fees, to be claimed in refresh_obligation by referrer or protocol (scaled fraction) */
-    pendingReferrerFeesSf: BN$1;
+    pendingReferrerFeesSf: BN;
     /** Reserve referrer fee absolute rate calculated at each refresh_reserve operation (scaled fraction) */
-    absoluteReferralRateSf: BN$1;
+    absoluteReferralRateSf: BN;
     /** Token program of the liquidity mint */
     tokenProgram: PublicKey;
-    padding2: Array<BN$1>;
-    padding3: Array<BN$1>;
+    padding2: Array<BN>;
+    padding3: Array<BN>;
 }
 interface ReserveCollateralFields {
     /** Reserve collateral mint address */
     mintPubkey: PublicKey;
     /** Reserve collateral mint supply, used for exchange rate */
-    mintTotalSupply: BN$1;
+    mintTotalSupply: BN;
     /** Reserve collateral supply address */
     supplyVault: PublicKey;
-    padding1: Array<BN$1>;
-    padding2: Array<BN$1>;
+    padding1: Array<BN>;
+    padding2: Array<BN>;
 }
 interface ReserveConfigFields {
     /** Status of the reserve Active/Obsolete/Hidden */
@@ -189,22 +189,22 @@ interface ReserveConfigFields {
      * crossed.
      * Only relevant when `autodeleverage_enabled == 1`, and must not be 0 in such case.
      */
-    deleveragingMarginCallPeriodSecs: BN$1;
+    deleveragingMarginCallPeriodSecs: BN;
     /**
      * The rate at which the deleveraging threshold decreases, in bps per day.
      * Only relevant when `autodeleverage_enabled == 1`, and must not be 0 in such case.
      */
-    deleveragingThresholdDecreaseBpsPerDay: BN$1;
+    deleveragingThresholdDecreaseBpsPerDay: BN;
     /** Program owner fees assessed, separate from gains due to interest accrual */
     fees: ReserveFeesFields;
     /** Borrow rate curve based on utilization */
     borrowRateCurve: BorrowRateCurveFields;
     /** Borrow factor in percentage - used for risk adjustment */
-    borrowFactorPct: BN$1;
+    borrowFactorPct: BN;
     /** Maximum deposit limit of liquidity in native units, u64::MAX for inf */
-    depositLimit: BN$1;
+    depositLimit: BN;
     /** Maximum amount borrowed, u64::MAX for inf, 0 to disable borrows (protected deposits) */
-    borrowLimit: BN$1;
+    borrowLimit: BN;
     /** Token id from TokenInfos struct */
     tokenInfo: TokenInfoFields$1;
     /** Deposit withdrawal caps - deposit & redeem */
@@ -229,19 +229,19 @@ interface ReserveConfigFields {
      * - u64::MAX for inf
      * - 0 to disable borrows outside elevation groups
      */
-    borrowLimitOutsideElevationGroup: BN$1;
+    borrowLimitOutsideElevationGroup: BN;
     /**
      * Defines the maximum amount (in lamports of elevation group debt asset)
      * that can be borrowed when this reserve is used as collateral.
      * - u64::MAX for inf
      * - 0 to disable borrows in this elevation group (expected value for the debt asset)
      */
-    borrowLimitAgainstThisCollateralInElevationGroup: Array<BN$1>;
+    borrowLimitAgainstThisCollateralInElevationGroup: Array<BN>;
     /**
      * The rate at which the deleveraging-related liquidation bonus increases, in bps per day.
      * Only relevant when `autodeleverage_enabled == 1`, and must not be 0 in such case.
      */
-    deleveragingBonusIncreaseBpsPerDay: BN$1;
+    deleveragingBonusIncreaseBpsPerDay: BN;
 }
 interface ReserveFeesFields {
     /**
@@ -252,12 +252,12 @@ interface ReserveFeesFields {
      * 0.01% (1 basis point) = 115292150460685
      * 0.00001% (Aave borrow fee) = 115292150461
      */
-    borrowFeeSf: BN$1;
+    borrowFeeSf: BN;
     /**
      * Fee for flash loan, expressed as scaled fraction.
      * 0.3% (Aave flash loan fee) = 0.003 * 2^60 = 3458764513820541
      */
-    flashLoanFeeSf: BN$1;
+    flashLoanFeeSf: BN;
     /** Used for allignment */
     padding: Array<number>;
 }
@@ -274,9 +274,9 @@ interface TokenInfoFields$1 {
     /** Heuristics limits of acceptable price */
     heuristic: PriceHeuristicFields;
     /** Max divergence between twap and price in bps */
-    maxTwapDivergenceBps: BN$1;
-    maxAgePriceSeconds: BN$1;
-    maxAgeTwapSeconds: BN$1;
+    maxTwapDivergenceBps: BN;
+    maxAgePriceSeconds: BN;
+    maxAgeTwapSeconds: BN;
     /** Scope price configuration */
     scopeConfiguration: ScopeConfigurationFields;
     /** Switchboard configuration */
@@ -285,15 +285,15 @@ interface TokenInfoFields$1 {
     pythConfiguration: PythConfigurationFields;
     blockPriceUsage: number;
     reserved: Array<number>;
-    padding: Array<BN$1>;
+    padding: Array<BN>;
 }
 interface PriceHeuristicFields {
     /** Lower value of acceptable price */
-    lower: BN$1;
+    lower: BN;
     /** Upper value of acceptable price */
-    upper: BN$1;
+    upper: BN;
     /** Number of decimals of the previously defined values */
-    exp: BN$1;
+    exp: BN;
 }
 interface ScopeConfigurationFields {
     /** Pubkey of the scope price feed (disabled if `null` or `default`) */
@@ -313,10 +313,10 @@ interface PythConfigurationFields {
     price: PublicKey;
 }
 interface WithdrawalCapsFields {
-    configCapacity: BN$1;
-    currentTotal: BN$1;
-    lastIntervalStartTimestamp: BN$1;
-    configIntervalLengthSeconds: BN$1;
+    configCapacity: BN;
+    currentTotal: BN;
+    lastIntervalStartTimestamp: BN;
+    configIntervalLengthSeconds: BN;
 }
 
 interface ReserveJSON {
@@ -746,7 +746,7 @@ interface ObligationOrderJSON {
 
 interface ObligationRaw {
     /** Version of the struct */
-    tag: BN$1;
+    tag: BN;
     /** Last update to collateral, liquidity, or their market values */
     lastUpdate: LastUpdateFields;
     /** Lending market address */
@@ -756,19 +756,19 @@ interface ObligationRaw {
     /** Deposited collateral for the obligation, unique by deposit reserve address */
     deposits: Array<ObligationCollateralFields>;
     /** Worst LTV for the collaterals backing the loan, represented as a percentage */
-    lowestReserveDepositLiquidationLtv: BN$1;
+    lowestReserveDepositLiquidationLtv: BN;
     /** Market value of deposits (scaled fraction) */
-    depositedValueSf: BN$1;
+    depositedValueSf: BN;
     /** Borrowed liquidity for the obligation, unique by borrow reserve address */
     borrows: Array<ObligationLiquidityFields>;
     /** Risk adjusted market value of borrows/debt (sum of price * borrowed_amount * borrow_factor) (scaled fraction) */
-    borrowFactorAdjustedDebtValueSf: BN$1;
+    borrowFactorAdjustedDebtValueSf: BN;
     /** Market value of borrows - used for max_liquidatable_borrowed_amount (scaled fraction) */
-    borrowedAssetsMarketValueSf: BN$1;
+    borrowedAssetsMarketValueSf: BN;
     /** The maximum borrow value at the weighted average loan to value ratio (scaled fraction) */
-    allowedBorrowValueSf: BN$1;
+    allowedBorrowValueSf: BN;
     /** The dangerous borrow value at the weighted average liquidation threshold (scaled fraction) */
-    unhealthyBorrowValueSf: BN$1;
+    unhealthyBorrowValueSf: BN;
     /** The asset tier of the deposits */
     depositsAssetTiers: Array<number>;
     /** The asset tier of the borrows */
@@ -793,50 +793,50 @@ interface ObligationRaw {
     /** The number of obsolete reserves the obligation has a borrow in */
     numOfObsoleteBorrowReserves: number;
     reserved: Array<number>;
-    highestBorrowFactorPct: BN$1;
+    highestBorrowFactorPct: BN;
     /**
      * A timestamp at which the risk council most-recently marked this obligation for deleveraging.
      * Zero if not currently subject to deleveraging.
      */
-    autodeleverageMarginCallStartedTimestamp: BN$1;
+    autodeleverageMarginCallStartedTimestamp: BN;
     /**
      * Owner-defined, liquidator-executed orders applicable to this obligation.
      * Typical use-cases would be a stop-loss and a take-profit (possibly co-existing).
      */
     orders: Array<ObligationOrderFields>;
-    padding3: Array<BN$1>;
+    padding3: Array<BN>;
 }
 interface ObligationCollateralFields {
     /** Reserve collateral is deposited to */
     depositReserve: PublicKey;
     /** Amount of collateral deposited */
-    depositedAmount: BN$1;
+    depositedAmount: BN;
     /** Collateral market value in quote currency (scaled fraction) */
-    marketValueSf: BN$1;
+    marketValueSf: BN;
     /**
      * Debt amount (lamport) taken against this collateral.
      * (only meaningful if this obligation is part of an elevation group, otherwise 0)
      * This is only indicative of the debt computed on the last refresh obligation.
      * If the obligation have multiple collateral this value is the same for all of them.
      */
-    borrowedAmountAgainstThisCollateralInElevationGroup: BN$1;
-    padding: Array<BN$1>;
+    borrowedAmountAgainstThisCollateralInElevationGroup: BN;
+    padding: Array<BN>;
 }
 interface ObligationLiquidityFields {
     /** Reserve liquidity is borrowed from */
     borrowReserve: PublicKey;
     /** Borrow rate used for calculating interest (big scaled fraction) */
     cumulativeBorrowRateBsf: BigFractionBytesFields;
-    padding: BN$1;
+    padding: BN;
     /** Amount of liquidity borrowed plus interest (scaled fraction) */
-    borrowedAmountSf: BN$1;
+    borrowedAmountSf: BN;
     /** Liquidity market value in quote currency (scaled fraction) */
-    marketValueSf: BN$1;
+    marketValueSf: BN;
     /** Risk adjusted liquidity market value in quote currency - DEBUG ONLY - use market_value instead */
-    borrowFactorAdjustedMarketValueSf: BN$1;
+    borrowFactorAdjustedMarketValueSf: BN;
     /** Amount of liquidity borrowed outside of an elevation group */
-    borrowedAmountOutsideElevationGroups: BN$1;
-    padding2: Array<BN$1>;
+    borrowedAmountOutsideElevationGroups: BN;
+    padding2: Array<BN>;
 }
 interface ObligationOrderFields {
     /**
@@ -852,7 +852,7 @@ interface ObligationOrderFields {
      * 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: BN$1;
+    conditionThresholdSf: BN;
     /**
      * A configuration parameter used by the opportunity (scaled [Fraction]).
      * The exact meaning depends on the specific [Self::opportunity_type].
@@ -867,7 +867,7 @@ interface ObligationOrderFields {
      * The only allowed value in this case is [Fraction::MAX] (to emphasize that *all* debt
      * should be repaid).
      */
-    opportunityParameterSf: BN$1;
+    opportunityParameterSf: BN;
     /**
      * A *minimum* additional fraction of collateral transferred to the liquidator, in bps.
      *
@@ -920,7 +920,7 @@ interface ObligationOrderFields {
      * End padding.
      * The total size of a single instance is 8*u128 = 128 bytes.
      */
-    padding2: Array<BN$1>;
+    padding2: Array<BN>;
 }
 
 interface FarmStateRaw {
@@ -928,17 +928,17 @@ interface FarmStateRaw {
     globalConfig: PublicKey;
     token: TokenInfoFields;
     rewardInfos: Array<RewardInfoFields>;
-    numRewardTokens: BN$1;
+    numRewardTokens: BN;
     /** Data used to calculate the rewards of the user */
-    numUsers: BN$1;
+    numUsers: BN;
     /**
      * The number of token in the `farm_vault` staked (getting rewards and fees)
      * Set such as `farm_vault.amount = total_staked_amount + total_pending_amount`
      */
-    totalStakedAmount: BN$1;
+    totalStakedAmount: BN;
     farmVault: PublicKey;
     farmVaultsAuthority: PublicKey;
-    farmVaultsAuthorityBump: BN$1;
+    farmVaultsAuthorityBump: BN;
     /**
      * Only used for delegate farms
      * Set to `default()` otherwise
@@ -973,59 +973,59 @@ interface FarmStateRaw {
     /** Delay between a user unstake and the ability to withdraw his deposit. */
     withdrawalCooldownPeriod: number;
     /** Total active stake of tokens in the farm (scaled from `Decimal` representation). */
-    totalActiveStakeScaled: BN$1;
+    totalActiveStakeScaled: BN;
     /**
      * Total pending stake of tokens in the farm (scaled from `Decimal` representation).
      * (can be used by `withdraw_authority` but don't get rewards or fees)
      */
-    totalPendingStakeScaled: BN$1;
+    totalPendingStakeScaled: BN;
     /** Total pending amount of tokens in the farm */
-    totalPendingAmount: BN$1;
+    totalPendingAmount: BN;
     /** Slashed amounts from early withdrawal */
-    slashedAmountCurrent: BN$1;
-    slashedAmountCumulative: BN$1;
+    slashedAmountCurrent: BN;
+    slashedAmountCumulative: BN;
     slashedAmountSpillAddress: PublicKey;
     /** Locking stake */
-    lockingMode: BN$1;
-    lockingStartTimestamp: BN$1;
-    lockingDuration: BN$1;
-    lockingEarlyWithdrawalPenaltyBps: BN$1;
-    depositCapAmount: BN$1;
+    lockingMode: BN;
+    lockingStartTimestamp: BN;
+    lockingDuration: BN;
+    lockingEarlyWithdrawalPenaltyBps: BN;
+    depositCapAmount: BN;
     scopePrices: PublicKey;
-    scopeOraclePriceId: BN$1;
-    scopeOracleMaxAge: BN$1;
+    scopeOraclePriceId: BN;
+    scopeOracleMaxAge: BN;
     pendingFarmAdmin: PublicKey;
     strategyId: PublicKey;
     delegatedRpsAdmin: PublicKey;
     vaultId: PublicKey;
     secondDelegatedAuthority: PublicKey;
-    padding: Array<BN$1>;
+    padding: Array<BN>;
 }
 interface TokenInfoFields {
     mint: PublicKey;
-    decimals: BN$1;
+    decimals: BN;
     tokenProgram: PublicKey;
-    padding: Array<BN$1>;
+    padding: Array<BN>;
 }
 interface RewardInfoFields {
     token: TokenInfoFields;
     rewardsVault: PublicKey;
-    rewardsAvailable: BN$1;
+    rewardsAvailable: BN;
     rewardScheduleCurve: RewardScheduleCurveFields;
-    minClaimDurationSeconds: BN$1;
-    lastIssuanceTs: BN$1;
-    rewardsIssuedUnclaimed: BN$1;
-    rewardsIssuedCumulative: BN$1;
-    rewardPerShareScaled: BN$1;
-    placeholder0: BN$1;
+    minClaimDurationSeconds: BN;
+    lastIssuanceTs: BN;
+    rewardsIssuedUnclaimed: BN;
+    rewardsIssuedCumulative: BN;
+    rewardPerShareScaled: BN;
+    placeholder0: BN;
     rewardType: number;
     rewardsPerSecondDecimals: number;
     padding0: Array<number>;
-    padding1: Array<BN$1>;
+    padding1: Array<BN>;
 }
 interface RewardPerTimeUnitPointFields {
-    tsStart: BN$1;
-    rewardPerTimeUnit: BN$1;
+    tsStart: BN;
+    rewardPerTimeUnit: BN;
 }
 interface RewardScheduleCurveFields {
     /**