@@ -10,58 +10,72 @@ export type TokenTypeStrategy =
1010
1111export interface StrategyConfigPayload {
1212 name : string ;
13- // token symbol of the strategy, is used as key in the strategies list
14- // ideally should be equal to sdk-gov-legacy SupportedSymbol or, if token is not present in that list, should be equal to symbol which provides sdk
13+ /**
14+ * Token symbol of the strategy, is used as key in the strategies list.
15+ */
1516 id : string ;
16- // token address of the strategy
17+ /**
18+ * Token address of the strategy
19+ */
1720 tokenOutAddress : Address ;
18- // chain id and network type as they are written in sdk. wrong entries are being omitted
21+ /**
22+ * Chain id and network type as they are written in sdk. Wrong entries are being omitted
23+ */
1924 chainId : number ;
2025 network : string ;
21- // if the chain doesn't have credit managers - strategy won't be shown on that chain
26+ /**
27+ * Credit managers strategy can be opened on. If it doesn't present - strategy won't be shown
28+ */
2229 creditManagers : Array < Address > ;
23- // strategy type; used for filtering
30+ /**
31+ * Strategy type. Used for filtering
32+ */
2433 strategyType : [ TokenTypeStrategy ] ;
2534
26- /*
27- undefined - released
28- number - one value for the current chain
29- In ms, for example: 1740398400_000
30- */
35+ /**
36+ * undefined - released;
37+ * number - one value for the current chain.
38+ * In ms, for example: 1740398400_000;
39+ */
3140 releaseAt ?: number ;
32- // an option to show strategies in dev environment only
33- // undefined, false = no
41+ /**
42+ * An option to show strategies in dev environment only.
43+ * undefined, false = no.
44+ */
3445 hideInProd ?: boolean ;
35- // an option to show strategies in main app only
36- // undefined, true = yes; false = no
46+ /** An option to show strategies in main app only.
47+ * undefined, true = yes; false = no.
48+ */
3749 showInMainApp ?: boolean ;
38- /*
39- undefined - no restrictions
40- number - one value for the current chain
41- */
50+ /**
51+ * undefined - no restrictions.
52+ * number - one value for the current chain.
53+ */
4254 maxLeverage ?: number ;
43- /*
44- undefined, false = no
45- PartialRecord<number, boolean> - delayed withdrawal for each chain separately
46- */
55+ /**
56+ * undefined, false = no.
57+ * PartialRecord<number, boolean> - delayed withdrawal for each chain separately.
58+ */
4759 delayedWithdrawal ?: boolean ;
48- /*
49- previously known as "bad asset", an asset closing account with may need extra capital.
50- undefined, false = no
51- VersionRange - problems only in this range
52- */
60+ /**
61+ * previously known as "bad asset", an asset closing account with may need extra capital.
62+ * undefined, false = no.
63+ * VersionRange - problems only in this range.
64+ */
5365 issuesOnClose ?: boolean | VersionRange ;
54- /*
55- pools in which current token has zero slippage
56- pool - boolean
57- */
66+ /**
67+ * pools in which current token has zero slippage.
68+ * pool - boolean.
69+ */
5870 zeroSlippage ?: PartialRecord < Address , boolean > ;
59- // pools in which additional quota should be bought for current token
60- // pool - boolean
71+ /**
72+ * pools in which additional quota should be bought for current token.
73+ * pool - boolean
74+ */
6175 additionalRewardQuotas ?: PartialRecord < Address , Address [ ] > ;
6276 /**
63- * If address provided - it is considered that this collateral can be used across all listed cms
64- * If object provided - it is considered that this collateral can be used only on the specified cm
77+ * If address provided - it is considered that this collateral can be used across all listed cms.
78+ * If object provided - it is considered that this collateral can be used only on the specified cm.
6579 */
6680 additionalCollaterals ?: Array < Address | { token : Address ; cm : Address } > ;
6781}
0 commit comments