aftermath-ts-sdk 1.2.51 → 1.2.52-perps.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (214) hide show
  1. package/README.md +62 -28
  2. package/dist/general/apiHelpers/eventsApiHelpers.d.ts +1 -1
  3. package/dist/general/apiHelpers/eventsApiHelpers.d.ts.map +1 -1
  4. package/dist/general/apiHelpers/eventsApiHelpers.js +4 -1
  5. package/dist/general/apiHelpers/transactionsApiHelpers.d.ts +6 -0
  6. package/dist/general/apiHelpers/transactionsApiHelpers.d.ts.map +1 -1
  7. package/dist/general/apiHelpers/transactionsApiHelpers.js +46 -0
  8. package/dist/general/dynamicGas/dynamicGas.d.ts +34 -0
  9. package/dist/general/dynamicGas/dynamicGas.d.ts.map +1 -1
  10. package/dist/general/dynamicGas/dynamicGas.js +34 -0
  11. package/dist/general/dynamicGas/dynamicGasTypes.d.ts +25 -0
  12. package/dist/general/dynamicGas/dynamicGasTypes.d.ts.map +1 -1
  13. package/dist/general/prices/coinGeckoTypes.d.ts +2 -0
  14. package/dist/general/prices/coinGeckoTypes.d.ts.map +1 -1
  15. package/dist/general/prices/prices.d.ts +73 -0
  16. package/dist/general/prices/prices.d.ts.map +1 -1
  17. package/dist/general/prices/prices.js +73 -0
  18. package/dist/general/providers/aftermath.d.ts +107 -27
  19. package/dist/general/providers/aftermath.d.ts.map +1 -1
  20. package/dist/general/providers/aftermath.js +110 -30
  21. package/dist/general/providers/aftermathApi.d.ts +128 -10
  22. package/dist/general/providers/aftermathApi.d.ts.map +1 -1
  23. package/dist/general/providers/aftermathApi.js +133 -14
  24. package/dist/general/types/castingTypes.d.ts +15 -7
  25. package/dist/general/types/castingTypes.d.ts.map +1 -1
  26. package/dist/general/types/castingTypes.js +6 -0
  27. package/dist/general/types/configTypes.d.ts +14 -8
  28. package/dist/general/types/configTypes.d.ts.map +1 -1
  29. package/dist/general/types/generalTypes.d.ts +229 -7
  30. package/dist/general/types/generalTypes.d.ts.map +1 -1
  31. package/dist/general/types/moveErrorsInterface.d.ts +1 -1
  32. package/dist/general/types/moveErrorsInterface.d.ts.map +1 -1
  33. package/dist/general/types/suiTypes.d.ts +0 -16
  34. package/dist/general/types/suiTypes.d.ts.map +1 -1
  35. package/dist/general/types/suiTypes.js +3 -25
  36. package/dist/general/utils/caller.d.ts +6 -3
  37. package/dist/general/utils/caller.d.ts.map +1 -1
  38. package/dist/general/utils/caller.js +22 -4
  39. package/dist/general/utils/casting.d.ts +156 -5
  40. package/dist/general/utils/casting.d.ts.map +1 -1
  41. package/dist/general/utils/casting.js +159 -18
  42. package/dist/general/utils/fixedUtils.d.ts +89 -2
  43. package/dist/general/utils/fixedUtils.d.ts.map +1 -1
  44. package/dist/general/utils/fixedUtils.js +81 -4
  45. package/dist/general/utils/helpers.d.ts +327 -10
  46. package/dist/general/utils/helpers.d.ts.map +1 -1
  47. package/dist/general/utils/helpers.js +409 -91
  48. package/dist/general/utils/iFixedUtils.d.ts +64 -0
  49. package/dist/general/utils/iFixedUtils.d.ts.map +1 -1
  50. package/dist/general/utils/iFixedUtils.js +64 -0
  51. package/dist/general/wallet/wallet.d.ts +76 -1
  52. package/dist/general/wallet/wallet.d.ts.map +1 -1
  53. package/dist/general/wallet/wallet.js +75 -5
  54. package/dist/packages/auth/auth.d.ts +113 -4
  55. package/dist/packages/auth/auth.d.ts.map +1 -1
  56. package/dist/packages/auth/auth.js +190 -59
  57. package/dist/packages/auth/authTypes.d.ts +66 -0
  58. package/dist/packages/auth/authTypes.d.ts.map +1 -1
  59. package/dist/packages/coin/api/coinApi.d.ts.map +1 -1
  60. package/dist/packages/coin/api/coinApi.js +29 -20
  61. package/dist/packages/coin/coin.d.ts +256 -1
  62. package/dist/packages/coin/coin.d.ts.map +1 -1
  63. package/dist/packages/coin/coin.js +246 -15
  64. package/dist/packages/coin/coinTypes.d.ts +95 -0
  65. package/dist/packages/coin/coinTypes.d.ts.map +1 -1
  66. package/dist/packages/dca/api/dcaApi.d.ts +2 -0
  67. package/dist/packages/dca/api/dcaApi.d.ts.map +1 -1
  68. package/dist/packages/dca/api/dcaApi.js +6 -3
  69. package/dist/packages/dca/dca.d.ts +125 -35
  70. package/dist/packages/dca/dca.d.ts.map +1 -1
  71. package/dist/packages/dca/dca.js +135 -43
  72. package/dist/packages/dca/dcaTypes.d.ts +217 -42
  73. package/dist/packages/dca/dcaTypes.d.ts.map +1 -1
  74. package/dist/packages/farms/api/farmsApi.d.ts +725 -58
  75. package/dist/packages/farms/api/farmsApi.d.ts.map +1 -1
  76. package/dist/packages/farms/api/farmsApi.js +1149 -153
  77. package/dist/packages/farms/api/farmsApiCasting.d.ts +34 -18
  78. package/dist/packages/farms/api/farmsApiCasting.d.ts.map +1 -1
  79. package/dist/packages/farms/api/farmsApiCasting.js +218 -17
  80. package/dist/packages/farms/api/farmsApiCastingTypes.d.ts +117 -21
  81. package/dist/packages/farms/api/farmsApiCastingTypes.d.ts.map +1 -1
  82. package/dist/packages/farms/farms.d.ts +200 -12
  83. package/dist/packages/farms/farms.d.ts.map +1 -1
  84. package/dist/packages/farms/farms.js +204 -50
  85. package/dist/packages/farms/farmsStakedPosition.d.ts +143 -8
  86. package/dist/packages/farms/farmsStakedPosition.d.ts.map +1 -1
  87. package/dist/packages/farms/farmsStakedPosition.js +243 -137
  88. package/dist/packages/farms/farmsStakingPool.d.ts +171 -3
  89. package/dist/packages/farms/farmsStakingPool.d.ts.map +1 -1
  90. package/dist/packages/farms/farmsStakingPool.js +233 -73
  91. package/dist/packages/farms/farmsTypes.d.ts +310 -2
  92. package/dist/packages/farms/farmsTypes.d.ts.map +1 -1
  93. package/dist/packages/farms/farmsTypes.js +47 -0
  94. package/dist/packages/faucet/api/faucetApi.d.ts +9 -17
  95. package/dist/packages/faucet/api/faucetApi.d.ts.map +1 -1
  96. package/dist/packages/faucet/api/faucetApi.js +44 -49
  97. package/dist/packages/faucet/api/faucetApiCasting.d.ts.map +1 -1
  98. package/dist/packages/faucet/api/faucetApiCasting.js +8 -5
  99. package/dist/packages/faucet/api/faucetApiCastingTypes.d.ts +1 -4
  100. package/dist/packages/faucet/api/faucetApiCastingTypes.d.ts.map +1 -1
  101. package/dist/packages/faucet/faucet.d.ts +1 -1
  102. package/dist/packages/faucet/faucet.d.ts.map +1 -1
  103. package/dist/packages/faucet/faucet.js +1 -1
  104. package/dist/packages/faucet/faucetTypes.d.ts +2 -3
  105. package/dist/packages/faucet/faucetTypes.d.ts.map +1 -1
  106. package/dist/packages/limitOrders/api/limitOrdersApi.d.ts +12 -0
  107. package/dist/packages/limitOrders/api/limitOrdersApi.d.ts.map +1 -0
  108. package/dist/packages/limitOrders/api/limitOrdersApi.js +25 -0
  109. package/dist/packages/limitOrders/index.d.ts +2 -0
  110. package/dist/packages/limitOrders/index.d.ts.map +1 -0
  111. package/dist/packages/limitOrders/index.js +17 -0
  112. package/dist/packages/limitOrders/limitOrders.d.ts +143 -0
  113. package/dist/packages/limitOrders/limitOrders.d.ts.map +1 -0
  114. package/dist/packages/limitOrders/limitOrders.js +190 -0
  115. package/dist/packages/limitOrders/limitOrdersTypes.d.ts +211 -0
  116. package/dist/packages/limitOrders/limitOrdersTypes.d.ts.map +1 -0
  117. package/dist/packages/multisig/multisig.d.ts +34 -5
  118. package/dist/packages/multisig/multisig.d.ts.map +1 -1
  119. package/dist/packages/multisig/multisig.js +33 -4
  120. package/dist/packages/multisig/multisigTypes.d.ts +17 -0
  121. package/dist/packages/multisig/multisigTypes.d.ts.map +1 -1
  122. package/dist/packages/nftAmm/nftAmm.d.ts +1 -1
  123. package/dist/packages/nftAmm/nftAmm.d.ts.map +1 -1
  124. package/dist/packages/perpetuals/api/perpetualsApi.d.ts +38 -23
  125. package/dist/packages/perpetuals/api/perpetualsApi.d.ts.map +1 -1
  126. package/dist/packages/perpetuals/api/perpetualsApi.js +740 -299
  127. package/dist/packages/perpetuals/api/perpetualsApiCasting.d.ts +10 -6
  128. package/dist/packages/perpetuals/api/perpetualsApiCasting.d.ts.map +1 -1
  129. package/dist/packages/perpetuals/api/perpetualsApiCasting.js +112 -42
  130. package/dist/packages/perpetuals/perpetuals.d.ts +33 -4
  131. package/dist/packages/perpetuals/perpetuals.d.ts.map +1 -1
  132. package/dist/packages/perpetuals/perpetuals.js +105 -18
  133. package/dist/packages/perpetuals/perpetualsAccount.d.ts +107 -33
  134. package/dist/packages/perpetuals/perpetualsAccount.d.ts.map +1 -1
  135. package/dist/packages/perpetuals/perpetualsAccount.js +569 -68
  136. package/dist/packages/perpetuals/perpetualsCastingTypes.d.ts +104 -25
  137. package/dist/packages/perpetuals/perpetualsCastingTypes.d.ts.map +1 -1
  138. package/dist/packages/perpetuals/perpetualsMarket.d.ts +31 -9
  139. package/dist/packages/perpetuals/perpetualsMarket.d.ts.map +1 -1
  140. package/dist/packages/perpetuals/perpetualsMarket.js +85 -77
  141. package/dist/packages/perpetuals/perpetualsTypes.d.ts +348 -380
  142. package/dist/packages/perpetuals/perpetualsTypes.d.ts.map +1 -1
  143. package/dist/packages/perpetuals/perpetualsTypes.js +43 -113
  144. package/dist/packages/pools/api/poolsApiCasting.d.ts.map +1 -1
  145. package/dist/packages/pools/api/poolsApiCasting.js +0 -1
  146. package/dist/packages/pools/pool.d.ts +333 -106
  147. package/dist/packages/pools/pool.d.ts.map +1 -1
  148. package/dist/packages/pools/pool.js +347 -119
  149. package/dist/packages/pools/pools.d.ts +307 -39
  150. package/dist/packages/pools/pools.d.ts.map +1 -1
  151. package/dist/packages/pools/pools.js +323 -54
  152. package/dist/packages/pools/poolsTypes.d.ts +267 -2
  153. package/dist/packages/pools/poolsTypes.d.ts.map +1 -1
  154. package/dist/packages/referralVault/referralVault.d.ts +38 -1
  155. package/dist/packages/referralVault/referralVault.d.ts.map +1 -1
  156. package/dist/packages/referralVault/referralVault.js +37 -0
  157. package/dist/packages/router/api/routerApi.d.ts +2 -2
  158. package/dist/packages/router/api/routerApi.d.ts.map +1 -1
  159. package/dist/packages/router/api/routerApi.js +19 -11
  160. package/dist/packages/router/router.d.ts +214 -18
  161. package/dist/packages/router/router.d.ts.map +1 -1
  162. package/dist/packages/router/router.js +216 -20
  163. package/dist/packages/router/routerTypes.d.ts +202 -17
  164. package/dist/packages/router/routerTypes.d.ts.map +1 -1
  165. package/dist/packages/staking/staking.d.ts +306 -45
  166. package/dist/packages/staking/staking.d.ts.map +1 -1
  167. package/dist/packages/staking/staking.js +313 -51
  168. package/dist/packages/staking/stakingTypes.d.ts +431 -6
  169. package/dist/packages/staking/stakingTypes.d.ts.map +1 -1
  170. package/dist/packages/staking/stakingTypes.js +19 -0
  171. package/dist/packages/sui/sui.d.ts +40 -1
  172. package/dist/packages/sui/sui.d.ts.map +1 -1
  173. package/dist/packages/sui/sui.js +39 -0
  174. package/dist/packages/suiFrens/stakedSuiFren.d.ts +1 -1
  175. package/dist/packages/suiFrens/stakedSuiFren.d.ts.map +1 -1
  176. package/dist/packages/suiFrens/suiFren.d.ts +1 -1
  177. package/dist/packages/suiFrens/suiFren.d.ts.map +1 -1
  178. package/dist/packages/suiFrens/suiFrens.d.ts +1 -1
  179. package/dist/packages/suiFrens/suiFrens.d.ts.map +1 -1
  180. package/dist/packages/userData/api/userDataApi.d.ts +6 -0
  181. package/dist/packages/userData/api/userDataApi.d.ts.map +1 -0
  182. package/dist/packages/userData/api/userDataApi.js +12 -0
  183. package/dist/packages/userData/index.d.ts +2 -0
  184. package/dist/packages/userData/index.d.ts.map +1 -0
  185. package/dist/packages/userData/index.js +17 -0
  186. package/dist/packages/userData/userData.d.ts +89 -0
  187. package/dist/packages/userData/userData.d.ts.map +1 -0
  188. package/dist/packages/userData/userData.js +119 -0
  189. package/dist/packages/userData/userDataTypes.d.ts +29 -0
  190. package/dist/packages/userData/userDataTypes.d.ts.map +1 -0
  191. package/dist/types.d.ts.map +1 -1
  192. package/dist/types.js +0 -1
  193. package/package.json +1 -1
  194. package/dist/general/historicalData/historicalData.d.ts +0 -15
  195. package/dist/general/historicalData/historicalData.d.ts.map +0 -1
  196. package/dist/general/historicalData/historicalData.js +0 -45
  197. package/dist/general/historicalData/historicalDataTypes.d.ts +0 -10
  198. package/dist/general/historicalData/historicalDataTypes.d.ts.map +0 -1
  199. package/dist/packages/dca/api/dcaApiCasting.d.ts +0 -11
  200. package/dist/packages/dca/api/dcaApiCasting.d.ts.map +0 -1
  201. package/dist/packages/dca/api/dcaApiCasting.js +0 -186
  202. package/dist/packages/dca/api/dcaApiCastingTypes.d.ts +0 -142
  203. package/dist/packages/dca/api/dcaApiCastingTypes.d.ts.map +0 -1
  204. package/dist/packages/oracle/api/oracleApi.d.ts +0 -13
  205. package/dist/packages/oracle/api/oracleApi.d.ts.map +0 -1
  206. package/dist/packages/oracle/api/oracleApi.js +0 -35
  207. package/dist/packages/oracle/oracle.d.ts +0 -15
  208. package/dist/packages/oracle/oracle.d.ts.map +0 -1
  209. package/dist/packages/oracle/oracle.js +0 -46
  210. package/dist/packages/oracle/oracleTypes.d.ts +0 -2
  211. package/dist/packages/oracle/oracleTypes.d.ts.map +0 -1
  212. package/dist/packages/oracle/oracleTypes.js +0 -2
  213. /package/dist/{general/historicalData/historicalDataTypes.js → packages/limitOrders/limitOrdersTypes.js} +0 -0
  214. /package/dist/packages/{dca/api/dcaApiCastingTypes.js → userData/userDataTypes.js} +0 -0
