aftermath-ts-sdk 4.0.0-dev.449f8e6 → 4.0.0-dev.f3b60ec
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/dist/index.d.ts +550 -545
- package/dist/index.js +36 -32
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -1914,6 +1914,388 @@ interface ApiNftAmmWithdrawBody {
|
|
|
1914
1914
|
referrer?: SuiAddress;
|
|
1915
1915
|
}
|
|
1916
1916
|
|
|
1917
|
+
/**
|
|
1918
|
+
* Request body for fetching a user's total accumulated reward points.
|
|
1919
|
+
* Uses a pre-signed message (bytes + signature) for authentication.
|
|
1920
|
+
*/
|
|
1921
|
+
interface ApiRewardsGetPointsBody {
|
|
1922
|
+
/**
|
|
1923
|
+
* Sui wallet address to query total points for.
|
|
1924
|
+
*/
|
|
1925
|
+
walletAddress: SuiAddress;
|
|
1926
|
+
/**
|
|
1927
|
+
* The message bytes (base64 encoded) that the user previously signed.
|
|
1928
|
+
* Can be reused from other signed messages (e.g., Terms and Conditions).
|
|
1929
|
+
*/
|
|
1930
|
+
bytes: string;
|
|
1931
|
+
/**
|
|
1932
|
+
* The signature corresponding to the signed message bytes.
|
|
1933
|
+
*/
|
|
1934
|
+
signature: string;
|
|
1935
|
+
}
|
|
1936
|
+
/**
|
|
1937
|
+
* Response containing the user's total accumulated reward points.
|
|
1938
|
+
*/
|
|
1939
|
+
interface ApiRewardsGetPointsResponse {
|
|
1940
|
+
/**
|
|
1941
|
+
* Total accumulated points for this wallet across all epochs and domains.
|
|
1942
|
+
*/
|
|
1943
|
+
totalPoints: number;
|
|
1944
|
+
}
|
|
1945
|
+
/**
|
|
1946
|
+
* Request body for fetching a user's rewards history.
|
|
1947
|
+
* Uses a pre-signed message (bytes + signature) for authentication.
|
|
1948
|
+
*/
|
|
1949
|
+
interface ApiRewardsGetHistoryBody {
|
|
1950
|
+
/**
|
|
1951
|
+
* Sui wallet address to query history for.
|
|
1952
|
+
*/
|
|
1953
|
+
walletAddress: SuiAddress;
|
|
1954
|
+
/**
|
|
1955
|
+
* The message bytes (base64 encoded) that the user previously signed.
|
|
1956
|
+
* Can be reused from other signed messages (e.g., Terms and Conditions).
|
|
1957
|
+
*/
|
|
1958
|
+
bytes: string;
|
|
1959
|
+
/**
|
|
1960
|
+
* The signature corresponding to the signed message bytes.
|
|
1961
|
+
*/
|
|
1962
|
+
signature: string;
|
|
1963
|
+
/**
|
|
1964
|
+
* Optional domain filter (e.g., "referrals", "perpetuals").
|
|
1965
|
+
* If omitted, returns all domains.
|
|
1966
|
+
*/
|
|
1967
|
+
domain?: string;
|
|
1968
|
+
/**
|
|
1969
|
+
* Maximum number of entries to return. Default: 20, max: 100.
|
|
1970
|
+
*/
|
|
1971
|
+
limit?: number;
|
|
1972
|
+
/**
|
|
1973
|
+
* Cursor for fetching next page.
|
|
1974
|
+
*/
|
|
1975
|
+
cursor?: number;
|
|
1976
|
+
}
|
|
1977
|
+
/**
|
|
1978
|
+
* Response containing the user's rewards history.
|
|
1979
|
+
*/
|
|
1980
|
+
interface ApiRewardsGetHistoryResponse {
|
|
1981
|
+
/**
|
|
1982
|
+
* Array of historical reward entries.
|
|
1983
|
+
*/
|
|
1984
|
+
history: RewardsHistoryEntry[];
|
|
1985
|
+
/**
|
|
1986
|
+
* Pagination info.
|
|
1987
|
+
*/
|
|
1988
|
+
pagination: RewardsPaginationInfo;
|
|
1989
|
+
}
|
|
1990
|
+
/**
|
|
1991
|
+
* Event type for a rewards history entry.
|
|
1992
|
+
*/
|
|
1993
|
+
type RewardsHistoryEventType = "deposit" | "withdraw" | "points";
|
|
1994
|
+
/**
|
|
1995
|
+
* A single historical reward entry.
|
|
1996
|
+
*/
|
|
1997
|
+
interface RewardsHistoryEntry {
|
|
1998
|
+
/**
|
|
1999
|
+
* Vault ID where the event occurred.
|
|
2000
|
+
*/
|
|
2001
|
+
vaultId: ObjectId;
|
|
2002
|
+
/**
|
|
2003
|
+
* Fully-qualified Coin type (e.g., "0x2::sui::SUI"), or "points" for point entries.
|
|
2004
|
+
*/
|
|
2005
|
+
coinType: "points" | (CoinType & {});
|
|
2006
|
+
/**
|
|
2007
|
+
* Reward amount in base units.
|
|
2008
|
+
*/
|
|
2009
|
+
amount: Balance;
|
|
2010
|
+
/**
|
|
2011
|
+
* Domain identifier (e.g., "referrals", "perpetuals").
|
|
2012
|
+
*/
|
|
2013
|
+
domain: string;
|
|
2014
|
+
/**
|
|
2015
|
+
* Epoch start timestamp in milliseconds.
|
|
2016
|
+
*/
|
|
2017
|
+
epochStartTimestampMs: Timestamp;
|
|
2018
|
+
/**
|
|
2019
|
+
* Epoch end timestamp in milliseconds.
|
|
2020
|
+
*/
|
|
2021
|
+
epochEndTimestampMs: Timestamp;
|
|
2022
|
+
/**
|
|
2023
|
+
* Transaction digest for this event, if available.
|
|
2024
|
+
*/
|
|
2025
|
+
txDigest?: TransactionDigest;
|
|
2026
|
+
/**
|
|
2027
|
+
* Event type: "deposit", "withdraw", or "points".
|
|
2028
|
+
*/
|
|
2029
|
+
eventType: RewardsHistoryEventType;
|
|
2030
|
+
}
|
|
2031
|
+
/**
|
|
2032
|
+
* Pagination information for paginated reward queries.
|
|
2033
|
+
*/
|
|
2034
|
+
interface RewardsPaginationInfo {
|
|
2035
|
+
/**
|
|
2036
|
+
* True if more results exist beyond the returned set.
|
|
2037
|
+
*/
|
|
2038
|
+
hasMore: boolean;
|
|
2039
|
+
/**
|
|
2040
|
+
* Cursor for fetching the next page. Undefined if no more results.
|
|
2041
|
+
*/
|
|
2042
|
+
nextCursor?: number;
|
|
2043
|
+
}
|
|
2044
|
+
/**
|
|
2045
|
+
* Request body for fetching a user's claimable rewards.
|
|
2046
|
+
*/
|
|
2047
|
+
interface ApiRewardsGetClaimableBody {
|
|
2048
|
+
/**
|
|
2049
|
+
* Sui wallet address to query claimable rewards for.
|
|
2050
|
+
*/
|
|
2051
|
+
walletAddress: SuiAddress;
|
|
2052
|
+
}
|
|
2053
|
+
/**
|
|
2054
|
+
* Response containing the user's claimable rewards.
|
|
2055
|
+
*/
|
|
2056
|
+
interface ApiRewardsGetClaimableResponse {
|
|
2057
|
+
/**
|
|
2058
|
+
* Array of claimable reward entries, one per coin type.
|
|
2059
|
+
* Empty array if no rewards are claimable.
|
|
2060
|
+
*/
|
|
2061
|
+
rewards: RewardsClaimableReward[];
|
|
2062
|
+
}
|
|
2063
|
+
/**
|
|
2064
|
+
* A single claimable reward entry.
|
|
2065
|
+
*/
|
|
2066
|
+
interface RewardsClaimableReward {
|
|
2067
|
+
/**
|
|
2068
|
+
* Full Sui coin type (e.g., "0x2::sui::SUI").
|
|
2069
|
+
*/
|
|
2070
|
+
coinType: CoinType;
|
|
2071
|
+
/**
|
|
2072
|
+
* Claimable amount in base units.
|
|
2073
|
+
*/
|
|
2074
|
+
amount: Balance;
|
|
2075
|
+
}
|
|
2076
|
+
/**
|
|
2077
|
+
* What-if overrides for the coefficients used to compute Q-scores and taker
|
|
2078
|
+
* shares. Omit to use the epoch's configured values.
|
|
2079
|
+
*/
|
|
2080
|
+
interface RewardsExpectedCalculationVariables {
|
|
2081
|
+
/** Coefficient applied to the market-maker Q-score component. */
|
|
2082
|
+
qScoreCoefficient: number;
|
|
2083
|
+
/** Coefficient applied to market-maker uptime. */
|
|
2084
|
+
uptimeCoefficient: number;
|
|
2085
|
+
/** Coefficient applied to market-maker volume. */
|
|
2086
|
+
mmVolumeCoefficient: number;
|
|
2087
|
+
/** Coefficient applied to taker trading volume. */
|
|
2088
|
+
takerVolumeCoefficient: number;
|
|
2089
|
+
/** Coefficient applied to taker open interest. */
|
|
2090
|
+
takerOiCoefficient: number;
|
|
2091
|
+
}
|
|
2092
|
+
/**
|
|
2093
|
+
* Request body for previewing a single account's expected rewards for an epoch.
|
|
2094
|
+
*
|
|
2095
|
+
* Provide exactly one of `address` or `accountId`. When `epoch` is omitted the
|
|
2096
|
+
* current epoch is used. All remaining fields are optional what-if overrides of
|
|
2097
|
+
* the epoch's reward configuration.
|
|
2098
|
+
*/
|
|
2099
|
+
interface ApiRewardsExpectedRewardsBody {
|
|
2100
|
+
/** Sui wallet address to preview rewards for. */
|
|
2101
|
+
address?: SuiAddress;
|
|
2102
|
+
/** Account ID to preview rewards for. */
|
|
2103
|
+
accountId?: BigIntAsString;
|
|
2104
|
+
/** Epoch number to preview. Defaults to the current epoch when omitted. */
|
|
2105
|
+
epoch?: number;
|
|
2106
|
+
/** Override for the total maker reward pool. */
|
|
2107
|
+
totalMakerRewards?: number;
|
|
2108
|
+
/** Override for the total taker reward pool. */
|
|
2109
|
+
totalTakerRewards?: number;
|
|
2110
|
+
/** Overrides for the Q-score / taker-share coefficients. */
|
|
2111
|
+
calculationVariables?: RewardsExpectedCalculationVariables;
|
|
2112
|
+
/** Override for the trading points budget. */
|
|
2113
|
+
tradingPointsBudget?: number;
|
|
2114
|
+
/** Override for the AFLP points budget. */
|
|
2115
|
+
aflpPointsBudget?: number;
|
|
2116
|
+
/** Override for the referee rate below the volume threshold. */
|
|
2117
|
+
refereeRateLow?: number;
|
|
2118
|
+
/** Override for the referee rate at or above the volume threshold. */
|
|
2119
|
+
refereeRateHigh?: number;
|
|
2120
|
+
/** Override for the referrer rate below the volume threshold. */
|
|
2121
|
+
referrerRateLow?: number;
|
|
2122
|
+
/** Override for the referrer rate at or above the volume threshold. */
|
|
2123
|
+
referrerRateHigh?: number;
|
|
2124
|
+
/** Override for the referral volume threshold. */
|
|
2125
|
+
referralVolumeThreshold?: number;
|
|
2126
|
+
}
|
|
2127
|
+
/**
|
|
2128
|
+
* The epoch a set of previewed rewards belongs to.
|
|
2129
|
+
*/
|
|
2130
|
+
interface RewardsExpectedEpochInfo {
|
|
2131
|
+
/** Epoch number. */
|
|
2132
|
+
number: number;
|
|
2133
|
+
/** Epoch start timestamp in milliseconds. */
|
|
2134
|
+
startTimestampMs: Timestamp;
|
|
2135
|
+
/** Epoch end timestamp in milliseconds. */
|
|
2136
|
+
endTimestampMs: Timestamp;
|
|
2137
|
+
/** Epoch status, e.g. "pending", "ready", "processed". */
|
|
2138
|
+
status: string;
|
|
2139
|
+
}
|
|
2140
|
+
/**
|
|
2141
|
+
* Totals summed across all reward domains.
|
|
2142
|
+
*/
|
|
2143
|
+
interface RewardsExpectedTotals {
|
|
2144
|
+
/** Total expected reward value in USD. */
|
|
2145
|
+
tokensUsd: number;
|
|
2146
|
+
/** Total expected reward amount in reward-coin base units (stringified). */
|
|
2147
|
+
tokensRaw: BigIntAsString;
|
|
2148
|
+
/** Total expected points across all domains. */
|
|
2149
|
+
points: number;
|
|
2150
|
+
}
|
|
2151
|
+
/**
|
|
2152
|
+
* Expected rewards for a single domain (e.g. "trading", "referral", "aflp").
|
|
2153
|
+
*/
|
|
2154
|
+
interface RewardsExpectedDomainTokens {
|
|
2155
|
+
/** Reward domain, e.g. "trading", "referral", "aflp", "integrator". */
|
|
2156
|
+
domain: string;
|
|
2157
|
+
/** Expected reward value in USD for this domain. */
|
|
2158
|
+
tokensUsd: number;
|
|
2159
|
+
/** Expected reward amount in reward-coin base units for this domain (stringified). */
|
|
2160
|
+
tokensRaw: BigIntAsString;
|
|
2161
|
+
}
|
|
2162
|
+
/**
|
|
2163
|
+
* Response with a single account's expected rewards for an epoch.
|
|
2164
|
+
*/
|
|
2165
|
+
interface ApiRewardsExpectedRewardsResponse {
|
|
2166
|
+
/** The epoch the rewards belong to. */
|
|
2167
|
+
epoch: RewardsExpectedEpochInfo;
|
|
2168
|
+
/** Totals summed across all domains. */
|
|
2169
|
+
total: RewardsExpectedTotals;
|
|
2170
|
+
/** Per-domain expected reward breakdown. */
|
|
2171
|
+
domains: RewardsExpectedDomainTokens[];
|
|
2172
|
+
}
|
|
2173
|
+
/**
|
|
2174
|
+
* Request body for claiming rewards for a user's wallet address.
|
|
2175
|
+
*/
|
|
2176
|
+
interface ApiRewardsClaimRequestTxBody {
|
|
2177
|
+
/**
|
|
2178
|
+
* The user's Sui wallet address.
|
|
2179
|
+
*/
|
|
2180
|
+
walletAddress: SuiAddress;
|
|
2181
|
+
/**
|
|
2182
|
+
* Optional list of coin types to claim.
|
|
2183
|
+
* If omitted, claims all available rewards.
|
|
2184
|
+
*/
|
|
2185
|
+
coinTypes?: CoinType[];
|
|
2186
|
+
/**
|
|
2187
|
+
* Optional recipient address for the claimed rewards.
|
|
2188
|
+
* Defaults to walletAddress if not provided.
|
|
2189
|
+
*/
|
|
2190
|
+
recipientAddress?: SuiAddress;
|
|
2191
|
+
/**
|
|
2192
|
+
* Optional serialized (base64) Sui `TransactionKind` to extend.
|
|
2193
|
+
*/
|
|
2194
|
+
txKind?: SerializedTransaction;
|
|
2195
|
+
}
|
|
2196
|
+
/** Raw response from the reward-claim transaction endpoint. */
|
|
2197
|
+
interface ApiRewardsClaimRequestTxResponse {
|
|
2198
|
+
/** Base64-serialized full transaction bytes or `TransactionKind` bytes. */
|
|
2199
|
+
txKind: SerializedTransaction;
|
|
2200
|
+
}
|
|
2201
|
+
/**
|
|
2202
|
+
* Request body for computing the rewards distribution across perpetuals
|
|
2203
|
+
* accounts.
|
|
2204
|
+
*
|
|
2205
|
+
* This corresponds to `POST /api/rewards/distribution`, which replaces the
|
|
2206
|
+
* removed `POST /api/perpetuals/rebates/rewards`.
|
|
2207
|
+
*
|
|
2208
|
+
* Given maker and taker reward pools and a list of accounts, computes
|
|
2209
|
+
* per-account reward allocations and fee-tier rebates. When `accountIds` is
|
|
2210
|
+
* omitted or empty, all eligible accounts are included.
|
|
2211
|
+
*
|
|
2212
|
+
* **Note:** All data returned is for the current epoch only.
|
|
2213
|
+
*/
|
|
2214
|
+
interface ApiRewardsDistributionBody {
|
|
2215
|
+
/**
|
|
2216
|
+
* Optional account filter. Omit or pass an empty array for all eligible
|
|
2217
|
+
* accounts. `Caller` serializes each id to the API's `"123n"` wire format
|
|
2218
|
+
* and parses the response back, so pass real bigints here.
|
|
2219
|
+
*/
|
|
2220
|
+
accountIds?: PerpetualsAccountId[];
|
|
2221
|
+
/** Total maker reward pool to distribute among eligible market makers. */
|
|
2222
|
+
totalMakerRewards: number;
|
|
2223
|
+
/** Total taker reward pool to distribute among eligible takers. */
|
|
2224
|
+
totalTakerRewards: number;
|
|
2225
|
+
/** Coefficients used to compute Q-scores and taker shares. */
|
|
2226
|
+
calculationVariables: RewardsDistributionCalculationVariables;
|
|
2227
|
+
}
|
|
2228
|
+
/**
|
|
2229
|
+
* Coefficients used when computing Q-scores and taker shares. Each is a
|
|
2230
|
+
* weighting exponent applied to a corresponding per-account metric.
|
|
2231
|
+
*/
|
|
2232
|
+
interface RewardsDistributionCalculationVariables {
|
|
2233
|
+
/** Exponent applied to the raw Q-score component. */
|
|
2234
|
+
qScoreCoefficient: number;
|
|
2235
|
+
/** Exponent applied to the uptime component. */
|
|
2236
|
+
uptimeCoefficient: number;
|
|
2237
|
+
/** Exponent applied to the maker volume component. */
|
|
2238
|
+
mmVolumeCoefficient: number;
|
|
2239
|
+
/** Exponent applied to the taker volume component. */
|
|
2240
|
+
takerVolumeCoefficient: number;
|
|
2241
|
+
/** Exponent applied to the taker open-interest component. */
|
|
2242
|
+
takerOiCoefficient: number;
|
|
2243
|
+
}
|
|
2244
|
+
/** Maker reward and rebate breakdown for a single account. */
|
|
2245
|
+
interface RewardsDistributionMakerData {
|
|
2246
|
+
/** Normalized Q-score: raw cross-market sum averaged over snapshot count. */
|
|
2247
|
+
qScore: number;
|
|
2248
|
+
/** Final score: `qScore^coeff * uptime^coeff * volume^coeff`. */
|
|
2249
|
+
qScoreFinal: number;
|
|
2250
|
+
/** Share of total `qScoreFinal` across all eligible accounts. */
|
|
2251
|
+
qScoreFinalShare: Percentage;
|
|
2252
|
+
/** Cross-market uptime count (number of snapshots with qualifying orders). */
|
|
2253
|
+
uptime: number;
|
|
2254
|
+
/** Q-score-based rewards from the maker reward pool. */
|
|
2255
|
+
rewards: number;
|
|
2256
|
+
/** Cross-market maker volume in USD. */
|
|
2257
|
+
volume: number;
|
|
2258
|
+
/** Share of total maker volume across all eligible accounts. */
|
|
2259
|
+
volumeShare: Percentage;
|
|
2260
|
+
/** Volume-share tier rebate: `tierRate * volume`. */
|
|
2261
|
+
volumeRebate: number;
|
|
2262
|
+
/** Total maker fees paid across all markets. */
|
|
2263
|
+
feesPaid: number;
|
|
2264
|
+
/** Fee tier rebate: `max(0, feesPaid - discountedFees)`. */
|
|
2265
|
+
feeRebate: number;
|
|
2266
|
+
}
|
|
2267
|
+
/** Taker reward and rebate breakdown for a single account. */
|
|
2268
|
+
interface RewardsDistributionTakerData {
|
|
2269
|
+
/** Volume-share-based rewards from the taker reward pool. */
|
|
2270
|
+
rewards: number;
|
|
2271
|
+
/** Cross-market taker volume in USD. */
|
|
2272
|
+
volume: number;
|
|
2273
|
+
/** Share of total taker volume across all eligible accounts. */
|
|
2274
|
+
volumeShare: Percentage;
|
|
2275
|
+
/** Total taker fees paid across all markets. */
|
|
2276
|
+
feesPaid: number;
|
|
2277
|
+
/** Fee tier rebate: `max(0, feesPaid - discountedFees)`. */
|
|
2278
|
+
feeRebate: number;
|
|
2279
|
+
}
|
|
2280
|
+
/** Combined reward and rebate data for a single account. */
|
|
2281
|
+
interface RewardsDistributionAccountData {
|
|
2282
|
+
/** Account receiving this reward and rebate breakdown. */
|
|
2283
|
+
accountId: PerpetualsAccountId;
|
|
2284
|
+
/** Maker-side reward and rebate metrics. */
|
|
2285
|
+
maker: RewardsDistributionMakerData;
|
|
2286
|
+
/** Taker-side reward and rebate metrics. */
|
|
2287
|
+
taker: RewardsDistributionTakerData;
|
|
2288
|
+
}
|
|
2289
|
+
/** Response body for the rewards distribution calculation. */
|
|
2290
|
+
interface ApiRewardsDistributionResponse {
|
|
2291
|
+
/** Sum of all final quality scores across eligible makers. */
|
|
2292
|
+
totalQScoreFinal: number;
|
|
2293
|
+
/** Total estimated gas cost for order management across all accounts (decimal SUI). */
|
|
2294
|
+
totalEstimatedGasCost: number;
|
|
2295
|
+
/** Per-account reward and rebate breakdown. */
|
|
2296
|
+
rewards: RewardsDistributionAccountData[];
|
|
2297
|
+
}
|
|
2298
|
+
|
|
1917
2299
|
/**
|
|
1918
2300
|
* Configuration for gas pool sponsorship on perpetuals transactions.
|
|
1919
2301
|
*
|
|
@@ -2599,7 +2981,7 @@ interface PerpetualsVaultMetatada {
|
|
|
2599
2981
|
* Network-specific protocol limits shared by all Perpetuals vaults.
|
|
2600
2982
|
*
|
|
2601
2983
|
* These values come from the current on-chain vaults configuration rather
|
|
2602
|
-
|
|
2984
|
+
* than SDK constants. Fetch them with `Perpetuals.getVaultsConfig`.
|
|
2603
2985
|
*/
|
|
2604
2986
|
interface PerpetualsVaultsConfig {
|
|
2605
2987
|
/** ID of the on-chain vaults configuration object. */
|
|
@@ -5929,188 +6311,45 @@ type ApiPerpetualsVaultPreviewPauseVaultForForceWithdrawRequestResponse = {
|
|
|
5929
6311
|
* Request body for previewing normal withdraw requests processing for a vault.
|
|
5930
6312
|
*/
|
|
5931
6313
|
interface ApiPerpetualsVaultPreviewOwnerProcessWithdrawRequestsBody {
|
|
5932
|
-
/** Vault whose queued requests are previewed. */
|
|
5933
|
-
vaultId: ObjectId;
|
|
5934
|
-
/** Wallets whose requests are included. */
|
|
5935
|
-
userAddresses: SuiAddress[];
|
|
5936
|
-
}
|
|
5937
|
-
/**
|
|
5938
|
-
* Response body for previewing normal withdraw requests processing.
|
|
5939
|
-
*/
|
|
5940
|
-
type ApiPerpetualsVaultPreviewOwnerProcessWithdrawRequestsResponse = {
|
|
5941
|
-
/** Error message returned when the operation cannot be completed. */
|
|
5942
|
-
error: string;
|
|
5943
|
-
} | {
|
|
5944
|
-
/** Per-user withdrawal previews returned by the operation. */
|
|
5945
|
-
userPreviews: {
|
|
5946
|
-
userAddress: SuiAddress;
|
|
5947
|
-
collateralAmountOut: Balance;
|
|
5948
|
-
}[];
|
|
5949
|
-
/** Collateral asset price used by the preview. */
|
|
5950
|
-
collateralPrice: number;
|
|
5951
|
-
};
|
|
5952
|
-
/**
|
|
5953
|
-
* Request body for previewing maximum performance fees withdrawable from a vault.
|
|
5954
|
-
*/
|
|
5955
|
-
interface ApiPerpetualsVaultPreviewOwnerWithdrawPerformanceFeesBody {
|
|
5956
|
-
/** Vault whose withdrawable fees are previewed. */
|
|
5957
|
-
vaultId: ObjectId;
|
|
5958
|
-
}
|
|
5959
|
-
/**
|
|
5960
|
-
* Response body for previewing vault performance fee withdrawal.
|
|
5961
|
-
*/
|
|
5962
|
-
type ApiPerpetualsVaultPreviewOwnerWithdrawPerformanceFeesResponse = {
|
|
5963
|
-
/** Error message returned when the operation cannot be completed. */
|
|
5964
|
-
error: string;
|
|
5965
|
-
} | {
|
|
5966
|
-
/** Maximum performance-fee amount available to withdraw. */
|
|
5967
|
-
maxFeesToWithdraw: Balance;
|
|
5968
|
-
/** Coin type used to pay or receive the performance fees. */
|
|
5969
|
-
feeCoinType: CoinType;
|
|
5970
|
-
};
|
|
5971
|
-
/**
|
|
5972
|
-
* Request body for calculating rewards and rebates for perpetuals accounts.
|
|
5973
|
-
*
|
|
5974
|
-
* This corresponds to `POST /api/perpetuals/rebates/rewards`.
|
|
5975
|
-
*
|
|
5976
|
-
* Given maker and taker reward pools and a list of accounts, computes
|
|
5977
|
-
* per-account reward allocations and fee-tier rebates.
|
|
5978
|
-
* When `accountIds` is omitted or empty, all eligible accounts are included.
|
|
5979
|
-
*
|
|
5980
|
-
* **Note:** All data returned is for the current epoch only.
|
|
5981
|
-
*/
|
|
5982
|
-
interface ApiPerpetualsCurrentRebateRewardsBody {
|
|
5983
|
-
/** Optional account filter. Omit or pass an empty array for all eligible accounts. */
|
|
5984
|
-
accountIds?: PerpetualsAccountId[];
|
|
5985
|
-
/** Total maker reward pool to distribute among eligible market makers. */
|
|
5986
|
-
totalMakerRewards: number;
|
|
5987
|
-
/** Total taker reward pool to distribute among eligible takers. */
|
|
5988
|
-
totalTakerRewards: number;
|
|
5989
|
-
/** Coefficients used to compute Q-scores and taker shares. */
|
|
5990
|
-
calculationVariables: PerpetualsCalculationVariables;
|
|
5991
|
-
}
|
|
5992
|
-
/**
|
|
5993
|
-
* Coefficients used when computing Q-scores and taker shares for the rebate
|
|
5994
|
-
* rewards calculation. Each is a weighting exponent applied to a corresponding
|
|
5995
|
-
* per-account metric.
|
|
5996
|
-
*/
|
|
5997
|
-
interface PerpetualsCalculationVariables {
|
|
5998
|
-
/** Exponent applied to the raw Q-score component. */
|
|
5999
|
-
qScoreCoefficient: number;
|
|
6000
|
-
/** Exponent applied to the uptime component. */
|
|
6001
|
-
uptimeCoefficient: number;
|
|
6002
|
-
/** Exponent applied to the maker volume component. */
|
|
6003
|
-
mmVolumeCoefficient: number;
|
|
6004
|
-
/** Exponent applied to the taker volume component. */
|
|
6005
|
-
takerVolumeCoefficient: number;
|
|
6006
|
-
/** Exponent applied to the taker open-interest component. */
|
|
6007
|
-
takerOiCoefficient: number;
|
|
6008
|
-
}
|
|
6009
|
-
/**
|
|
6010
|
-
* Maker reward and rebate breakdown for a single account.
|
|
6011
|
-
*/
|
|
6012
|
-
interface PerpetualsMakerData {
|
|
6013
|
-
/** Normalized Q-score: raw cross-market sum averaged over snapshot count. */
|
|
6014
|
-
qScore: number;
|
|
6015
|
-
/** Final score: `qScore^coeff * uptime^coeff * volume^coeff`. */
|
|
6016
|
-
qScoreFinal: number;
|
|
6017
|
-
/** Share of total `qScoreFinal` across all eligible accounts (between 0 and 1). */
|
|
6018
|
-
qScoreFinalShare: number;
|
|
6019
|
-
/** Cross-market uptime count (number of snapshots with qualifying orders). */
|
|
6020
|
-
uptime: number;
|
|
6021
|
-
/** Q-score-based rewards from the maker reward pool. */
|
|
6022
|
-
rewards: number;
|
|
6023
|
-
/** Cross-market maker volume in USD. */
|
|
6024
|
-
volume: number;
|
|
6025
|
-
/** Share of total maker volume across all eligible accounts (between 0 and 1). */
|
|
6026
|
-
volumeShare: number;
|
|
6027
|
-
/** Volume-share tier rebate: `tierRate * volume`. */
|
|
6028
|
-
volumeRebate: number;
|
|
6029
|
-
/** Total maker fees paid across all markets. */
|
|
6030
|
-
feesPaid: number;
|
|
6031
|
-
/** Fee tier rebate: `max(0, feesPaid - discountedFees)`. */
|
|
6032
|
-
feeRebate: number;
|
|
6033
|
-
}
|
|
6034
|
-
/**
|
|
6035
|
-
* Taker reward and rebate breakdown for a single account.
|
|
6036
|
-
*/
|
|
6037
|
-
interface PerpetualsTakerData {
|
|
6038
|
-
/** Volume-share-based rewards from the taker reward pool. */
|
|
6039
|
-
rewards: number;
|
|
6040
|
-
/** Cross-market taker volume in USD. */
|
|
6041
|
-
volume: number;
|
|
6042
|
-
/** Share of total taker volume across all eligible accounts (between 0 and 1). */
|
|
6043
|
-
volumeShare: number;
|
|
6044
|
-
/** Total taker fees paid across all markets. */
|
|
6045
|
-
feesPaid: number;
|
|
6046
|
-
/** Fee tier rebate: `max(0, feesPaid - discountedFees)`. */
|
|
6047
|
-
feeRebate: number;
|
|
6048
|
-
}
|
|
6049
|
-
/**
|
|
6050
|
-
* Combined reward and rebate data for a single account.
|
|
6051
|
-
*/
|
|
6052
|
-
interface PerpetualsRewardData {
|
|
6053
|
-
/** Account receiving this reward and rebate breakdown. */
|
|
6054
|
-
accountId: PerpetualsAccountId;
|
|
6055
|
-
/** Maker-side reward and rebate metrics. */
|
|
6056
|
-
maker: PerpetualsMakerData;
|
|
6057
|
-
/** Taker-side reward and rebate metrics. */
|
|
6058
|
-
taker: PerpetualsTakerData;
|
|
6059
|
-
}
|
|
6060
|
-
/**
|
|
6061
|
-
* Response body for the rewards and rebates calculation.
|
|
6062
|
-
*/
|
|
6063
|
-
interface ApiPerpetualsCurrentRebateRewardsResponse {
|
|
6064
|
-
/** Sum of all final quality scores across eligible makers. */
|
|
6065
|
-
totalQScoreFinal: number;
|
|
6066
|
-
/** Total estimated gas cost for order management across all accounts (decimal SUI). */
|
|
6067
|
-
totalEstimatedGasCost: number;
|
|
6068
|
-
/** Per-account reward and rebate breakdown. */
|
|
6069
|
-
rewards: PerpetualsRewardData[];
|
|
6070
|
-
}
|
|
6071
|
-
/**
|
|
6072
|
-
* Request body for generating a CSV-formatted rebate report.
|
|
6073
|
-
*
|
|
6074
|
-
* This corresponds to `POST /api/perpetuals/rebates/create-csv-rebates`.
|
|
6075
|
-
*
|
|
6076
|
-
* Produces a CSV string containing per-account rebate and reward data.
|
|
6077
|
-
* When `accountIds` is omitted or empty, all eligible accounts are included.
|
|
6078
|
-
*/
|
|
6079
|
-
interface ApiPerpetualsCreateCsvRebatesBody extends ApiPerpetualsCurrentRebateRewardsBody {
|
|
6080
|
-
/**
|
|
6081
|
-
* When true, aggregate rewards by owner address instead of per-account.
|
|
6082
|
-
* Defaults to false when omitted.
|
|
6083
|
-
*/
|
|
6084
|
-
aggregated?: boolean;
|
|
6314
|
+
/** Vault whose queued requests are previewed. */
|
|
6315
|
+
vaultId: ObjectId;
|
|
6316
|
+
/** Wallets whose requests are included. */
|
|
6317
|
+
userAddresses: SuiAddress[];
|
|
6085
6318
|
}
|
|
6086
6319
|
/**
|
|
6087
|
-
* Response body for
|
|
6320
|
+
* Response body for previewing normal withdraw requests processing.
|
|
6088
6321
|
*/
|
|
6089
|
-
|
|
6090
|
-
/**
|
|
6091
|
-
|
|
6092
|
-
}
|
|
6322
|
+
type ApiPerpetualsVaultPreviewOwnerProcessWithdrawRequestsResponse = {
|
|
6323
|
+
/** Error message returned when the operation cannot be completed. */
|
|
6324
|
+
error: string;
|
|
6325
|
+
} | {
|
|
6326
|
+
/** Per-user withdrawal previews returned by the operation. */
|
|
6327
|
+
userPreviews: {
|
|
6328
|
+
userAddress: SuiAddress;
|
|
6329
|
+
collateralAmountOut: Balance;
|
|
6330
|
+
}[];
|
|
6331
|
+
/** Collateral asset price used by the preview. */
|
|
6332
|
+
collateralPrice: number;
|
|
6333
|
+
};
|
|
6093
6334
|
/**
|
|
6094
|
-
* Request body for
|
|
6095
|
-
*
|
|
6096
|
-
* This corresponds to `POST /api/perpetuals/rebates/create-referral-csv-rebates`.
|
|
6097
|
-
*
|
|
6098
|
-
* Calculates referrer commissions and referee discounts based on trading
|
|
6099
|
-
* fees within the specified epoch.
|
|
6335
|
+
* Request body for previewing maximum performance fees withdrawable from a vault.
|
|
6100
6336
|
*/
|
|
6101
|
-
interface
|
|
6102
|
-
/**
|
|
6103
|
-
|
|
6104
|
-
/** Epoch end timestamp in milliseconds. */
|
|
6105
|
-
epochEndTimestampMs: Timestamp;
|
|
6337
|
+
interface ApiPerpetualsVaultPreviewOwnerWithdrawPerformanceFeesBody {
|
|
6338
|
+
/** Vault whose withdrawable fees are previewed. */
|
|
6339
|
+
vaultId: ObjectId;
|
|
6106
6340
|
}
|
|
6107
6341
|
/**
|
|
6108
|
-
* Response body for
|
|
6342
|
+
* Response body for previewing vault performance fee withdrawal.
|
|
6109
6343
|
*/
|
|
6110
|
-
|
|
6111
|
-
/**
|
|
6112
|
-
|
|
6113
|
-
}
|
|
6344
|
+
type ApiPerpetualsVaultPreviewOwnerWithdrawPerformanceFeesResponse = {
|
|
6345
|
+
/** Error message returned when the operation cannot be completed. */
|
|
6346
|
+
error: string;
|
|
6347
|
+
} | {
|
|
6348
|
+
/** Maximum performance-fee amount available to withdraw. */
|
|
6349
|
+
maxFeesToWithdraw: Balance;
|
|
6350
|
+
/** Coin type used to pay or receive the performance fees. */
|
|
6351
|
+
feeCoinType: CoinType;
|
|
6352
|
+
};
|
|
6114
6353
|
/**
|
|
6115
6354
|
* SDK-level inputs for placing a market order from a client.
|
|
6116
6355
|
*
|
|
@@ -6323,6 +6562,17 @@ interface PerpetualsWsUpdatesOraclePayload {
|
|
|
6323
6562
|
basePrice: number;
|
|
6324
6563
|
/** Current collateral price, in USD. */
|
|
6325
6564
|
collateralPrice: number;
|
|
6565
|
+
/**
|
|
6566
|
+
* Current mark price — what positions are marked against for PnL and
|
|
6567
|
+
* liquidation, as opposed to the raw index price.
|
|
6568
|
+
*/
|
|
6569
|
+
markPrice: number;
|
|
6570
|
+
/**
|
|
6571
|
+
* Raw orderbook mid price, or `null` when either side of the book is empty.
|
|
6572
|
+
* Nullable where `markPrice` is not: mark falls back to the index price
|
|
6573
|
+
* upstream, whereas a raw mid has none.
|
|
6574
|
+
*/
|
|
6575
|
+
bookPrice: number | null;
|
|
6326
6576
|
}
|
|
6327
6577
|
/**
|
|
6328
6578
|
* Websocket payload for market orders stream.
|
|
@@ -6480,6 +6730,45 @@ interface PerpetualsWsUpdatesMarketCandlesPayload {
|
|
|
6480
6730
|
/** Latest candle for the market and interval. */
|
|
6481
6731
|
lastCandle: PerpetualsMarketCandleDataPoint;
|
|
6482
6732
|
}
|
|
6733
|
+
/**
|
|
6734
|
+
* Request body for generating a CSV-formatted rebate report.
|
|
6735
|
+
*
|
|
6736
|
+
* This corresponds to `POST /api/perpetuals/rebates/create-csv-rebates`.
|
|
6737
|
+
*
|
|
6738
|
+
* The same inputs as {@link ApiRewardsDistributionBody}, plus `aggregated`.
|
|
6739
|
+
* When `accountIds` is omitted or empty, all eligible accounts are included.
|
|
6740
|
+
*/
|
|
6741
|
+
interface ApiPerpetualsCreateCsvRebatesBody extends ApiRewardsDistributionBody {
|
|
6742
|
+
/**
|
|
6743
|
+
* When true, aggregate rewards by owner address instead of per-account.
|
|
6744
|
+
* Defaults to false when omitted.
|
|
6745
|
+
*/
|
|
6746
|
+
aggregated?: boolean;
|
|
6747
|
+
}
|
|
6748
|
+
/** Response body for the CSV rebate report. */
|
|
6749
|
+
interface ApiPerpetualsCreateCsvRebatesResponse {
|
|
6750
|
+
/** The CSV-formatted rebate data as a string. */
|
|
6751
|
+
csv: string;
|
|
6752
|
+
}
|
|
6753
|
+
/**
|
|
6754
|
+
* Request body for generating a referral rebate CSV report.
|
|
6755
|
+
*
|
|
6756
|
+
* This corresponds to `POST /api/perpetuals/rebates/create-referral-csv-rebates`.
|
|
6757
|
+
*
|
|
6758
|
+
* Calculates referrer commissions and referee discounts based on trading
|
|
6759
|
+
* fees within the specified epoch.
|
|
6760
|
+
*/
|
|
6761
|
+
interface ApiPerpetualsCreateReferralCsvRebatesBody {
|
|
6762
|
+
/** Epoch start timestamp in milliseconds. */
|
|
6763
|
+
epochStartTimestampMs: Timestamp;
|
|
6764
|
+
/** Epoch end timestamp in milliseconds. */
|
|
6765
|
+
epochEndTimestampMs: Timestamp;
|
|
6766
|
+
}
|
|
6767
|
+
/** Response body for the referral rebate CSV report. */
|
|
6768
|
+
interface ApiPerpetualsCreateReferralCsvRebatesResponse {
|
|
6769
|
+
/** The CSV-formatted referral rebate data as a string. */
|
|
6770
|
+
csv: string;
|
|
6771
|
+
}
|
|
6483
6772
|
|
|
6484
6773
|
/**
|
|
6485
6774
|
* Inputs for querying the gas pool associated with a wallet.
|
|
@@ -7673,387 +7962,102 @@ interface ApiReferralsGetRefereesResponse {
|
|
|
7673
7962
|
* Total number of referees for the code before applying `limit` and `offset`.
|
|
7674
7963
|
*/
|
|
7675
7964
|
totalCount: number;
|
|
7676
|
-
}
|
|
7677
|
-
/** Request body for checking referral-code availability. */
|
|
7678
|
-
interface ApiReferralsIsRefCodeTakenBody {
|
|
7679
|
-
/**
|
|
7680
|
-
* Referral code to check.
|
|
7681
|
-
*/
|
|
7682
|
-
refCode: string;
|
|
7683
|
-
}
|
|
7684
|
-
/** Response containing a referral-code availability result. */
|
|
7685
|
-
interface ApiReferralsIsRefCodeTakenResponse {
|
|
7686
|
-
/**
|
|
7687
|
-
* Referral code that was checked.
|
|
7688
|
-
*/
|
|
7689
|
-
refCode: string;
|
|
7690
|
-
/**
|
|
7691
|
-
* `true` when the code is available for use, or `false` when it is taken.
|
|
7692
|
-
*/
|
|
7693
|
-
isAvailable: boolean;
|
|
7694
|
-
}
|
|
7695
|
-
/** Request body for creating a referral link for a wallet. */
|
|
7696
|
-
interface ApiReferralsCreateReferralLinkBody {
|
|
7697
|
-
/**
|
|
7698
|
-
* Wallet address of the user creating the link.
|
|
7699
|
-
*/
|
|
7700
|
-
walletAddress: SuiAddress;
|
|
7701
|
-
/**
|
|
7702
|
-
* Serialized bytes of the message signed by the wallet for authentication.
|
|
7703
|
-
*/
|
|
7704
|
-
bytes: string;
|
|
7705
|
-
/**
|
|
7706
|
-
* Signature corresponding to `bytes`.
|
|
7707
|
-
*/
|
|
7708
|
-
signature: string;
|
|
7709
|
-
/**
|
|
7710
|
-
* Referral code to create. The current signed terms message does not carry
|
|
7711
|
-
* this code, so the code travels in the body.
|
|
7712
|
-
*/
|
|
7713
|
-
refCode: string;
|
|
7714
|
-
}
|
|
7715
|
-
/** Response returned after creating a referral link. */
|
|
7716
|
-
interface ApiReferralsCreateReferralLinkResponse {
|
|
7717
|
-
/**
|
|
7718
|
-
* The created referral code.
|
|
7719
|
-
*/
|
|
7720
|
-
refCode: string;
|
|
7721
|
-
/**
|
|
7722
|
-
* Wallet address of the referrer.
|
|
7723
|
-
*/
|
|
7724
|
-
walletAddress: SuiAddress;
|
|
7725
|
-
/**
|
|
7726
|
-
* Unix timestamp, in milliseconds, when the link was created.
|
|
7727
|
-
*/
|
|
7728
|
-
createdAt: Timestamp;
|
|
7729
|
-
/**
|
|
7730
|
-
* Backend status for the creation result.
|
|
7731
|
-
*/
|
|
7732
|
-
status: string;
|
|
7733
|
-
}
|
|
7734
|
-
/** Request body for linking a wallet to an existing referral code. */
|
|
7735
|
-
interface ApiReferralsSetReferrerBody {
|
|
7736
|
-
/**
|
|
7737
|
-
* Wallet address of the user being linked.
|
|
7738
|
-
*/
|
|
7739
|
-
walletAddress: SuiAddress;
|
|
7740
|
-
/**
|
|
7741
|
-
* Serialized bytes of the message signed by the wallet for authentication.
|
|
7742
|
-
*/
|
|
7743
|
-
bytes: string;
|
|
7744
|
-
/**
|
|
7745
|
-
* Signature corresponding to `bytes`.
|
|
7746
|
-
*/
|
|
7747
|
-
signature: string;
|
|
7748
|
-
/**
|
|
7749
|
-
* Referral code to link. The current signed terms message does not carry the
|
|
7750
|
-
* code, so the code travels in the body.
|
|
7751
|
-
*/
|
|
7752
|
-
refCode: string;
|
|
7753
|
-
}
|
|
7754
|
-
/** Response returned after linking a wallet to a referral code. */
|
|
7755
|
-
interface ApiReferralsSetReferrerResponse {
|
|
7756
|
-
/**
|
|
7757
|
-
* Wallet address of the referred user.
|
|
7758
|
-
*/
|
|
7759
|
-
refereeAddress: SuiAddress;
|
|
7760
|
-
/**
|
|
7761
|
-
* Referral code used for the link.
|
|
7762
|
-
*/
|
|
7763
|
-
refCode: string;
|
|
7764
|
-
/**
|
|
7765
|
-
* Unix timestamp, in milliseconds, when the relationship was established.
|
|
7766
|
-
*/
|
|
7767
|
-
createdAt: Timestamp;
|
|
7768
|
-
/**
|
|
7769
|
-
* Backend status for the link result.
|
|
7770
|
-
*/
|
|
7771
|
-
status: string;
|
|
7772
|
-
}
|
|
7773
|
-
|
|
7774
|
-
/**
|
|
7775
|
-
* Request body for fetching a user's total accumulated reward points.
|
|
7776
|
-
* Uses a pre-signed message (bytes + signature) for authentication.
|
|
7777
|
-
*/
|
|
7778
|
-
interface ApiRewardsGetPointsBody {
|
|
7779
|
-
/**
|
|
7780
|
-
* Sui wallet address to query total points for.
|
|
7781
|
-
*/
|
|
7782
|
-
walletAddress: SuiAddress;
|
|
7783
|
-
/**
|
|
7784
|
-
* The message bytes (base64 encoded) that the user previously signed.
|
|
7785
|
-
* Can be reused from other signed messages (e.g., Terms and Conditions).
|
|
7786
|
-
*/
|
|
7787
|
-
bytes: string;
|
|
7788
|
-
/**
|
|
7789
|
-
* The signature corresponding to the signed message bytes.
|
|
7790
|
-
*/
|
|
7791
|
-
signature: string;
|
|
7792
|
-
}
|
|
7793
|
-
/**
|
|
7794
|
-
* Response containing the user's total accumulated reward points.
|
|
7795
|
-
*/
|
|
7796
|
-
interface ApiRewardsGetPointsResponse {
|
|
7797
|
-
/**
|
|
7798
|
-
* Total accumulated points for this wallet across all epochs and domains.
|
|
7799
|
-
*/
|
|
7800
|
-
totalPoints: number;
|
|
7801
|
-
}
|
|
7802
|
-
/**
|
|
7803
|
-
* Request body for fetching a user's rewards history.
|
|
7804
|
-
* Uses a pre-signed message (bytes + signature) for authentication.
|
|
7805
|
-
*/
|
|
7806
|
-
interface ApiRewardsGetHistoryBody {
|
|
7807
|
-
/**
|
|
7808
|
-
* Sui wallet address to query history for.
|
|
7809
|
-
*/
|
|
7810
|
-
walletAddress: SuiAddress;
|
|
7811
|
-
/**
|
|
7812
|
-
* The message bytes (base64 encoded) that the user previously signed.
|
|
7813
|
-
* Can be reused from other signed messages (e.g., Terms and Conditions).
|
|
7814
|
-
*/
|
|
7815
|
-
bytes: string;
|
|
7816
|
-
/**
|
|
7817
|
-
* The signature corresponding to the signed message bytes.
|
|
7818
|
-
*/
|
|
7819
|
-
signature: string;
|
|
7820
|
-
/**
|
|
7821
|
-
* Optional domain filter (e.g., "referrals", "perpetuals").
|
|
7822
|
-
* If omitted, returns all domains.
|
|
7823
|
-
*/
|
|
7824
|
-
domain?: string;
|
|
7825
|
-
/**
|
|
7826
|
-
* Maximum number of entries to return. Default: 20, max: 100.
|
|
7827
|
-
*/
|
|
7828
|
-
limit?: number;
|
|
7829
|
-
/**
|
|
7830
|
-
* Cursor for fetching next page.
|
|
7831
|
-
*/
|
|
7832
|
-
cursor?: number;
|
|
7833
|
-
}
|
|
7834
|
-
/**
|
|
7835
|
-
* Response containing the user's rewards history.
|
|
7836
|
-
*/
|
|
7837
|
-
interface ApiRewardsGetHistoryResponse {
|
|
7838
|
-
/**
|
|
7839
|
-
* Array of historical reward entries.
|
|
7840
|
-
*/
|
|
7841
|
-
history: RewardsHistoryEntry[];
|
|
7965
|
+
}
|
|
7966
|
+
/** Request body for checking referral-code availability. */
|
|
7967
|
+
interface ApiReferralsIsRefCodeTakenBody {
|
|
7842
7968
|
/**
|
|
7843
|
-
*
|
|
7969
|
+
* Referral code to check.
|
|
7844
7970
|
*/
|
|
7845
|
-
|
|
7971
|
+
refCode: string;
|
|
7846
7972
|
}
|
|
7847
|
-
/**
|
|
7848
|
-
|
|
7849
|
-
*/
|
|
7850
|
-
type RewardsHistoryEventType = "deposit" | "withdraw" | "points";
|
|
7851
|
-
/**
|
|
7852
|
-
* A single historical reward entry.
|
|
7853
|
-
*/
|
|
7854
|
-
interface RewardsHistoryEntry {
|
|
7973
|
+
/** Response containing a referral-code availability result. */
|
|
7974
|
+
interface ApiReferralsIsRefCodeTakenResponse {
|
|
7855
7975
|
/**
|
|
7856
|
-
*
|
|
7976
|
+
* Referral code that was checked.
|
|
7857
7977
|
*/
|
|
7858
|
-
|
|
7978
|
+
refCode: string;
|
|
7859
7979
|
/**
|
|
7860
|
-
*
|
|
7980
|
+
* `true` when the code is available for use, or `false` when it is taken.
|
|
7861
7981
|
*/
|
|
7862
|
-
|
|
7982
|
+
isAvailable: boolean;
|
|
7983
|
+
}
|
|
7984
|
+
/** Request body for creating a referral link for a wallet. */
|
|
7985
|
+
interface ApiReferralsCreateReferralLinkBody {
|
|
7863
7986
|
/**
|
|
7864
|
-
*
|
|
7987
|
+
* Wallet address of the user creating the link.
|
|
7865
7988
|
*/
|
|
7866
|
-
|
|
7989
|
+
walletAddress: SuiAddress;
|
|
7867
7990
|
/**
|
|
7868
|
-
*
|
|
7991
|
+
* Serialized bytes of the message signed by the wallet for authentication.
|
|
7869
7992
|
*/
|
|
7870
|
-
|
|
7993
|
+
bytes: string;
|
|
7871
7994
|
/**
|
|
7872
|
-
*
|
|
7995
|
+
* Signature corresponding to `bytes`.
|
|
7873
7996
|
*/
|
|
7874
|
-
|
|
7997
|
+
signature: string;
|
|
7875
7998
|
/**
|
|
7876
|
-
*
|
|
7999
|
+
* Referral code to create. The current signed terms message does not carry
|
|
8000
|
+
* this code, so the code travels in the body.
|
|
7877
8001
|
*/
|
|
7878
|
-
|
|
8002
|
+
refCode: string;
|
|
8003
|
+
}
|
|
8004
|
+
/** Response returned after creating a referral link. */
|
|
8005
|
+
interface ApiReferralsCreateReferralLinkResponse {
|
|
7879
8006
|
/**
|
|
7880
|
-
*
|
|
8007
|
+
* The created referral code.
|
|
7881
8008
|
*/
|
|
7882
|
-
|
|
8009
|
+
refCode: string;
|
|
7883
8010
|
/**
|
|
7884
|
-
*
|
|
8011
|
+
* Wallet address of the referrer.
|
|
7885
8012
|
*/
|
|
7886
|
-
|
|
7887
|
-
}
|
|
7888
|
-
/**
|
|
7889
|
-
* Pagination information for paginated reward queries.
|
|
7890
|
-
*/
|
|
7891
|
-
interface RewardsPaginationInfo {
|
|
8013
|
+
walletAddress: SuiAddress;
|
|
7892
8014
|
/**
|
|
7893
|
-
*
|
|
8015
|
+
* Unix timestamp, in milliseconds, when the link was created.
|
|
7894
8016
|
*/
|
|
7895
|
-
|
|
8017
|
+
createdAt: Timestamp;
|
|
7896
8018
|
/**
|
|
7897
|
-
*
|
|
8019
|
+
* Backend status for the creation result.
|
|
7898
8020
|
*/
|
|
7899
|
-
|
|
8021
|
+
status: string;
|
|
7900
8022
|
}
|
|
7901
|
-
/**
|
|
7902
|
-
|
|
7903
|
-
*/
|
|
7904
|
-
interface ApiRewardsGetClaimableBody {
|
|
8023
|
+
/** Request body for linking a wallet to an existing referral code. */
|
|
8024
|
+
interface ApiReferralsSetReferrerBody {
|
|
7905
8025
|
/**
|
|
7906
|
-
*
|
|
8026
|
+
* Wallet address of the user being linked.
|
|
7907
8027
|
*/
|
|
7908
8028
|
walletAddress: SuiAddress;
|
|
7909
|
-
}
|
|
7910
|
-
/**
|
|
7911
|
-
* Response containing the user's claimable rewards.
|
|
7912
|
-
*/
|
|
7913
|
-
interface ApiRewardsGetClaimableResponse {
|
|
7914
8029
|
/**
|
|
7915
|
-
*
|
|
7916
|
-
* Empty array if no rewards are claimable.
|
|
8030
|
+
* Serialized bytes of the message signed by the wallet for authentication.
|
|
7917
8031
|
*/
|
|
7918
|
-
|
|
7919
|
-
}
|
|
7920
|
-
/**
|
|
7921
|
-
* A single claimable reward entry.
|
|
7922
|
-
*/
|
|
7923
|
-
interface RewardsClaimableReward {
|
|
8032
|
+
bytes: string;
|
|
7924
8033
|
/**
|
|
7925
|
-
*
|
|
8034
|
+
* Signature corresponding to `bytes`.
|
|
7926
8035
|
*/
|
|
7927
|
-
|
|
8036
|
+
signature: string;
|
|
7928
8037
|
/**
|
|
7929
|
-
*
|
|
8038
|
+
* Referral code to link. The current signed terms message does not carry the
|
|
8039
|
+
* code, so the code travels in the body.
|
|
7930
8040
|
*/
|
|
7931
|
-
|
|
7932
|
-
}
|
|
7933
|
-
/**
|
|
7934
|
-
* What-if overrides for the coefficients used to compute Q-scores and taker
|
|
7935
|
-
* shares. Omit to use the epoch's configured values.
|
|
7936
|
-
*/
|
|
7937
|
-
interface RewardsExpectedCalculationVariables {
|
|
7938
|
-
/** Coefficient applied to the market-maker Q-score component. */
|
|
7939
|
-
qScoreCoefficient: number;
|
|
7940
|
-
/** Coefficient applied to market-maker uptime. */
|
|
7941
|
-
uptimeCoefficient: number;
|
|
7942
|
-
/** Coefficient applied to market-maker volume. */
|
|
7943
|
-
mmVolumeCoefficient: number;
|
|
7944
|
-
/** Coefficient applied to taker trading volume. */
|
|
7945
|
-
takerVolumeCoefficient: number;
|
|
7946
|
-
/** Coefficient applied to taker open interest. */
|
|
7947
|
-
takerOiCoefficient: number;
|
|
7948
|
-
}
|
|
7949
|
-
/**
|
|
7950
|
-
* Request body for previewing a single account's expected rewards for an epoch.
|
|
7951
|
-
*
|
|
7952
|
-
* Provide exactly one of `address` or `accountId`. When `epoch` is omitted the
|
|
7953
|
-
* current epoch is used. All remaining fields are optional what-if overrides of
|
|
7954
|
-
* the epoch's reward configuration.
|
|
7955
|
-
*/
|
|
7956
|
-
interface ApiRewardsExpectedRewardsBody {
|
|
7957
|
-
/** Sui wallet address to preview rewards for. */
|
|
7958
|
-
address?: SuiAddress;
|
|
7959
|
-
/** Account ID to preview rewards for. */
|
|
7960
|
-
accountId?: BigIntAsString;
|
|
7961
|
-
/** Epoch number to preview. Defaults to the current epoch when omitted. */
|
|
7962
|
-
epoch?: number;
|
|
7963
|
-
/** Override for the total maker reward pool. */
|
|
7964
|
-
totalMakerRewards?: number;
|
|
7965
|
-
/** Override for the total taker reward pool. */
|
|
7966
|
-
totalTakerRewards?: number;
|
|
7967
|
-
/** Overrides for the Q-score / taker-share coefficients. */
|
|
7968
|
-
calculationVariables?: RewardsExpectedCalculationVariables;
|
|
7969
|
-
/** Override for the trading points budget. */
|
|
7970
|
-
tradingPointsBudget?: number;
|
|
7971
|
-
/** Override for the AFLP points budget. */
|
|
7972
|
-
aflpPointsBudget?: number;
|
|
7973
|
-
/** Override for the referee rate below the volume threshold. */
|
|
7974
|
-
refereeRateLow?: number;
|
|
7975
|
-
/** Override for the referee rate at or above the volume threshold. */
|
|
7976
|
-
refereeRateHigh?: number;
|
|
7977
|
-
/** Override for the referrer rate below the volume threshold. */
|
|
7978
|
-
referrerRateLow?: number;
|
|
7979
|
-
/** Override for the referrer rate at or above the volume threshold. */
|
|
7980
|
-
referrerRateHigh?: number;
|
|
7981
|
-
/** Override for the referral volume threshold. */
|
|
7982
|
-
referralVolumeThreshold?: number;
|
|
7983
|
-
}
|
|
7984
|
-
/**
|
|
7985
|
-
* The epoch a set of previewed rewards belongs to.
|
|
7986
|
-
*/
|
|
7987
|
-
interface RewardsExpectedEpochInfo {
|
|
7988
|
-
/** Epoch number. */
|
|
7989
|
-
number: number;
|
|
7990
|
-
/** Epoch start timestamp in milliseconds. */
|
|
7991
|
-
startTimestampMs: Timestamp;
|
|
7992
|
-
/** Epoch end timestamp in milliseconds. */
|
|
7993
|
-
endTimestampMs: Timestamp;
|
|
7994
|
-
/** Epoch status, e.g. "pending", "ready", "processed". */
|
|
7995
|
-
status: string;
|
|
7996
|
-
}
|
|
7997
|
-
/**
|
|
7998
|
-
* Totals summed across all reward domains.
|
|
7999
|
-
*/
|
|
8000
|
-
interface RewardsExpectedTotals {
|
|
8001
|
-
/** Total expected reward value in USD. */
|
|
8002
|
-
tokensUsd: number;
|
|
8003
|
-
/** Total expected reward amount in reward-coin base units (stringified). */
|
|
8004
|
-
tokensRaw: BigIntAsString;
|
|
8005
|
-
/** Total expected points across all domains. */
|
|
8006
|
-
points: number;
|
|
8007
|
-
}
|
|
8008
|
-
/**
|
|
8009
|
-
* Expected rewards for a single domain (e.g. "trading", "referral", "aflp").
|
|
8010
|
-
*/
|
|
8011
|
-
interface RewardsExpectedDomainTokens {
|
|
8012
|
-
/** Reward domain, e.g. "trading", "referral", "aflp", "integrator". */
|
|
8013
|
-
domain: string;
|
|
8014
|
-
/** Expected reward value in USD for this domain. */
|
|
8015
|
-
tokensUsd: number;
|
|
8016
|
-
/** Expected reward amount in reward-coin base units for this domain (stringified). */
|
|
8017
|
-
tokensRaw: BigIntAsString;
|
|
8018
|
-
}
|
|
8019
|
-
/**
|
|
8020
|
-
* Response with a single account's expected rewards for an epoch.
|
|
8021
|
-
*/
|
|
8022
|
-
interface ApiRewardsExpectedRewardsResponse {
|
|
8023
|
-
/** The epoch the rewards belong to. */
|
|
8024
|
-
epoch: RewardsExpectedEpochInfo;
|
|
8025
|
-
/** Totals summed across all domains. */
|
|
8026
|
-
total: RewardsExpectedTotals;
|
|
8027
|
-
/** Per-domain expected reward breakdown. */
|
|
8028
|
-
domains: RewardsExpectedDomainTokens[];
|
|
8041
|
+
refCode: string;
|
|
8029
8042
|
}
|
|
8030
|
-
/**
|
|
8031
|
-
|
|
8032
|
-
*/
|
|
8033
|
-
interface ApiRewardsClaimRequestTxBody {
|
|
8043
|
+
/** Response returned after linking a wallet to a referral code. */
|
|
8044
|
+
interface ApiReferralsSetReferrerResponse {
|
|
8034
8045
|
/**
|
|
8035
|
-
*
|
|
8046
|
+
* Wallet address of the referred user.
|
|
8036
8047
|
*/
|
|
8037
|
-
|
|
8048
|
+
refereeAddress: SuiAddress;
|
|
8038
8049
|
/**
|
|
8039
|
-
*
|
|
8040
|
-
* If omitted, claims all available rewards.
|
|
8050
|
+
* Referral code used for the link.
|
|
8041
8051
|
*/
|
|
8042
|
-
|
|
8052
|
+
refCode: string;
|
|
8043
8053
|
/**
|
|
8044
|
-
*
|
|
8045
|
-
* Defaults to walletAddress if not provided.
|
|
8054
|
+
* Unix timestamp, in milliseconds, when the relationship was established.
|
|
8046
8055
|
*/
|
|
8047
|
-
|
|
8056
|
+
createdAt: Timestamp;
|
|
8048
8057
|
/**
|
|
8049
|
-
*
|
|
8058
|
+
* Backend status for the link result.
|
|
8050
8059
|
*/
|
|
8051
|
-
|
|
8052
|
-
}
|
|
8053
|
-
/** Raw response from the reward-claim transaction endpoint. */
|
|
8054
|
-
interface ApiRewardsClaimRequestTxResponse {
|
|
8055
|
-
/** Base64-serialized full transaction bytes or `TransactionKind` bytes. */
|
|
8056
|
-
txKind: SerializedTransaction;
|
|
8060
|
+
status: string;
|
|
8057
8061
|
}
|
|
8058
8062
|
|
|
8059
8063
|
/**
|
|
@@ -14286,37 +14290,12 @@ declare class Perpetuals extends Caller {
|
|
|
14286
14290
|
})): Promise<Omit<ApiTransactionResponse, "txKind"> & {
|
|
14287
14291
|
tx: Transaction;
|
|
14288
14292
|
}>;
|
|
14289
|
-
/**
|
|
14290
|
-
* Calculate rewards and rebates for one or more perpetuals accounts.
|
|
14291
|
-
*
|
|
14292
|
-
* Computes per-account maker and taker reward allocations, fee-tier rebates,
|
|
14293
|
-
* and volume-based metrics. When `accountIds` is omitted or empty, all eligible
|
|
14294
|
-
* accounts are included.
|
|
14295
|
-
*
|
|
14296
|
-
* **Note:** All data returned is for the current epoch only.
|
|
14297
|
-
*
|
|
14298
|
-
* @param inputs.totalMakerRewards - Total maker reward pool to distribute.
|
|
14299
|
-
* @param inputs.totalTakerRewards - Total taker reward pool to distribute.
|
|
14300
|
-
* @param inputs.accountIds - Optional list of account IDs.
|
|
14301
|
-
* @returns `ApiPerpetualsCurrentRebateRewardsResponse` with per-account reward and rebate data.
|
|
14302
|
-
*
|
|
14303
|
-
* @example
|
|
14304
|
-
* ```ts
|
|
14305
|
-
* const { totalQScoreFinal, rewards } = await perps.getCurrentRebateRewards({
|
|
14306
|
-
* totalMakerRewards: 10000,
|
|
14307
|
-
* totalTakerRewards: 5000,
|
|
14308
|
-
* });
|
|
14309
|
-
* ```
|
|
14310
|
-
*/
|
|
14311
|
-
getCurrentRebateRewards(inputs: ApiPerpetualsCurrentRebateRewardsBody): Promise<ApiPerpetualsCurrentRebateRewardsResponse>;
|
|
14312
14293
|
/**
|
|
14313
14294
|
* Generate a CSV-formatted rebate report for perpetuals market makers.
|
|
14314
14295
|
*
|
|
14315
|
-
*
|
|
14316
|
-
*
|
|
14317
|
-
*
|
|
14318
|
-
*
|
|
14319
|
-
* **Note:** All data returned is for the current epoch only.
|
|
14296
|
+
* **Currently unavailable:** the backend removed
|
|
14297
|
+
* `/api/perpetuals/rebates/create-csv-rebates`, so this request fails until
|
|
14298
|
+
* a replacement endpoint ships. Kept so existing callers still compile.
|
|
14320
14299
|
*
|
|
14321
14300
|
* @param inputs - {@link ApiPerpetualsCreateCsvRebatesBody}.
|
|
14322
14301
|
* @returns `ApiPerpetualsCreateCsvRebatesResponse` containing the CSV string.
|
|
@@ -14325,8 +14304,10 @@ declare class Perpetuals extends Caller {
|
|
|
14325
14304
|
/**
|
|
14326
14305
|
* Generate a CSV-formatted referral rebate report.
|
|
14327
14306
|
*
|
|
14328
|
-
*
|
|
14329
|
-
*
|
|
14307
|
+
* **Currently unavailable:** the backend removed
|
|
14308
|
+
* `/api/perpetuals/rebates/create-referral-csv-rebates`, so this request
|
|
14309
|
+
* fails until a replacement endpoint ships. Kept so existing callers still
|
|
14310
|
+
* compile.
|
|
14330
14311
|
*
|
|
14331
14312
|
* @param inputs - {@link ApiPerpetualsCreateReferralCsvRebatesBody}.
|
|
14332
14313
|
* @returns `ApiPerpetualsCreateReferralCsvRebatesResponse` containing the CSV string.
|
|
@@ -17212,6 +17193,30 @@ declare class Rewards extends Caller {
|
|
|
17212
17193
|
* @returns The total points across all reward epochs and domains.
|
|
17213
17194
|
* @throws `AftermathTransportError` when the API request or response fails.
|
|
17214
17195
|
*/
|
|
17196
|
+
/**
|
|
17197
|
+
* Computes the distribution of the maker and taker reward pools across
|
|
17198
|
+
* perpetuals accounts.
|
|
17199
|
+
*
|
|
17200
|
+
* Returns per-account maker and taker reward allocations, fee-tier rebates
|
|
17201
|
+
* and volume metrics. When `accountIds` is omitted or empty the API includes
|
|
17202
|
+
* every eligible account, so pass an explicit list to scope the result.
|
|
17203
|
+
*
|
|
17204
|
+
* **Note:** All data returned is for the current epoch only.
|
|
17205
|
+
*
|
|
17206
|
+
* @param inputs - {@link ApiRewardsDistributionBody}.
|
|
17207
|
+
* @returns Per-account reward and rebate breakdown for the current epoch.
|
|
17208
|
+
* @throws `AftermathTransportError` when the API request or response fails.
|
|
17209
|
+
*
|
|
17210
|
+
* @example
|
|
17211
|
+
* ```ts
|
|
17212
|
+
* const { totalQScoreFinal, rewards } = await rewards.getDistribution({
|
|
17213
|
+
* totalMakerRewards: 10000,
|
|
17214
|
+
* totalTakerRewards: 5000,
|
|
17215
|
+
* calculationVariables: { ... },
|
|
17216
|
+
* });
|
|
17217
|
+
* ```
|
|
17218
|
+
*/
|
|
17219
|
+
getDistribution(inputs: ApiRewardsDistributionBody): Promise<ApiRewardsDistributionResponse>;
|
|
17215
17220
|
getPoints(inputs: ApiRewardsGetPointsBody): Promise<ApiRewardsGetPointsResponse>;
|
|
17216
17221
|
/**
|
|
17217
17222
|
* Fetches one page of the wallet's reward history.
|
|
@@ -25723,4 +25728,4 @@ declare class Aftermath extends Caller {
|
|
|
25723
25728
|
static casting: typeof Casting;
|
|
25724
25729
|
}
|
|
25725
25730
|
|
|
25726
|
-
export { type AfSuiRouterPoolObject, Aftermath, type AftermathAbortSource, AftermathApi, type AftermathOptions, AftermathTransportError, type AftermathTransportErrorKind, type AllocatedCollateralEvent, type AmountInCoinAndUsd, type AnyObjectType, type ApiAccessoriesForSuiFrenBody, type ApiAddSuiFrenAccessoryBody, type ApiCreateAuthAccountBody, type ApiCreatePoolBody, type ApiDataWithCursorBody, type ApiDelegatedStakesBody, type ApiDynamicFieldsBody, type ApiDynamicGasBody, type ApiDynamicGasResponse, type ApiEventsBody, type ApiFarmsCreateStakingPoolBody, type ApiFarmsCreateStakingPoolBodyV1, type ApiFarmsDepositPrincipalBody, type ApiFarmsGrantOneTimeAdminCapBody, type ApiFarmsIncreaseStakingPoolRewardsEmissionsBody, type ApiFarmsInitializeStakingPoolRewardBody, type ApiFarmsLockBody, type ApiFarmsOwnedStakedPositionsBody, type ApiFarmsOwnedStakingPoolOneTimeAdminCapsBody, type ApiFarmsOwnedStakingPoolOwnerCapsBody, type ApiFarmsRenewLockBody, type ApiFarmsStakeBody, type ApiFarmsStakeBodyV1, type ApiFarmsSummaryBody, type ApiFarmsTopUpStakingPoolRewardsBody, type ApiFarmsUnlockBody, type ApiFarmsUnstakeBody, type ApiFaucetMintSuiFrenBody, type ApiFaucetRequestBody, type ApiGasPoolBody, type ApiGasPoolCreateBody, type ApiGasPoolCreateResponse, type ApiGasPoolDepositBody, type ApiGasPoolGrantBody, type ApiGasPoolResponse, type ApiGasPoolRevokeBody, type ApiGasPoolShareBody, type ApiGasPoolSponsorBody, type ApiGasPoolSponsorResponse, type ApiGasPoolWithdrawBody, type ApiGasPoolWithdrawResponse, type ApiGetAccessTokenBody, type ApiGetAccessTokenResponse, type ApiHarvestFarmsRewardsBody, type ApiHarvestSuiFrenFeesBody, type ApiIndexerEventsBody, type ApiIndexerUserEventsBody, type ApiMixSuiFrensBody, type ApiNftAmmBuyBody, type ApiNftAmmDepositBody, type ApiNftAmmSellBody, type ApiNftAmmWithdrawBody, type ApiOwnedStakedSuiFrensBody, type ApiOwnedSuiFrenAccessoriesBody, type ApiOwnedSuiFrensBody, type ApiPerpetualsAccountCollateralHistoryBody, type ApiPerpetualsAccountCollateralHistoryResponse, type ApiPerpetualsAccountMarginHistoryBody, type ApiPerpetualsAccountMarginHistoryResponse, type ApiPerpetualsAccountOrderHistoryBody, type ApiPerpetualsAccountOrderHistoryResponse, type ApiPerpetualsAccountPositionsBody, type ApiPerpetualsAccountPositionsResponse, type ApiPerpetualsAdminAccountCapsBody, type ApiPerpetualsAdminAccountCapsResponse, type ApiPerpetualsAllMarketsBody, type ApiPerpetualsAllMarketsResponse, type ApiPerpetualsAllocateCollateralBody, type ApiPerpetualsBuilderCodesClaimIntegratorVaultFeesTxBody, type ApiPerpetualsBuilderCodesClaimIntegratorVaultFeesTxResponse, type ApiPerpetualsBuilderCodesCreateIntegratorConfigTxBody, type ApiPerpetualsBuilderCodesCreateIntegratorVaultTxBody, type ApiPerpetualsBuilderCodesIntegratorConfigBody, type ApiPerpetualsBuilderCodesIntegratorConfigResponse, type ApiPerpetualsBuilderCodesIntegratorVaultsBody, type ApiPerpetualsBuilderCodesIntegratorVaultsResponse, type ApiPerpetualsBuilderCodesRemoveIntegratorConfigTxBody, type ApiPerpetualsCancelAndPlaceOrdersBody, type ApiPerpetualsCancelOrdersBody, type ApiPerpetualsCancelStopOrdersBody, type ApiPerpetualsCancelTwapOrdersBody, type ApiPerpetualsCreateAccountBody, type ApiPerpetualsCreateAccountResponse, type ApiPerpetualsCreateCsvRebatesBody, type ApiPerpetualsCreateCsvRebatesResponse, type ApiPerpetualsCreateReferralCsvRebatesBody, type ApiPerpetualsCreateReferralCsvRebatesResponse, type ApiPerpetualsCreateTwapOrdersBody, type ApiPerpetualsCreateVaultBody, type ApiPerpetualsCreateVaultCapBody, type ApiPerpetualsCurrentRebateRewardsBody, type ApiPerpetualsCurrentRebateRewardsResponse, type ApiPerpetualsDeallocateCollateralBody, type ApiPerpetualsDepositCollateralBody, type ApiPerpetualsEditStopOrdersBody, type ApiPerpetualsEditTwapOrdersBody, type ApiPerpetualsExecutionPriceBody, type ApiPerpetualsExecutionPriceResponse, type ApiPerpetualsGrantAgentWalletTxBody, type ApiPerpetualsHistoricalDataWithCursorBody, type ApiPerpetualsHistoricalDataWithCursorResponse, type ApiPerpetualsLimitOrderBody, type ApiPerpetualsMarketCandleHistoryBody, type ApiPerpetualsMarketCandleHistoryResponse, type ApiPerpetualsMarketFundingHistoryBody, type ApiPerpetualsMarketFundingHistoryResponse, type ApiPerpetualsMarketOrderBody, type ApiPerpetualsMarketOrderHistoryBody, type ApiPerpetualsMarketOrderHistoryResponse, type ApiPerpetualsMarkets24hrStatsResponse, type ApiPerpetualsMarketsBody, type ApiPerpetualsMarketsPricesBody, type ApiPerpetualsMarketsPricesResponse, type ApiPerpetualsMarketsResponse, type ApiPerpetualsMaxOrderSizeBody, type ApiPerpetualsOrderToPlace, type ApiPerpetualsOrderbooksBody, type ApiPerpetualsOrderbooksResponse, type ApiPerpetualsOwnedAccountCapsBody, type ApiPerpetualsOwnedAccountCapsResponse, type ApiPerpetualsOwnedVaultAssistantCapsBody, type ApiPerpetualsOwnedVaultAssistantCapsResponse, type ApiPerpetualsOwnedVaultCapsBody, type ApiPerpetualsOwnedVaultCapsResponse, type ApiPerpetualsPlaceSlTpOrdersBody, type ApiPerpetualsPlaceStopOrdersBody, type ApiPerpetualsPreviewCancelOrdersBody, type ApiPerpetualsPreviewCancelOrdersResponse, type ApiPerpetualsPreviewEditCollateralBody, type ApiPerpetualsPreviewEditCollateralResponse, type ApiPerpetualsPreviewPlaceLimitOrderBody, type ApiPerpetualsPreviewPlaceMarketOrderBody, type ApiPerpetualsPreviewPlaceOrderResponse, type ApiPerpetualsPreviewPlaceScaleOrderBody, type ApiPerpetualsPreviewSetLeverageBody, type ApiPerpetualsPreviewSetLeverageResponse, type ApiPerpetualsRevokeAgentWalletTxBody, type ApiPerpetualsScaleOrderBody, type ApiPerpetualsSetLeverageTxBody, type ApiPerpetualsShareAccountBody, type ApiPerpetualsStopOrderDatasBody, type ApiPerpetualsStopOrderDatasResponse, type ApiPerpetualsTransferCapTxBody, type ApiPerpetualsTransferCollateralBody, type ApiPerpetualsTwapOrderDatasBody, type ApiPerpetualsTwapOrderDatasResponse, type ApiPerpetualsVaultCancelWithdrawRequestTxBody, type ApiPerpetualsVaultCreateWithdrawRequestTxBody, type ApiPerpetualsVaultDepositTxBody, type ApiPerpetualsVaultGrantAgentWalletTxBody, type ApiPerpetualsVaultLpCoinPricesBody, type ApiPerpetualsVaultLpCoinPricesResponse, type ApiPerpetualsVaultOwnedLpCoinsBody, type ApiPerpetualsVaultOwnedLpCoinsResponse, type ApiPerpetualsVaultOwnedWithdrawRequestsBody, type ApiPerpetualsVaultOwnedWithdrawRequestsResponse, type ApiPerpetualsVaultOwnerProcessWithdrawRequestsTxBody, type ApiPerpetualsVaultOwnerUpdateForceWithdrawDelayTxBody, type ApiPerpetualsVaultOwnerUpdateLockPeriodTxBody, type ApiPerpetualsVaultOwnerUpdatePerformanceFeeTxBody, type ApiPerpetualsVaultOwnerWithdrawCollateralTxBody, type ApiPerpetualsVaultOwnerWithdrawCollateralTxResponse, type ApiPerpetualsVaultOwnerWithdrawLockedLiquidityTxBody, type ApiPerpetualsVaultOwnerWithdrawLockedLiquidityTxResponse, type ApiPerpetualsVaultOwnerWithdrawPerformanceFeesTxBody, type ApiPerpetualsVaultOwnerWithdrawPerformanceFeesTxResponse, type ApiPerpetualsVaultPauseVaultForForceWithdrawRequestTxBody, type ApiPerpetualsVaultPreviewCreateWithdrawRequestBody, type ApiPerpetualsVaultPreviewCreateWithdrawRequestResponse, type ApiPerpetualsVaultPreviewDepositBody, type ApiPerpetualsVaultPreviewDepositResponse, type ApiPerpetualsVaultPreviewOwnerProcessWithdrawRequestsBody, type ApiPerpetualsVaultPreviewOwnerProcessWithdrawRequestsResponse, type ApiPerpetualsVaultPreviewOwnerWithdrawCollateralBody, type ApiPerpetualsVaultPreviewOwnerWithdrawCollateralResponse, type ApiPerpetualsVaultPreviewOwnerWithdrawLockedLiquidityBody, type ApiPerpetualsVaultPreviewOwnerWithdrawLockedLiquidityResponse, type ApiPerpetualsVaultPreviewOwnerWithdrawPerformanceFeesBody, type ApiPerpetualsVaultPreviewOwnerWithdrawPerformanceFeesResponse, type ApiPerpetualsVaultPreviewPauseVaultForForceWithdrawRequestBody, type ApiPerpetualsVaultPreviewPauseVaultForForceWithdrawRequestResponse, type ApiPerpetualsVaultPreviewProcessForceWithdrawRequestBody, type ApiPerpetualsVaultPreviewProcessForceWithdrawRequestResponse, type ApiPerpetualsVaultProcessForceWithdrawRequestTxBody, type ApiPerpetualsVaultProcessForceWithdrawRequestTxResponse, type ApiPerpetualsVaultRevokeAgentWalletTxBody, type ApiPerpetualsVaultUpdateWithdrawRequestSlippageTxBody, type ApiPerpetualsVaultsBody, type ApiPerpetualsVaultsResponse, type ApiPerpetualsVaultsWithdrawRequestsBody, type ApiPerpetualsVaultsWithdrawRequestsResponse, type ApiPerpetualsWithdrawCollateralBody, type ApiPerpetualsWithdrawCollateralResponse, type ApiPoolAllCoinWithdrawBody, type ApiPoolDepositBody, type ApiPoolObjectIdForLpCoinTypeBody, type ApiPoolSpotPriceBody, type ApiPoolTradeBody, type ApiPoolWithdrawBody, type ApiPoolsOwnedDaoFeePoolOwnerCapsBody, type ApiPoolsStatsBody, type ApiPoolsSummaryBody, type ApiPublishLpCoinBody, type ApiReferralsCreateReferralLinkBody, type ApiReferralsCreateReferralLinkResponse, type ApiReferralsGetLinkedRefCodeBody, type ApiReferralsGetLinkedRefCodeResponse, type ApiReferralsGetRefCodeBody, type ApiReferralsGetRefCodeResponse, type ApiReferralsGetRefereesBody, type ApiReferralsGetRefereesResponse, type ApiReferralsIsRefCodeTakenBody, type ApiReferralsIsRefCodeTakenResponse, type ApiReferralsSetReferrerBody, type ApiReferralsSetReferrerResponse, type ApiRemoveSuiFrenAccessoryBody, type ApiRewardsClaimRequestTxBody, type ApiRewardsClaimRequestTxResponse, type ApiRewardsExpectedRewardsBody, type ApiRewardsExpectedRewardsResponse, type ApiRewardsGetClaimableBody, type ApiRewardsGetClaimableResponse, type ApiRewardsGetHistoryBody, type ApiRewardsGetHistoryResponse, type ApiRewardsGetPointsBody, type ApiRewardsGetPointsResponse, type ApiRouterAddTransactionForCompleteTradeRouteBody, type ApiRouterAddTransactionForCompleteTradeRouteBodyDeprecated, type ApiRouterAddTransactionForCompleteTradeRouteResponse, type ApiRouterAddTransactionForCompleteTradeRouteResponseDeprecated, type ApiRouterCompleteTradeRouteBody, type ApiRouterDynamicGasBody, type ApiRouterPartialCompleteTradeRouteBody, type ApiRouterTradeEventsBody, type ApiRouterTransactionForCompleteTradeRouteBody, type ApiStakeBody, type ApiStakeStakedSuiBody, type ApiStakeSuiFrenBody, type ApiStakingEventsBody, type ApiStakingPositionsBody, type ApiTransactionResponse, type ApiTransactionsBody, type ApiUnstakeBody, type ApiUnstakeSuiFrenBody, type ApiUpdateValidatorFeeBody, type ApiValidatorOperationCapsBody, type Apr, type Apy, Auth, type Balance, type BigIntAsString, type Bps, type Byte, type CallerConfig, type CanceledOrderEvent, type CapyLabsAppObject, Casting, Coin, type CoinDecimal, type CoinGeckoChain, type CoinGeckoCoinApiId, type CoinGeckoCoinData, type CoinGeckoCoinSymbolData, type CoinGeckoHistoricalTradeData, type CoinGeckoTickerData, type CoinMetadaWithInfo, type CoinPriceInfo, type CoinSymbol, type CoinSymbolToCoinTypes, type CoinSymbolsToPriceInfo, type CoinType, type CoinWithAmount, type CoinWithAmountOrUndefined, type CoinsToBalance, type CoinsToBalanceOrUndefined, type CoinsToDecimals, type CoinsToPrice, type CoinsToPriceInfo, type CollateralEvent, type Color, type ComposedTransferArgs, type ConfigAddresses, type CreatedAccountEvent, type CreatedDaoFeePoolEvent, type CreatedStopOrderTicketEvent, type DaoFeePoolObject, type DaoFeePoolOwnerCapObject, type DaoFeePoolsAddresses, type DcaAddresses, type DeallocatedCollateralEvent, type DecimalsScalar, type DeferredAccountArgs, type DeletedStopOrderTicketEvent, type DepositedCollateralEvent, type DynamicFieldObjectsWithCursor, type DynamicFieldsInputs, type DynamicFieldsWithCursor, type DynamicGasAddresses, type EditedStopOrderTicketDetailsEvent, type EditedStopOrderTicketExecutorEvent, type EmptyObject, type EpochWasChangedEvent, type Event$1 as Event, type EventsInputs, type EventsWithCursor, type ExecutedStopOrderTicketEvent, type ExternalFee, type FarmEvent, type FarmOwnerOrOneTimeAdminCap, type FarmSummary, type FarmUserEvent, Farms, type FarmsAddedRewardEvent, type FarmsAddresses, type FarmsCreatedVaultEvent, type FarmsDepositedPrincipalEvent, type FarmsDestroyedStakedPositionEvent, type FarmsHarvestedRewardsEvent, type FarmsIncreasedEmissionsEvent, type FarmsInitializedRewardEvent, type FarmsJoinedEvent, type FarmsLockEnforcement, type FarmsLockedEvent, type FarmsMultiplier, type FarmsSplitEvent, type FarmsStakedEvent, FarmsStakedPosition, type FarmsStakedPositionObject, type FarmsStakedPositionRewardCoin, type FarmsStakedRelaxedEvent, FarmsStakingPool, type FarmsStakingPoolObject, type FarmsStakingPoolRewardCoin, type FarmsUnlockedEvent, type FarmsVersion, type FarmsWithdrewPrincipalEvent, Faucet, type FaucetAddCoinEvent, type FaucetAddresses, type FaucetMintCoinEvent, type FilePath, type FilledMakerOrderEventFields, type FilledMakerOrdersEvent, type FilledTakerOrderEvent, type FunctionName, type GasBudget, GasPools, GrpcCasting, type HarvestSuiFrenFeesEvent, Helpers, type IFixed, type IFixedAsBytes, type IFixedAsString, type IFixedAsStringBytes, type IdAsStringBytes, type IndexerDataWithCursorQueryParams, type IndexerEventsWithCursor, type KeyType, type KioskObject, type KioskOwnerCapObject, type LimitAddresses, type LiquidatedEvent, type LocalUrl, type MixSuiFrensEvent, type ModuleName, type MoveErrorCode, type MoveErrors, type MoveErrorsInterface, type Nft, NftAmm, type NftAmmAddresses, type NftAmmInterfaceGenericTypes, type NftAmmMarketObject, type NftDisplay, type NftDisplayOther, type NftDisplaySuggested, type NftInfo, type NftsAddresses, type NormalizedBalance, type NumberAsString, type Object$1 as Object, type ObjectDigest, type ObjectId, type ObjectVersion, type OrderbookFillReceiptEvent, type PackageId, type ParsedMoveError, type PartialFarmsStakedPositionObject, type PartialSuiFrenObject, type Percentage, Perpetuals, PerpetualsAccount, type PerpetualsAccountCap, type PerpetualsAccountCollateralChange, type PerpetualsAccountData, type PerpetualsAccountId, type PerpetualsAccountMarginHistoryData, type PerpetualsAccountMarginHistoryTimeframeKey, type PerpetualsAccountObject, type PerpetualsAccountOrderHistoryData, type PerpetualsAddresses, type PerpetualsBuilderCodeParamaters, type PerpetualsCalculationVariables, type PerpetualsCandleResolution, type PerpetualsCapType, type PerpetualsClientOrderId, type PerpetualsExecutionInfo, type PerpetualsFilledOrderData, type PerpetualsIntegratorVaultData, type PerpetualsMakerData, PerpetualsMarket, type PerpetualsMarket24hrStats, type PerpetualsMarketCandleDataPoint, type PerpetualsMarketData, type PerpetualsMarketFundingHistoryPoint, type PerpetualsMarketId, type PerpetualsMarketMetadata, type PerpetualsMarketOrderHistoryData, type PerpetualsMarketParams, type PerpetualsMarketState, type PerpetualsOrderData, type PerpetualsOrderEvent, type PerpetualsOrderId, type PerpetualsOrderIdAsString, type PerpetualsOrderInfo, type PerpetualsOrderPrice, PerpetualsOrderSide, type PerpetualsOrderState, PerpetualsOrderType, type PerpetualsOrderbook, type PerpetualsOrderbookDeltas, type PerpetualsOrderbookItem, type PerpetualsPartialVaultCap, type PerpetualsPosition, type PerpetualsRewardData, type PerpetualsServerInjectedTxFields, type PerpetualsSponsorConfig, type PerpetualsStopOrderData, PerpetualsStopOrderTriggerPriceType, PerpetualsStopOrderType, type PerpetualsTakerData, type PerpetualsTopOfOrderbook, type PerpetualsTopOfOrderbookDataPoint, type PerpetualsTwapEvent, type PerpetualsTwapOrderData, type PerpetualsTwapOrderDetails, type PerpetualsTwapOrderDetailsData, type PerpetualsTwapOrderEdit, type PerpetualsTwapOrderState, PerpetualsVault, type PerpetualsVaultCap, type PerpetualsVaultLpCoin, type PerpetualsVaultMetatada, type PerpetualsVaultObject, type PerpetualsVaultWithdrawRequest, type PerpetualsVaultsAddresses, type PerpetualsVaultsConfig, type PerpetualsWsCandleResponseMessage, type PerpetualsWsUpdatesMarketCandlesPayload, type PerpetualsWsUpdatesMarketCandlesSubscriptionType, type PerpetualsWsUpdatesMarketOrdersPayload, type PerpetualsWsUpdatesMarketOrdersSubscriptionType, type PerpetualsWsUpdatesMarketSubscriptionType, type PerpetualsWsUpdatesOraclePayload, type PerpetualsWsUpdatesOracleSubscriptionType, type PerpetualsWsUpdatesOrderbookPayload, type PerpetualsWsUpdatesOrderbookSubscriptionType, type PerpetualsWsUpdatesResponseMessage, type PerpetualsWsUpdatesSubscriptionAction, type PerpetualsWsUpdatesSubscriptionMessage, type PerpetualsWsUpdatesSubscriptionType, type PerpetualsWsUpdatesTopOfOrderbookPayload, type PerpetualsWsUpdatesTopOfOrderbookSubscriptionType, type PerpetualsWsUpdatesUserCollateralChangesPayload, type PerpetualsWsUpdatesUserCollateralChangesSubscriptionType, type PerpetualsWsUpdatesUserOrdersPayload, type PerpetualsWsUpdatesUserOrdersSubscriptionType, type PerpetualsWsUpdatesUserPayload, type PerpetualsWsUpdatesUserSubscriptionType, Pool, type PoolCoin, type PoolCoins, type PoolCreationCoinInfo, type PoolCreationLpCoinMetadata, type PoolDataPoint, type PoolDepositEvent, type PoolDepositFee, type PoolFlatness, type PoolGraphDataTimeUnit, type PoolGraphDataTimeframe, type PoolGraphDataTimeframeKey, type PoolLpInfo, type PoolName, type PoolObject, type PoolStats, type PoolSummary, type PoolTradeEvent, type PoolTradeFee, type PoolWeight, type PoolWithdrawEvent, type PoolWithdrawFee, Pools, type PoolsAddresses, type PostedOrderEvent, type RateLimit, type ReceivedCollateralEvent, type ReducedOrderEvent, ReferralVault, type ReferralVaultAddresses, type ReferralsRefereeInfo, type RewardsClaimableReward, type RewardsExpectedCalculationVariables, type RewardsExpectedDomainTokens, type RewardsExpectedEpochInfo, type RewardsExpectedTotals, type RewardsHistoryEntry, type RewardsHistoryEventType, type RewardsPaginationInfo, Router, type RouterAddresses, type RouterCompleteTradeRoute, type RouterCompleteTradeRouteWithFee, type RouterExternalFee, type RouterProtocolName, type RouterTradeCoin, type RouterTradeEvent, type RouterTradeInfo, type RouterTradePath, type RouterTradeRoute, type RpcEndpoint, type ScallopAddresses, type SdkPerpetualsCancelAndPlaceOrdersInputs, type SdkPerpetualsCancelOrdersPreviewInputs, type SdkPerpetualsCancelTwapOrdersInputs, type SdkPerpetualsCreateTwapOrdersInputs, type SdkPerpetualsEditTwapOrdersInputs, type SdkPerpetualsPlaceLimitOrderInputs, type SdkPerpetualsPlaceLimitOrderPreviewInputs, type SdkPerpetualsPlaceMarketOrderInputs, type SdkPerpetualsPlaceMarketOrderPreviewInputs, type SdkPerpetualsPlaceScaleOrderInputs, type SdkPerpetualsPlaceScaleOrderPreviewInputs, type SdkPerpetualsPlaceSlTpOrdersInputs, type SdkPerpetualsPlaceStopOrdersInputs, type SdkTransactionResponse, type SerializedTransaction, type ServiceCoinData, type ServiceCoinDataV2, type SetPositionInitialMarginRatioEvent, type SettledFundingEvent, type SharedCustodyAddresses, type SignMessageCallback, type Slippage, type StakeBalanceDynamicField, type StakeEvent, type StakePosition, type StakeSuiFrenEvent, type StakedEvent, StakedSuiFren, type StakedSuiFrenInfo, type StakedSuiFrenMetadataV1Object, type StakedSuiFrenPositionObject, type StakedSuiVaultStateObject, Staking, type StakingAddresses, type StakingApyDataPoint, type StakingApyTimeframeKey, type StakingPoolOneTimeAdminCapObject, type StakingPoolOwnerCapObject, type StakingPosition, type StringByte, Sui, type SuiAddress, type SuiCheckpoint, type SuiDelegatedStake, type SuiDelegatedStakeState, SuiFren, type SuiFrenAccessoryName, type SuiFrenAccessoryObject, type SuiFrenAccessoryType, type SuiFrenAttributes, type SuiFrenObject, type SuiFrenStats, type SuiFrenVaultStateV1Object, SuiFrens, type SuiFrensAddresses, SuiFrensSortOption, type SuiNetwork, type SuiObjectView, type Timestamp, type TransactionDigest, type TransactionsWithCursor, type TransferredDeallocatedCollateralEvent, type TranslatedMoveError, type TxBytes, type UniqueId, type UnstakeEvent, type UnstakePosition, type UnstakePositionState, type UnstakeRequestedEvent, type UnstakeSuiFrenEvent, type UnstakedEvent, type UpdatedFeeBpsEvent, type UpdatedFeeRecipientEvent, type UpdatedFundingEvent, type UpdatedMarketVersionEvent, type UpdatedPremiumTwapEvent, type UpdatedSpreadTwapEvent, type Url, type UserEventsInputs, type UserHistoryEventType, type ValidatorConfigObject, type ValidatorOperationCapObject, type ValueOf, type WithdrewCollateralEvent, isAftermathTransportError, isAllocatedCollateralEvent, isCanceledOrderEvent, isDeallocatedCollateralEvent, isDepositedCollateralEvent, isFarmsDepositedPrincipalEvent, isFarmsHarvestedRewardsEvent, isFarmsLockedEvent, isFarmsStakedEvent, isFarmsUnlockedEvent, isFarmsWithdrewPrincipalEvent, isFilledMakerOrdersEvent, isFilledTakerOrderEvent, isLiquidatedEvent, isPostedOrderEvent, isReducedOrderEvent, isSettledFundingEvent, isStakeEvent, isStakePosition, isSuiDelegatedStake, isUnstakeEvent, isUnstakePosition, isUpdatedFundingEvent, isUpdatedMarketVersion, isUpdatedPremiumTwapEvent, isUpdatedSpreadTwapEvent, isWithdrewCollateralEvent };
|
|
25731
|
+
export { type AfSuiRouterPoolObject, Aftermath, type AftermathAbortSource, AftermathApi, type AftermathOptions, AftermathTransportError, type AftermathTransportErrorKind, type AllocatedCollateralEvent, type AmountInCoinAndUsd, type AnyObjectType, type ApiAccessoriesForSuiFrenBody, type ApiAddSuiFrenAccessoryBody, type ApiCreateAuthAccountBody, type ApiCreatePoolBody, type ApiDataWithCursorBody, type ApiDelegatedStakesBody, type ApiDynamicFieldsBody, type ApiDynamicGasBody, type ApiDynamicGasResponse, type ApiEventsBody, type ApiFarmsCreateStakingPoolBody, type ApiFarmsCreateStakingPoolBodyV1, type ApiFarmsDepositPrincipalBody, type ApiFarmsGrantOneTimeAdminCapBody, type ApiFarmsIncreaseStakingPoolRewardsEmissionsBody, type ApiFarmsInitializeStakingPoolRewardBody, type ApiFarmsLockBody, type ApiFarmsOwnedStakedPositionsBody, type ApiFarmsOwnedStakingPoolOneTimeAdminCapsBody, type ApiFarmsOwnedStakingPoolOwnerCapsBody, type ApiFarmsRenewLockBody, type ApiFarmsStakeBody, type ApiFarmsStakeBodyV1, type ApiFarmsSummaryBody, type ApiFarmsTopUpStakingPoolRewardsBody, type ApiFarmsUnlockBody, type ApiFarmsUnstakeBody, type ApiFaucetMintSuiFrenBody, type ApiFaucetRequestBody, type ApiGasPoolBody, type ApiGasPoolCreateBody, type ApiGasPoolCreateResponse, type ApiGasPoolDepositBody, type ApiGasPoolGrantBody, type ApiGasPoolResponse, type ApiGasPoolRevokeBody, type ApiGasPoolShareBody, type ApiGasPoolSponsorBody, type ApiGasPoolSponsorResponse, type ApiGasPoolWithdrawBody, type ApiGasPoolWithdrawResponse, type ApiGetAccessTokenBody, type ApiGetAccessTokenResponse, type ApiHarvestFarmsRewardsBody, type ApiHarvestSuiFrenFeesBody, type ApiIndexerEventsBody, type ApiIndexerUserEventsBody, type ApiMixSuiFrensBody, type ApiNftAmmBuyBody, type ApiNftAmmDepositBody, type ApiNftAmmSellBody, type ApiNftAmmWithdrawBody, type ApiOwnedStakedSuiFrensBody, type ApiOwnedSuiFrenAccessoriesBody, type ApiOwnedSuiFrensBody, type ApiPerpetualsAccountCollateralHistoryBody, type ApiPerpetualsAccountCollateralHistoryResponse, type ApiPerpetualsAccountMarginHistoryBody, type ApiPerpetualsAccountMarginHistoryResponse, type ApiPerpetualsAccountOrderHistoryBody, type ApiPerpetualsAccountOrderHistoryResponse, type ApiPerpetualsAccountPositionsBody, type ApiPerpetualsAccountPositionsResponse, type ApiPerpetualsAdminAccountCapsBody, type ApiPerpetualsAdminAccountCapsResponse, type ApiPerpetualsAllMarketsBody, type ApiPerpetualsAllMarketsResponse, type ApiPerpetualsAllocateCollateralBody, type ApiPerpetualsBuilderCodesClaimIntegratorVaultFeesTxBody, type ApiPerpetualsBuilderCodesClaimIntegratorVaultFeesTxResponse, type ApiPerpetualsBuilderCodesCreateIntegratorConfigTxBody, type ApiPerpetualsBuilderCodesCreateIntegratorVaultTxBody, type ApiPerpetualsBuilderCodesIntegratorConfigBody, type ApiPerpetualsBuilderCodesIntegratorConfigResponse, type ApiPerpetualsBuilderCodesIntegratorVaultsBody, type ApiPerpetualsBuilderCodesIntegratorVaultsResponse, type ApiPerpetualsBuilderCodesRemoveIntegratorConfigTxBody, type ApiPerpetualsCancelAndPlaceOrdersBody, type ApiPerpetualsCancelOrdersBody, type ApiPerpetualsCancelStopOrdersBody, type ApiPerpetualsCancelTwapOrdersBody, type ApiPerpetualsCreateAccountBody, type ApiPerpetualsCreateAccountResponse, type ApiPerpetualsCreateCsvRebatesBody, type ApiPerpetualsCreateCsvRebatesResponse, type ApiPerpetualsCreateReferralCsvRebatesBody, type ApiPerpetualsCreateReferralCsvRebatesResponse, type ApiPerpetualsCreateTwapOrdersBody, type ApiPerpetualsCreateVaultBody, type ApiPerpetualsCreateVaultCapBody, type ApiPerpetualsDeallocateCollateralBody, type ApiPerpetualsDepositCollateralBody, type ApiPerpetualsEditStopOrdersBody, type ApiPerpetualsEditTwapOrdersBody, type ApiPerpetualsExecutionPriceBody, type ApiPerpetualsExecutionPriceResponse, type ApiPerpetualsGrantAgentWalletTxBody, type ApiPerpetualsHistoricalDataWithCursorBody, type ApiPerpetualsHistoricalDataWithCursorResponse, type ApiPerpetualsLimitOrderBody, type ApiPerpetualsMarketCandleHistoryBody, type ApiPerpetualsMarketCandleHistoryResponse, type ApiPerpetualsMarketFundingHistoryBody, type ApiPerpetualsMarketFundingHistoryResponse, type ApiPerpetualsMarketOrderBody, type ApiPerpetualsMarketOrderHistoryBody, type ApiPerpetualsMarketOrderHistoryResponse, type ApiPerpetualsMarkets24hrStatsResponse, type ApiPerpetualsMarketsBody, type ApiPerpetualsMarketsPricesBody, type ApiPerpetualsMarketsPricesResponse, type ApiPerpetualsMarketsResponse, type ApiPerpetualsMaxOrderSizeBody, type ApiPerpetualsOrderToPlace, type ApiPerpetualsOrderbooksBody, type ApiPerpetualsOrderbooksResponse, type ApiPerpetualsOwnedAccountCapsBody, type ApiPerpetualsOwnedAccountCapsResponse, type ApiPerpetualsOwnedVaultAssistantCapsBody, type ApiPerpetualsOwnedVaultAssistantCapsResponse, type ApiPerpetualsOwnedVaultCapsBody, type ApiPerpetualsOwnedVaultCapsResponse, type ApiPerpetualsPlaceSlTpOrdersBody, type ApiPerpetualsPlaceStopOrdersBody, type ApiPerpetualsPreviewCancelOrdersBody, type ApiPerpetualsPreviewCancelOrdersResponse, type ApiPerpetualsPreviewEditCollateralBody, type ApiPerpetualsPreviewEditCollateralResponse, type ApiPerpetualsPreviewPlaceLimitOrderBody, type ApiPerpetualsPreviewPlaceMarketOrderBody, type ApiPerpetualsPreviewPlaceOrderResponse, type ApiPerpetualsPreviewPlaceScaleOrderBody, type ApiPerpetualsPreviewSetLeverageBody, type ApiPerpetualsPreviewSetLeverageResponse, type ApiPerpetualsRevokeAgentWalletTxBody, type ApiPerpetualsScaleOrderBody, type ApiPerpetualsSetLeverageTxBody, type ApiPerpetualsShareAccountBody, type ApiPerpetualsStopOrderDatasBody, type ApiPerpetualsStopOrderDatasResponse, type ApiPerpetualsTransferCapTxBody, type ApiPerpetualsTransferCollateralBody, type ApiPerpetualsTwapOrderDatasBody, type ApiPerpetualsTwapOrderDatasResponse, type ApiPerpetualsVaultCancelWithdrawRequestTxBody, type ApiPerpetualsVaultCreateWithdrawRequestTxBody, type ApiPerpetualsVaultDepositTxBody, type ApiPerpetualsVaultGrantAgentWalletTxBody, type ApiPerpetualsVaultLpCoinPricesBody, type ApiPerpetualsVaultLpCoinPricesResponse, type ApiPerpetualsVaultOwnedLpCoinsBody, type ApiPerpetualsVaultOwnedLpCoinsResponse, type ApiPerpetualsVaultOwnedWithdrawRequestsBody, type ApiPerpetualsVaultOwnedWithdrawRequestsResponse, type ApiPerpetualsVaultOwnerProcessWithdrawRequestsTxBody, type ApiPerpetualsVaultOwnerUpdateForceWithdrawDelayTxBody, type ApiPerpetualsVaultOwnerUpdateLockPeriodTxBody, type ApiPerpetualsVaultOwnerUpdatePerformanceFeeTxBody, type ApiPerpetualsVaultOwnerWithdrawCollateralTxBody, type ApiPerpetualsVaultOwnerWithdrawCollateralTxResponse, type ApiPerpetualsVaultOwnerWithdrawLockedLiquidityTxBody, type ApiPerpetualsVaultOwnerWithdrawLockedLiquidityTxResponse, type ApiPerpetualsVaultOwnerWithdrawPerformanceFeesTxBody, type ApiPerpetualsVaultOwnerWithdrawPerformanceFeesTxResponse, type ApiPerpetualsVaultPauseVaultForForceWithdrawRequestTxBody, type ApiPerpetualsVaultPreviewCreateWithdrawRequestBody, type ApiPerpetualsVaultPreviewCreateWithdrawRequestResponse, type ApiPerpetualsVaultPreviewDepositBody, type ApiPerpetualsVaultPreviewDepositResponse, type ApiPerpetualsVaultPreviewOwnerProcessWithdrawRequestsBody, type ApiPerpetualsVaultPreviewOwnerProcessWithdrawRequestsResponse, type ApiPerpetualsVaultPreviewOwnerWithdrawCollateralBody, type ApiPerpetualsVaultPreviewOwnerWithdrawCollateralResponse, type ApiPerpetualsVaultPreviewOwnerWithdrawLockedLiquidityBody, type ApiPerpetualsVaultPreviewOwnerWithdrawLockedLiquidityResponse, type ApiPerpetualsVaultPreviewOwnerWithdrawPerformanceFeesBody, type ApiPerpetualsVaultPreviewOwnerWithdrawPerformanceFeesResponse, type ApiPerpetualsVaultPreviewPauseVaultForForceWithdrawRequestBody, type ApiPerpetualsVaultPreviewPauseVaultForForceWithdrawRequestResponse, type ApiPerpetualsVaultPreviewProcessForceWithdrawRequestBody, type ApiPerpetualsVaultPreviewProcessForceWithdrawRequestResponse, type ApiPerpetualsVaultProcessForceWithdrawRequestTxBody, type ApiPerpetualsVaultProcessForceWithdrawRequestTxResponse, type ApiPerpetualsVaultRevokeAgentWalletTxBody, type ApiPerpetualsVaultUpdateWithdrawRequestSlippageTxBody, type ApiPerpetualsVaultsBody, type ApiPerpetualsVaultsResponse, type ApiPerpetualsVaultsWithdrawRequestsBody, type ApiPerpetualsVaultsWithdrawRequestsResponse, type ApiPerpetualsWithdrawCollateralBody, type ApiPerpetualsWithdrawCollateralResponse, type ApiPoolAllCoinWithdrawBody, type ApiPoolDepositBody, type ApiPoolObjectIdForLpCoinTypeBody, type ApiPoolSpotPriceBody, type ApiPoolTradeBody, type ApiPoolWithdrawBody, type ApiPoolsOwnedDaoFeePoolOwnerCapsBody, type ApiPoolsStatsBody, type ApiPoolsSummaryBody, type ApiPublishLpCoinBody, type ApiReferralsCreateReferralLinkBody, type ApiReferralsCreateReferralLinkResponse, type ApiReferralsGetLinkedRefCodeBody, type ApiReferralsGetLinkedRefCodeResponse, type ApiReferralsGetRefCodeBody, type ApiReferralsGetRefCodeResponse, type ApiReferralsGetRefereesBody, type ApiReferralsGetRefereesResponse, type ApiReferralsIsRefCodeTakenBody, type ApiReferralsIsRefCodeTakenResponse, type ApiReferralsSetReferrerBody, type ApiReferralsSetReferrerResponse, type ApiRemoveSuiFrenAccessoryBody, type ApiRewardsClaimRequestTxBody, type ApiRewardsClaimRequestTxResponse, type ApiRewardsDistributionBody, type ApiRewardsDistributionResponse, type ApiRewardsExpectedRewardsBody, type ApiRewardsExpectedRewardsResponse, type ApiRewardsGetClaimableBody, type ApiRewardsGetClaimableResponse, type ApiRewardsGetHistoryBody, type ApiRewardsGetHistoryResponse, type ApiRewardsGetPointsBody, type ApiRewardsGetPointsResponse, type ApiRouterAddTransactionForCompleteTradeRouteBody, type ApiRouterAddTransactionForCompleteTradeRouteBodyDeprecated, type ApiRouterAddTransactionForCompleteTradeRouteResponse, type ApiRouterAddTransactionForCompleteTradeRouteResponseDeprecated, type ApiRouterCompleteTradeRouteBody, type ApiRouterDynamicGasBody, type ApiRouterPartialCompleteTradeRouteBody, type ApiRouterTradeEventsBody, type ApiRouterTransactionForCompleteTradeRouteBody, type ApiStakeBody, type ApiStakeStakedSuiBody, type ApiStakeSuiFrenBody, type ApiStakingEventsBody, type ApiStakingPositionsBody, type ApiTransactionResponse, type ApiTransactionsBody, type ApiUnstakeBody, type ApiUnstakeSuiFrenBody, type ApiUpdateValidatorFeeBody, type ApiValidatorOperationCapsBody, type Apr, type Apy, Auth, type Balance, type BigIntAsString, type Bps, type Byte, type CallerConfig, type CanceledOrderEvent, type CapyLabsAppObject, Casting, Coin, type CoinDecimal, type CoinGeckoChain, type CoinGeckoCoinApiId, type CoinGeckoCoinData, type CoinGeckoCoinSymbolData, type CoinGeckoHistoricalTradeData, type CoinGeckoTickerData, type CoinMetadaWithInfo, type CoinPriceInfo, type CoinSymbol, type CoinSymbolToCoinTypes, type CoinSymbolsToPriceInfo, type CoinType, type CoinWithAmount, type CoinWithAmountOrUndefined, type CoinsToBalance, type CoinsToBalanceOrUndefined, type CoinsToDecimals, type CoinsToPrice, type CoinsToPriceInfo, type CollateralEvent, type Color, type ComposedTransferArgs, type ConfigAddresses, type CreatedAccountEvent, type CreatedDaoFeePoolEvent, type CreatedStopOrderTicketEvent, type DaoFeePoolObject, type DaoFeePoolOwnerCapObject, type DaoFeePoolsAddresses, type DcaAddresses, type DeallocatedCollateralEvent, type DecimalsScalar, type DeferredAccountArgs, type DeletedStopOrderTicketEvent, type DepositedCollateralEvent, type DynamicFieldObjectsWithCursor, type DynamicFieldsInputs, type DynamicFieldsWithCursor, type DynamicGasAddresses, type EditedStopOrderTicketDetailsEvent, type EditedStopOrderTicketExecutorEvent, type EmptyObject, type EpochWasChangedEvent, type Event$1 as Event, type EventsInputs, type EventsWithCursor, type ExecutedStopOrderTicketEvent, type ExternalFee, type FarmEvent, type FarmOwnerOrOneTimeAdminCap, type FarmSummary, type FarmUserEvent, Farms, type FarmsAddedRewardEvent, type FarmsAddresses, type FarmsCreatedVaultEvent, type FarmsDepositedPrincipalEvent, type FarmsDestroyedStakedPositionEvent, type FarmsHarvestedRewardsEvent, type FarmsIncreasedEmissionsEvent, type FarmsInitializedRewardEvent, type FarmsJoinedEvent, type FarmsLockEnforcement, type FarmsLockedEvent, type FarmsMultiplier, type FarmsSplitEvent, type FarmsStakedEvent, FarmsStakedPosition, type FarmsStakedPositionObject, type FarmsStakedPositionRewardCoin, type FarmsStakedRelaxedEvent, FarmsStakingPool, type FarmsStakingPoolObject, type FarmsStakingPoolRewardCoin, type FarmsUnlockedEvent, type FarmsVersion, type FarmsWithdrewPrincipalEvent, Faucet, type FaucetAddCoinEvent, type FaucetAddresses, type FaucetMintCoinEvent, type FilePath, type FilledMakerOrderEventFields, type FilledMakerOrdersEvent, type FilledTakerOrderEvent, type FunctionName, type GasBudget, GasPools, GrpcCasting, type HarvestSuiFrenFeesEvent, Helpers, type IFixed, type IFixedAsBytes, type IFixedAsString, type IFixedAsStringBytes, type IdAsStringBytes, type IndexerDataWithCursorQueryParams, type IndexerEventsWithCursor, type KeyType, type KioskObject, type KioskOwnerCapObject, type LimitAddresses, type LiquidatedEvent, type LocalUrl, type MixSuiFrensEvent, type ModuleName, type MoveErrorCode, type MoveErrors, type MoveErrorsInterface, type Nft, NftAmm, type NftAmmAddresses, type NftAmmInterfaceGenericTypes, type NftAmmMarketObject, type NftDisplay, type NftDisplayOther, type NftDisplaySuggested, type NftInfo, type NftsAddresses, type NormalizedBalance, type NumberAsString, type Object$1 as Object, type ObjectDigest, type ObjectId, type ObjectVersion, type OrderbookFillReceiptEvent, type PackageId, type ParsedMoveError, type PartialFarmsStakedPositionObject, type PartialSuiFrenObject, type Percentage, Perpetuals, PerpetualsAccount, type PerpetualsAccountCap, type PerpetualsAccountCollateralChange, type PerpetualsAccountData, type PerpetualsAccountId, type PerpetualsAccountMarginHistoryData, type PerpetualsAccountMarginHistoryTimeframeKey, type PerpetualsAccountObject, type PerpetualsAccountOrderHistoryData, type PerpetualsAddresses, type PerpetualsBuilderCodeParamaters, type PerpetualsCandleResolution, type PerpetualsCapType, type PerpetualsClientOrderId, type PerpetualsExecutionInfo, type PerpetualsFilledOrderData, type PerpetualsIntegratorVaultData, PerpetualsMarket, type PerpetualsMarket24hrStats, type PerpetualsMarketCandleDataPoint, type PerpetualsMarketData, type PerpetualsMarketFundingHistoryPoint, type PerpetualsMarketId, type PerpetualsMarketMetadata, type PerpetualsMarketOrderHistoryData, type PerpetualsMarketParams, type PerpetualsMarketState, type PerpetualsOrderData, type PerpetualsOrderEvent, type PerpetualsOrderId, type PerpetualsOrderIdAsString, type PerpetualsOrderInfo, type PerpetualsOrderPrice, PerpetualsOrderSide, type PerpetualsOrderState, PerpetualsOrderType, type PerpetualsOrderbook, type PerpetualsOrderbookDeltas, type PerpetualsOrderbookItem, type PerpetualsPartialVaultCap, type PerpetualsPosition, type PerpetualsServerInjectedTxFields, type PerpetualsSponsorConfig, type PerpetualsStopOrderData, PerpetualsStopOrderTriggerPriceType, PerpetualsStopOrderType, type PerpetualsTopOfOrderbook, type PerpetualsTopOfOrderbookDataPoint, type PerpetualsTwapEvent, type PerpetualsTwapOrderData, type PerpetualsTwapOrderDetails, type PerpetualsTwapOrderDetailsData, type PerpetualsTwapOrderEdit, type PerpetualsTwapOrderState, PerpetualsVault, type PerpetualsVaultCap, type PerpetualsVaultLpCoin, type PerpetualsVaultMetatada, type PerpetualsVaultObject, type PerpetualsVaultWithdrawRequest, type PerpetualsVaultsAddresses, type PerpetualsVaultsConfig, type PerpetualsWsCandleResponseMessage, type PerpetualsWsUpdatesMarketCandlesPayload, type PerpetualsWsUpdatesMarketCandlesSubscriptionType, type PerpetualsWsUpdatesMarketOrdersPayload, type PerpetualsWsUpdatesMarketOrdersSubscriptionType, type PerpetualsWsUpdatesMarketSubscriptionType, type PerpetualsWsUpdatesOraclePayload, type PerpetualsWsUpdatesOracleSubscriptionType, type PerpetualsWsUpdatesOrderbookPayload, type PerpetualsWsUpdatesOrderbookSubscriptionType, type PerpetualsWsUpdatesResponseMessage, type PerpetualsWsUpdatesSubscriptionAction, type PerpetualsWsUpdatesSubscriptionMessage, type PerpetualsWsUpdatesSubscriptionType, type PerpetualsWsUpdatesTopOfOrderbookPayload, type PerpetualsWsUpdatesTopOfOrderbookSubscriptionType, type PerpetualsWsUpdatesUserCollateralChangesPayload, type PerpetualsWsUpdatesUserCollateralChangesSubscriptionType, type PerpetualsWsUpdatesUserOrdersPayload, type PerpetualsWsUpdatesUserOrdersSubscriptionType, type PerpetualsWsUpdatesUserPayload, type PerpetualsWsUpdatesUserSubscriptionType, Pool, type PoolCoin, type PoolCoins, type PoolCreationCoinInfo, type PoolCreationLpCoinMetadata, type PoolDataPoint, type PoolDepositEvent, type PoolDepositFee, type PoolFlatness, type PoolGraphDataTimeUnit, type PoolGraphDataTimeframe, type PoolGraphDataTimeframeKey, type PoolLpInfo, type PoolName, type PoolObject, type PoolStats, type PoolSummary, type PoolTradeEvent, type PoolTradeFee, type PoolWeight, type PoolWithdrawEvent, type PoolWithdrawFee, Pools, type PoolsAddresses, type PostedOrderEvent, type RateLimit, type ReceivedCollateralEvent, type ReducedOrderEvent, ReferralVault, type ReferralVaultAddresses, type ReferralsRefereeInfo, type RewardsClaimableReward, type RewardsDistributionAccountData, type RewardsDistributionCalculationVariables, type RewardsDistributionMakerData, type RewardsDistributionTakerData, type RewardsExpectedCalculationVariables, type RewardsExpectedDomainTokens, type RewardsExpectedEpochInfo, type RewardsExpectedTotals, type RewardsHistoryEntry, type RewardsHistoryEventType, type RewardsPaginationInfo, Router, type RouterAddresses, type RouterCompleteTradeRoute, type RouterCompleteTradeRouteWithFee, type RouterExternalFee, type RouterProtocolName, type RouterTradeCoin, type RouterTradeEvent, type RouterTradeInfo, type RouterTradePath, type RouterTradeRoute, type RpcEndpoint, type ScallopAddresses, type SdkPerpetualsCancelAndPlaceOrdersInputs, type SdkPerpetualsCancelOrdersPreviewInputs, type SdkPerpetualsCancelTwapOrdersInputs, type SdkPerpetualsCreateTwapOrdersInputs, type SdkPerpetualsEditTwapOrdersInputs, type SdkPerpetualsPlaceLimitOrderInputs, type SdkPerpetualsPlaceLimitOrderPreviewInputs, type SdkPerpetualsPlaceMarketOrderInputs, type SdkPerpetualsPlaceMarketOrderPreviewInputs, type SdkPerpetualsPlaceScaleOrderInputs, type SdkPerpetualsPlaceScaleOrderPreviewInputs, type SdkPerpetualsPlaceSlTpOrdersInputs, type SdkPerpetualsPlaceStopOrdersInputs, type SdkTransactionResponse, type SerializedTransaction, type ServiceCoinData, type ServiceCoinDataV2, type SetPositionInitialMarginRatioEvent, type SettledFundingEvent, type SharedCustodyAddresses, type SignMessageCallback, type Slippage, type StakeBalanceDynamicField, type StakeEvent, type StakePosition, type StakeSuiFrenEvent, type StakedEvent, StakedSuiFren, type StakedSuiFrenInfo, type StakedSuiFrenMetadataV1Object, type StakedSuiFrenPositionObject, type StakedSuiVaultStateObject, Staking, type StakingAddresses, type StakingApyDataPoint, type StakingApyTimeframeKey, type StakingPoolOneTimeAdminCapObject, type StakingPoolOwnerCapObject, type StakingPosition, type StringByte, Sui, type SuiAddress, type SuiCheckpoint, type SuiDelegatedStake, type SuiDelegatedStakeState, SuiFren, type SuiFrenAccessoryName, type SuiFrenAccessoryObject, type SuiFrenAccessoryType, type SuiFrenAttributes, type SuiFrenObject, type SuiFrenStats, type SuiFrenVaultStateV1Object, SuiFrens, type SuiFrensAddresses, SuiFrensSortOption, type SuiNetwork, type SuiObjectView, type Timestamp, type TransactionDigest, type TransactionsWithCursor, type TransferredDeallocatedCollateralEvent, type TranslatedMoveError, type TxBytes, type UniqueId, type UnstakeEvent, type UnstakePosition, type UnstakePositionState, type UnstakeRequestedEvent, type UnstakeSuiFrenEvent, type UnstakedEvent, type UpdatedFeeBpsEvent, type UpdatedFeeRecipientEvent, type UpdatedFundingEvent, type UpdatedMarketVersionEvent, type UpdatedPremiumTwapEvent, type UpdatedSpreadTwapEvent, type Url, type UserEventsInputs, type UserHistoryEventType, type ValidatorConfigObject, type ValidatorOperationCapObject, type ValueOf, type WithdrewCollateralEvent, isAftermathTransportError, isAllocatedCollateralEvent, isCanceledOrderEvent, isDeallocatedCollateralEvent, isDepositedCollateralEvent, isFarmsDepositedPrincipalEvent, isFarmsHarvestedRewardsEvent, isFarmsLockedEvent, isFarmsStakedEvent, isFarmsUnlockedEvent, isFarmsWithdrewPrincipalEvent, isFilledMakerOrdersEvent, isFilledTakerOrderEvent, isLiquidatedEvent, isPostedOrderEvent, isReducedOrderEvent, isSettledFundingEvent, isStakeEvent, isStakePosition, isSuiDelegatedStake, isUnstakeEvent, isUnstakePosition, isUpdatedFundingEvent, isUpdatedMarketVersion, isUpdatedPremiumTwapEvent, isUpdatedSpreadTwapEvent, isWithdrewCollateralEvent };
|