aftermath-ts-sdk 1.2.51-temp.0 → 1.2.52-perps.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +61 -27
- package/dist/general/apiHelpers/eventsApiHelpers.d.ts +1 -1
- package/dist/general/apiHelpers/eventsApiHelpers.d.ts.map +1 -1
- package/dist/general/apiHelpers/eventsApiHelpers.js +4 -1
- package/dist/general/apiHelpers/transactionsApiHelpers.d.ts +6 -0
- package/dist/general/apiHelpers/transactionsApiHelpers.d.ts.map +1 -1
- package/dist/general/apiHelpers/transactionsApiHelpers.js +46 -0
- package/dist/general/dynamicGas/dynamicGas.d.ts +34 -0
- package/dist/general/dynamicGas/dynamicGas.d.ts.map +1 -1
- package/dist/general/dynamicGas/dynamicGas.js +34 -0
- package/dist/general/dynamicGas/dynamicGasTypes.d.ts +25 -0
- package/dist/general/dynamicGas/dynamicGasTypes.d.ts.map +1 -1
- package/dist/general/prices/coinGeckoTypes.d.ts +2 -0
- package/dist/general/prices/coinGeckoTypes.d.ts.map +1 -1
- package/dist/general/prices/prices.d.ts +73 -0
- package/dist/general/prices/prices.d.ts.map +1 -1
- package/dist/general/prices/prices.js +73 -0
- package/dist/general/providers/aftermath.d.ts +107 -27
- package/dist/general/providers/aftermath.d.ts.map +1 -1
- package/dist/general/providers/aftermath.js +110 -30
- package/dist/general/providers/aftermathApi.d.ts +128 -10
- package/dist/general/providers/aftermathApi.d.ts.map +1 -1
- package/dist/general/providers/aftermathApi.js +133 -14
- package/dist/general/types/castingTypes.d.ts +15 -7
- package/dist/general/types/castingTypes.d.ts.map +1 -1
- package/dist/general/types/castingTypes.js +6 -0
- package/dist/general/types/configTypes.d.ts +14 -9
- package/dist/general/types/configTypes.d.ts.map +1 -1
- package/dist/general/types/generalTypes.d.ts +229 -7
- package/dist/general/types/generalTypes.d.ts.map +1 -1
- package/dist/general/types/moveErrorsInterface.d.ts +1 -1
- package/dist/general/types/moveErrorsInterface.d.ts.map +1 -1
- package/dist/general/types/suiTypes.d.ts +0 -16
- package/dist/general/types/suiTypes.d.ts.map +1 -1
- package/dist/general/types/suiTypes.js +3 -25
- package/dist/general/utils/caller.d.ts +5 -2
- package/dist/general/utils/caller.d.ts.map +1 -1
- package/dist/general/utils/caller.js +9 -1
- package/dist/general/utils/casting.d.ts +156 -7
- package/dist/general/utils/casting.d.ts.map +1 -1
- package/dist/general/utils/casting.js +159 -20
- package/dist/general/utils/fixedUtils.d.ts +89 -2
- package/dist/general/utils/fixedUtils.d.ts.map +1 -1
- package/dist/general/utils/fixedUtils.js +81 -4
- package/dist/general/utils/helpers.d.ts +327 -10
- package/dist/general/utils/helpers.d.ts.map +1 -1
- package/dist/general/utils/helpers.js +409 -91
- package/dist/general/utils/iFixedUtils.d.ts +64 -0
- package/dist/general/utils/iFixedUtils.d.ts.map +1 -1
- package/dist/general/utils/iFixedUtils.js +64 -0
- package/dist/general/wallet/wallet.d.ts +76 -1
- package/dist/general/wallet/wallet.d.ts.map +1 -1
- package/dist/general/wallet/wallet.js +75 -5
- package/dist/packages/auth/auth.d.ts +113 -4
- package/dist/packages/auth/auth.d.ts.map +1 -1
- package/dist/packages/auth/auth.js +190 -59
- package/dist/packages/auth/authTypes.d.ts +66 -0
- package/dist/packages/auth/authTypes.d.ts.map +1 -1
- package/dist/packages/coin/api/coinApi.d.ts.map +1 -1
- package/dist/packages/coin/api/coinApi.js +29 -20
- package/dist/packages/coin/coin.d.ts +256 -1
- package/dist/packages/coin/coin.d.ts.map +1 -1
- package/dist/packages/coin/coin.js +246 -15
- package/dist/packages/coin/coinTypes.d.ts +95 -0
- package/dist/packages/coin/coinTypes.d.ts.map +1 -1
- package/dist/packages/dca/api/dcaApi.d.ts +2 -0
- package/dist/packages/dca/api/dcaApi.d.ts.map +1 -1
- package/dist/packages/dca/api/dcaApi.js +6 -3
- package/dist/packages/dca/dca.d.ts +125 -35
- package/dist/packages/dca/dca.d.ts.map +1 -1
- package/dist/packages/dca/dca.js +135 -43
- package/dist/packages/dca/dcaTypes.d.ts +217 -42
- package/dist/packages/dca/dcaTypes.d.ts.map +1 -1
- package/dist/packages/farms/api/farmsApi.d.ts +725 -58
- package/dist/packages/farms/api/farmsApi.d.ts.map +1 -1
- package/dist/packages/farms/api/farmsApi.js +1149 -153
- package/dist/packages/farms/api/farmsApiCasting.d.ts +34 -18
- package/dist/packages/farms/api/farmsApiCasting.d.ts.map +1 -1
- package/dist/packages/farms/api/farmsApiCasting.js +218 -17
- package/dist/packages/farms/api/farmsApiCastingTypes.d.ts +117 -21
- package/dist/packages/farms/api/farmsApiCastingTypes.d.ts.map +1 -1
- package/dist/packages/farms/farms.d.ts +188 -3
- package/dist/packages/farms/farms.d.ts.map +1 -1
- package/dist/packages/farms/farms.js +192 -12
- package/dist/packages/farms/farmsStakedPosition.d.ts +143 -8
- package/dist/packages/farms/farmsStakedPosition.d.ts.map +1 -1
- package/dist/packages/farms/farmsStakedPosition.js +243 -137
- package/dist/packages/farms/farmsStakingPool.d.ts +169 -3
- package/dist/packages/farms/farmsStakingPool.d.ts.map +1 -1
- package/dist/packages/farms/farmsStakingPool.js +212 -70
- package/dist/packages/farms/farmsTypes.d.ts +302 -2
- package/dist/packages/farms/farmsTypes.d.ts.map +1 -1
- package/dist/packages/farms/farmsTypes.js +18 -0
- package/dist/packages/faucet/api/faucetApi.d.ts +9 -17
- package/dist/packages/faucet/api/faucetApi.d.ts.map +1 -1
- package/dist/packages/faucet/api/faucetApi.js +44 -49
- package/dist/packages/faucet/api/faucetApiCasting.d.ts.map +1 -1
- package/dist/packages/faucet/api/faucetApiCasting.js +8 -5
- package/dist/packages/faucet/api/faucetApiCastingTypes.d.ts +1 -4
- package/dist/packages/faucet/api/faucetApiCastingTypes.d.ts.map +1 -1
- package/dist/packages/faucet/faucet.d.ts +1 -1
- package/dist/packages/faucet/faucet.d.ts.map +1 -1
- package/dist/packages/faucet/faucet.js +1 -1
- package/dist/packages/faucet/faucetTypes.d.ts +2 -3
- package/dist/packages/faucet/faucetTypes.d.ts.map +1 -1
- package/dist/packages/limitOrders/api/limitOrdersApi.d.ts +12 -0
- package/dist/packages/limitOrders/api/limitOrdersApi.d.ts.map +1 -0
- package/dist/packages/limitOrders/api/limitOrdersApi.js +25 -0
- package/dist/packages/limitOrders/index.d.ts +2 -0
- package/dist/packages/limitOrders/index.d.ts.map +1 -0
- package/dist/packages/limitOrders/index.js +17 -0
- package/dist/packages/limitOrders/limitOrders.d.ts +143 -0
- package/dist/packages/limitOrders/limitOrders.d.ts.map +1 -0
- package/dist/packages/limitOrders/limitOrders.js +190 -0
- package/dist/packages/limitOrders/limitOrdersTypes.d.ts +211 -0
- package/dist/packages/limitOrders/limitOrdersTypes.d.ts.map +1 -0
- package/dist/packages/multisig/multisig.d.ts +34 -5
- package/dist/packages/multisig/multisig.d.ts.map +1 -1
- package/dist/packages/multisig/multisig.js +33 -4
- package/dist/packages/multisig/multisigTypes.d.ts +17 -0
- package/dist/packages/multisig/multisigTypes.d.ts.map +1 -1
- package/dist/packages/nftAmm/nftAmm.d.ts +1 -1
- package/dist/packages/nftAmm/nftAmm.d.ts.map +1 -1
- package/dist/packages/perpetuals/api/perpetualsApi.d.ts +7 -16
- package/dist/packages/perpetuals/api/perpetualsApi.d.ts.map +1 -1
- package/dist/packages/perpetuals/api/perpetualsApi.js +318 -276
- package/dist/packages/perpetuals/api/perpetualsApiCasting.d.ts +7 -7
- package/dist/packages/perpetuals/api/perpetualsApiCasting.d.ts.map +1 -1
- package/dist/packages/perpetuals/api/perpetualsApiCasting.js +71 -84
- package/dist/packages/perpetuals/perpetuals.d.ts +33 -4
- package/dist/packages/perpetuals/perpetuals.d.ts.map +1 -1
- package/dist/packages/perpetuals/perpetuals.js +105 -18
- package/dist/packages/perpetuals/perpetualsAccount.d.ts +87 -52
- package/dist/packages/perpetuals/perpetualsAccount.d.ts.map +1 -1
- package/dist/packages/perpetuals/perpetualsAccount.js +544 -91
- package/dist/packages/perpetuals/perpetualsCastingTypes.d.ts +55 -26
- package/dist/packages/perpetuals/perpetualsCastingTypes.d.ts.map +1 -1
- package/dist/packages/perpetuals/perpetualsMarket.d.ts +28 -4
- package/dist/packages/perpetuals/perpetualsMarket.d.ts.map +1 -1
- package/dist/packages/perpetuals/perpetualsMarket.js +75 -13
- package/dist/packages/perpetuals/perpetualsTypes.d.ts +263 -213
- package/dist/packages/perpetuals/perpetualsTypes.d.ts.map +1 -1
- package/dist/packages/perpetuals/perpetualsTypes.js +24 -77
- package/dist/packages/pools/pool.d.ts +328 -86
- package/dist/packages/pools/pool.d.ts.map +1 -1
- package/dist/packages/pools/pool.js +333 -91
- package/dist/packages/pools/pools.d.ts +300 -38
- package/dist/packages/pools/pools.d.ts.map +1 -1
- package/dist/packages/pools/pools.js +306 -52
- package/dist/packages/pools/poolsTypes.d.ts +267 -2
- package/dist/packages/pools/poolsTypes.d.ts.map +1 -1
- package/dist/packages/referralVault/referralVault.d.ts +38 -1
- package/dist/packages/referralVault/referralVault.d.ts.map +1 -1
- package/dist/packages/referralVault/referralVault.js +37 -0
- package/dist/packages/router/router.d.ts +213 -17
- package/dist/packages/router/router.d.ts.map +1 -1
- package/dist/packages/router/router.js +214 -18
- package/dist/packages/router/routerTypes.d.ts +199 -15
- package/dist/packages/router/routerTypes.d.ts.map +1 -1
- package/dist/packages/staking/staking.d.ts +302 -44
- package/dist/packages/staking/staking.d.ts.map +1 -1
- package/dist/packages/staking/staking.js +308 -51
- package/dist/packages/staking/stakingTypes.d.ts +426 -6
- package/dist/packages/staking/stakingTypes.d.ts.map +1 -1
- package/dist/packages/staking/stakingTypes.js +19 -0
- package/dist/packages/sui/sui.d.ts +40 -1
- package/dist/packages/sui/sui.d.ts.map +1 -1
- package/dist/packages/sui/sui.js +39 -0
- package/dist/packages/suiFrens/stakedSuiFren.d.ts +1 -1
- package/dist/packages/suiFrens/stakedSuiFren.d.ts.map +1 -1
- package/dist/packages/suiFrens/suiFren.d.ts +1 -1
- package/dist/packages/suiFrens/suiFren.d.ts.map +1 -1
- package/dist/packages/suiFrens/suiFrens.d.ts +1 -1
- package/dist/packages/suiFrens/suiFrens.d.ts.map +1 -1
- package/dist/packages/userData/api/userDataApi.d.ts +6 -0
- package/dist/packages/userData/api/userDataApi.d.ts.map +1 -0
- package/dist/packages/userData/api/userDataApi.js +12 -0
- package/dist/packages/userData/index.d.ts +2 -0
- package/dist/packages/userData/index.d.ts.map +1 -0
- package/dist/packages/userData/index.js +17 -0
- package/dist/packages/userData/userData.d.ts +89 -0
- package/dist/packages/userData/userData.d.ts.map +1 -0
- package/dist/packages/userData/userData.js +119 -0
- package/dist/packages/userData/userDataTypes.d.ts +29 -0
- package/dist/packages/userData/userDataTypes.d.ts.map +1 -0
- package/dist/types.d.ts +0 -1
- package/dist/types.d.ts.map +1 -1
- package/dist/types.js +0 -2
- package/package.json +1 -1
- package/dist/general/historicalData/historicalData.d.ts +0 -15
- package/dist/general/historicalData/historicalData.d.ts.map +0 -1
- package/dist/general/historicalData/historicalData.js +0 -45
- package/dist/general/historicalData/historicalDataTypes.d.ts +0 -10
- package/dist/general/historicalData/historicalDataTypes.d.ts.map +0 -1
- package/dist/packages/dca/api/dcaApiCasting.d.ts +0 -11
- package/dist/packages/dca/api/dcaApiCasting.d.ts.map +0 -1
- package/dist/packages/dca/api/dcaApiCasting.js +0 -186
- package/dist/packages/dca/api/dcaApiCastingTypes.d.ts +0 -142
- package/dist/packages/dca/api/dcaApiCastingTypes.d.ts.map +0 -1
- package/dist/packages/oracle/api/oracleApi.d.ts +0 -21
- package/dist/packages/oracle/api/oracleApi.d.ts.map +0 -1
- package/dist/packages/oracle/api/oracleApi.js +0 -76
- package/dist/packages/oracle/api/oracleApiCasting.d.ts +0 -6
- package/dist/packages/oracle/api/oracleApiCasting.d.ts.map +0 -1
- package/dist/packages/oracle/api/oracleApiCasting.js +0 -25
- package/dist/packages/oracle/oracle.d.ts +0 -15
- package/dist/packages/oracle/oracle.d.ts.map +0 -1
- package/dist/packages/oracle/oracle.js +0 -46
- package/dist/packages/oracle/oracleCastingTypes.d.ts +0 -11
- package/dist/packages/oracle/oracleCastingTypes.d.ts.map +0 -1
- package/dist/packages/oracle/oracleCastingTypes.js +0 -2
- package/dist/packages/oracle/oracleTypes.d.ts +0 -10
- package/dist/packages/oracle/oracleTypes.d.ts.map +0 -1
- package/dist/packages/oracle/oracleTypes.js +0 -2
- /package/dist/{general/historicalData/historicalDataTypes.js → packages/limitOrders/limitOrdersTypes.js} +0 -0
- /package/dist/packages/{dca/api/dcaApiCastingTypes.js → userData/userDataTypes.js} +0 -0
|
@@ -1,144 +1,319 @@
|
|
|
1
1
|
import { ObjectId, SuiAddress } from "../../types";
|
|
2
2
|
import { CoinType } from "../coin/coinTypes";
|
|
3
|
-
import { Balance,
|
|
3
|
+
import { Balance, Timestamp, TransactionDigest } from "../../general/types/generalTypes";
|
|
4
|
+
/**
|
|
5
|
+
* Describes an optional integrator fee configuration for advanced usage,
|
|
6
|
+
* allowing a portion of DCA trades to be collected by a third party.
|
|
7
|
+
*/
|
|
4
8
|
export interface DcaIntegratorFeeData {
|
|
9
|
+
/**
|
|
10
|
+
* The fee in basis points (bps). e.g., 100 => 1%.
|
|
11
|
+
*/
|
|
5
12
|
feeBps: number;
|
|
13
|
+
/**
|
|
14
|
+
* The Sui address that will receive the fee portion.
|
|
15
|
+
*/
|
|
6
16
|
feeRecipient: SuiAddress;
|
|
7
17
|
}
|
|
18
|
+
/**
|
|
19
|
+
* Optional DCA order strategy parameters, typically bounding min & max
|
|
20
|
+
* acceptable prices for the trades.
|
|
21
|
+
*/
|
|
8
22
|
export interface DcaOrderStrategyData {
|
|
23
|
+
/**
|
|
24
|
+
* The minimum acceptable spot price for the trade, as a bigint scaled by 1e9 or 1e18 depending on usage.
|
|
25
|
+
*/
|
|
9
26
|
minPrice: Balance;
|
|
27
|
+
/**
|
|
28
|
+
* The maximum acceptable spot price for the trade, similarly scaled.
|
|
29
|
+
*/
|
|
10
30
|
maxPrice: Balance;
|
|
11
31
|
}
|
|
32
|
+
/**
|
|
33
|
+
* The inputs required to create a new DCA order. This includes all relevant
|
|
34
|
+
* coin types, amounts, frequency, trade count, etc.
|
|
35
|
+
*/
|
|
12
36
|
export interface ApiDcaTransactionForCreateOrderBody {
|
|
37
|
+
/**
|
|
38
|
+
* The user's address that owns & initiates the DCA order.
|
|
39
|
+
*/
|
|
13
40
|
walletAddress: SuiAddress;
|
|
41
|
+
/**
|
|
42
|
+
* The coin type from which funds will be allocated (sold).
|
|
43
|
+
*/
|
|
14
44
|
allocateCoinType: CoinType;
|
|
45
|
+
/**
|
|
46
|
+
* The total amount of the allocate coin to be used across trades.
|
|
47
|
+
*/
|
|
15
48
|
allocateCoinAmount: Balance;
|
|
49
|
+
/**
|
|
50
|
+
* The coin type that will be purchased periodically.
|
|
51
|
+
*/
|
|
16
52
|
buyCoinType: CoinType;
|
|
53
|
+
/**
|
|
54
|
+
* The frequency (in ms) at which trades occur, e.g. every hour => 3600000.
|
|
55
|
+
*/
|
|
17
56
|
frequencyMs: Timestamp;
|
|
57
|
+
/**
|
|
58
|
+
* The total number of trades to execute before concluding the DCA plan.
|
|
59
|
+
*/
|
|
18
60
|
tradesAmount: number;
|
|
61
|
+
/**
|
|
62
|
+
* An optional bounding strategy specifying min & max acceptable prices.
|
|
63
|
+
*/
|
|
19
64
|
strategy?: DcaOrderStrategyData;
|
|
65
|
+
/**
|
|
66
|
+
* If `true`, indicates a partially or fully sponsored transaction, removing gas burden from the user.
|
|
67
|
+
*/
|
|
20
68
|
isSponsoredTx?: boolean;
|
|
69
|
+
/**
|
|
70
|
+
* A delay (in ms) before the first trade executes. If `0`, it starts immediately.
|
|
71
|
+
*/
|
|
21
72
|
delayTimeMs: Timestamp;
|
|
73
|
+
/**
|
|
74
|
+
* The maximum allowable slippage (in basis points) for each trade, e.g. 100 => 1%.
|
|
75
|
+
*/
|
|
22
76
|
maxAllowableSlippageBps: number;
|
|
77
|
+
/**
|
|
78
|
+
* The per-trade amount of `allocateCoinType` to be used, e.g. each trade uses 2 SUI if this is `2e9`.
|
|
79
|
+
*/
|
|
23
80
|
coinPerTradeAmount: Balance;
|
|
81
|
+
/**
|
|
82
|
+
* An optional alternate address to receive the purchased coin. Defaults to `walletAddress` if undefined.
|
|
83
|
+
*/
|
|
24
84
|
customRecipient?: SuiAddress;
|
|
85
|
+
/**
|
|
86
|
+
* Optional integrator fee data. If provided, a portion of each trade is allocated to the integrator.
|
|
87
|
+
*/
|
|
25
88
|
integratorFee?: DcaIntegratorFeeData;
|
|
26
89
|
}
|
|
90
|
+
/**
|
|
91
|
+
* The request body for closing a DCA order, typically requiring a signature
|
|
92
|
+
* over a JSON message specifying which orders to cancel.
|
|
93
|
+
*/
|
|
27
94
|
export interface ApiDcaTransactionForCloseOrderBody {
|
|
95
|
+
/**
|
|
96
|
+
* The user's address initiating the close/cancel action.
|
|
97
|
+
*/
|
|
28
98
|
walletAddress: SuiAddress;
|
|
99
|
+
/**
|
|
100
|
+
* The signed bytes of the cancellation message.
|
|
101
|
+
*/
|
|
29
102
|
bytes: string;
|
|
103
|
+
/**
|
|
104
|
+
* The user's signature corresponding to `bytes`.
|
|
105
|
+
*/
|
|
30
106
|
signature: string;
|
|
31
107
|
}
|
|
108
|
+
/**
|
|
109
|
+
* Represents parameters for a manual order close workflow. Typically not
|
|
110
|
+
* used in the standard approach.
|
|
111
|
+
*/
|
|
32
112
|
export type ApiDcaManualCloseOrderBody = {
|
|
33
113
|
walletAddress: SuiAddress;
|
|
34
114
|
buyCoinType: CoinType;
|
|
35
115
|
allocateCoinType: CoinType;
|
|
36
116
|
orderId: SuiAddress;
|
|
37
117
|
};
|
|
118
|
+
/**
|
|
119
|
+
* Enumerates reasons that a DCA trade might fail, e.g., the price was out of bounds
|
|
120
|
+
* or the user lacked enough gas.
|
|
121
|
+
*/
|
|
38
122
|
export type DcaFailedTradeReason = "INTERNAL" | "STRATEGY" | "GAS_CAP" | "UNKNOWN_USER" | "SLIPPAGE";
|
|
123
|
+
/**
|
|
124
|
+
* Represents data for a successful trade that occurred in a DCA sequence,
|
|
125
|
+
* including the amounts of allocated/buy coins, the final transaction info, etc.
|
|
126
|
+
*/
|
|
39
127
|
export interface DcaOrderTradeObject {
|
|
128
|
+
/**
|
|
129
|
+
* The coin & amount that was spent in this trade (e.g., SUI).
|
|
130
|
+
*/
|
|
40
131
|
allocatedCoin: {
|
|
41
132
|
coin: CoinType;
|
|
42
133
|
amount: Balance;
|
|
43
134
|
};
|
|
135
|
+
/**
|
|
136
|
+
* The coin & amount that was purchased (e.g., USDC).
|
|
137
|
+
*/
|
|
44
138
|
buyCoin: {
|
|
45
139
|
coin: CoinType;
|
|
46
140
|
amount: Balance;
|
|
47
141
|
};
|
|
142
|
+
/**
|
|
143
|
+
* The final transaction digest for this trade. (Deprecated field `tnxDigest` also present.)
|
|
144
|
+
*/
|
|
145
|
+
txnDigest: TransactionDigest;
|
|
146
|
+
/** @deprecated use `txnDigest` instead */
|
|
48
147
|
tnxDigest: TransactionDigest;
|
|
148
|
+
/**
|
|
149
|
+
* The timestamp (in ms) when this trade was executed. (Deprecated field `tnxDate` also present.)
|
|
150
|
+
*/
|
|
151
|
+
txnTimestamp: Timestamp;
|
|
152
|
+
/** @deprecated use `txnTimestamp` instead */
|
|
49
153
|
tnxDate: Timestamp;
|
|
154
|
+
/**
|
|
155
|
+
* The effective rate of the trade, if available, e.g. "0.95" or "1.10".
|
|
156
|
+
*/
|
|
50
157
|
rate: number | undefined;
|
|
51
158
|
}
|
|
159
|
+
/**
|
|
160
|
+
* Represents a failed trade attempt in a DCA sequence, including time
|
|
161
|
+
* of failure and the reason code.
|
|
162
|
+
*/
|
|
52
163
|
export interface DcaOrderFailedTradeObject {
|
|
53
164
|
timestamp: number;
|
|
54
165
|
reason: DcaFailedTradeReason | undefined;
|
|
55
166
|
}
|
|
167
|
+
/**
|
|
168
|
+
* Summarizes the main details of a DCA order, including how much coin is allocated
|
|
169
|
+
* and how many trades remain.
|
|
170
|
+
*/
|
|
56
171
|
export interface DcaOrderOverviewObject {
|
|
172
|
+
/**
|
|
173
|
+
* The coin & amount the user allocated for the entire DCA cycle.
|
|
174
|
+
*/
|
|
57
175
|
allocatedCoin: {
|
|
58
176
|
coin: CoinType;
|
|
59
177
|
amount: Balance;
|
|
60
178
|
};
|
|
179
|
+
/**
|
|
180
|
+
* The coin & amount that is being purchased in each periodic trade.
|
|
181
|
+
*/
|
|
61
182
|
buyCoin: {
|
|
62
183
|
coin: CoinType;
|
|
63
184
|
amount: Balance;
|
|
64
185
|
};
|
|
186
|
+
/**
|
|
187
|
+
* The total amount of allocateCoin actually spent so far.
|
|
188
|
+
*/
|
|
65
189
|
totalSpent: Balance;
|
|
190
|
+
/**
|
|
191
|
+
* The interval (in ms) between each trade, e.g., every hour => 3600000.
|
|
192
|
+
*/
|
|
66
193
|
intervalMs: Timestamp;
|
|
194
|
+
/**
|
|
195
|
+
* The total number of trades that were planned.
|
|
196
|
+
*/
|
|
67
197
|
totalTrades: number;
|
|
198
|
+
/**
|
|
199
|
+
* The number of remaining trades that have not yet executed.
|
|
200
|
+
*/
|
|
68
201
|
tradesRemaining: number;
|
|
202
|
+
/**
|
|
203
|
+
* The maximum slippage (bps) allowed for each trade.
|
|
204
|
+
*/
|
|
69
205
|
maxSlippageBps: number;
|
|
206
|
+
/**
|
|
207
|
+
* Optional bounding strategy with min/max acceptable prices.
|
|
208
|
+
*/
|
|
70
209
|
strategy?: DcaOrderStrategyData;
|
|
71
|
-
|
|
210
|
+
/**
|
|
211
|
+
* The address to receive the purchased coin. Defaults to the DCA owner's address if unspecified.
|
|
212
|
+
*/
|
|
213
|
+
recipient: SuiAddress;
|
|
214
|
+
/**
|
|
215
|
+
* Represents how far along the DCA has progressed, typically out of `totalTrades`.
|
|
216
|
+
*/
|
|
72
217
|
progress: number;
|
|
218
|
+
/**
|
|
219
|
+
* Details about when & how the DCA was created. Contains timestamps and transaction references.
|
|
220
|
+
*/
|
|
73
221
|
created: {
|
|
222
|
+
timestamp: Timestamp;
|
|
223
|
+
/** @deprecated use `timestamp` instead */
|
|
74
224
|
time: Timestamp;
|
|
225
|
+
txnDigest: TransactionDigest;
|
|
226
|
+
/** @deprecated use `txnDigest` instead */
|
|
75
227
|
tnxDigest: TransactionDigest;
|
|
76
228
|
};
|
|
77
|
-
|
|
229
|
+
/**
|
|
230
|
+
* If the next trade is scheduled in the future, indicates when that trade will occur.
|
|
231
|
+
*/
|
|
232
|
+
nextTrade?: {
|
|
233
|
+
timestamp: Timestamp;
|
|
234
|
+
/** @deprecated use `timestamp` instead */
|
|
78
235
|
time: Timestamp;
|
|
236
|
+
txnDigest: TransactionDigest;
|
|
237
|
+
/** @deprecated use `txnDigest` instead */
|
|
79
238
|
tnxDigest: TransactionDigest;
|
|
80
239
|
};
|
|
240
|
+
/**
|
|
241
|
+
* If at least one trade has already executed, shows when & how the last one occurred.
|
|
242
|
+
*/
|
|
81
243
|
lastExecutedTrade?: {
|
|
244
|
+
timestamp: Timestamp;
|
|
245
|
+
/** @deprecated use `timestamp` instead */
|
|
82
246
|
time: Timestamp;
|
|
247
|
+
txnDigest: TransactionDigest;
|
|
248
|
+
/** @deprecated use `txnDigest` instead */
|
|
83
249
|
tnxDigest: TransactionDigest;
|
|
84
250
|
};
|
|
251
|
+
/**
|
|
252
|
+
* Optional integrator fee settings that might apply to each trade.
|
|
253
|
+
*/
|
|
85
254
|
integratorFee?: DcaIntegratorFeeData;
|
|
86
255
|
}
|
|
256
|
+
/**
|
|
257
|
+
* Represents a single DCA order, including overview data, all successful trades, and all failed trades.
|
|
258
|
+
*/
|
|
87
259
|
export interface DcaOrderObject {
|
|
260
|
+
/**
|
|
261
|
+
* The on-chain object ID representing this DCA order.
|
|
262
|
+
*/
|
|
88
263
|
objectId: ObjectId;
|
|
264
|
+
/**
|
|
265
|
+
* Summary of the DCA (allocated amounts, trades remaining, etc.).
|
|
266
|
+
*/
|
|
89
267
|
overview: DcaOrderOverviewObject;
|
|
268
|
+
/**
|
|
269
|
+
* An array of all completed trades.
|
|
270
|
+
*/
|
|
90
271
|
trades: DcaOrderTradeObject[];
|
|
272
|
+
/**
|
|
273
|
+
* An array of attempted trades that failed, along with reasons/timestamps.
|
|
274
|
+
*/
|
|
91
275
|
failed: DcaOrderFailedTradeObject[];
|
|
92
276
|
}
|
|
277
|
+
/**
|
|
278
|
+
* Represents a grouping of DCA orders, typically used in the older or combined approach.
|
|
279
|
+
* Contains both `active` and `past` arrays.
|
|
280
|
+
*/
|
|
93
281
|
export interface DcaOrdersObject {
|
|
282
|
+
/**
|
|
283
|
+
* Active DCA orders.
|
|
284
|
+
*/
|
|
94
285
|
active: DcaOrderObject[];
|
|
286
|
+
/**
|
|
287
|
+
* Past (completed or canceled) DCA orders.
|
|
288
|
+
*/
|
|
95
289
|
past: DcaOrderObject[];
|
|
96
290
|
}
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
inputType: CoinType;
|
|
102
|
-
outputType: CoinType;
|
|
103
|
-
gasValue: Balance;
|
|
104
|
-
frequencyMs: Timestamp;
|
|
105
|
-
startTimestampMs: Timestamp;
|
|
106
|
-
amountPerTrade: Balance;
|
|
107
|
-
maxAllowableSlippageBps: Balance;
|
|
108
|
-
minAmountOut: Balance;
|
|
109
|
-
maxAmountOut: Balance;
|
|
110
|
-
remainingTrades: bigint;
|
|
111
|
-
recipient: SuiAddress;
|
|
112
|
-
}
|
|
113
|
-
export interface DcaClosedOrderEvent extends Event {
|
|
114
|
-
orderId: ObjectId;
|
|
115
|
-
owner: ObjectId;
|
|
116
|
-
remainingValue: Balance;
|
|
117
|
-
inputType: CoinType;
|
|
118
|
-
outputType: CoinType;
|
|
119
|
-
gasValue: Balance;
|
|
120
|
-
frequencyMs: Timestamp;
|
|
121
|
-
lastTradeTimestampMs: Timestamp;
|
|
122
|
-
amountPerTrade: Balance;
|
|
123
|
-
maxAllowableSlippageBps: Balance;
|
|
124
|
-
minAmountOut: Balance;
|
|
125
|
-
maxAmountOut: Balance;
|
|
126
|
-
remainingTrades: bigint;
|
|
127
|
-
}
|
|
128
|
-
export interface DcaExecutedTradeEvent extends Event {
|
|
129
|
-
orderId: ObjectId;
|
|
130
|
-
user: ObjectId;
|
|
131
|
-
inputType: CoinType;
|
|
132
|
-
inputAmount: Balance;
|
|
133
|
-
outputType: CoinType;
|
|
134
|
-
outputAmount: Balance;
|
|
135
|
-
}
|
|
291
|
+
/**
|
|
292
|
+
* **Deprecated**. Body for creating a user public key in the old DCA system.
|
|
293
|
+
* Use `ApiUserDataCreateUserBody` from `userData` package instead.
|
|
294
|
+
*/
|
|
136
295
|
export interface ApiDcaCreateUserBody {
|
|
296
|
+
/**
|
|
297
|
+
* The Sui address of the user.
|
|
298
|
+
*/
|
|
137
299
|
walletAddress: SuiAddress;
|
|
300
|
+
/**
|
|
301
|
+
* The message bytes that the user is signing (in hex or base64).
|
|
302
|
+
*/
|
|
138
303
|
bytes: string;
|
|
304
|
+
/**
|
|
305
|
+
* The resulting signature from signing `bytes`.
|
|
306
|
+
*/
|
|
139
307
|
signature: string;
|
|
140
308
|
}
|
|
309
|
+
/**
|
|
310
|
+
* **Deprecated**. Body for fetching the DCA orders owned by a specific user.
|
|
311
|
+
* Use separate `getActiveDcaOrders` and `getPastDcaOrders` calls instead.
|
|
312
|
+
*/
|
|
141
313
|
export interface ApiDCAsOwnedBody {
|
|
314
|
+
/**
|
|
315
|
+
* The user's Sui address whose DCA orders should be fetched.
|
|
316
|
+
*/
|
|
142
317
|
walletAddress: SuiAddress;
|
|
143
318
|
}
|
|
144
319
|
//# sourceMappingURL=dcaTypes.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"dcaTypes.d.ts","sourceRoot":"","sources":["../../../src/packages/dca/dcaTypes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7C,OAAO,EACN,OAAO,EACP,
|
|
1
|
+
{"version":3,"file":"dcaTypes.d.ts","sourceRoot":"","sources":["../../../src/packages/dca/dcaTypes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7C,OAAO,EACN,OAAO,EACP,SAAS,EAET,iBAAiB,EAGjB,MAAM,kCAAkC,CAAC;AAM1C;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACpC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,YAAY,EAAE,UAAU,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACpC;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;CAClB;AAMD;;;GAGG;AACH,MAAM,WAAW,mCAAmC;IACnD;;OAEG;IACH,aAAa,EAAE,UAAU,CAAC;IAC1B;;OAEG;IACH,gBAAgB,EAAE,QAAQ,CAAC;IAC3B;;OAEG;IACH,kBAAkB,EAAE,OAAO,CAAC;IAC5B;;OAEG;IACH,WAAW,EAAE,QAAQ,CAAC;IACtB;;OAEG;IACH,WAAW,EAAE,SAAS,CAAC;IACvB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,QAAQ,CAAC,EAAE,oBAAoB,CAAC;IAChC;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;OAEG;IACH,WAAW,EAAE,SAAS,CAAC;IACvB;;OAEG;IACH,uBAAuB,EAAE,MAAM,CAAC;IAChC;;OAEG;IACH,kBAAkB,EAAE,OAAO,CAAC;IAC5B;;OAEG;IACH,eAAe,CAAC,EAAE,UAAU,CAAC;IAC7B;;OAEG;IACH,aAAa,CAAC,EAAE,oBAAoB,CAAC;CACrC;AAMD;;;GAGG;AACH,MAAM,WAAW,kCAAkC;IAClD;;OAEG;IACH,aAAa,EAAE,UAAU,CAAC;IAC1B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CAClB;AAMD;;;GAGG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACxC,aAAa,EAAE,UAAU,CAAC;IAC1B,WAAW,EAAE,QAAQ,CAAC;IACtB,gBAAgB,EAAE,QAAQ,CAAC;IAC3B,OAAO,EAAE,UAAU,CAAC;CACpB,CAAC;AAMF;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAC7B,UAAU,GACV,UAAU,GACV,SAAS,GACT,cAAc,GACd,UAAU,CAAC;AAEd;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IACnC;;OAEG;IACH,aAAa,EAAE;QACd,IAAI,EAAE,QAAQ,CAAC;QACf,MAAM,EAAE,OAAO,CAAC;KAChB,CAAC;IACF;;OAEG;IACH,OAAO,EAAE;QACR,IAAI,EAAE,QAAQ,CAAC;QACf,MAAM,EAAE,OAAO,CAAC;KAChB,CAAC;IACF;;OAEG;IACH,SAAS,EAAE,iBAAiB,CAAC;IAC7B,0CAA0C;IAC1C,SAAS,EAAE,iBAAiB,CAAC;IAE7B;;OAEG;IACH,YAAY,EAAE,SAAS,CAAC;IACxB,6CAA6C;IAC7C,OAAO,EAAE,SAAS,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACzC,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,oBAAoB,GAAG,SAAS,CAAC;CACzC;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACtC;;OAEG;IACH,aAAa,EAAE;QACd,IAAI,EAAE,QAAQ,CAAC;QACf,MAAM,EAAE,OAAO,CAAC;KAChB,CAAC;IACF;;OAEG;IACH,OAAO,EAAE;QACR,IAAI,EAAE,QAAQ,CAAC;QACf,MAAM,EAAE,OAAO,CAAC;KAChB,CAAC;IACF;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,UAAU,EAAE,SAAS,CAAC;IACtB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,QAAQ,CAAC,EAAE,oBAAoB,CAAC;IAChC;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC;IACtB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,OAAO,EAAE;QACR,SAAS,EAAE,SAAS,CAAC;QACrB,0CAA0C;QAC1C,IAAI,EAAE,SAAS,CAAC;QAChB,SAAS,EAAE,iBAAiB,CAAC;QAC7B,0CAA0C;QAC1C,SAAS,EAAE,iBAAiB,CAAC;KAC7B,CAAC;IACF;;OAEG;IACH,SAAS,CAAC,EAAE;QACX,SAAS,EAAE,SAAS,CAAC;QACrB,0CAA0C;QAC1C,IAAI,EAAE,SAAS,CAAC;QAChB,SAAS,EAAE,iBAAiB,CAAC;QAC7B,0CAA0C;QAC1C,SAAS,EAAE,iBAAiB,CAAC;KAC7B,CAAC;IACF;;OAEG;IACH,iBAAiB,CAAC,EAAE;QACnB,SAAS,EAAE,SAAS,CAAC;QACrB,0CAA0C;QAC1C,IAAI,EAAE,SAAS,CAAC;QAChB,SAAS,EAAE,iBAAiB,CAAC;QAC7B,0CAA0C;QAC1C,SAAS,EAAE,iBAAiB,CAAC;KAC7B,CAAC;IACF;;OAEG;IACH,aAAa,CAAC,EAAE,oBAAoB,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC9B;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAC;IACnB;;OAEG;IACH,QAAQ,EAAE,sBAAsB,CAAC;IACjC;;OAEG;IACH,MAAM,EAAE,mBAAmB,EAAE,CAAC;IAC9B;;OAEG;IACH,MAAM,EAAE,yBAAyB,EAAE,CAAC;CACpC;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC/B;;OAEG;IACH,MAAM,EAAE,cAAc,EAAE,CAAC;IACzB;;OAEG;IACH,IAAI,EAAE,cAAc,EAAE,CAAC;CACvB;AAMD;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACpC;;OAEG;IACH,aAAa,EAAE,UAAU,CAAC;IAC1B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CAClB;AAMD;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAChC;;OAEG;IACH,aAAa,EAAE,UAAU,CAAC;CAC1B"}
|