@@ -1,5 +1,5 @@
1
1
  import { AftermathApi } from "../../../general/providers/aftermathApi";
2
- import { AnyObjectType, FarmsAddresses, Timestamp, CoinType, ApiFarmsStakeBody, ApiHarvestFarmsRewardsBody, ApiFarmsDepositPrincipalBody, Balance, ApiFarmsUnstakeBody, FarmsLockEnforcement, FarmsMultiplier, ApiFarmsCreateStakingPoolBody, ApiFarmsTopUpStakingPoolRewardsBody, ApiFarmsInitializeStakingPoolRewardBody, StakingPoolOwnerCapObject, ApiFarmsOwnedStakingPoolOwnerCapsBody, ApiFarmsIncreaseStakingPoolRewardsEmissionsBody, PartialFarmsStakedPositionObject, EventsInputs, FarmsStakedEvent, FarmsStakedRelaxedEvent, FarmsLockedEvent, FarmsUnlockedEvent, FarmsWithdrewPrincipalEvent, FarmsDepositedPrincipalEvent, FarmsHarvestedRewardsEvent, FarmsCreatedVaultEvent, StakingPoolOneTimeAdminCapObject, FarmOwnerOrOneTimeAdminCap, ObjectId, SuiAddress } from "../../../types";
2
+ import { AnyObjectType, FarmsAddresses, Timestamp, CoinType, ApiFarmsStakeBody, ApiHarvestFarmsRewardsBody, ApiFarmsDepositPrincipalBody, Balance, ApiFarmsUnstakeBody, FarmsLockEnforcement, FarmsMultiplier, ApiFarmsCreateStakingPoolBody, ApiFarmsTopUpStakingPoolRewardsBody, ApiFarmsInitializeStakingPoolRewardBody, StakingPoolOwnerCapObject, ApiFarmsOwnedStakingPoolOwnerCapsBody, ApiFarmsIncreaseStakingPoolRewardsEmissionsBody, PartialFarmsStakedPositionObject, StakingPoolOneTimeAdminCapObject, FarmOwnerOrOneTimeAdminCap, ObjectId, SuiAddress, ApiFarmsCreateStakingPoolBodyV1, ApiFarmsStakeBodyV1 } from "../../../types";
3
3
  import { TransactionArgument, Transaction } from "@mysten/sui/transactions";
