aftermath-ts-sdk 1.2.63 → 1.2.64-docs.1
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.
- package/README.md +61 -27
- package/dist/general/dynamicGas/dynamicGas.d.ts +34 -0
- package/dist/general/dynamicGas/dynamicGas.d.ts.map +1 -1
- package/dist/general/dynamicGas/dynamicGas.js +34 -0
- package/dist/general/dynamicGas/dynamicGasTypes.d.ts +25 -0
- package/dist/general/dynamicGas/dynamicGasTypes.d.ts.map +1 -1
- package/dist/general/prices/prices.d.ts +73 -0
- package/dist/general/prices/prices.d.ts.map +1 -1
- package/dist/general/prices/prices.js +73 -0
- package/dist/general/providers/aftermath.d.ts +106 -25
- package/dist/general/providers/aftermath.d.ts.map +1 -1
- package/dist/general/providers/aftermath.js +108 -27
- package/dist/general/providers/aftermathApi.d.ts +127 -8
- package/dist/general/providers/aftermathApi.d.ts.map +1 -1
- package/dist/general/providers/aftermathApi.js +132 -12
- package/dist/general/types/castingTypes.d.ts +0 -7
- package/dist/general/types/castingTypes.d.ts.map +1 -1
- package/dist/general/types/castingTypes.js +6 -0
- package/dist/general/types/generalTypes.d.ts +228 -7
- package/dist/general/types/generalTypes.d.ts.map +1 -1
- package/dist/general/types/suiTypes.d.ts +0 -16
- package/dist/general/types/suiTypes.d.ts.map +1 -1
- package/dist/general/types/suiTypes.js +3 -25
- package/dist/general/utils/casting.d.ts +159 -3
- package/dist/general/utils/casting.d.ts.map +1 -1
- package/dist/general/utils/casting.js +162 -16
- package/dist/general/utils/fixedUtils.d.ts +89 -2
- package/dist/general/utils/fixedUtils.d.ts.map +1 -1
- package/dist/general/utils/fixedUtils.js +81 -4
- package/dist/general/utils/helpers.d.ts +320 -9
- package/dist/general/utils/helpers.d.ts.map +1 -1
- package/dist/general/utils/helpers.js +350 -89
- package/dist/general/utils/iFixedUtils.d.ts +64 -0
- package/dist/general/utils/iFixedUtils.d.ts.map +1 -1
- package/dist/general/utils/iFixedUtils.js +64 -0
- package/dist/general/wallet/wallet.d.ts +75 -0
- package/dist/general/wallet/wallet.d.ts.map +1 -1
- package/dist/general/wallet/wallet.js +75 -5
- package/dist/packages/auth/auth.d.ts +113 -0
- package/dist/packages/auth/auth.d.ts.map +1 -1
- package/dist/packages/auth/auth.js +129 -15
- package/dist/packages/auth/authTypes.d.ts +66 -0
- package/dist/packages/auth/authTypes.d.ts.map +1 -1
- package/dist/packages/coin/api/coinApi.d.ts.map +1 -1
- package/dist/packages/coin/api/coinApi.js +28 -20
- package/dist/packages/coin/coin.d.ts +250 -0
- package/dist/packages/coin/coin.d.ts.map +1 -1
- package/dist/packages/coin/coin.js +238 -14
- package/dist/packages/coin/coinTypes.d.ts +93 -0
- package/dist/packages/coin/coinTypes.d.ts.map +1 -1
- package/dist/packages/dca/dca.d.ts +124 -35
- package/dist/packages/dca/dca.d.ts.map +1 -1
- package/dist/packages/dca/dca.js +127 -37
- package/dist/packages/dca/dcaTypes.d.ts +213 -28
- package/dist/packages/dca/dcaTypes.d.ts.map +1 -1
- package/dist/packages/farms/farms.d.ts +184 -1
- package/dist/packages/farms/farms.d.ts.map +1 -1
- package/dist/packages/farms/farms.js +185 -11
- package/dist/packages/farms/farmsStakedPosition.d.ts +140 -6
- package/dist/packages/farms/farmsStakedPosition.d.ts.map +1 -1
- package/dist/packages/farms/farmsStakedPosition.js +189 -144
- package/dist/packages/farms/farmsStakingPool.d.ts +161 -1
- package/dist/packages/farms/farmsStakingPool.d.ts.map +1 -1
- package/dist/packages/farms/farmsStakingPool.js +176 -70
- package/dist/packages/farms/farmsTypes.d.ts +283 -2
- package/dist/packages/farms/farmsTypes.d.ts.map +1 -1
- package/dist/packages/farms/farmsTypes.js +18 -0
- package/dist/packages/limitOrders/limitOrders.d.ts +108 -21
- package/dist/packages/limitOrders/limitOrders.d.ts.map +1 -1
- package/dist/packages/limitOrders/limitOrders.js +110 -22
- package/dist/packages/limitOrders/limitOrdersTypes.d.ts +142 -0
- package/dist/packages/limitOrders/limitOrdersTypes.d.ts.map +1 -1
- package/dist/packages/multisig/multisig.d.ts +33 -4
- package/dist/packages/multisig/multisig.d.ts.map +1 -1
- package/dist/packages/multisig/multisig.js +33 -4
- package/dist/packages/multisig/multisigTypes.d.ts +17 -0
- package/dist/packages/multisig/multisigTypes.d.ts.map +1 -1
- package/dist/packages/perpetuals/api/perpetualsApi.d.ts.map +1 -1
- package/dist/packages/pools/pool.d.ts +327 -85
- package/dist/packages/pools/pool.d.ts.map +1 -1
- package/dist/packages/pools/pool.js +333 -91
- package/dist/packages/pools/pools.d.ts +299 -37
- package/dist/packages/pools/pools.d.ts.map +1 -1
- package/dist/packages/pools/pools.js +306 -52
- package/dist/packages/pools/poolsTypes.d.ts +267 -2
- package/dist/packages/pools/poolsTypes.d.ts.map +1 -1
- package/dist/packages/referralVault/referralVault.d.ts +37 -0
- package/dist/packages/referralVault/referralVault.d.ts.map +1 -1
- package/dist/packages/referralVault/referralVault.js +37 -0
- package/dist/packages/router/router.d.ts +213 -17
- package/dist/packages/router/router.d.ts.map +1 -1
- package/dist/packages/router/router.js +214 -18
- package/dist/packages/router/routerTypes.d.ts +198 -14
- package/dist/packages/router/routerTypes.d.ts.map +1 -1
- package/dist/packages/staking/staking.d.ts +301 -43
- package/dist/packages/staking/staking.d.ts.map +1 -1
- package/dist/packages/staking/staking.js +308 -51
- package/dist/packages/staking/stakingTypes.d.ts +426 -6
- package/dist/packages/staking/stakingTypes.d.ts.map +1 -1
- package/dist/packages/staking/stakingTypes.js +19 -0
- package/dist/packages/sui/sui.d.ts +39 -0
- package/dist/packages/sui/sui.d.ts.map +1 -1
- package/dist/packages/sui/sui.js +39 -0
- package/dist/packages/userData/userData.d.ts +66 -12
- package/dist/packages/userData/userData.d.ts.map +1 -1
- package/dist/packages/userData/userData.js +66 -12
- package/dist/packages/userData/userDataTypes.d.ts +19 -0
- package/dist/packages/userData/userDataTypes.d.ts.map +1 -1
- package/dist/types.d.ts.map +1 -1
- package/dist/types.js +0 -1
- package/package.json +1 -1
- package/dist/general/historicalData/historicalData.d.ts +0 -15
- package/dist/general/historicalData/historicalData.d.ts.map +0 -1
- package/dist/general/historicalData/historicalData.js +0 -45
- package/dist/general/historicalData/historicalDataTypes.d.ts +0 -10
- package/dist/general/historicalData/historicalDataTypes.d.ts.map +0 -1
- package/dist/general/historicalData/historicalDataTypes.js +0 -2
|
@@ -1,79 +1,269 @@
|
|
|
1
1
|
import { ObjectId, SuiAddress } from "../../types";
|
|
2
2
|
import { Balance, Event, Object, Timestamp } from "../../general/types/generalTypes";
|
|
3
3
|
import { CoinType } from "../coin/coinTypes";
|
|
4
|
+
/**
|
|
5
|
+
* A multiplier type (in fixed-point bigint) used to scale a staked amount based on lock duration.
|
|
6
|
+
* Typically, 1.0 is represented as 1e9 (i.e., `FixedUtils.fixedOneB`).
|
|
7
|
+
*/
|
|
4
8
|
export type FarmsMultiplier = bigint;
|
|
9
|
+
/**
|
|
10
|
+
* Enumerates the supported farm system versions.
|
|
11
|
+
*/
|
|
5
12
|
export type FarmsVersion = 1 | 2;
|
|
13
|
+
/**
|
|
14
|
+
* A union type indicating whether an action is authorized by the `ownerCapId`
|
|
15
|
+
* or by a `oneTimeAdminCapId`.
|
|
16
|
+
*/
|
|
6
17
|
export type FarmOwnerOrOneTimeAdminCap = {
|
|
7
18
|
ownerCapId: ObjectId;
|
|
8
19
|
} | {
|
|
9
20
|
oneTimeAdminCapId: ObjectId;
|
|
10
21
|
};
|
|
22
|
+
/**
|
|
23
|
+
* Indicates how strictly the lock duration is enforced in the vault.
|
|
24
|
+
* - **Strict**: The position cannot be unlocked before the lock period ends.
|
|
25
|
+
* - **Relaxed**: The position can be unlocked early, but may have penalized rewards.
|
|
26
|
+
*/
|
|
11
27
|
export type FarmsLockEnforcement = "Strict" | "Relaxed";
|
|
28
|
+
/**
|
|
29
|
+
* Describes a single reward coin's parameters and state within a staking pool.
|
|
30
|
+
*/
|
|
12
31
|
export interface FarmsStakingPoolRewardCoin {
|
|
32
|
+
/**
|
|
33
|
+
* The coin type of this reward (e.g., "0x2::sui::SUI").
|
|
34
|
+
*/
|
|
13
35
|
coinType: CoinType;
|
|
36
|
+
/**
|
|
37
|
+
* The total number of reward tokens allocated for this pool (in smallest units).
|
|
38
|
+
*/
|
|
14
39
|
rewards: Balance;
|
|
40
|
+
/**
|
|
41
|
+
* Represents how many rewards are allocated per share in the pool. The share
|
|
42
|
+
* is typically the "stakedAmountWithMultiplier".
|
|
43
|
+
*/
|
|
15
44
|
rewardsAccumulatedPerShare: Balance;
|
|
45
|
+
/**
|
|
46
|
+
* The emission rate per emission schedule for this reward coin. For example, if
|
|
47
|
+
* `emissionSchedulesMs` is 1 hour, then this emissionRate is distributed each hour.
|
|
48
|
+
*/
|
|
16
49
|
emissionRate: Balance;
|
|
50
|
+
/**
|
|
51
|
+
* The interval (in ms) at which the emissionRate is released.
|
|
52
|
+
*/
|
|
17
53
|
emissionSchedulesMs: Timestamp;
|
|
54
|
+
/**
|
|
55
|
+
* The timestamp (ms) when emission for this reward coin starts.
|
|
56
|
+
*/
|
|
18
57
|
emissionStartTimestamp: Timestamp;
|
|
58
|
+
/**
|
|
59
|
+
* The last timestamp (ms) at which rewards were emitted for this reward coin.
|
|
60
|
+
*/
|
|
19
61
|
lastRewardTimestamp: Timestamp;
|
|
62
|
+
/**
|
|
63
|
+
* The total number of rewards still available. If we have distributed
|
|
64
|
+
* part of `rewards`, the remainder is `rewardsRemaining`.
|
|
65
|
+
*/
|
|
20
66
|
rewardsRemaining: Balance;
|
|
67
|
+
/**
|
|
68
|
+
* The actual number of reward tokens in the pool's on-chain object. This can differ
|
|
69
|
+
* from `rewards` for internal or reserved logic.
|
|
70
|
+
*/
|
|
21
71
|
actualRewards: Balance;
|
|
22
72
|
}
|
|
73
|
+
/**
|
|
74
|
+
* Represents the core object for a staking pool (a "vault"). It includes
|
|
75
|
+
* information about staking amounts, locking constraints, reward coins,
|
|
76
|
+
* and emission parameters.
|
|
77
|
+
*/
|
|
23
78
|
export interface FarmsStakingPoolObject extends Object {
|
|
79
|
+
/**
|
|
80
|
+
* The coin type that users stake into this pool.
|
|
81
|
+
*/
|
|
24
82
|
stakeCoinType: CoinType;
|
|
83
|
+
/**
|
|
84
|
+
* The total amount of staked tokens (principal) in this pool, in smallest units.
|
|
85
|
+
*/
|
|
25
86
|
stakedAmount: Balance;
|
|
87
|
+
/**
|
|
88
|
+
* The total staked amount multiplied by users' lock multipliers. Used for reward calculations.
|
|
89
|
+
*/
|
|
26
90
|
stakedAmountWithMultiplier: Balance;
|
|
91
|
+
/**
|
|
92
|
+
* The minimum time (ms) that a position can be locked for a valid multiplier.
|
|
93
|
+
*/
|
|
27
94
|
minLockDurationMs: Timestamp;
|
|
95
|
+
/**
|
|
96
|
+
* The maximum time (ms) that a position can be locked. The position's lock multiplier is derived from
|
|
97
|
+
* minLockDurationMs to maxLockDurationMs.
|
|
98
|
+
*/
|
|
28
99
|
maxLockDurationMs: Timestamp;
|
|
100
|
+
/**
|
|
101
|
+
* The maximum lock multiplier in fixed-point representation (1.0 = 1e9).
|
|
102
|
+
*/
|
|
29
103
|
maxLockMultiplier: FarmsMultiplier;
|
|
104
|
+
/**
|
|
105
|
+
* An array of reward coins that this pool distributes.
|
|
106
|
+
*/
|
|
30
107
|
rewardCoins: FarmsStakingPoolRewardCoin[];
|
|
108
|
+
/**
|
|
109
|
+
* The timestamp (ms) after which no further emissions occur.
|
|
110
|
+
*/
|
|
31
111
|
emissionEndTimestamp: Timestamp;
|
|
112
|
+
/**
|
|
113
|
+
* The minimum stake required to open a position in this pool.
|
|
114
|
+
*/
|
|
32
115
|
minStakeAmount: Balance;
|
|
116
|
+
/**
|
|
117
|
+
* Whether the pool is forcibly unlocked. If `true`, positions might be able to exit early.
|
|
118
|
+
*/
|
|
33
119
|
isUnlocked: boolean;
|
|
120
|
+
/**
|
|
121
|
+
* Indicates whether this is version 1 or version 2 of the farm system.
|
|
122
|
+
*/
|
|
34
123
|
version: FarmsVersion;
|
|
35
124
|
}
|
|
125
|
+
/**
|
|
126
|
+
* Represents the owner's capability to manage a specific staking pool. Typically
|
|
127
|
+
* allows updating emission rates, reward coins, or other parameters.
|
|
128
|
+
*/
|
|
36
129
|
export interface StakingPoolOwnerCapObject extends Object {
|
|
130
|
+
/**
|
|
131
|
+
* The staking pool (vault) ID associated with this owner cap.
|
|
132
|
+
*/
|
|
37
133
|
stakingPoolId: ObjectId;
|
|
38
134
|
}
|
|
135
|
+
/**
|
|
136
|
+
* Represents a one-time admin capability object for a specific staking pool. Allows
|
|
137
|
+
* the holder to initialize a new reward coin once.
|
|
138
|
+
*/
|
|
39
139
|
export interface StakingPoolOneTimeAdminCapObject extends Object {
|
|
140
|
+
/**
|
|
141
|
+
* The staking pool (vault) ID associated with this admin cap.
|
|
142
|
+
*/
|
|
40
143
|
stakingPoolId: ObjectId;
|
|
41
144
|
}
|
|
145
|
+
/**
|
|
146
|
+
* Represents the rewards accumulated and owed to a staked position for a specific coin type.
|
|
147
|
+
*/
|
|
42
148
|
export interface FarmsStakedPositionRewardCoin {
|
|
149
|
+
/**
|
|
150
|
+
* The coin type of the reward.
|
|
151
|
+
*/
|
|
43
152
|
coinType: CoinType;
|
|
153
|
+
/**
|
|
154
|
+
* The base (non-multiplied) rewards accrued since the position was opened or last updated.
|
|
155
|
+
*/
|
|
44
156
|
baseRewardsAccumulated: Balance;
|
|
157
|
+
/**
|
|
158
|
+
* The base rewards debt, representing the total base rewards from time t0 to the last update checkpoint.
|
|
159
|
+
*/
|
|
45
160
|
baseRewardsDebt: Balance;
|
|
161
|
+
/**
|
|
162
|
+
* The multiplier-based rewards accrued, factoring in the lock multiplier, since the position was opened or last updated.
|
|
163
|
+
*/
|
|
46
164
|
multiplierRewardsAccumulated: Balance;
|
|
165
|
+
/**
|
|
166
|
+
* The multiplier-based rewards debt, from time t0 to the last update checkpoint.
|
|
167
|
+
*/
|
|
47
168
|
multiplierRewardsDebt: Balance;
|
|
48
169
|
}
|
|
170
|
+
/**
|
|
171
|
+
* Represents a user's staked position in a specific staking pool, including
|
|
172
|
+
* the lock parameters, staked amounts, and accumulated rewards.
|
|
173
|
+
*/
|
|
49
174
|
export interface FarmsStakedPositionObject extends Object {
|
|
175
|
+
/**
|
|
176
|
+
* The on-chain object ID of the pool in which this position is staked.
|
|
177
|
+
*/
|
|
50
178
|
stakingPoolObjectId: ObjectId;
|
|
179
|
+
/**
|
|
180
|
+
* The coin type that was staked into this position (matching the pool's stakeCoinType).
|
|
181
|
+
*/
|
|
51
182
|
stakeCoinType: CoinType;
|
|
183
|
+
/**
|
|
184
|
+
* The amount of principal staked in smallest units.
|
|
185
|
+
*/
|
|
52
186
|
stakedAmount: Balance;
|
|
187
|
+
/**
|
|
188
|
+
* The principal multiplied by the lock multiplier.
|
|
189
|
+
*/
|
|
53
190
|
stakedAmountWithMultiplier: Balance;
|
|
191
|
+
/**
|
|
192
|
+
* The timestamp (ms) when this position’s lock started.
|
|
193
|
+
*/
|
|
54
194
|
lockStartTimestamp: Timestamp;
|
|
195
|
+
/**
|
|
196
|
+
* The duration (ms) for which this position is locked.
|
|
197
|
+
*/
|
|
55
198
|
lockDurationMs: Timestamp;
|
|
199
|
+
/**
|
|
200
|
+
* The current lock multiplier in fixed-point representation.
|
|
201
|
+
*/
|
|
56
202
|
lockMultiplier: FarmsMultiplier;
|
|
203
|
+
/**
|
|
204
|
+
* An array of reward coins that track base + multiplier rewards for this position.
|
|
205
|
+
*/
|
|
57
206
|
rewardCoins: FarmsStakedPositionRewardCoin[];
|
|
207
|
+
/**
|
|
208
|
+
* The last time (ms) that rewards were updated or harvested for this position.
|
|
209
|
+
*/
|
|
58
210
|
lastHarvestRewardsTimestamp: Timestamp;
|
|
211
|
+
/**
|
|
212
|
+
* The farm system version of this staked position (1 or 2).
|
|
213
|
+
*/
|
|
59
214
|
version: FarmsVersion;
|
|
60
215
|
}
|
|
216
|
+
/**
|
|
217
|
+
* A partial staked position structure sometimes used internally, excluding
|
|
218
|
+
* certain fields like `coinType`.
|
|
219
|
+
*/
|
|
61
220
|
export type PartialFarmsStakedPositionObject = Omit<FarmsStakedPositionObject, "rewardCoins"> & {
|
|
62
221
|
rewardCoins: Omit<FarmsStakedPositionRewardCoin, "coinType">[];
|
|
63
222
|
};
|
|
223
|
+
/**
|
|
224
|
+
* A union type representing any possible event from a farm (vault) system.
|
|
225
|
+
*/
|
|
64
226
|
export type FarmEvent = FarmsAddedRewardEvent | FarmsCreatedVaultEvent | FarmsDepositedPrincipalEvent | FarmsDestroyedStakedPositionEvent | FarmsHarvestedRewardsEvent | FarmsIncreasedEmissionsEvent | FarmsInitializedRewardEvent | FarmsJoinedEvent | FarmsLockedEvent | FarmsSplitEvent | FarmsStakedEvent | FarmsStakedRelaxedEvent | FarmsUnlockedEvent | FarmsWithdrewPrincipalEvent;
|
|
227
|
+
/**
|
|
228
|
+
* A union type for events that specifically involve user interactions with a farm,
|
|
229
|
+
* such as depositing principal, harvesting, or unlocking.
|
|
230
|
+
*/
|
|
65
231
|
export type FarmUserEvent = FarmsDepositedPrincipalEvent | FarmsHarvestedRewardsEvent | FarmsLockedEvent | FarmsStakedEvent | FarmsUnlockedEvent | FarmsWithdrewPrincipalEvent;
|
|
232
|
+
/**
|
|
233
|
+
* Type guard to determine if a `FarmUserEvent` is a `FarmsDepositedPrincipalEvent`.
|
|
234
|
+
*/
|
|
66
235
|
export declare const isFarmsDepositedPrincipalEvent: (event: FarmUserEvent) => event is FarmsDepositedPrincipalEvent;
|
|
236
|
+
/**
|
|
237
|
+
* Type guard to determine if a `FarmUserEvent` is a `FarmsHarvestedRewardsEvent`.
|
|
238
|
+
*/
|
|
67
239
|
export declare const isFarmsHarvestedRewardsEvent: (event: FarmUserEvent) => event is FarmsHarvestedRewardsEvent;
|
|
240
|
+
/**
|
|
241
|
+
* Type guard to determine if a `FarmUserEvent` is a `FarmsLockedEvent`.
|
|
242
|
+
*/
|
|
68
243
|
export declare const isFarmsLockedEvent: (event: FarmUserEvent) => event is FarmsLockedEvent;
|
|
244
|
+
/**
|
|
245
|
+
* Type guard to determine if a `FarmUserEvent` is a `FarmsStakedEvent`.
|
|
246
|
+
*/
|
|
69
247
|
export declare const isFarmsStakedEvent: (event: FarmUserEvent) => event is FarmsStakedEvent;
|
|
248
|
+
/**
|
|
249
|
+
* Type guard to determine if a `FarmUserEvent` is a `FarmsUnlockedEvent`.
|
|
250
|
+
*/
|
|
70
251
|
export declare const isFarmsUnlockedEvent: (event: FarmUserEvent) => event is FarmsUnlockedEvent;
|
|
252
|
+
/**
|
|
253
|
+
* Type guard to determine if a `FarmUserEvent` is a `FarmsWithdrewPrincipalEvent`.
|
|
254
|
+
*/
|
|
71
255
|
export declare const isFarmsWithdrewPrincipalEvent: (event: FarmUserEvent) => event is FarmsWithdrewPrincipalEvent;
|
|
256
|
+
/**
|
|
257
|
+
* Fired when additional reward tokens are added to a vault after creation.
|
|
258
|
+
*/
|
|
72
259
|
export interface FarmsAddedRewardEvent extends Event {
|
|
73
260
|
vaultId: ObjectId;
|
|
74
261
|
rewardType: CoinType;
|
|
75
262
|
rewardAmount: Balance;
|
|
76
263
|
}
|
|
264
|
+
/**
|
|
265
|
+
* Fired when a new vault (staking pool) is created.
|
|
266
|
+
*/
|
|
77
267
|
export interface FarmsCreatedVaultEvent extends Event {
|
|
78
268
|
vaultId: ObjectId;
|
|
79
269
|
stakeType: CoinType;
|
|
@@ -82,26 +272,41 @@ export interface FarmsCreatedVaultEvent extends Event {
|
|
|
82
272
|
maxLockMultiplier: FarmsMultiplier;
|
|
83
273
|
minStakeAmount: Balance;
|
|
84
274
|
}
|
|
275
|
+
/**
|
|
276
|
+
* Fired when principal is deposited into a staked position in the vault.
|
|
277
|
+
*/
|
|
85
278
|
export interface FarmsDepositedPrincipalEvent extends Event {
|
|
86
279
|
stakedPositionId: ObjectId;
|
|
87
280
|
vaultId: ObjectId;
|
|
88
281
|
amount: Balance;
|
|
89
282
|
stakeType: CoinType;
|
|
90
283
|
}
|
|
284
|
+
/**
|
|
285
|
+
* Fired when a staked position object is destroyed.
|
|
286
|
+
*/
|
|
91
287
|
export interface FarmsDestroyedStakedPositionEvent extends Event {
|
|
92
288
|
stakedPositionId: ObjectId;
|
|
93
289
|
}
|
|
290
|
+
/**
|
|
291
|
+
* Fired when a user harvests their rewards from one or more staked positions.
|
|
292
|
+
*/
|
|
94
293
|
export interface FarmsHarvestedRewardsEvent extends Event {
|
|
95
294
|
vaultId: ObjectId;
|
|
96
295
|
rewardTypes: CoinType[];
|
|
97
296
|
rewardAmounts: Balance[];
|
|
98
297
|
}
|
|
298
|
+
/**
|
|
299
|
+
* Fired when emissions (or the emission schedule) are increased for a specific reward coin.
|
|
300
|
+
*/
|
|
99
301
|
export interface FarmsIncreasedEmissionsEvent extends Event {
|
|
100
302
|
vaultId: ObjectId;
|
|
101
303
|
rewardType: CoinType;
|
|
102
304
|
emissionScheduleMs: Timestamp;
|
|
103
305
|
emissionRate: Balance;
|
|
104
306
|
}
|
|
307
|
+
/**
|
|
308
|
+
* Fired when a new reward coin is initialized in the vault.
|
|
309
|
+
*/
|
|
105
310
|
export interface FarmsInitializedRewardEvent extends Event {
|
|
106
311
|
vaultId: ObjectId;
|
|
107
312
|
rewardType: CoinType;
|
|
@@ -109,10 +314,16 @@ export interface FarmsInitializedRewardEvent extends Event {
|
|
|
109
314
|
emissionRate: Balance;
|
|
110
315
|
emissionStartMs: Timestamp;
|
|
111
316
|
}
|
|
317
|
+
/**
|
|
318
|
+
* Fired when two staked positions are combined (joined) into one.
|
|
319
|
+
*/
|
|
112
320
|
export interface FarmsJoinedEvent extends Event {
|
|
113
321
|
stakedPositionId: ObjectId;
|
|
114
322
|
otherStakedPositionId: ObjectId;
|
|
115
323
|
}
|
|
324
|
+
/**
|
|
325
|
+
* Fired when a position is locked, specifying the lock duration and multiplier.
|
|
326
|
+
*/
|
|
116
327
|
export interface FarmsLockedEvent extends Event {
|
|
117
328
|
stakedPositionId: ObjectId;
|
|
118
329
|
vaultId: ObjectId;
|
|
@@ -122,10 +333,16 @@ export interface FarmsLockedEvent extends Event {
|
|
|
122
333
|
lockDurationMs: Timestamp;
|
|
123
334
|
lockMultiplier: FarmsMultiplier;
|
|
124
335
|
}
|
|
336
|
+
/**
|
|
337
|
+
* Fired when a staked position is split into two separate positions.
|
|
338
|
+
*/
|
|
125
339
|
export interface FarmsSplitEvent extends Event {
|
|
126
340
|
stakedPositionId: ObjectId;
|
|
127
341
|
splitStakedPositionId: ObjectId;
|
|
128
342
|
}
|
|
343
|
+
/**
|
|
344
|
+
* Fired when a user stakes a new position in the vault (version 1 only).
|
|
345
|
+
*/
|
|
129
346
|
export interface FarmsStakedEvent extends Event {
|
|
130
347
|
stakedPositionId: ObjectId;
|
|
131
348
|
vaultId: ObjectId;
|
|
@@ -136,6 +353,9 @@ export interface FarmsStakedEvent extends Event {
|
|
|
136
353
|
lockDurationMs: Timestamp;
|
|
137
354
|
lockMultiplier: FarmsMultiplier;
|
|
138
355
|
}
|
|
356
|
+
/**
|
|
357
|
+
* Fired when a user stakes a new position in the vault under "relaxed" locking (version 2).
|
|
358
|
+
*/
|
|
139
359
|
export interface FarmsStakedRelaxedEvent extends Event {
|
|
140
360
|
stakedPositionId: ObjectId;
|
|
141
361
|
vaultId: ObjectId;
|
|
@@ -144,21 +364,36 @@ export interface FarmsStakedRelaxedEvent extends Event {
|
|
|
144
364
|
lockStartTimestampMs: Timestamp;
|
|
145
365
|
lockEndTimestampMs: Timestamp;
|
|
146
366
|
}
|
|
367
|
+
/**
|
|
368
|
+
* Fired when a position is unlocked.
|
|
369
|
+
*/
|
|
147
370
|
export interface FarmsUnlockedEvent extends Event {
|
|
148
371
|
stakedPositionId: ObjectId;
|
|
149
372
|
vaultId: ObjectId;
|
|
150
373
|
stakedType: CoinType;
|
|
151
374
|
stakedAmount: Balance;
|
|
152
375
|
}
|
|
376
|
+
/**
|
|
377
|
+
* Fired when principal is withdrawn from a staked position.
|
|
378
|
+
*/
|
|
153
379
|
export interface FarmsWithdrewPrincipalEvent extends Event {
|
|
154
380
|
stakedPositionId: ObjectId;
|
|
155
381
|
vaultId: ObjectId;
|
|
156
382
|
amount: Balance;
|
|
157
383
|
stakeType: CoinType;
|
|
158
384
|
}
|
|
385
|
+
/**
|
|
386
|
+
* Request body for fetching all staked positions owned by a given user.
|
|
387
|
+
*/
|
|
159
388
|
export interface ApiFarmsOwnedStakedPositionsBody {
|
|
389
|
+
/**
|
|
390
|
+
* The user's wallet address whose positions are being queried.
|
|
391
|
+
*/
|
|
160
392
|
walletAddress: SuiAddress;
|
|
161
393
|
}
|
|
394
|
+
/**
|
|
395
|
+
* Request body for staking tokens in a pool (version 2).
|
|
396
|
+
*/
|
|
162
397
|
export interface ApiFarmsStakeBody {
|
|
163
398
|
stakingPoolId: ObjectId;
|
|
164
399
|
lockDurationMs: Timestamp;
|
|
@@ -167,7 +402,9 @@ export interface ApiFarmsStakeBody {
|
|
|
167
402
|
walletAddress: SuiAddress;
|
|
168
403
|
isSponsoredTx?: boolean;
|
|
169
404
|
}
|
|
170
|
-
/**
|
|
405
|
+
/**
|
|
406
|
+
* **Deprecated**: Use `ApiFarmsStakeBody` instead.
|
|
407
|
+
*/
|
|
171
408
|
export interface ApiFarmsStakeBodyV1 {
|
|
172
409
|
stakingPoolId: ObjectId;
|
|
173
410
|
lockDurationMs: Timestamp;
|
|
@@ -176,6 +413,9 @@ export interface ApiFarmsStakeBodyV1 {
|
|
|
176
413
|
walletAddress: SuiAddress;
|
|
177
414
|
isSponsoredTx?: boolean;
|
|
178
415
|
}
|
|
416
|
+
/**
|
|
417
|
+
* Request body for depositing additional principal into an existing staked position.
|
|
418
|
+
*/
|
|
179
419
|
export interface ApiFarmsDepositPrincipalBody {
|
|
180
420
|
stakedPositionId: ObjectId;
|
|
181
421
|
stakingPoolId: ObjectId;
|
|
@@ -184,6 +424,9 @@ export interface ApiFarmsDepositPrincipalBody {
|
|
|
184
424
|
walletAddress: SuiAddress;
|
|
185
425
|
isSponsoredTx?: boolean;
|
|
186
426
|
}
|
|
427
|
+
/**
|
|
428
|
+
* Request body for fully or partially unstaking a position.
|
|
429
|
+
*/
|
|
187
430
|
export interface ApiFarmsUnstakeBody {
|
|
188
431
|
stakedPositionId: ObjectId;
|
|
189
432
|
stakingPoolId: ObjectId;
|
|
@@ -193,6 +436,9 @@ export interface ApiFarmsUnstakeBody {
|
|
|
193
436
|
walletAddress: SuiAddress;
|
|
194
437
|
claimSuiAsAfSui?: boolean;
|
|
195
438
|
}
|
|
439
|
+
/**
|
|
440
|
+
* Request body for locking a staked position to gain a multiplier (version 2).
|
|
441
|
+
*/
|
|
196
442
|
export interface ApiFarmsLockBody {
|
|
197
443
|
stakedPositionId: ObjectId;
|
|
198
444
|
stakingPoolId: ObjectId;
|
|
@@ -200,18 +446,27 @@ export interface ApiFarmsLockBody {
|
|
|
200
446
|
stakeCoinType: CoinType;
|
|
201
447
|
walletAddress: SuiAddress;
|
|
202
448
|
}
|
|
449
|
+
/**
|
|
450
|
+
* Request body for renewing an existing lock on a staked position.
|
|
451
|
+
*/
|
|
203
452
|
export interface ApiFarmsRenewLockBody {
|
|
204
453
|
stakedPositionId: ObjectId;
|
|
205
454
|
stakingPoolId: ObjectId;
|
|
206
455
|
stakeCoinType: CoinType;
|
|
207
456
|
walletAddress: SuiAddress;
|
|
208
457
|
}
|
|
458
|
+
/**
|
|
459
|
+
* Request body for unlocking a staked position prior to or at lock expiry.
|
|
460
|
+
*/
|
|
209
461
|
export interface ApiFarmsUnlockBody {
|
|
210
462
|
stakedPositionId: ObjectId;
|
|
211
463
|
stakingPoolId: ObjectId;
|
|
212
464
|
stakeCoinType: CoinType;
|
|
213
465
|
walletAddress: SuiAddress;
|
|
214
466
|
}
|
|
467
|
+
/**
|
|
468
|
+
* Request body for harvesting rewards from one or more staked positions.
|
|
469
|
+
*/
|
|
215
470
|
export interface ApiHarvestFarmsRewardsBody {
|
|
216
471
|
stakingPoolId: ObjectId;
|
|
217
472
|
stakeCoinType: CoinType;
|
|
@@ -220,6 +475,9 @@ export interface ApiHarvestFarmsRewardsBody {
|
|
|
220
475
|
walletAddress: SuiAddress;
|
|
221
476
|
claimSuiAsAfSui?: boolean;
|
|
222
477
|
}
|
|
478
|
+
/**
|
|
479
|
+
* Request body for creating a new staking pool (version 2).
|
|
480
|
+
*/
|
|
223
481
|
export interface ApiFarmsCreateStakingPoolBody {
|
|
224
482
|
minLockDurationMs: Timestamp;
|
|
225
483
|
maxLockDurationMs: Timestamp;
|
|
@@ -227,8 +485,11 @@ export interface ApiFarmsCreateStakingPoolBody {
|
|
|
227
485
|
minStakeAmount: Balance;
|
|
228
486
|
stakeCoinType: CoinType;
|
|
229
487
|
walletAddress: SuiAddress;
|
|
488
|
+
isSponsoredTx?: boolean;
|
|
230
489
|
}
|
|
231
|
-
/**
|
|
490
|
+
/**
|
|
491
|
+
* **Deprecated**: Use `ApiFarmsCreateStakingPoolBody` instead.
|
|
492
|
+
*/
|
|
232
493
|
export interface ApiFarmsCreateStakingPoolBodyV1 {
|
|
233
494
|
minLockDurationMs: Timestamp;
|
|
234
495
|
maxLockDurationMs: Timestamp;
|
|
@@ -236,7 +497,11 @@ export interface ApiFarmsCreateStakingPoolBodyV1 {
|
|
|
236
497
|
minStakeAmount: Balance;
|
|
237
498
|
stakeCoinType: CoinType;
|
|
238
499
|
walletAddress: SuiAddress;
|
|
500
|
+
isSponsoredTx?: boolean;
|
|
239
501
|
}
|
|
502
|
+
/**
|
|
503
|
+
* Request body for initializing a new reward in a staking pool, requiring either `ownerCapId` or `oneTimeAdminCapId`.
|
|
504
|
+
*/
|
|
240
505
|
export type ApiFarmsInitializeStakingPoolRewardBody = {
|
|
241
506
|
stakingPoolId: ObjectId;
|
|
242
507
|
rewardAmount: Balance;
|
|
@@ -248,6 +513,9 @@ export type ApiFarmsInitializeStakingPoolRewardBody = {
|
|
|
248
513
|
walletAddress: SuiAddress;
|
|
249
514
|
isSponsoredTx?: boolean;
|
|
250
515
|
} & FarmOwnerOrOneTimeAdminCap;
|
|
516
|
+
/**
|
|
517
|
+
* Request body for topping up multiple reward coins in a staking pool, requiring either `ownerCapId` or `oneTimeAdminCapId`.
|
|
518
|
+
*/
|
|
251
519
|
export type ApiFarmsTopUpStakingPoolRewardsBody = {
|
|
252
520
|
stakingPoolId: ObjectId;
|
|
253
521
|
stakeCoinType: CoinType;
|
|
@@ -258,6 +526,9 @@ export type ApiFarmsTopUpStakingPoolRewardsBody = {
|
|
|
258
526
|
walletAddress: SuiAddress;
|
|
259
527
|
isSponsoredTx?: boolean;
|
|
260
528
|
} & FarmOwnerOrOneTimeAdminCap;
|
|
529
|
+
/**
|
|
530
|
+
* Request body for increasing the emissions for specified reward coins in a pool (owner only).
|
|
531
|
+
*/
|
|
261
532
|
export type ApiFarmsIncreaseStakingPoolRewardsEmissionsBody = {
|
|
262
533
|
ownerCapId: ObjectId;
|
|
263
534
|
stakingPoolId: ObjectId;
|
|
@@ -269,16 +540,26 @@ export type ApiFarmsIncreaseStakingPoolRewardsEmissionsBody = {
|
|
|
269
540
|
}[];
|
|
270
541
|
walletAddress: SuiAddress;
|
|
271
542
|
};
|
|
543
|
+
/**
|
|
544
|
+
* Request body for fetching staking pool owner caps owned by a user.
|
|
545
|
+
*/
|
|
272
546
|
export interface ApiFarmsOwnedStakingPoolOwnerCapsBody {
|
|
273
547
|
walletAddress: SuiAddress;
|
|
274
548
|
}
|
|
549
|
+
/**
|
|
550
|
+
* Request body for fetching staking pool one-time admin caps owned by a user.
|
|
551
|
+
*/
|
|
275
552
|
export interface ApiFarmsOwnedStakingPoolOneTimeAdminCapsBody {
|
|
276
553
|
walletAddress: SuiAddress;
|
|
277
554
|
}
|
|
555
|
+
/**
|
|
556
|
+
* Request body for granting a one-time admin cap of a particular reward coin to another user.
|
|
557
|
+
*/
|
|
278
558
|
export type ApiFarmsGrantOneTimeAdminCapBody = {
|
|
279
559
|
ownerCapId: ObjectId;
|
|
280
560
|
recipientAddress: SuiAddress;
|
|
281
561
|
rewardCoinType: CoinType;
|
|
282
562
|
walletAddress: SuiAddress;
|
|
563
|
+
isSponsoredTx?: boolean;
|
|
283
564
|
};
|
|
284
565
|
//# sourceMappingURL=farmsTypes.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"farmsTypes.d.ts","sourceRoot":"","sources":["../../../src/packages/farms/farmsTypes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,EACN,OAAO,EACP,KAAK,EACL,MAAM,EACN,SAAS,EACT,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAM7C,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC;
|
|
1
|
+
{"version":3,"file":"farmsTypes.d.ts","sourceRoot":"","sources":["../../../src/packages/farms/farmsTypes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,EACN,OAAO,EACP,KAAK,EACL,MAAM,EACN,SAAS,EACT,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAM7C;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC;AAErC;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,CAAC,GAAG,CAAC,CAAC;AAMjC;;;GAGG;AACH,MAAM,MAAM,0BAA0B,GACnC;IAAE,UAAU,EAAE,QAAQ,CAAA;CAAE,GACxB;IAAE,iBAAiB,EAAE,QAAQ,CAAA;CAAE,CAAC;AAUnC;;;;GAIG;AACH,MAAM,MAAM,oBAAoB,GAAG,QAAQ,GAAG,SAAS,CAAC;AAExD;;GAEG;AACH,MAAM,WAAW,0BAA0B;IAC1C;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAC;IACnB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;;OAGG;IACH,0BAA0B,EAAE,OAAO,CAAC;IACpC;;;OAGG;IACH,YAAY,EAAE,OAAO,CAAC;IACtB;;OAEG;IACH,mBAAmB,EAAE,SAAS,CAAC;IAC/B;;OAEG;IACH,sBAAsB,EAAE,SAAS,CAAC;IAClC;;OAEG;IACH,mBAAmB,EAAE,SAAS,CAAC;IAC/B;;;OAGG;IACH,gBAAgB,EAAE,OAAO,CAAC;IAC1B;;;OAGG;IACH,aAAa,EAAE,OAAO,CAAC;CACvB;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAuB,SAAQ,MAAM;IACrD;;OAEG;IACH,aAAa,EAAE,QAAQ,CAAC;IACxB;;OAEG;IACH,YAAY,EAAE,OAAO,CAAC;IACtB;;OAEG;IACH,0BAA0B,EAAE,OAAO,CAAC;IACpC;;OAEG;IACH,iBAAiB,EAAE,SAAS,CAAC;IAC7B;;;OAGG;IACH,iBAAiB,EAAE,SAAS,CAAC;IAC7B;;OAEG;IACH,iBAAiB,EAAE,eAAe,CAAC;IACnC;;OAEG;IACH,WAAW,EAAE,0BAA0B,EAAE,CAAC;IAC1C;;OAEG;IACH,oBAAoB,EAAE,SAAS,CAAC;IAChC;;OAEG;IACH,cAAc,EAAE,OAAO,CAAC;IACxB;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,OAAO,EAAE,YAAY,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,yBAA0B,SAAQ,MAAM;IACxD;;OAEG;IACH,aAAa,EAAE,QAAQ,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,gCAAiC,SAAQ,MAAM;IAC/D;;OAEG;IACH,aAAa,EAAE,QAAQ,CAAC;CACxB;AAMD;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC7C;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAC;IACnB;;OAEG;IACH,sBAAsB,EAAE,OAAO,CAAC;IAChC;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;IACzB;;OAEG;IACH,4BAA4B,EAAE,OAAO,CAAC;IACtC;;OAEG;IACH,qBAAqB,EAAE,OAAO,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,yBAA0B,SAAQ,MAAM;IACxD;;OAEG;IACH,mBAAmB,EAAE,QAAQ,CAAC;IAC9B;;OAEG;IACH,aAAa,EAAE,QAAQ,CAAC;IACxB;;OAEG;IACH,YAAY,EAAE,OAAO,CAAC;IACtB;;OAEG;IACH,0BAA0B,EAAE,OAAO,CAAC;IACpC;;OAEG;IACH,kBAAkB,EAAE,SAAS,CAAC;IAC9B;;OAEG;IACH,cAAc,EAAE,SAAS,CAAC;IAC1B;;OAEG;IACH,cAAc,EAAE,eAAe,CAAC;IAChC;;OAEG;IACH,WAAW,EAAE,6BAA6B,EAAE,CAAC;IAC7C;;OAEG;IACH,2BAA2B,EAAE,SAAS,CAAC;IACvC;;OAEG;IACH,OAAO,EAAE,YAAY,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,MAAM,gCAAgC,GAAG,IAAI,CAClD,yBAAyB,EACzB,aAAa,CACb,GAAG;IACH,WAAW,EAAE,IAAI,CAAC,6BAA6B,EAAE,UAAU,CAAC,EAAE,CAAC;CAC/D,CAAC;AAMF;;GAEG;AACH,MAAM,MAAM,SAAS,GAClB,qBAAqB,GACrB,sBAAsB,GACtB,4BAA4B,GAC5B,iCAAiC,GACjC,0BAA0B,GAC1B,4BAA4B,GAC5B,2BAA2B,GAC3B,gBAAgB,GAChB,gBAAgB,GAChB,eAAe,GACf,gBAAgB,GAChB,uBAAuB,GACvB,kBAAkB,GAClB,2BAA2B,CAAC;AAE/B;;;GAGG;AACH,MAAM,MAAM,aAAa,GACtB,4BAA4B,GAC5B,0BAA0B,GAC1B,gBAAgB,GAChB,gBAAgB,GAChB,kBAAkB,GAClB,2BAA2B,CAAC;AAM/B;;GAEG;AACH,eAAO,MAAM,8BAA8B,UACnC,aAAa,0CAGpB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,4BAA4B,UACjC,aAAa,wCAGpB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,kBAAkB,UACvB,aAAa,8BAGpB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,kBAAkB,UACvB,aAAa,8BAGpB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,oBAAoB,UACzB,aAAa,gCAGpB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,6BAA6B,UAClC,aAAa,yCAGpB,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,KAAK;IACnD,OAAO,EAAE,QAAQ,CAAC;IAClB,UAAU,EAAE,QAAQ,CAAC;IACrB,YAAY,EAAE,OAAO,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,KAAK;IACpD,OAAO,EAAE,QAAQ,CAAC;IAClB,SAAS,EAAE,QAAQ,CAAC;IACpB,iBAAiB,EAAE,SAAS,CAAC;IAC7B,iBAAiB,EAAE,SAAS,CAAC;IAC7B,iBAAiB,EAAE,eAAe,CAAC;IACnC,cAAc,EAAE,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,4BAA6B,SAAQ,KAAK;IAC1D,gBAAgB,EAAE,QAAQ,CAAC;IAC3B,OAAO,EAAE,QAAQ,CAAC;IAClB,MAAM,EAAE,OAAO,CAAC;IAChB,SAAS,EAAE,QAAQ,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,iCAAkC,SAAQ,KAAK;IAC/D,gBAAgB,EAAE,QAAQ,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,0BAA2B,SAAQ,KAAK;IACxD,OAAO,EAAE,QAAQ,CAAC;IAClB,WAAW,EAAE,QAAQ,EAAE,CAAC;IACxB,aAAa,EAAE,OAAO,EAAE,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,4BAA6B,SAAQ,KAAK;IAC1D,OAAO,EAAE,QAAQ,CAAC;IAClB,UAAU,EAAE,QAAQ,CAAC;IACrB,kBAAkB,EAAE,SAAS,CAAC;IAC9B,YAAY,EAAE,OAAO,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,2BAA4B,SAAQ,KAAK;IACzD,OAAO,EAAE,QAAQ,CAAC;IAClB,UAAU,EAAE,QAAQ,CAAC;IACrB,YAAY,EAAE,OAAO,CAAC;IACtB,YAAY,EAAE,OAAO,CAAC;IACtB,eAAe,EAAE,SAAS,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,KAAK;IAC9C,gBAAgB,EAAE,QAAQ,CAAC;IAC3B,qBAAqB,EAAE,QAAQ,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,KAAK;IAC9C,gBAAgB,EAAE,QAAQ,CAAC;IAC3B,OAAO,EAAE,QAAQ,CAAC;IAClB,UAAU,EAAE,QAAQ,CAAC;IACrB,YAAY,EAAE,OAAO,CAAC;IACtB,oBAAoB,EAAE,SAAS,CAAC;IAChC,cAAc,EAAE,SAAS,CAAC;IAC1B,cAAc,EAAE,eAAe,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,eAAgB,SAAQ,KAAK;IAC7C,gBAAgB,EAAE,QAAQ,CAAC;IAC3B,qBAAqB,EAAE,QAAQ,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,KAAK;IAC9C,gBAAgB,EAAE,QAAQ,CAAC;IAC3B,OAAO,EAAE,QAAQ,CAAC;IAClB,UAAU,EAAE,QAAQ,CAAC;IACrB,YAAY,EAAE,OAAO,CAAC;IACtB,sBAAsB,EAAE,OAAO,CAAC;IAChC,oBAAoB,EAAE,SAAS,CAAC;IAChC,cAAc,EAAE,SAAS,CAAC;IAC1B,cAAc,EAAE,eAAe,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,KAAK;IACrD,gBAAgB,EAAE,QAAQ,CAAC;IAC3B,OAAO,EAAE,QAAQ,CAAC;IAClB,UAAU,EAAE,QAAQ,CAAC;IACrB,YAAY,EAAE,OAAO,CAAC;IACtB,oBAAoB,EAAE,SAAS,CAAC;IAChC,kBAAkB,EAAE,SAAS,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,KAAK;IAChD,gBAAgB,EAAE,QAAQ,CAAC;IAC3B,OAAO,EAAE,QAAQ,CAAC;IAClB,UAAU,EAAE,QAAQ,CAAC;IACrB,YAAY,EAAE,OAAO,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,2BAA4B,SAAQ,KAAK;IACzD,gBAAgB,EAAE,QAAQ,CAAC;IAC3B,OAAO,EAAE,QAAQ,CAAC;IAClB,MAAM,EAAE,OAAO,CAAC;IAChB,SAAS,EAAE,QAAQ,CAAC;CACpB;AAUD;;GAEG;AACH,MAAM,WAAW,gCAAgC;IAChD;;OAEG;IACH,aAAa,EAAE,UAAU,CAAC;CAC1B;AAMD;;GAEG;AACH,MAAM,WAAW,iBAAiB;IACjC,aAAa,EAAE,QAAQ,CAAC;IACxB,cAAc,EAAE,SAAS,CAAC;IAC1B,aAAa,EAAE,QAAQ,CAAC;IACxB,WAAW,EAAE,OAAO,CAAC;IACrB,aAAa,EAAE,UAAU,CAAC;IAE1B,aAAa,CAAC,EAAE,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IACnC,aAAa,EAAE,QAAQ,CAAC;IACxB,cAAc,EAAE,SAAS,CAAC;IAC1B,aAAa,EAAE,QAAQ,CAAC;IACxB,WAAW,EAAE,OAAO,CAAC;IACrB,aAAa,EAAE,UAAU,CAAC;IAC1B,aAAa,CAAC,EAAE,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC5C,gBAAgB,EAAE,QAAQ,CAAC;IAC3B,aAAa,EAAE,QAAQ,CAAC;IACxB,aAAa,EAAE,QAAQ,CAAC;IACxB,aAAa,EAAE,OAAO,CAAC;IACvB,aAAa,EAAE,UAAU,CAAC;IAC1B,aAAa,CAAC,EAAE,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IACnC,gBAAgB,EAAE,QAAQ,CAAC;IAC3B,aAAa,EAAE,QAAQ,CAAC;IACxB,aAAa,EAAE,QAAQ,CAAC;IACxB,eAAe,EAAE,QAAQ,EAAE,CAAC;IAC5B,cAAc,EAAE,OAAO,CAAC;IACxB,aAAa,EAAE,UAAU,CAAC;IAC1B,eAAe,CAAC,EAAE,OAAO,CAAC;CAC1B;AAMD;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAChC,gBAAgB,EAAE,QAAQ,CAAC;IAC3B,aAAa,EAAE,QAAQ,CAAC;IACxB,cAAc,EAAE,SAAS,CAAC;IAC1B,aAAa,EAAE,QAAQ,CAAC;IACxB,aAAa,EAAE,UAAU,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACrC,gBAAgB,EAAE,QAAQ,CAAC;IAC3B,aAAa,EAAE,QAAQ,CAAC;IACxB,aAAa,EAAE,QAAQ,CAAC;IACxB,aAAa,EAAE,UAAU,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAClC,gBAAgB,EAAE,QAAQ,CAAC;IAC3B,aAAa,EAAE,QAAQ,CAAC;IACxB,aAAa,EAAE,QAAQ,CAAC;IACxB,aAAa,EAAE,UAAU,CAAC;CAC1B;AAMD;;GAEG;AACH,MAAM,WAAW,0BAA0B;IAC1C,aAAa,EAAE,QAAQ,CAAC;IACxB,aAAa,EAAE,QAAQ,CAAC;IACxB,iBAAiB,EAAE,QAAQ,EAAE,CAAC;IAC9B,eAAe,EAAE,QAAQ,EAAE,CAAC;IAC5B,aAAa,EAAE,UAAU,CAAC;IAC1B,eAAe,CAAC,EAAE,OAAO,CAAC;CAC1B;AAUD;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAE7C,iBAAiB,EAAE,SAAS,CAAC;IAC7B,iBAAiB,EAAE,SAAS,CAAC;IAC7B,iBAAiB,EAAE,eAAe,CAAC;IACnC,cAAc,EAAE,OAAO,CAAC;IACxB,aAAa,EAAE,QAAQ,CAAC;IACxB,aAAa,EAAE,UAAU,CAAC;IAC1B,aAAa,CAAC,EAAE,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAE/C,iBAAiB,EAAE,SAAS,CAAC;IAC7B,iBAAiB,EAAE,SAAS,CAAC;IAC7B,iBAAiB,EAAE,eAAe,CAAC;IACnC,cAAc,EAAE,OAAO,CAAC;IACxB,aAAa,EAAE,QAAQ,CAAC;IACxB,aAAa,EAAE,UAAU,CAAC;IAC1B,aAAa,CAAC,EAAE,OAAO,CAAC;CACxB;AAMD;;GAEG;AACH,MAAM,MAAM,uCAAuC,GAAG;IACrD,aAAa,EAAE,QAAQ,CAAC;IACxB,YAAY,EAAE,OAAO,CAAC;IACtB,kBAAkB,EAAE,SAAS,CAAC;IAC9B,YAAY,EAAE,MAAM,CAAC;IACrB,wBAAwB,EAAE,SAAS,CAAC;IACpC,aAAa,EAAE,QAAQ,CAAC;IACxB,cAAc,EAAE,QAAQ,CAAC;IACzB,aAAa,EAAE,UAAU,CAAC;IAC1B,aAAa,CAAC,EAAE,OAAO,CAAC;CACxB,GAAG,0BAA0B,CAAC;AAE/B;;GAEG;AACH,MAAM,MAAM,mCAAmC,GAAG;IACjD,aAAa,EAAE,QAAQ,CAAC;IACxB,aAAa,EAAE,QAAQ,CAAC;IACxB,OAAO,EAAE;QACR,cAAc,EAAE,QAAQ,CAAC;QACzB,YAAY,EAAE,OAAO,CAAC;KACtB,EAAE,CAAC;IACJ,aAAa,EAAE,UAAU,CAAC;IAC1B,aAAa,CAAC,EAAE,OAAO,CAAC;CACxB,GAAG,0BAA0B,CAAC;AAE/B;;GAEG;AACH,MAAM,MAAM,+CAA+C,GAAG;IAC7D,UAAU,EAAE,QAAQ,CAAC;IACrB,aAAa,EAAE,QAAQ,CAAC;IACxB,aAAa,EAAE,QAAQ,CAAC;IACxB,OAAO,EAAE;QACR,cAAc,EAAE,QAAQ,CAAC;QACzB,kBAAkB,EAAE,SAAS,CAAC;QAC9B,YAAY,EAAE,MAAM,CAAC;KACrB,EAAE,CAAC;IACJ,aAAa,EAAE,UAAU,CAAC;CAC1B,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,qCAAqC;IACrD,aAAa,EAAE,UAAU,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,4CAA4C;IAC5D,aAAa,EAAE,UAAU,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,MAAM,gCAAgC,GAAG;IAC9C,UAAU,EAAE,QAAQ,CAAC;IACrB,gBAAgB,EAAE,UAAU,CAAC;IAC7B,cAAc,EAAE,QAAQ,CAAC;IACzB,aAAa,EAAE,UAAU,CAAC;IAC1B,aAAa,CAAC,EAAE,OAAO,CAAC;CACxB,CAAC"}
|
|
@@ -5,26 +5,44 @@ exports.isFarmsWithdrewPrincipalEvent = exports.isFarmsUnlockedEvent = exports.i
|
|
|
5
5
|
// | FarmsJoinedEvent
|
|
6
6
|
// | FarmsSplitEvent
|
|
7
7
|
// | FarmsStakedRelaxedEvent
|
|
8
|
+
/**
|
|
9
|
+
* Type guard to determine if a `FarmUserEvent` is a `FarmsDepositedPrincipalEvent`.
|
|
10
|
+
*/
|
|
8
11
|
const isFarmsDepositedPrincipalEvent = (event) => {
|
|
9
12
|
return event.type.toLowerCase().includes("::depositedprincipalevent");
|
|
10
13
|
};
|
|
11
14
|
exports.isFarmsDepositedPrincipalEvent = isFarmsDepositedPrincipalEvent;
|
|
15
|
+
/**
|
|
16
|
+
* Type guard to determine if a `FarmUserEvent` is a `FarmsHarvestedRewardsEvent`.
|
|
17
|
+
*/
|
|
12
18
|
const isFarmsHarvestedRewardsEvent = (event) => {
|
|
13
19
|
return event.type.toLowerCase().includes("::harvestedrewardsevent");
|
|
14
20
|
};
|
|
15
21
|
exports.isFarmsHarvestedRewardsEvent = isFarmsHarvestedRewardsEvent;
|
|
22
|
+
/**
|
|
23
|
+
* Type guard to determine if a `FarmUserEvent` is a `FarmsLockedEvent`.
|
|
24
|
+
*/
|
|
16
25
|
const isFarmsLockedEvent = (event) => {
|
|
17
26
|
return event.type.toLowerCase().includes("::lockedevent");
|
|
18
27
|
};
|
|
19
28
|
exports.isFarmsLockedEvent = isFarmsLockedEvent;
|
|
29
|
+
/**
|
|
30
|
+
* Type guard to determine if a `FarmUserEvent` is a `FarmsStakedEvent`.
|
|
31
|
+
*/
|
|
20
32
|
const isFarmsStakedEvent = (event) => {
|
|
21
33
|
return event.type.toLowerCase().includes("::stakedevent");
|
|
22
34
|
};
|
|
23
35
|
exports.isFarmsStakedEvent = isFarmsStakedEvent;
|
|
36
|
+
/**
|
|
37
|
+
* Type guard to determine if a `FarmUserEvent` is a `FarmsUnlockedEvent`.
|
|
38
|
+
*/
|
|
24
39
|
const isFarmsUnlockedEvent = (event) => {
|
|
25
40
|
return event.type.toLowerCase().includes("::unlockedevent");
|
|
26
41
|
};
|
|
27
42
|
exports.isFarmsUnlockedEvent = isFarmsUnlockedEvent;
|
|
43
|
+
/**
|
|
44
|
+
* Type guard to determine if a `FarmUserEvent` is a `FarmsWithdrewPrincipalEvent`.
|
|
45
|
+
*/
|
|
28
46
|
const isFarmsWithdrewPrincipalEvent = (event) => {
|
|
29
47
|
return event.type.toLowerCase().includes("::withdrewprincipalevent");
|
|
30
48
|
};
|