4
4
  import { MoveErrors, MoveErrorsInterface } from "../../../general/types/moveErrorsInterface";
5
5
  export declare class FarmsApi implements MoveErrorsInterface {
@@ -7,96 +7,284 @@ export declare class FarmsApi implements MoveErrorsInterface {
7
7
  private static readonly constants;
8
8
  readonly addresses: FarmsAddresses;
9
9
  readonly objectTypes: {
10
- stakedPosition: AnyObjectType;
11
- stakingPoolOwnerCap: AnyObjectType;
12
- stakingPoolOneTimeAdminCap: AnyObjectType;
10
+ stakedPositionV1: AnyObjectType;
11
+ stakingPoolOwnerCapV1: AnyObjectType;
12
+ stakingPoolOneTimeAdminCapV1: AnyObjectType;
13
+ stakedPositionV2: AnyObjectType;
14
+ stakingPoolOwnerCapV2: AnyObjectType;
15
+ stakingPoolOneTimeAdminCapV2: AnyObjectType;
13
16
  };
14
17
  readonly eventTypes: {
15
- createdVault: AnyObjectType;
16
- initializedReward: AnyObjectType;
17
- addedReward: AnyObjectType;
18
- increasedEmissions: AnyObjectType;
19
- staked: AnyObjectType;
20
- stakedRelaxed: AnyObjectType;
21
- locked: AnyObjectType;
22
- unlocked: AnyObjectType;
23
- depositedPrincipal: AnyObjectType;
24
- withdrewPrincipal: AnyObjectType;
25
- harvestedRewards: AnyObjectType;
18
+ createdVaultV1: AnyObjectType;
19
+ initializedRewardV1: AnyObjectType;
20
+ addedRewardV1: AnyObjectType;
21
+ increasedEmissionsV1: AnyObjectType;
22
+ stakedV1: AnyObjectType;
23
+ stakedRelaxedV1: AnyObjectType;
24
+ lockedV1: AnyObjectType;
25
+ unlockedV1: AnyObjectType;
26
+ depositedPrincipalV1: AnyObjectType;
27
+ withdrewPrincipalV1: AnyObjectType;
28
+ harvestedRewardsV1: AnyObjectType;
29
+ createdVaultV2: AnyObjectType;
30
+ initializedRewardV2: AnyObjectType;
31
+ addedRewardV2: AnyObjectType;
32
+ updatedEmissionsV2: AnyObjectType;
33
+ stakedV2: AnyObjectType;
34
+ lockedV2: AnyObjectType;
35
+ unlockedV2: AnyObjectType;
36
+ depositedPrincipalV2: AnyObjectType;
37
+ withdrewPrincipalV2: AnyObjectType;
38
+ harvestedRewardsV2: AnyObjectType;
26
39
  };
27
40
  readonly moveErrors: MoveErrors;
41
+ /**
42
+ * Constructor for FarmsApi
43
+ * @param Provider The AftermathApi provider instance
44
+ * @throws Error if not all required addresses have been set in provider
45
+ */
28
46
  constructor(Provider: AftermathApi);
47
+ /**
48
+ * Fetches the owner caps for staking pools owned by a specific wallet address
49
+ * @param inputs Object containing wallet address
50
+ * @returns Array of StakingPoolOwnerCapObject
51
+ */
29
52
  fetchOwnedStakingPoolOwnerCaps: (inputs: ApiFarmsOwnedStakingPoolOwnerCapsBody) => Promise<StakingPoolOwnerCapObject[]>;
53
+ /**
54
+ * Fetches the one-time admin caps for staking pools owned by a specific wallet address
55
+ * @param inputs Object containing wallet address
56
+ * @returns Array of StakingPoolOneTimeAdminCapObject
57
+ */
30
58
  fetchOwnedStakingPoolOneTimeAdminCaps: (inputs: ApiFarmsOwnedStakingPoolOwnerCapsBody) => Promise<StakingPoolOneTimeAdminCapObject[]>;
59
+ /**
60
+ * Fetches partial staked positions owned by a specific wallet address
61
+ * @param inputs Object containing wallet address
62
+ * @returns Array of PartialFarmsStakedPositionObject
63
+ */
31
64
  fetchOwnedPartialStakedPositions: (inputs: {
32
65
  walletAddress: SuiAddress;
33
66
  }) => Promise<PartialFarmsStakedPositionObject[]>;
34
- fetchCreatedVaultEvents: (inputs: EventsInputs) => Promise<import("../../../types").EventsWithCursor<FarmsCreatedVaultEvent>>;
35
- fetchStakedEvents: (inputs: EventsInputs) => Promise<import("../../../types").EventsWithCursor<FarmsStakedEvent>>;
36
- fetchStakedRelaxedEvents: (inputs: EventsInputs) => Promise<import("../../../types").EventsWithCursor<FarmsStakedRelaxedEvent>>;
37
- fetchLockedEvents: (inputs: EventsInputs) => Promise<import("../../../types").EventsWithCursor<FarmsLockedEvent>>;
38
- fetchUnlockedEvents: (inputs: EventsInputs) => Promise<import("../../../types").EventsWithCursor<FarmsUnlockedEvent>>;
39
- fetchDepositedPrincipalEvents: (inputs: EventsInputs) => Promise<import("../../../types").EventsWithCursor<FarmsDepositedPrincipalEvent>>;
40
- fetchWithdrewPrincipalEvents: (inputs: EventsInputs) => Promise<import("../../../types").EventsWithCursor<FarmsWithdrewPrincipalEvent>>;
41
- fetchHarvestedRewardsEvents: (inputs: EventsInputs) => Promise<import("../../../types").EventsWithCursor<FarmsHarvestedRewardsEvent>>;
42
- stakeTx: (inputs: {
67
+ /**
68
+ * @deprecated use stakeTxV2 instead
69
+ * Creates a transaction to stake coins in a staking pool (original version)
70
+ * @param inputs Staking parameters including transaction, pool ID, coin ID, lock duration, and coin type
71
+ * @returns Transaction object argument for StakedPosition
72
+ */
73
+ stakeTxV1: (inputs: {
43
74
  tx: Transaction;
44
75
  stakingPoolId: ObjectId;
45
76
  stakeCoinId: ObjectId | TransactionArgument;
46
77
  lockDurationMs: Timestamp;
47
78
  stakeCoinType: CoinType;
48
79
  }) => import("@mysten/sui/transactions").TransactionResult;
49
- depositPrincipalTx: (inputs: {
80
+ /**
81
+ * Creates a transaction to stake coins in a staking pool
82
+ * @param inputs Staking parameters including transaction, pool ID, coin ID, lock duration, lock enforcement, and coin type
83
+ * @returns Transaction object argument for StakedPosition
84
+ */
85
+ stakeTxV2: (inputs: {
86
+ tx: Transaction;
87
+ stakingPoolId: ObjectId;
88
+ stakeCoinId: ObjectId | TransactionArgument;
89
+ lockDurationMs: Timestamp;
90
+ lockEnforcement: FarmsLockEnforcement;
91
+ stakeCoinType: CoinType;
92
+ }) => import("@mysten/sui/transactions").TransactionResult;
93
+ /**
94
+ * @deprecated use depositPrincipalTxV2 instead
95
+ * Creates a transaction to deposit additional principal to a staked position (original version)
96
+ * @param inputs Deposit parameters including transaction, position ID, pool ID, coin ID, and coin type
97
+ * @returns Transaction command to deposit principal
98
+ */
99
+ depositPrincipalTxV1: (inputs: {
50
100
  tx: Transaction;
51
101
  stakedPositionId: ObjectId;
52
102
  stakingPoolId: ObjectId;
53
103
  stakeCoinId: ObjectId | TransactionArgument;
54
104
  stakeCoinType: CoinType;
55
105
  }) => import("@mysten/sui/transactions").TransactionResult;
56
- withdrawPrincipalTx: (inputs: {
106
+ /**
107
+ * Creates a transaction to deposit additional principal to a staked position
108
+ * @param inputs Deposit parameters including transaction, position ID, pool ID, coin ID, and coin type
109
+ * @returns Transaction command to deposit principal
110
+ */
111
+ depositPrincipalTxV2: (inputs: {
112
+ tx: Transaction;
113
+ stakedPositionId: ObjectId;
114
+ stakingPoolId: ObjectId;
115
+ stakeCoinId: ObjectId | TransactionArgument;
116
+ stakeCoinType: CoinType;
117
+ }) => import("@mysten/sui/transactions").TransactionResult;
118
+ /**
119
+ * @deprecated use withdrawPrincipalTxV2 instead
120
+ * Creates a transaction to withdraw principal from a staked position (original version)
121
+ * @param inputs Withdrawal parameters including transaction, position ID, pool ID, amount, and coin type
122
+ * @returns Transaction object argument for the withdrawn Coin
123
+ */
124
+ withdrawPrincipalTxV1: (inputs: {
57
125
  tx: Transaction;
58
126
  stakedPositionId: ObjectId;
59
127
  stakingPoolId: ObjectId;
60
128
  withdrawAmount: Balance;
61
129
  stakeCoinType: CoinType;
62
130
  }) => import("@mysten/sui/transactions").TransactionResult;
63
- destroyStakedPositionTx: (inputs: {
131
+ /**
132
+ * Creates a transaction to withdraw principal from a staked position
133
+ * @param inputs Withdrawal parameters including transaction, position ID, pool ID, amount, and coin type
134
+ * @returns Transaction object argument for the withdrawn Coin
135
+ */
136
+ withdrawPrincipalTxV2: (inputs: {
64
137
  tx: Transaction;
65
138
  stakedPositionId: ObjectId;
66
139
  stakingPoolId: ObjectId;
140
+ withdrawAmount: Balance;
67
141
  stakeCoinType: CoinType;
68
142
  }) => import("@mysten/sui/transactions").TransactionResult;
69
- updatePositionTx: (inputs: {
143
+ /**
144
+ * @deprecated use destroyStakedPositionTxV2 instead
145
+ * Creates a transaction to destroy a staked position (original version)
146
+ * @param inputs Destroy parameters including transaction, position ID, pool ID, and coin type
147
+ * @returns Transaction command to destroy the position
148
+ */
149
+ destroyStakedPositionTxV1: (inputs: {
70
150
  tx: Transaction;
71
151
  stakedPositionId: ObjectId;
72
152
  stakingPoolId: ObjectId;
73
153
  stakeCoinType: CoinType;
74
154
  }) => import("@mysten/sui/transactions").TransactionResult;
75
- lockTx: (inputs: {
155
+ /**
156
+ * Creates a transaction to destroy a staked position
157
+ * @param inputs Destroy parameters including transaction, position ID, and coin type
158
+ * @returns Transaction command to destroy the position
159
+ */
160
+ destroyStakedPositionTxV2: (inputs: {
161
+ tx: Transaction;
162
+ stakedPositionId: ObjectId;
163
+ stakeCoinType: CoinType;
164
+ }) => import("@mysten/sui/transactions").TransactionResult;
165
+ /**
166
+ * @deprecated use updatePositionTxV2 instead
167
+ * Creates a transaction to update a staked position, recalculating rewards (original version)
168
+ * @param inputs Update parameters including transaction, position ID, pool ID, and coin type
169
+ * @returns Transaction command to update the position
170
+ */
171
+ updatePositionTxV1: (inputs: {
172
+ tx: Transaction;
173
+ stakedPositionId: ObjectId;
174
+ stakingPoolId: ObjectId;
175
+ stakeCoinType: CoinType;
176
+ }) => import("@mysten/sui/transactions").TransactionResult;
177
+ /**
178
+ * Creates a transaction to update a staked position, recalculating rewards
179
+ * @param inputs Update parameters including transaction, position ID, pool ID, and coin type
180
+ * @returns Transaction command to update the position
181
+ */
182
+ updatePositionTxV2: (inputs: {
183
+ tx: Transaction;
184
+ stakedPositionId: ObjectId;
185
+ stakingPoolId: ObjectId;
186
+ stakeCoinType: CoinType;
187
+ }) => import("@mysten/sui/transactions").TransactionResult;
188
+ /**
189
+ * @deprecated use lockTxV2 instead
190
+ * Creates a transaction to lock a staked position for a specific duration (original version)
191
+ * @param inputs Lock parameters including transaction, position ID, pool ID, lock duration, and coin type
192
+ * @returns Transaction command to lock the position
193
+ */
194
+ lockTxV1: (inputs: {
195
+ tx: Transaction;
196
+ stakedPositionId: ObjectId;
197
+ stakingPoolId: ObjectId;
198
+ lockDurationMs: Timestamp;
199
+ stakeCoinType: CoinType;
200
+ }) => import("@mysten/sui/transactions").TransactionResult;
201
+ /**
202
+ * Creates a transaction to lock a staked position for a specific duration
203
+ * @param inputs Lock parameters including transaction, position ID, pool ID, lock duration, and coin type
204
+ * @returns Transaction command to lock the position
205
+ */
206
+ lockTxV2: (inputs: {
76
207
  tx: Transaction;
77
208
  stakedPositionId: ObjectId;
78
209
  stakingPoolId: ObjectId;
79
210
  lockDurationMs: Timestamp;
80
211
  stakeCoinType: CoinType;
81
212
  }) => import("@mysten/sui/transactions").TransactionResult;
82
- renewLockTx: (inputs: {
213
+ /**
214
+ * @deprecated use renewLockTxV2 instead
215
+ * Creates a transaction to renew the lock on a staked position (original version)
216
+ * @param inputs Renew lock parameters including transaction, position ID, pool ID, and coin type
217
+ * @returns Transaction command to renew the lock
218
+ */
219
+ renewLockTxV1: (inputs: {
83
220
  tx: Transaction;
84
221
  stakedPositionId: ObjectId;
85
222
  stakingPoolId: ObjectId;
86
223
  stakeCoinType: CoinType;
87
224
  }) => import("@mysten/sui/transactions").TransactionResult;
88
- unlockTx: (inputs: {
225
+ /**
226
+ * Creates a transaction to renew the lock on a staked position
227
+ * @param inputs Renew lock parameters including transaction, position ID, pool ID, and coin type
228
+ * @returns Transaction command to renew the lock
229
+ */
230
+ renewLockTxV2: (inputs: {
89
231
  tx: Transaction;
90
232
  stakedPositionId: ObjectId;
91
233
  stakingPoolId: ObjectId;
92
234
  stakeCoinType: CoinType;
93
235
  }) => import("@mysten/sui/transactions").TransactionResult;
94
- beginHarvestTx: (inputs: {
236
+ /**
237
+ * @deprecated use unlockTxV2 instead
238
+ * Creates a transaction to unlock a staked position (original version)
239
+ * @param inputs Unlock parameters including transaction, position ID, pool ID, and coin type
240
+ * @returns Transaction command to unlock the position
241
+ */
242
+ unlockTxV1: (inputs: {
95
243
  tx: Transaction;
244
+ stakedPositionId: ObjectId;
96
245
  stakingPoolId: ObjectId;
97
246
  stakeCoinType: CoinType;
98
247
  }) => import("@mysten/sui/transactions").TransactionResult;
99
- harvestRewardsTx: (inputs: {
248
+ /**
249
+ * Creates a transaction to unlock a staked position
250
+ * @param inputs Unlock parameters including transaction, position ID, pool ID, and coin type
251
+ * @returns Transaction command to unlock the position
252
+ */
253
+ unlockTxV2: (inputs: {
254
+ tx: Transaction;
255
+ stakedPositionId: ObjectId;
256
+ stakingPoolId: ObjectId;
257
+ stakeCoinType: CoinType;
258
+ }) => import("@mysten/sui/transactions").TransactionResult;
259
+ /**
260
+ * @deprecated use beginHarvestTxV2 instead
261
+ * Creates a transaction to begin the reward harvesting process (original version)
262
+ * @param inputs Begin harvest parameters including transaction, pool ID, and coin type
263
+ * @returns Transaction object argument for the harvest metadata
264
+ */
265
+ beginHarvestTxV1: (inputs: {
266
+ tx: Transaction;
267
+ stakingPoolId: ObjectId;
268
+ stakeCoinType: CoinType;
269
+ }) => import("@mysten/sui/transactions").TransactionResult;
270
+ /**
271
+ * Creates a transaction to begin the reward harvesting process
272
+ * @param inputs Begin harvest parameters including transaction, position ID, pool ID, and coin type
273
+ * @returns Transaction object argument for the harvest cap
274
+ */
275
+ beginHarvestTxV2: (inputs: {
276
+ tx: Transaction;
277
+ stakedPositionId: ObjectId;
278
+ stakingPoolId: ObjectId;
279
+ stakeCoinType: CoinType;
280
+ }) => import("@mysten/sui/transactions").TransactionResult;
281
+ /**
282
+ * @deprecated use harvestRewardsTxV2 instead
283
+ * Creates a transaction to harvest rewards from a staked position (original version)
284
+ * @param inputs Harvest parameters including transaction, position ID, pool ID, harvest metadata, stake coin type, and reward coin type
285
+ * @returns Transaction object argument for the harvested rewards
286
+ */
287
+ harvestRewardsTxV1: (inputs: {
100
288
  tx: Transaction;
101
289
  stakedPositionId: ObjectId;
102
290
  stakingPoolId: ObjectId;
@@ -104,11 +292,45 @@ export declare class FarmsApi implements MoveErrorsInterface {
104
292
  stakeCoinType: CoinType;
105
293
  rewardCoinType: CoinType;
106
294
  }) => import("@mysten/sui/transactions").TransactionResult;
107
- endHarvestTx: (inputs: {
295
+ /**
296
+ * Creates a transaction to harvest rewards from a staked position
297
+ * @param inputs Harvest parameters including transaction, harvest cap, position ID, pool ID, stake coin type, and reward coin type
298
+ * @returns Transaction object argument for the harvested rewards
299
+ */
300
+ harvestRewardsTxV2: (inputs: {
301
+ tx: Transaction;
302
+ harvestRewardsCap: ObjectId | TransactionArgument;
303
+ stakedPositionId: ObjectId;
304
+ stakingPoolId: ObjectId;
305
+ stakeCoinType: CoinType;
306
+ rewardCoinType: CoinType;
307
+ }) => import("@mysten/sui/transactions").TransactionResult;
308
+ /**
309
+ * @deprecated use endHarvestTxV2 instead
310
+ * Creates a transaction to end the reward harvesting process (original version)
311
+ * @param inputs End harvest parameters including transaction and harvest metadata
312
+ * @returns Transaction command to end the harvest
313
+ */
314
+ endHarvestTxV1: (inputs: {
108
315
  tx: Transaction;
109
316
  harvestedRewardsEventMetadataId: ObjectId | TransactionArgument;
110
317
  }) => import("@mysten/sui/transactions").TransactionResult;
111
- newStakingPoolTx: (inputs: {
318
+ /**
319
+ * Creates a transaction to end the reward harvesting process
320
+ * @param inputs End harvest parameters including transaction and harvest cap
321
+ * @returns Transaction command to end the harvest
322
+ */
323
+ endHarvestTxV2: (inputs: {
324
+ tx: Transaction;
325
+ harvestRewardsCap: ObjectId | TransactionArgument;
326
+ }) => import("@mysten/sui/transactions").TransactionResult;
327
+ /**
328
+ * @deprecated use newStakingPoolTxV2 instead
329
+ * Creates a transaction for the deprecated version of staking pool creation
330
+ * @param inputs Pool creation parameters including transaction, lock enforcement, durations, multiplier, stake amount, and coin type
331
+ * @returns Transaction objects for the vault and owner cap
332
+ */
333
+ newStakingPoolTxV1: (inputs: {
112
334
  tx: Transaction;
113
335
  lockEnforcement: FarmsLockEnforcement;
114
336
  minLockDurationMs: Timestamp;
@@ -117,23 +339,97 @@ export declare class FarmsApi implements MoveErrorsInterface {
117
339
  minStakeAmount: Balance;
118
340
  stakeCoinType: CoinType;
119
341
  }) => import("@mysten/sui/transactions").TransactionResult;
120
- shareStakingPoolTx: (inputs: {
342
+ /**
343
+ * Creates a transaction for the current version of staking pool creation
344
+ * @param inputs Pool creation parameters including transaction, lock enforcements array, durations, multiplier, stake amount, and coin type
345
+ * @returns Transaction objects for the vault and authority cap
346
+ */
347
+ newStakingPoolTxV2: (inputs: {
348
+ tx: Transaction;
349
+ lockEnforcements: FarmsLockEnforcement[];
350
+ minLockDurationMs: Timestamp;
351
+ maxLockDurationMs: Timestamp;
352
+ maxLockMultiplier: FarmsMultiplier;
353
+ minStakeAmount: Balance;
354
+ stakeCoinType: CoinType;
355
+ }) => import("@mysten/sui/transactions").TransactionResult;
356
+ /**
357
+ * @deprecated use shareStakingPoolTxV2 instead
358
+ * Creates a transaction to share a staking pool, making it public
359
+ * @param inputs Share pool parameters including transaction, pool ID, and coin type
360
+ * @returns Transaction command to share the pool
361
+ */
362
+ shareStakingPoolTxV1: (inputs: {
363
+ tx: Transaction;
364
+ stakingPoolId: ObjectId | TransactionArgument;
365
+ stakeCoinType: CoinType;
366
+ }) => import("@mysten/sui/transactions").TransactionResult;
367
+ /**
368
+ * Creates a transaction to share a staking pool, making it public
369
+ * @param inputs Share pool parameters including transaction, pool ID, and coin type
370
+ * @returns Transaction command to share the pool
371
+ */
372
+ shareStakingPoolTxV2: (inputs: {
121
373
  tx: Transaction;
122
374
  stakingPoolId: ObjectId | TransactionArgument;
123
375
  stakeCoinType: CoinType;
124
376
  }) => import("@mysten/sui/transactions").TransactionResult;
125
- transferOwnerCapTx: (inputs: {
377
+ /**
378
+ * @deprecated use transferOwnerCapTxV2 instead
379
+ * Creates a transaction to transfer ownership of a staking pool
380
+ * @param inputs Transfer parameters including transaction, owner cap ID, and recipient address
381
+ * @returns Transaction command to transfer the owner cap
382
+ */
383
+ transferOwnerCapTxV1: (inputs: {
384
+ tx: Transaction;
385
+ ownerCapId: ObjectId | TransactionArgument;
386
+ recipientAddress: SuiAddress;
387
+ }) => import("@mysten/sui/transactions").TransactionResult;
388
+ /**
389
+ * @deprecated use grantOneTimeAdminCapTxV2 instead
390
+ * Creates a transaction to grant a one-time admin capability for a staking pool (original version)
391
+ * @param inputs Grant parameters including transaction, owner cap ID, recipient address, and reward coin type
392
+ * @returns Transaction command to grant the one-time admin cap
393
+ */
394
+ grantOneTimeAdminCapTxV1: (inputs: {
126
395
  tx: Transaction;
127
396
  ownerCapId: ObjectId | TransactionArgument;
128
397
  recipientAddress: SuiAddress;
398
+ rewardCoinType: CoinType;
129
399
  }) => import("@mysten/sui/transactions").TransactionResult;
130
- grantOneTimeAdminCapTx: (inputs: {
400
+ /**
401
+ * Creates a transaction to grant a one-time admin capability for a staking pool
402
+ * @param inputs Grant parameters including transaction, owner cap ID, recipient address, and reward coin type
403
+ * @returns Transaction command to grant the one-time admin cap
404
+ */
405
+ grantOneTimeAdminCapTxV2: (inputs: {
131
406
  tx: Transaction;
132
407
  ownerCapId: ObjectId | TransactionArgument;
133
408
  recipientAddress: SuiAddress;
134
409
  rewardCoinType: CoinType;
135
410
  }) => import("@mysten/sui/transactions").TransactionResult;
136
- initializeStakingPoolRewardTx: (inputs: {
411
+ /**
412
+ * @deprecated use initializeStakingPoolRewardTxV2 instead
413
+ * Creates a transaction to initialize rewards for a staking pool (original version)
414
+ * @param inputs Initialize reward parameters including transaction, pool ID, reward coin ID, emission parameters, stake coin type, and reward coin type
415
+ * @returns Transaction command to initialize the reward
416
+ */
417
+ initializeStakingPoolRewardTxV1: (inputs: {
418
+ tx: Transaction;
419
+ stakingPoolId: ObjectId;
420
+ rewardCoinId: ObjectId | TransactionArgument;
421
+ emissionScheduleMs: Timestamp;
422
+ emissionRate: bigint;
423
+ emissionDelayTimestampMs: Timestamp;
424
+ stakeCoinType: CoinType;
425
+ rewardCoinType: CoinType;
426
+ } & FarmOwnerOrOneTimeAdminCap) => import("@mysten/sui/transactions").TransactionResult;
427
+ /**
428
+ * Creates a transaction to initialize rewards for a staking pool
429
+ * @param inputs Initialize reward parameters including transaction, pool ID, reward coin ID, emission parameters, stake coin type, and reward coin type
430
+ * @returns Transaction command to initialize the reward
431
+ */
432
+ initializeStakingPoolRewardTxV2: (inputs: {
137
433
  tx: Transaction;
138
434
  stakingPoolId: ObjectId;
139
435
  rewardCoinId: ObjectId | TransactionArgument;
@@ -143,14 +439,38 @@ export declare class FarmsApi implements MoveErrorsInterface {
143
439
  stakeCoinType: CoinType;
144
440
  rewardCoinType: CoinType;
145
441
  } & FarmOwnerOrOneTimeAdminCap) => import("@mysten/sui/transactions").TransactionResult;
146
- topUpStakingPoolRewardTx: (inputs: {
442
+ /**
443
+ * @deprecated use topUpStakingPoolRewardTxV2 instead
444
+ * Creates a transaction to add more rewards to a staking pool (original version)
445
+ * @param inputs Top up parameters including transaction, pool ID, reward coin ID, stake coin type, and reward coin type
446
+ * @returns Transaction command to add rewards
447
+ */
448
+ topUpStakingPoolRewardTxV1: (inputs: {
147
449
  tx: Transaction;
148
450
  stakingPoolId: ObjectId;
149
451
  rewardCoinId: ObjectId | TransactionArgument;
150
452
  stakeCoinType: CoinType;
151
453
  rewardCoinType: CoinType;
152
454
  } & FarmOwnerOrOneTimeAdminCap) => import("@mysten/sui/transactions").TransactionResult;
153
- increaseStakingPoolRewardEmissionsTx: (inputs: {
455
+ /**
456
+ * Creates a transaction to add more rewards to a staking pool
457
+ * @param inputs Top up parameters including transaction, pool ID, reward coin ID, stake coin type, and reward coin type
458
+ * @returns Transaction command to add rewards
459
+ */
460
+ topUpStakingPoolRewardTxV2: (inputs: {
461
+ tx: Transaction;
462
+ stakingPoolId: ObjectId;
463
+ rewardCoinId: ObjectId | TransactionArgument;
464
+ stakeCoinType: CoinType;
465
+ rewardCoinType: CoinType;
466
+ } & FarmOwnerOrOneTimeAdminCap) => import("@mysten/sui/transactions").TransactionResult;
467
+ /**
468
+ * @deprecated use increaseStakingPoolRewardEmissionsTxV2 instead
469
+ * Creates a transaction to increase the emission rate for a staking pool reward (original version)
470
+ * @param inputs Increase emissions parameters including transaction, owner cap ID, pool ID, emission parameters, stake coin type, and reward coin type
471
+ * @returns Transaction command to update emissions
472
+ */
473
+ increaseStakingPoolRewardEmissionsTxV1: (inputs: {
154
474
  tx: Transaction;
155
475
  ownerCapId: ObjectId;
156
476
  stakingPoolId: ObjectId;
@@ -159,27 +479,136 @@ export declare class FarmsApi implements MoveErrorsInterface {
159
479
  stakeCoinType: CoinType;
160
480
  rewardCoinType: CoinType;
161
481
  }) => import("@mysten/sui/transactions").TransactionResult;
162
- isVaultUnlockedTx: (inputs: {
482
+ /**
483
+ * Creates a transaction to increase the emission rate for a staking pool reward
484
+ * @param inputs Increase emissions parameters including transaction, owner cap ID, pool ID, emission parameters, stake coin type, and reward coin type
485
+ * @returns Transaction command to update emissions
486
+ */
487
+ increaseStakingPoolRewardEmissionsTxV2: (inputs: {
163
488
  tx: Transaction;
489
+ ownerCapId: ObjectId;
490
+ stakingPoolId: ObjectId;
491
+ emissionScheduleMs: Timestamp;
492
+ emissionRate: bigint;
493
+ stakeCoinType: CoinType;
494
+ rewardCoinType: CoinType;
495
+ }) => import("@mysten/sui/transactions").TransactionResult;
496
+ /**
497
+ * @deprecated use setStakingPoolMinStakeAmountTxV2 instead
498
+ * Creates a transaction to set the minimum stake amount for a staking pool (original version)
499
+ * @param inputs Min stake amount parameters including transaction, owner cap ID, pool ID, minimum amount, and stake coin type
500
+ * @returns Transaction command to set the minimum stake amount
501
+ */
502
+ setStakingPoolMinStakeAmountTxV1: (inputs: {
503
+ tx: Transaction;
504
+ ownerCapId: ObjectId;
505
+ stakingPoolId: ObjectId;
506
+ minStakeAmount: bigint;
507
+ stakeCoinType: CoinType;
508
+ }) => import("@mysten/sui/transactions").TransactionResult;
509
+ /**
510
+ * Creates a transaction to set the minimum stake amount for a staking pool
511
+ * @param inputs Min stake amount parameters including transaction, owner cap ID, pool ID, minimum amount, and stake coin type
512
+ * @returns Transaction command to set the minimum stake amount
513
+ */
514
+ setStakingPoolMinStakeAmountTxV2: (inputs: {
515
+ tx: Transaction;
516
+ ownerCapId: ObjectId;
164
517
  stakingPoolId: ObjectId;
518
+ minStakeAmount: bigint;
165
519
  stakeCoinType: CoinType;
166
520
  }) => import("@mysten/sui/transactions").TransactionResult;
167
- remainingRewardsTx: (inputs: {
521
+ /**
522
+ * Creates a transaction to check if a staking pool is unlocked
523
+ * @param inputs Check parameters including transaction, pool ID, and coin type
524
+ * @returns Transaction object argument for the boolean result
525
+ */
526
+ isVaultUnlockedTxV1: (inputs: {
168
527
  tx: Transaction;
169
528
  stakingPoolId: ObjectId;
170
529
  stakeCoinType: CoinType;
171
530
  }) => import("@mysten/sui/transactions").TransactionResult;
172
- fetchBuildStakeTx: (inputs: ApiFarmsStakeBody) => Promise<Transaction>;
173
- fetchBuildDepositPrincipalTx: (inputs: ApiFarmsDepositPrincipalBody) => Promise<Transaction>;
174
- fetchBuildWithdrawPrincipalTx: (inputs: {
531
+ /**
532
+ * Creates a transaction to get the remaining rewards for a staking pool
533
+ * @param inputs Remaining rewards parameters including transaction, pool ID, and coin type
534
+ * @returns Transaction object argument for the vector of remaining rewards
535
+ */
536
+ remainingRewardsTxV1: (inputs: {
537
+ tx: Transaction;
538
+ stakingPoolId: ObjectId;
539
+ stakeCoinType: CoinType;
540
+ }) => import("@mysten/sui/transactions").TransactionResult;
541
+ /**
542
+ * @deprecated use fetchBuildStakeTxV2 instead
543
+ * Builds a complete transaction for staking coins
544
+ * @param inputs Staking parameters including wallet address, lock enforcement, stake amount, pool ID, lock duration, and coin type
545
+ * @returns Complete transaction ready for signing and execution
546
+ */
547
+ fetchBuildStakeTxV1: (inputs: ApiFarmsStakeBodyV1) => Promise<Transaction>;
548
+ /**
549
+ * Builds a complete transaction for staking coins
550
+ * @param inputs Staking parameters including wallet address, lock enforcement, stake amount, pool ID, lock duration, and coin type
551
+ * @returns Complete transaction ready for signing and execution
552
+ */
553
+ fetchBuildStakeTxV2: (inputs: ApiFarmsStakeBody) => Promise<Transaction>;
554
+ /**
555
+ * @deprecated use fetchBuildDepositPrincipalTxV2 instead
556
+ * Builds a complete transaction for depositing additional principal to a staked position
557
+ * @param inputs Deposit parameters including wallet address, position ID, pool ID, deposit amount, and coin type
558
+ * @returns Complete transaction ready for signing and execution
559
+ */
560
+ fetchBuildDepositPrincipalTxV1: (inputs: ApiFarmsDepositPrincipalBody) => Promise<Transaction>;
561
+ /**
562
+ * Builds a complete transaction for depositing additional principal to a staked position
563
+ * @param inputs Deposit parameters including wallet address, position ID, pool ID, deposit amount, and coin type
564
+ * @returns Complete transaction ready for signing and execution
565
+ */
566
+ fetchBuildDepositPrincipalTxV2: (inputs: ApiFarmsDepositPrincipalBody) => Promise<Transaction>;
567
+ /**
568
+ * @deprecated use fetchBuildWithdrawPrincipalTxV2 instead
569
+ * Builds a complete transaction for withdrawing principal from a staked position
570
+ * @param inputs Withdraw parameters including wallet address, position ID, pool ID, withdraw amount, and coin type
571
+ * @returns Complete transaction ready for signing and execution
572
+ */
573
+ fetchBuildWithdrawPrincipalTxV1: (inputs: {
574
+ stakedPositionId: ObjectId;
575
+ stakingPoolId: ObjectId;
576
+ withdrawAmount: Balance;
577
+ stakeCoinType: CoinType;
578
+ walletAddress: SuiAddress;
579
+ }) => Promise<Transaction>;
580
+ /**
581
+ * Builds a complete transaction for withdrawing principal from a staked position
582
+ * @param inputs Withdraw parameters including wallet address, position ID, pool ID, withdraw amount, and coin type
583
+ * @returns Complete transaction ready for signing and execution
584
+ */
585
+ fetchBuildWithdrawPrincipalTxV2: (inputs: {
175
586
  stakedPositionId: ObjectId;
176
587
  stakingPoolId: ObjectId;
177
588
  withdrawAmount: Balance;
178
589
  stakeCoinType: CoinType;
179
590
  walletAddress: SuiAddress;
180
591
  }) => Promise<Transaction>;
181
- fetchBuildUnstakeTx: (inputs: ApiFarmsUnstakeBody) => Promise<Transaction>;
182
- buildUpdatePositionTx: (inputs: {
592
+ /**
593
+ * @deprecated use fetchBuildUnstakeTxV2 instead
594
+ * Builds a complete transaction for unstaking (withdrawing and destroying a position)
595
+ * @param inputs Unstake parameters including wallet address, position ID, pool ID, reward coin types, and coin type
596
+ * @returns Complete transaction ready for signing and execution
597
+ */
598
+ fetchBuildUnstakeTxV1: (inputs: ApiFarmsUnstakeBody) => Promise<Transaction>;
599
+ /**
600
+ * Builds a complete transaction for unstaking (withdrawing and destroying a position)
601
+ * @param inputs Unstake parameters including wallet address, position ID, pool ID, reward coin types, and coin type
602
+ * @returns Complete transaction ready for signing and execution
603
+ */
604
+ fetchBuildUnstakeTxV2: (inputs: ApiFarmsUnstakeBody) => Promise<Transaction>;
605
+ /**
606
+ * @deprecated use buildUpdatePositionTxV2 instead
607
+ * Builds a transaction for updating a staked position
608
+ * @param parameters for updatePositionTx
609
+ * @returns Complete transaction ready for signing and execution
610
+ */
611
+ buildUpdatePositionTxV1: (inputs: {
183
612
  walletAddress: string;
184
613
  } & Omit<{
185
614
  tx: Transaction;
@@ -187,7 +616,26 @@ export declare class FarmsApi implements MoveErrorsInterface {
187
616
  stakingPoolId: ObjectId;
188
617
  stakeCoinType: CoinType;
189
618
  }, "tx">) => Transaction;
190
- buildLockTx: (inputs: {
619
+ /**
620
+ * Builds a transaction for updating a staked position
621
+ * @param parameters for updatePositionTx
622
+ * @returns Complete transaction ready for signing and execution
623
+ */
624
+ buildUpdatePositionTx2: (inputs: {
625
+ walletAddress: string;
626
+ } & Omit<{
627
+ tx: Transaction;
628
+ stakedPositionId: ObjectId;
629
+ stakingPoolId: ObjectId;
630
+ stakeCoinType: CoinType;
631
+ }, "tx">) => Transaction;
632
+ /**
633
+ * @deprecated use buildLockTxV2 instead
634
+ * Builds a transaction for locking a staked position
635
+ * @param parameters for lockTx
636
+ * @returns Complete transaction ready for signing and execution
637
+ */
638
+ buildLockTxV1: (inputs: {
191
639
  walletAddress: string;
192
640
  } & Omit<{
193
641
  tx: Transaction;
@@ -196,15 +644,27 @@ export declare class FarmsApi implements MoveErrorsInterface {
196
644
  lockDurationMs: Timestamp;
197
645
  stakeCoinType: CoinType;
198
646
  }, "tx">) => Transaction;
199
- buildRenewLockTx: (inputs: {
647
+ /**
648
+ * Builds a transaction for locking a staked position
649
+ * @param parameters for lockTx
650
+ * @returns Complete transaction ready for signing and execution
651
+ */
652
+ buildLockTxV2: (inputs: {
200
653
  walletAddress: string;
201
654
  } & Omit<{
202
655
  tx: Transaction;
203
656
  stakedPositionId: ObjectId;
204
657
  stakingPoolId: ObjectId;
658
+ lockDurationMs: Timestamp;
205
659
  stakeCoinType: CoinType;
206
660
  }, "tx">) => Transaction;
207
- buildUnlockTx: (inputs: {
661
+ /**
662
+ * @deprecated use buildRenewLockTxV2 instead
663
+ * Builds a transaction for renewing the lock on a staked position
664
+ * @param parameters for renewLockTx
665
+ * @returns Complete transaction ready for signing and execution
666
+ */
667
+ buildRenewLockTxV1: (inputs: {
208
668
  walletAddress: string;
209
669
  } & Omit<{
210
670
  tx: Transaction;
@@ -212,12 +672,160 @@ export declare class FarmsApi implements MoveErrorsInterface {
212
672
  stakingPoolId: ObjectId;
213
673
  stakeCoinType: CoinType;
214
674
  }, "tx">) => Transaction;
215
- fetchBuildHarvestRewardsTx: (inputs: ApiHarvestFarmsRewardsBody) => Promise<Transaction>;
216
- fetchBuildCreateStakingPoolTx: (inputs: ApiFarmsCreateStakingPoolBody) => Promise<Transaction>;
217
- fetchBuildInitializeStakingPoolRewardTx: (inputs: ApiFarmsInitializeStakingPoolRewardBody) => Promise<Transaction>;
218
- fetchBuildTopUpStakingPoolRewardsTx: (inputs: ApiFarmsTopUpStakingPoolRewardsBody) => Promise<Transaction>;
219
- fetchIncreaseStakingPoolRewardsEmissionsTx: (inputs: ApiFarmsIncreaseStakingPoolRewardsEmissionsBody) => Transaction;
220
- buildGrantOneTimeAdminCapTx: (inputs: {
675
+ /**
676
+ * Builds a transaction for renewing the lock on a staked position
677
+ * @param parameters for renewLockTx
678
+ * @returns Complete transaction ready for signing and execution
679
+ */
680
+ buildRenewLockTxV2: (inputs: {
681
+ walletAddress: string;
682
+ } & Omit<{
683
+ tx: Transaction;
684
+ stakedPositionId: ObjectId;
685
+ stakingPoolId: ObjectId;
686
+ stakeCoinType: CoinType;
687
+ }, "tx">) => Transaction;
688
+ /**
689
+ * @deprecated use buildUnlockTxV2 instead
690
+ * Builds a transaction for unlocking a staked position
691
+ * @param parameters for unlockTx
692
+ * @returns Complete transaction ready for signing and execution
693
+ */
694
+ buildUnlockTxV1: (inputs: {
695
+ walletAddress: string;
696
+ } & Omit<{
697
+ tx: Transaction;
698
+ stakedPositionId: ObjectId;
699
+ stakingPoolId: ObjectId;
700
+ stakeCoinType: CoinType;
701
+ }, "tx">) => Transaction;
702
+ /**
703
+ * Builds a transaction for unlocking a staked position
704
+ * @param parameters for unlockTx
705
+ * @returns Complete transaction ready for signing and execution
706
+ */
707
+ buildUnlockTxV2: (inputs: {
708
+ walletAddress: string;
709
+ } & Omit<{
710
+ tx: Transaction;
711
+ stakedPositionId: ObjectId;
712
+ stakingPoolId: ObjectId;
713
+ stakeCoinType: CoinType;
714
+ }, "tx">) => Transaction;
715
+ /**
716
+ * @deprecated use fetchBuildHarvestRewardsTxV2 instead
717
+ * Builds a complete transaction for harvesting rewards from staked positions
718
+ * @param inputs Harvest parameters including wallet address, position IDs, pool ID, reward coin types, and optional claim as AfSui flag
719
+ * @returns Complete transaction ready for signing and execution
720
+ */
721
+ fetchBuildHarvestRewardsTxV1: (inputs: ApiHarvestFarmsRewardsBody) => Promise<Transaction>;
722
+ /**
723
+ * Builds a complete transaction for harvesting rewards from staked positions
724
+ * @param inputs Harvest parameters including wallet address, position IDs, pool ID, reward coin types, and optional claim as AfSui flag
725
+ * @returns Complete transaction ready for signing and execution
726
+ */
727
+ fetchBuildHarvestRewardsTxV2: (inputs: ApiHarvestFarmsRewardsBody) => Promise<Transaction>;
728
+ /**
729
+ * @deprecated use fetchBuildCreateStakingPoolTxV2 instead
730
+ * Builds a complete transaction for creating a new staking pool
731
+ * @param inputs Pool creation parameters including wallet address, lock enforcements, durations, multiplier, stake amount, and coin type
732
+ * @returns Complete transaction ready for signing and execution
733
+ */
734
+ fetchBuildCreateStakingPoolTxV1: (inputs: ApiFarmsCreateStakingPoolBodyV1) => Promise<Transaction>;
735
+ /**
736
+ * Builds a complete transaction for creating a new staking pool
737
+ * @param inputs Pool creation parameters including wallet address, lock enforcements, durations, multiplier, stake amount, and coin type
738
+ * @returns Complete transaction ready for signing and execution
739
+ */
740
+ fetchBuildCreateStakingPoolTxV2: (inputs: ApiFarmsCreateStakingPoolBody) => Promise<Transaction>;
741
+ /**
742
+ * @deprecated use fetchBuildInitializeStakingPoolRewardTxV2 instead
743
+ * Builds a complete transaction for initializing rewards for a staking pool
744
+ * @param inputs Initialize rewards parameters including wallet address, owner cap ID, pool ID, reward amount, emission parameters, stake coin type, and reward coin type
745
+ * @returns Complete transaction ready for signing and execution
746
+ */
747
+ fetchBuildInitializeStakingPoolRewardTxV1: (inputs: ApiFarmsInitializeStakingPoolRewardBody) => Promise<Transaction>;
748
+ /**
749
+ * Builds a complete transaction for initializing rewards for a staking pool
750
+ * @param inputs Initialize rewards parameters including wallet address, owner cap ID, pool ID, reward amount, emission parameters, stake coin type, and reward coin type
751
+ * @returns Complete transaction ready for signing and execution
752
+ */
753
+ fetchBuildInitializeStakingPoolRewardTxV2: (inputs: ApiFarmsInitializeStakingPoolRewardBody) => Promise<Transaction>;
754
+ /**
755
+ * @deprecated use fetchBuildTopUpStakingPoolRewardsTxV2 instead
756
+ * Builds a complete transaction for adding more rewards to a staking pool
757
+ * @param inputs Top up rewards parameters including wallet address, owner cap ID, pool ID, rewards array with amounts and coin types, and stake coin type
758
+ * @returns Complete transaction ready for signing and execution
759
+ */
760
+ fetchBuildTopUpStakingPoolRewardsTxV1: (inputs: ApiFarmsTopUpStakingPoolRewardsBody) => Promise<Transaction>;
761
+ /**
762
+ * Builds a complete transaction for adding more rewards to a staking pool
763
+ * @param inputs Top up rewards parameters including wallet address, owner cap ID, pool ID, rewards array with amounts and coin types, and stake coin type
764
+ * @returns Complete transaction ready for signing and execution
765
+ */
766
+ fetchBuildTopUpStakingPoolRewardsTxV2: (inputs: ApiFarmsTopUpStakingPoolRewardsBody) => Promise<Transaction>;
767
+ /**
768
+ * @deprecated use fetchIncreaseStakingPoolRewardsEmissionsTxV2 instead
769
+ * Builds a complete transaction for increasing the emission rate of rewards for a staking pool
770
+ * @param inputs Increase emissions parameters including wallet address, owner cap ID, pool ID, rewards array with emission parameters and coin types, and stake coin type
771
+ * @returns Complete transaction ready for signing and execution
772
+ */
773
+ fetchIncreaseStakingPoolRewardsEmissionsTxV1: (inputs: ApiFarmsIncreaseStakingPoolRewardsEmissionsBody) => Transaction;
774
+ /**
775
+ * Builds a complete transaction for increasing the emission rate of rewards for a staking pool
776
+ * @param inputs Increase emissions parameters including wallet address, owner cap ID, pool ID, rewards array with emission parameters and coin types, and stake coin type
777
+ * @returns Complete transaction ready for signing and execution
778
+ */
779
+ fetchIncreaseStakingPoolRewardsEmissionsTxV2: (inputs: ApiFarmsIncreaseStakingPoolRewardsEmissionsBody) => Transaction;
780
+ /**
781
+ * @deprecated use buildSetStakingPoolMinStakeAmountTxV2 instead
782
+ * Builds a transaction for setting the minimum stake amount for a staking pool
783
+ * @param parameters for setStakingPoolMinStakeAmountTx
784
+ * @returns Complete transaction ready for signing and execution
785
+ */
786
+ buildSetStakingPoolMinStakeAmountTxV1: (inputs: {
787
+ walletAddress: string;
788
+ } & Omit<{
789
+ tx: Transaction;
790
+ ownerCapId: ObjectId;
791
+ stakingPoolId: ObjectId;
792
+ minStakeAmount: bigint;
793
+ stakeCoinType: CoinType;
794
+ }, "tx">) => Transaction;
795
+ /**
796
+ * Builds a transaction for setting the minimum stake amount for a staking pool
797
+ * @param parameters for setStakingPoolMinStakeAmountTx
798
+ * @returns Complete transaction ready for signing and execution
799
+ */
800
+ buildSetStakingPoolMinStakeAmountTxV2: (inputs: {
801
+ walletAddress: string;
802
+ } & Omit<{
803
+ tx: Transaction;
804
+ ownerCapId: ObjectId;
805
+ stakingPoolId: ObjectId;
806
+ minStakeAmount: bigint;
807
+ stakeCoinType: CoinType;
808
+ }, "tx">) => Transaction;
809
+ /**
810
+ * @deprecated use buildGrantOneTimeAdminCapTxV2 instead
811
+ * Builds a transaction for granting a one-time admin capability for a staking pool
812
+ * @param parameters for grantOneTimeAdminCapTx
813
+ * @returns Complete transaction ready for signing and execution
814
+ */
815
+ buildGrantOneTimeAdminCapTxV1: (inputs: {
816
+ walletAddress: string;
817
+ } & Omit<{
818
+ tx: Transaction;
819
+ ownerCapId: ObjectId | TransactionArgument;
820
+ recipientAddress: SuiAddress;
821
+ rewardCoinType: CoinType;
822
+ }, "tx">) => Transaction;
823
+ /**
824
+ * Builds a transaction for granting a one-time admin capability for a staking pool
825
+ * @param parameters for grantOneTimeAdminCapTx
826
+ * @returns Complete transaction ready for signing and execution
827
+ */
828
+ buildGrantOneTimeAdminCapTxV2: (inputs: {
221
829
  walletAddress: string;
222
830
  } & Omit<{
223
831
  tx: Transaction;
@@ -225,19 +833,78 @@ export declare class FarmsApi implements MoveErrorsInterface {
225
833
  recipientAddress: SuiAddress;
226
834
  rewardCoinType: CoinType;
227
835
  }, "tx">) => Transaction;
836
+ private eventWrapperType;
837
+ /**
838
+ * Creates the event type for vault creation events
839
+ * @returns Fully qualified event type string
840
+ */
228
841
  private createdVaultEventType;
842
+ /**
843
+ * Creates the event type for reward initialization events
844
+ * @returns Fully qualified event type string
845
+ */
229
846
  private initializedRewardEventType;
847
+ /**
848
+ * Creates the event type for reward addition events
849
+ * @returns Fully qualified event type string
850
+ */
230
851
  private addedRewardEventType;
852
+ /**
853
+ * Creates the event type for emission increase events
854
+ * @returns Fully qualified event type string
855
+ */
231
856
  private increasedEmissionsEventType;
857
+ /**
858
+ * Creates the event type for emission update events
859
+ * @returns Fully qualified event type string
860
+ */
861
+ private updatedEmissionsEventType;
862
+ /**
863
+ * Creates the event type for strict staking events
864
+ * @returns Fully qualified event type string
865
+ */
232
866
  private stakedEventType;
867
+ /**
868
+ * Creates the event type for relaxed staking events
869
+ * @returns Fully qualified event type string
870
+ */
233
871
  private stakedRelaxedEventType;
872
+ /**
873
+ * Creates the event type for position locking events
874
+ * @returns Fully qualified event type string
875
+ */
234
876
  private lockedEventType;
877
+ /**
878
+ * Creates the event type for position unlocking events
879
+ * @returns Fully qualified event type string
880
+ */
235
881
  private unlockedEventType;
882
+ /**
883
+ * Creates the event type for principal deposit events
884
+ * @returns Fully qualified event type string
885
+ */
236
886
  private depositedPrincipalEventType;
887
+ /**
888
+ * Creates the event type for principal withdrawal events
889
+ * @returns Fully qualified event type string
890
+ */
237
891
  private withdrewPrincipalEventType;
892
+ /**
893
+ * Creates the event type for reward harvesting events
894
+ * @returns Fully qualified event type string
895
+ */
238
896
  private harvestedRewardsEventType;
239
- private static isFarmOwnerCapId;
897
+ /**
898
+ * Checks if the input contains a one-time admin cap ID
899
+ * @param inputs FarmOwnerOrOneTimeAdminCap object
900
+ * @returns True if the input contains a one-time admin cap ID
901
+ */
240
902
  private static isFarmOneTimeAdminCapId;
903
+ /**
904
+ * Gets the appropriate cap ID from the input
905
+ * @param inputs FarmOwnerOrOneTimeAdminCap object
906
+ * @returns Either the owner cap ID or one-time admin cap ID
907
+ */
241
908
  private static farmCapId;
242
909
  }
243
910
  //# sourceMappingURL=farmsApi.d.ts.map