@velora-dex/sdk 9.3.6 → 9.4.1-dev.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (147) hide show
  1. package/README.md +2 -0
  2. package/dist/examples/externalDelta.d.ts +2 -0
  3. package/dist/examples/externalDelta.d.ts.map +1 -0
  4. package/dist/examples/helpers/delta.d.ts +2 -2
  5. package/dist/examples/helpers/delta.d.ts.map +1 -1
  6. package/dist/index.d.ts +17 -6
  7. package/dist/index.d.ts.map +1 -1
  8. package/dist/methods/delta/buildDeltaOrder.d.ts +4 -10
  9. package/dist/methods/delta/buildDeltaOrder.d.ts.map +1 -1
  10. package/dist/methods/delta/buildExternalDeltaOrder.d.ts +46 -0
  11. package/dist/methods/delta/buildExternalDeltaOrder.d.ts.map +1 -0
  12. package/dist/methods/delta/buildTWAPDeltaOrder.d.ts +65 -0
  13. package/dist/methods/delta/buildTWAPDeltaOrder.d.ts.map +1 -0
  14. package/dist/methods/delta/getDeltaOrders.d.ts +14 -6
  15. package/dist/methods/delta/getDeltaOrders.d.ts.map +1 -1
  16. package/dist/methods/delta/helpers/abi.d.ts +16 -0
  17. package/dist/methods/delta/helpers/abi.d.ts.map +1 -0
  18. package/dist/methods/delta/helpers/buildDeltaOrderData.d.ts +0 -1
  19. package/dist/methods/delta/helpers/buildDeltaOrderData.d.ts.map +1 -1
  20. package/dist/methods/delta/helpers/buildExternalOrderData.d.ts +34 -0
  21. package/dist/methods/delta/helpers/buildExternalOrderData.d.ts.map +1 -0
  22. package/dist/methods/delta/helpers/buildTWAPOrderData.d.ts +74 -0
  23. package/dist/methods/delta/helpers/buildTWAPOrderData.d.ts.map +1 -0
  24. package/dist/methods/delta/helpers/misc.d.ts +51 -0
  25. package/dist/methods/delta/helpers/misc.d.ts.map +1 -1
  26. package/dist/methods/delta/helpers/types.d.ts +116 -4
  27. package/dist/methods/delta/helpers/types.d.ts.map +1 -1
  28. package/dist/methods/delta/index.d.ts +34 -3
  29. package/dist/methods/delta/index.d.ts.map +1 -1
  30. package/dist/methods/delta/postDeltaOrder.d.ts +4 -9
  31. package/dist/methods/delta/postDeltaOrder.d.ts.map +1 -1
  32. package/dist/methods/delta/postExternalDeltaOrder.d.ts +11 -0
  33. package/dist/methods/delta/postExternalDeltaOrder.d.ts.map +1 -0
  34. package/dist/methods/delta/postTWAPDeltaOrder.d.ts +16 -0
  35. package/dist/methods/delta/postTWAPDeltaOrder.d.ts.map +1 -0
  36. package/dist/methods/delta/preSignDeltaOrder.d.ts.map +1 -1
  37. package/dist/methods/delta/preSignExternalDeltaOrder.d.ts +17 -0
  38. package/dist/methods/delta/preSignExternalDeltaOrder.d.ts.map +1 -0
  39. package/dist/methods/delta/preSignTWAPDeltaOrder.d.ts +20 -0
  40. package/dist/methods/delta/preSignTWAPDeltaOrder.d.ts.map +1 -0
  41. package/dist/methods/delta/signExternalDeltaOrder.d.ts +9 -0
  42. package/dist/methods/delta/signExternalDeltaOrder.d.ts.map +1 -0
  43. package/dist/methods/delta/signTWAPDeltaOrder.d.ts +9 -0
  44. package/dist/methods/delta/signTWAPDeltaOrder.d.ts.map +1 -0
  45. package/dist/methods/limitOrders/approveForOrder.d.ts +2 -0
  46. package/dist/methods/limitOrders/approveForOrder.d.ts.map +1 -1
  47. package/dist/methods/limitOrders/buildOrder.d.ts +3 -0
  48. package/dist/methods/limitOrders/buildOrder.d.ts.map +1 -1
  49. package/dist/methods/limitOrders/cancelOrder.d.ts +2 -0
  50. package/dist/methods/limitOrders/cancelOrder.d.ts.map +1 -1
  51. package/dist/methods/limitOrders/fillOrderDirectly.d.ts +2 -0
  52. package/dist/methods/limitOrders/fillOrderDirectly.d.ts.map +1 -1
  53. package/dist/methods/limitOrders/getOrders.d.ts +2 -0
  54. package/dist/methods/limitOrders/getOrders.d.ts.map +1 -1
  55. package/dist/methods/limitOrders/getOrdersContract.d.ts +2 -0
  56. package/dist/methods/limitOrders/getOrdersContract.d.ts.map +1 -1
  57. package/dist/methods/limitOrders/index.d.ts +7 -1
  58. package/dist/methods/limitOrders/index.d.ts.map +1 -1
  59. package/dist/methods/limitOrders/postOrder.d.ts +2 -0
  60. package/dist/methods/limitOrders/postOrder.d.ts.map +1 -1
  61. package/dist/methods/limitOrders/signOrder.d.ts +2 -0
  62. package/dist/methods/limitOrders/signOrder.d.ts.map +1 -1
  63. package/dist/methods/limitOrders/transaction.d.ts +2 -0
  64. package/dist/methods/limitOrders/transaction.d.ts.map +1 -1
  65. package/dist/methods/nftOrders/approveForOrder.d.ts +2 -0
  66. package/dist/methods/nftOrders/approveForOrder.d.ts.map +1 -1
  67. package/dist/methods/nftOrders/buildOrder.d.ts +3 -0
  68. package/dist/methods/nftOrders/buildOrder.d.ts.map +1 -1
  69. package/dist/methods/nftOrders/cancelOrder.d.ts +2 -0
  70. package/dist/methods/nftOrders/cancelOrder.d.ts.map +1 -1
  71. package/dist/methods/nftOrders/getOrders.d.ts +2 -0
  72. package/dist/methods/nftOrders/getOrders.d.ts.map +1 -1
  73. package/dist/methods/nftOrders/getOrdersContract.d.ts +2 -0
  74. package/dist/methods/nftOrders/getOrdersContract.d.ts.map +1 -1
  75. package/dist/methods/nftOrders/helpers/misc.d.ts +1 -0
  76. package/dist/methods/nftOrders/helpers/misc.d.ts.map +1 -1
  77. package/dist/methods/nftOrders/index.d.ts +7 -1
  78. package/dist/methods/nftOrders/index.d.ts.map +1 -1
  79. package/dist/methods/nftOrders/postOrder.d.ts +2 -0
  80. package/dist/methods/nftOrders/postOrder.d.ts.map +1 -1
  81. package/dist/methods/nftOrders/signOrder.d.ts +2 -0
  82. package/dist/methods/nftOrders/signOrder.d.ts.map +1 -1
  83. package/dist/methods/nftOrders/transaction.d.ts +2 -0
  84. package/dist/methods/nftOrders/transaction.d.ts.map +1 -1
  85. package/dist/sdk/full.d.ts +2 -0
  86. package/dist/sdk/full.d.ts.map +1 -1
  87. package/dist/sdk/partial.d.ts +5 -1
  88. package/dist/sdk/partial.d.ts.map +1 -1
  89. package/dist/sdk/simple.d.ts +6 -0
  90. package/dist/sdk/simple.d.ts.map +1 -1
  91. package/dist/sdk.cjs.development.js +1357 -210
  92. package/dist/sdk.cjs.development.js.map +1 -1
  93. package/dist/sdk.cjs.production.min.js +1 -1
  94. package/dist/sdk.cjs.production.min.js.map +1 -1
  95. package/dist/sdk.esm.js +1348 -211
  96. package/dist/sdk.esm.js.map +1 -1
  97. package/package.json +1 -1
  98. package/src/constants.js +3 -0
  99. package/src/examples/delta.ts +9 -20
  100. package/src/examples/externalDelta.ts +162 -0
  101. package/src/examples/helpers/delta.ts +8 -4
  102. package/src/gas.js +1 -0
  103. package/src/index.js +85 -0
  104. package/src/index.ts +103 -3
  105. package/src/methods/delta/buildDeltaOrder.ts +13 -61
  106. package/src/methods/delta/buildExternalDeltaOrder.ts +124 -0
  107. package/src/methods/delta/buildTWAPDeltaOrder.ts +181 -0
  108. package/src/methods/delta/getDeltaOrders.ts +31 -13
  109. package/src/methods/delta/helpers/abi.ts +20 -0
  110. package/src/methods/delta/helpers/buildDeltaOrderData.ts +3 -35
  111. package/src/methods/delta/helpers/buildExternalOrderData.ts +129 -0
  112. package/src/methods/delta/helpers/buildTWAPOrderData.ts +227 -0
  113. package/src/methods/delta/helpers/misc.ts +244 -0
  114. package/src/methods/delta/helpers/types.ts +138 -9
  115. package/src/methods/delta/index.ts +159 -3
  116. package/src/methods/delta/postDeltaOrder.ts +9 -11
  117. package/src/methods/delta/postExternalDeltaOrder.ts +45 -0
  118. package/src/methods/delta/postTWAPDeltaOrder.ts +57 -0
  119. package/src/methods/delta/preSignDeltaOrder.ts +1 -21
  120. package/src/methods/delta/preSignExternalDeltaOrder.ts +141 -0
  121. package/src/methods/delta/preSignTWAPDeltaOrder.ts +168 -0
  122. package/src/methods/delta/signExternalDeltaOrder.ts +35 -0
  123. package/src/methods/delta/signTWAPDeltaOrder.ts +32 -0
  124. package/src/methods/limitOrders/approveForOrder.ts +2 -0
  125. package/src/methods/limitOrders/buildOrder.ts +3 -0
  126. package/src/methods/limitOrders/cancelOrder.ts +2 -0
  127. package/src/methods/limitOrders/fillOrderDirectly.ts +2 -0
  128. package/src/methods/limitOrders/getOrders.ts +2 -0
  129. package/src/methods/limitOrders/getOrdersContract.ts +2 -0
  130. package/src/methods/limitOrders/index.ts +7 -1
  131. package/src/methods/limitOrders/postOrder.ts +2 -0
  132. package/src/methods/limitOrders/signOrder.ts +2 -0
  133. package/src/methods/limitOrders/transaction.ts +2 -0
  134. package/src/methods/nftOrders/approveForOrder.ts +2 -0
  135. package/src/methods/nftOrders/buildOrder.ts +3 -0
  136. package/src/methods/nftOrders/cancelOrder.ts +2 -0
  137. package/src/methods/nftOrders/getOrders.ts +2 -0
  138. package/src/methods/nftOrders/getOrdersContract.ts +2 -0
  139. package/src/methods/nftOrders/helpers/misc.ts +1 -0
  140. package/src/methods/nftOrders/index.ts +7 -1
  141. package/src/methods/nftOrders/postOrder.ts +2 -0
  142. package/src/methods/nftOrders/signOrder.ts +2 -0
  143. package/src/methods/nftOrders/transaction.ts +2 -0
  144. package/src/sdk/full.ts +2 -0
  145. package/src/sdk/partial.ts +5 -1
  146. package/src/sdk/simple.ts +6 -0
  147. package/src/types.js +1 -0
@@ -0,0 +1,168 @@
1
+ import { hashTypedData } from 'viem/utils';
2
+ import type {
3
+ ConstructProviderFetchInput,
4
+ RequestParameters,
5
+ TxSendOverrides,
6
+ } from '../../types';
7
+ import {
8
+ produceTWAPOrderTypedData,
9
+ SignableTWAPOrderData,
10
+ } from './helpers/buildTWAPOrderData';
11
+ import { sanitizeTWAPOrderData } from './helpers/misc';
12
+ import { PreSignatureModuleAbi } from './helpers/abi';
13
+ import type { ExtractAbiMethodNames } from '../../helpers/misc';
14
+ import { findPrimaryType } from '../../helpers/providers/helpers';
15
+ import { constructGetDeltaContract } from './getDeltaContract';
16
+ import type { TWAPDeltaOrder, TWAPBuyDeltaOrder } from './helpers/types';
17
+ import { TypedDataField } from 'ethersV5';
18
+
19
+ type HashTWAPDeltaOrderTypedData = (
20
+ signableOrderData: SignableTWAPOrderData
21
+ ) => string;
22
+
23
+ type HashTWAPDeltaOrder = {
24
+ (
25
+ orderData: TWAPDeltaOrder,
26
+ onChainOrderType: 'TWAPOrder',
27
+ requestParams?: RequestParameters
28
+ ): Promise<string>;
29
+
30
+ (
31
+ orderData: TWAPBuyDeltaOrder,
32
+ onChainOrderType: 'TWAPBuyOrder',
33
+ requestParams?: RequestParameters
34
+ ): Promise<string>;
35
+ };
36
+
37
+ export type SetTWAPDeltaOrderPreSignature<T> = (
38
+ orderHash: string,
39
+ overrides?: TxSendOverrides,
40
+ requestParams?: RequestParameters
41
+ ) => Promise<T>;
42
+
43
+ export type PreSignTWAPDeltaOrder<T> = (
44
+ signableOrderData: SignableTWAPOrderData,
45
+ overrides?: TxSendOverrides,
46
+ requestParams?: RequestParameters
47
+ ) => Promise<T>;
48
+
49
+ export type PreSignTWAPDeltaOrderFunctions<T> = {
50
+ hashTWAPDeltaOrderTypedData: HashTWAPDeltaOrderTypedData;
51
+ hashTWAPDeltaOrder: HashTWAPDeltaOrder;
52
+ setTWAPDeltaOrderPreSignature: SetTWAPDeltaOrderPreSignature<T>;
53
+ preSignTWAPDeltaOrder: PreSignTWAPDeltaOrder<T>;
54
+ };
55
+
56
+ type AvailableMethods = ExtractAbiMethodNames<typeof PreSignatureModuleAbi>;
57
+
58
+ export const constructPreSignTWAPDeltaOrder = <T>(
59
+ options: ConstructProviderFetchInput<T, 'transactCall'>
60
+ ): PreSignTWAPDeltaOrderFunctions<T> => {
61
+ const hashTWAPDeltaOrderTypedData: HashTWAPDeltaOrderTypedData = (
62
+ typedData
63
+ ) => {
64
+ const typedDataOnly = {
65
+ ...typedData,
66
+ data: sanitizeTWAPOrderData(typedData.data),
67
+ } as SignableTWAPOrderData;
68
+
69
+ const orderHash = produceTWAPOrderHash(typedDataOnly);
70
+
71
+ return orderHash;
72
+ };
73
+
74
+ const { getDeltaContract } = constructGetDeltaContract(options);
75
+
76
+ const hashTWAPDeltaOrder: HashTWAPDeltaOrder = async (
77
+ orderData,
78
+ onChainOrderType,
79
+ requestParams
80
+ ) => {
81
+ const ParaswapDelta = await getDeltaContract(requestParams);
82
+ if (!ParaswapDelta) {
83
+ throw new Error(`Delta is not available on chain ${options.chainId}`);
84
+ }
85
+
86
+ if (onChainOrderType === 'TWAPOrder' && 'totalSrcAmount' in orderData) {
87
+ const typedData = produceTWAPOrderTypedData({
88
+ orderInput: orderData,
89
+ chainId: options.chainId,
90
+ paraswapDeltaAddress: ParaswapDelta,
91
+ onChainOrderType,
92
+ });
93
+ return hashTWAPDeltaOrderTypedData(typedData);
94
+ }
95
+
96
+ if (onChainOrderType === 'TWAPBuyOrder' && 'maxSrcAmount' in orderData) {
97
+ const typedData = produceTWAPOrderTypedData({
98
+ orderInput: orderData,
99
+ chainId: options.chainId,
100
+ paraswapDeltaAddress: ParaswapDelta,
101
+ onChainOrderType,
102
+ });
103
+ return hashTWAPDeltaOrderTypedData(typedData);
104
+ }
105
+
106
+ throw new Error(
107
+ `Invalid order data for onChainOrderType ${onChainOrderType}`
108
+ );
109
+ };
110
+
111
+ const setTWAPDeltaOrderPreSignature: SetTWAPDeltaOrderPreSignature<
112
+ T
113
+ > = async (orderHash, overrides = {}, requestParams) => {
114
+ const ParaswapDelta = await getDeltaContract(requestParams);
115
+ if (!ParaswapDelta) {
116
+ throw new Error(`Delta is not available on chain ${options.chainId}`);
117
+ }
118
+
119
+ const res = await options.contractCaller.transactCall<AvailableMethods>({
120
+ address: ParaswapDelta,
121
+ abi: PreSignatureModuleAbi,
122
+ contractMethod: 'setPreSignature',
123
+ args: [orderHash, true],
124
+ overrides,
125
+ });
126
+
127
+ return res;
128
+ };
129
+
130
+ const preSignTWAPDeltaOrder: PreSignTWAPDeltaOrder<T> = async (
131
+ signableOrderData,
132
+ overrides = {},
133
+ requestParams
134
+ ) => {
135
+ const orderHash = hashTWAPDeltaOrderTypedData(signableOrderData);
136
+ const res = await setTWAPDeltaOrderPreSignature(
137
+ orderHash,
138
+ overrides,
139
+ requestParams
140
+ );
141
+ return res;
142
+ };
143
+
144
+ return {
145
+ hashTWAPDeltaOrderTypedData,
146
+ hashTWAPDeltaOrder,
147
+ setTWAPDeltaOrderPreSignature,
148
+ preSignTWAPDeltaOrder,
149
+ };
150
+ };
151
+
152
+ export function produceTWAPOrderHash(typedData: SignableTWAPOrderData): string {
153
+ const types = typedData.types as Record<
154
+ 'TWAPOrder' | 'TWAPBuyOrder' | 'Bridge',
155
+ TypedDataField[]
156
+ >;
157
+ return hashTypedData({
158
+ domain: {
159
+ name: typedData.domain.name,
160
+ version: typedData.domain.version,
161
+ chainId: typedData.domain.chainId,
162
+ verifyingContract: typedData.domain.verifyingContract as `0x${string}`,
163
+ },
164
+ types,
165
+ primaryType: findPrimaryType(types),
166
+ message: typedData.data,
167
+ });
168
+ }
@@ -0,0 +1,35 @@
1
+ import type { ConstructProviderFetchInput } from '../../types';
2
+ import { SignableExternalOrderData } from './helpers/buildExternalOrderData';
3
+ import { sanitizeExternalOrderData } from './helpers/misc';
4
+
5
+ type SignExternalDeltaOrder = (
6
+ signableOrderData: SignableExternalOrderData
7
+ ) => Promise<string>;
8
+
9
+ export type SignExternalDeltaOrderFunctions = {
10
+ signExternalDeltaOrder: SignExternalDeltaOrder;
11
+ };
12
+
13
+ // returns whatever `contractCaller` returns
14
+ // to allow for better versatility
15
+ export const constructSignExternalDeltaOrder = (
16
+ options: Pick<
17
+ ConstructProviderFetchInput<any, 'signTypedDataCall'>,
18
+ 'contractCaller'
19
+ >
20
+ ): SignExternalDeltaOrderFunctions => {
21
+ const signExternalDeltaOrder: SignExternalDeltaOrder = async (typedData) => {
22
+ // types allow to pass OrderData & extra_stuff, but tx will break like that
23
+ const typedDataOnly: SignableExternalOrderData = {
24
+ ...typedData,
25
+ data: sanitizeExternalOrderData(typedData.data),
26
+ };
27
+ const signature = await options.contractCaller.signTypedDataCall(
28
+ typedDataOnly
29
+ );
30
+
31
+ return signature;
32
+ };
33
+
34
+ return { signExternalDeltaOrder };
35
+ };
@@ -0,0 +1,32 @@
1
+ import type { ConstructProviderFetchInput } from '../../types';
2
+ import { SignableTWAPOrderData } from './helpers/buildTWAPOrderData';
3
+ import { sanitizeTWAPOrderData } from './helpers/misc';
4
+
5
+ type SignTWAPDeltaOrder = (
6
+ signableOrderData: SignableTWAPOrderData
7
+ ) => Promise<string>;
8
+
9
+ export type SignTWAPDeltaOrderFunctions = {
10
+ signTWAPDeltaOrder: SignTWAPDeltaOrder;
11
+ };
12
+
13
+ export const constructSignTWAPDeltaOrder = (
14
+ options: Pick<
15
+ ConstructProviderFetchInput<any, 'signTypedDataCall'>,
16
+ 'contractCaller'
17
+ >
18
+ ): SignTWAPDeltaOrderFunctions => {
19
+ const signTWAPDeltaOrder: SignTWAPDeltaOrder = async (typedData) => {
20
+ const typedDataOnly = {
21
+ ...typedData,
22
+ data: sanitizeTWAPOrderData(typedData.data),
23
+ } as SignableTWAPOrderData;
24
+ const signature = await options.contractCaller.signTypedDataCall(
25
+ typedDataOnly
26
+ );
27
+
28
+ return signature;
29
+ };
30
+
31
+ return { signTWAPDeltaOrder };
32
+ };
@@ -3,6 +3,7 @@ import { ApproveToken, approveTokenMethodFactory } from '../../helpers/approve';
3
3
  import { constructApproveToken } from '../swap/approve';
4
4
  import { constructGetSpender } from '../swap/spender';
5
5
 
6
+ /** @deprecated Limit Orders are deprecated and will be removed in a future version. */
6
7
  export type ApproveTokenForLimitOrderFunctions<T> = {
7
8
  /** @description approving AugustusRFQ as spender for makerAsset */
8
9
  approveMakerTokenForLimitOrder: ApproveToken<T>;
@@ -14,6 +15,7 @@ export type ApproveTokenForLimitOrderFunctions<T> = {
14
15
 
15
16
  // returns whatever `contractCaller` returns
16
17
  // to allow for better versatility
18
+ /** @deprecated Limit Orders are deprecated and will be removed in a future version. */
17
19
  export const constructApproveTokenForLimitOrder = <T>(
18
20
  options: ConstructProviderFetchInput<T, 'transactCall'>
19
21
  ): ApproveTokenForLimitOrderFunctions<T> => {
@@ -8,6 +8,7 @@ import {
8
8
  } from './helpers/buildOrderData';
9
9
  export * from './helpers/buildOrderData';
10
10
 
11
+ /** @deprecated Limit Orders are deprecated and will be removed in a future version. */
11
12
  export type BuildLimitOrderInput = Omit<
12
13
  BuildOrderDataInput,
13
14
  'chainId' | 'verifyingContract' | 'AugustusAddress' | 'AppVersion'
@@ -18,11 +19,13 @@ type BuildLimitOrder = (
18
19
  requestParams?: RequestParameters
19
20
  ) => Promise<SignableOrderData>;
20
21
 
22
+ /** @deprecated Limit Orders are deprecated and will be removed in a future version. */
21
23
  export type BuildLimitOrderFunctions = {
22
24
  /** @description Build Orders that will be excuted through AugustusSwapper */
23
25
  buildLimitOrder: BuildLimitOrder;
24
26
  };
25
27
 
28
+ /** @deprecated Limit Orders are deprecated and will be removed in a future version. */
26
29
  export const constructBuildLimitOrder = (
27
30
  options: ConstructFetchInput
28
31
  ): BuildLimitOrderFunctions => {
@@ -18,6 +18,7 @@ export type CancelOrderBulk<T> = (
18
18
  requestParams?: RequestParameters
19
19
  ) => Promise<T>;
20
20
 
21
+ /** @deprecated Limit Orders are deprecated and will be removed in a future version. */
21
22
  export type CancelLimitOrderFunctions<T> = {
22
23
  cancelLimitOrder: CancelOrder<T>;
23
24
  cancelLimitOrderBulk: CancelOrderBulk<T>;
@@ -57,6 +58,7 @@ type AvailableMethods = ExtractAbiMethodNames<typeof MinAugustusRFQAbi>;
57
58
 
58
59
  // returns whatever `contractCaller` returns
59
60
  // to allow for better versatility
61
+ /** @deprecated Limit Orders are deprecated and will be removed in a future version. */
60
62
  export const constructCancelLimitOrder = <T>(
61
63
  options: ConstructProviderFetchInput<T, 'transactCall'>
62
64
  ): CancelLimitOrderFunctions<T> => {
@@ -12,6 +12,7 @@ import {
12
12
  encodeEIP_2612PermitFunctionInput,
13
13
  } from '../common/orders/encoding';
14
14
 
15
+ /** @deprecated Limit Orders are deprecated and will be removed in a future version. */
15
16
  export type FillOrderDirectlyFunctions<T> = {
16
17
  fillOrderDirectly: FillOrderDirectly<T>;
17
18
  };
@@ -204,6 +205,7 @@ type FillOrderMethods = ExtractAbiMethodNames<typeof MinAugustusRFQAbi>;
204
205
 
205
206
  // returns whatever `contractCaller` returns
206
207
  // to allow for better versatility
208
+ /** @deprecated Limit Orders are deprecated and will be removed in a future version. */
207
209
  export function constructFillOrderDirectly<T>(
208
210
  options: ConstructProviderFetchInput<T, 'transactCall'>
209
211
  ): FillOrderDirectlyFunctions<T> {
@@ -52,6 +52,7 @@ type GetRequiredBalance = (
52
52
  requestParams?: RequestParameters
53
53
  ) => Promise<Record<string, string>>;
54
54
 
55
+ /** @deprecated Limit Orders are deprecated and will be removed in a future version. */
55
56
  export type GetLimitOrdersFunctions = {
56
57
  getLimitOrders: GetLimitOrders;
57
58
  getLimitOrderByHash: GetLimitOrderByHash;
@@ -67,6 +68,7 @@ export type GetLimitOrdersFunctions = {
67
68
  getRequiredBalance: GetRequiredBalance;
68
69
  };
69
70
 
71
+ /** @deprecated Limit Orders are deprecated and will be removed in a future version. */
70
72
  export const constructGetLimitOrders = ({
71
73
  apiURL = API_URL,
72
74
  chainId,
@@ -1,11 +1,13 @@
1
1
  import type { ConstructFetchInput } from '../../types';
2
2
  import { constructGetSpender, GetSpender } from '../swap/spender';
3
3
 
4
+ /** @deprecated Limit Orders are deprecated and will be removed in a future version. */
4
5
  export type GetLimitOrdersContractFunctions = {
5
6
  getLimitOrdersContract: GetSpender;
6
7
  getTokenTransferProxy: GetSpender;
7
8
  };
8
9
 
10
+ /** @deprecated Limit Orders are deprecated and will be removed in a future version. */
9
11
  export const constructGetLimitOrdersContract = (
10
12
  options: ConstructFetchInput
11
13
  ): GetLimitOrdersContractFunctions => {
@@ -45,11 +45,13 @@ type SubmitP2POrder = (
45
45
  requestParams?: RequestParameters
46
46
  ) => Promise<LimitOrderFromApi>;
47
47
 
48
+ /** @deprecated Limit Orders are deprecated and will be removed in a future version. */
48
49
  export type SubmitLimitOrderFuncs = {
49
50
  submitLimitOrder: SubmitLimitOrder;
50
51
  submitP2POrder: SubmitP2POrder;
51
52
  };
52
53
 
54
+ /** @deprecated Limit Orders are deprecated and will be removed in a future version. */
53
55
  export const constructSubmitLimitOrder = (
54
56
  options: ConstructProviderFetchInput<any, 'signTypedDataCall'>
55
57
  ): SubmitLimitOrderFuncs => {
@@ -106,6 +108,7 @@ export const constructSubmitLimitOrder = (
106
108
  return { submitLimitOrder, submitP2POrder };
107
109
  };
108
110
 
111
+ /** @deprecated Limit Orders are deprecated and will be removed in a future version. */
109
112
  export type LimitOrderHandlers<T> = SubmitLimitOrderFuncs &
110
113
  BuildLimitOrderFunctions &
111
114
  SignLimitOrderFunctions &
@@ -117,7 +120,10 @@ export type LimitOrderHandlers<T> = SubmitLimitOrderFuncs &
117
120
  ApproveTokenForLimitOrderFunctions<T> &
118
121
  FillOrderDirectlyFunctions<T>;
119
122
 
120
- /** @description construct SDK with every LimitOrders-related method, fetching from API and contract calls */
123
+ /**
124
+ * @description construct SDK with every LimitOrders-related method, fetching from API and contract calls
125
+ * @deprecated Limit Orders are deprecated and will be removed in a future version.
126
+ */
121
127
  export const constructAllLimitOrdersHandlers = <TxResponse>(
122
128
  options: ConstructProviderFetchInput<
123
129
  TxResponse,
@@ -13,11 +13,13 @@ type PostLimitOrder = (
13
13
  requestParams?: RequestParameters
14
14
  ) => Promise<LimitOrderFromApi>;
15
15
 
16
+ /** @deprecated Limit Orders are deprecated and will be removed in a future version. */
16
17
  export type PostLimitOrderFunctions = {
17
18
  postLimitOrder: PostLimitOrder;
18
19
  postP2POrder: PostLimitOrder;
19
20
  };
20
21
 
22
+ /** @deprecated Limit Orders are deprecated and will be removed in a future version. */
21
23
  export const constructPostLimitOrder = ({
22
24
  apiURL = API_URL,
23
25
  chainId,
@@ -2,12 +2,14 @@ import type { ConstructProviderFetchInput } from '../../types';
2
2
  import type { SignableOrderData } from './buildOrder';
3
3
  import { sanitizeOrderData } from './helpers/misc';
4
4
 
5
+ /** @deprecated Limit Orders are deprecated and will be removed in a future version. */
5
6
  export type SignLimitOrderFunctions = {
6
7
  signLimitOrder: (signableOrderData: SignableOrderData) => Promise<string>;
7
8
  };
8
9
 
9
10
  // returns whatever `contractCaller` returns
10
11
  // to allow for better versatility
12
+ /** @deprecated Limit Orders are deprecated and will be removed in a future version. */
11
13
  export const constructSignLimitOrder = (
12
14
  options: Pick<
13
15
  ConstructProviderFetchInput<any, 'signTypedDataCall'>,
@@ -44,6 +44,7 @@ type BuildLimitOrdersTx = (
44
44
  requestParams?: RequestParameters
45
45
  ) => Promise<TransactionParams>;
46
46
 
47
+ /** @deprecated Limit Orders are deprecated and will be removed in a future version. */
47
48
  export type BuildLimitOrdersTxFunctions = {
48
49
  getLimitOrdersRate: GetLimitOrdersRate;
49
50
  buildLimitOrderTx: BuildLimitOrdersTx;
@@ -57,6 +58,7 @@ type GetLimitOrdersRate = (
57
58
  requestParams?: RequestParameters
58
59
  ) => Promise<OptimalRate>;
59
60
 
61
+ /** @deprecated Limit Orders are deprecated and will be removed in a future version. */
60
62
  export const constructBuildLimitOrderTx = ({
61
63
  apiURL = API_URL,
62
64
  version = DEFAULT_VERSION,
@@ -15,6 +15,7 @@ type ApproveNFT<T> = (
15
15
  requestParams?: RequestParameters
16
16
  ) => Promise<T>;
17
17
 
18
+ /** @deprecated NFT Orders are deprecated and will be removed in a future version. */
18
19
  export type ApproveTokenForNFTOrderFunctions<T> = {
19
20
  /** @description approving AugustusSwapper as spender for takerAsset (ERC20) for Limit Orders that will be executed through it */
20
21
  approveERC20ForNFTOrder: ApproveToken<T>;
@@ -47,6 +48,7 @@ type ApprovalMethods = ExtractAbiMethodNames<typeof MinNFTAbi>;
47
48
 
48
49
  // returns whatever `contractCaller` returns
49
50
  // to allow for better versatility
51
+ /** @deprecated NFT Orders are deprecated and will be removed in a future version. */
50
52
  export const constructApproveTokenForNFTOrder = <T>(
51
53
  options: ConstructProviderFetchInput<T, 'transactCall'>
52
54
  ): ApproveTokenForNFTOrderFunctions<T> => {
@@ -7,6 +7,7 @@ import {
7
7
  } from './helpers/buildOrderData';
8
8
  export * from './helpers/buildOrderData';
9
9
 
10
+ /** @deprecated NFT Orders are deprecated and will be removed in a future version. */
10
11
  export type BuildNFTOrderInput = Omit<
11
12
  BuildNFTOrderDataInput,
12
13
  'chainId' | 'verifyingContract' | 'AugustusAddress'
@@ -17,11 +18,13 @@ type BuildNFTOrder = (
17
18
  requestParams?: RequestParameters
18
19
  ) => Promise<SignableNFTOrderData>;
19
20
 
21
+ /** @deprecated NFT Orders are deprecated and will be removed in a future version. */
20
22
  export type BuildNFTOrderFunctions = {
21
23
  /** @description Build Orders that will be excuted through AugustusSwapper */
22
24
  buildNFTOrder: BuildNFTOrder;
23
25
  };
24
26
 
27
+ /** @deprecated NFT Orders are deprecated and will be removed in a future version. */
25
28
  export const constructBuildNFTOrder = (
26
29
  options: ConstructFetchInput
27
30
  ): BuildNFTOrderFunctions => {
@@ -5,12 +5,14 @@ import {
5
5
  constructCancelLimitOrder,
6
6
  } from '../limitOrders/cancelOrder';
7
7
 
8
+ /** @deprecated NFT Orders are deprecated and will be removed in a future version. */
8
9
  export type CancelNFTOrderFunctions<T> = {
9
10
  cancelNFTOrder: CancelOrder<T>;
10
11
  cancelNFTOrderBulk: CancelOrderBulk<T>;
11
12
  };
12
13
 
13
14
  // should work the same as for LimitOrders
15
+ /** @deprecated NFT Orders are deprecated and will be removed in a future version. */
14
16
  export const constructCancelNFTOrder = <T>(
15
17
  options: ConstructProviderFetchInput<T, 'transactCall'>
16
18
  ): CancelNFTOrderFunctions<T> => {
@@ -28,11 +28,13 @@ type GetNFTOrders = (
28
28
  requestParams?: RequestParameters
29
29
  ) => Promise<NFTOrdersApiResponse>;
30
30
 
31
+ /** @deprecated NFT Orders are deprecated and will be removed in a future version. */
31
32
  export type GetNFTOrdersFunctions = {
32
33
  getNFTOrders: GetNFTOrders;
33
34
  getNFTOrderByHash: GetNFTOrderByHash;
34
35
  };
35
36
 
37
+ /** @deprecated NFT Orders are deprecated and will be removed in a future version. */
36
38
  export const constructGetNFTOrders = ({
37
39
  apiURL = API_URL,
38
40
  chainId,
@@ -1,12 +1,14 @@
1
1
  import type { ConstructFetchInput } from '../../types';
2
2
  import { constructGetSpender, GetSpender } from '../swap/spender';
3
3
 
4
+ /** @deprecated NFT Orders are deprecated and will be removed in a future version. */
4
5
  export type GetNFTOrdersContractFunctions = {
5
6
  getNFTOrdersContract: GetSpender;
6
7
  getTokenTransferProxy: GetSpender;
7
8
  };
8
9
 
9
10
  // should work the same as LimitOrders
11
+ /** @deprecated NFT Orders are deprecated and will be removed in a future version. */
10
12
  export const constructGetNFTOrdersContract = (
11
13
  options: ConstructFetchInput
12
14
  ): GetNFTOrdersContractFunctions => {
@@ -18,6 +18,7 @@ import {
18
18
  // ERC721 = 2,
19
19
  // }
20
20
 
21
+ /** @deprecated NFT Orders are deprecated and will be removed in a future version. */
21
22
  export const AssetType = {
22
23
  ERC20: 0,
23
24
  ERC1155: 1,
@@ -34,11 +34,13 @@ type SubmitNFTOrder = (
34
34
  requestParams?: RequestParameters
35
35
  ) => Promise<NFTOrderFromAPI>;
36
36
 
37
+ /** @deprecated NFT Orders are deprecated and will be removed in a future version. */
37
38
  export type SubmitNFTOrderFuncs = {
38
39
  submitNFTOrder: SubmitNFTOrder;
39
40
  submitP2POrder: SubmitNFTOrder;
40
41
  };
41
42
 
43
+ /** @deprecated NFT Orders are deprecated and will be removed in a future version. */
42
44
  export const constructSubmitNFTOrder = (
43
45
  options: ConstructProviderFetchInput<any, 'signTypedDataCall'>
44
46
  ): SubmitNFTOrderFuncs => {
@@ -95,6 +97,7 @@ export const constructSubmitNFTOrder = (
95
97
  return { submitNFTOrder, submitP2POrder };
96
98
  };
97
99
 
100
+ /** @deprecated NFT Orders are deprecated and will be removed in a future version. */
98
101
  export type NFTOrderHandlers<T> = SubmitNFTOrderFuncs &
99
102
  BuildNFTOrderFunctions &
100
103
  SignNFTOrderFunctions &
@@ -105,7 +108,10 @@ export type NFTOrderHandlers<T> = SubmitNFTOrderFuncs &
105
108
  CancelNFTOrderFunctions<T> &
106
109
  ApproveTokenForNFTOrderFunctions<T>;
107
110
 
108
- /** @description construct SDK with every NFTOrders-related method, fetching from API and contract calls */
111
+ /**
112
+ * @description construct SDK with every NFTOrders-related method, fetching from API and contract calls
113
+ * @deprecated NFT Orders are deprecated and will be removed in a future version.
114
+ */
109
115
  export const constructAllNFTOrdersHandlers = <TxResponse>(
110
116
  options: ConstructProviderFetchInput<
111
117
  TxResponse,
@@ -13,11 +13,13 @@ type PostNFTOrder = (
13
13
  requestParams?: RequestParameters
14
14
  ) => Promise<NFTOrderFromAPI>;
15
15
 
16
+ /** @deprecated NFT Orders are deprecated and will be removed in a future version. */
16
17
  export type PostNFTOrderFunctions = {
17
18
  postNFTLimitOrder: PostNFTOrder;
18
19
  postNFTP2POrder: PostNFTOrder;
19
20
  };
20
21
 
22
+ /** @deprecated NFT Orders are deprecated and will be removed in a future version. */
21
23
  export const constructPostNFTOrder = ({
22
24
  apiURL = API_URL,
23
25
  chainId,
@@ -2,12 +2,14 @@ import type { ConstructProviderFetchInput } from '../../types';
2
2
  import type { SignableNFTOrderData } from './buildOrder';
3
3
  import { sanitizeOrderData } from './helpers/misc';
4
4
 
5
+ /** @deprecated NFT Orders are deprecated and will be removed in a future version. */
5
6
  export type SignNFTOrderFunctions = {
6
7
  signNFTOrder: (signableOrderData: SignableNFTOrderData) => Promise<string>;
7
8
  };
8
9
 
9
10
  // returns whatever `contractCaller` returns
10
11
  // to allow for better versatility
12
+ /** @deprecated NFT Orders are deprecated and will be removed in a future version. */
11
13
  export const constructSignNFTOrder = (
12
14
  options: Pick<
13
15
  ConstructProviderFetchInput<any, 'signTypedDataCall'>,
@@ -43,6 +43,7 @@ type BuildNFTOrdersTx = (
43
43
  requestParams?: RequestParameters
44
44
  ) => Promise<TransactionParams>;
45
45
 
46
+ /** @deprecated NFT Orders are deprecated and will be removed in a future version. */
46
47
  export type BuildNFTOrdersTxFunctions = {
47
48
  getNFTOrdersRate: GetNFTOrdersRate;
48
49
  buildNFTOrderTx: BuildNFTOrdersTx;
@@ -56,6 +57,7 @@ type GetNFTOrdersRate = (
56
57
  requestParams?: RequestParameters
57
58
  ) => Promise<OptimalRate>;
58
59
 
60
+ /** @deprecated NFT Orders are deprecated and will be removed in a future version. */
59
61
  export const constructBuildNFTOrderTx = ({
60
62
  apiURL = API_URL,
61
63
  version = DEFAULT_VERSION,
package/src/sdk/full.ts CHANGED
@@ -21,7 +21,9 @@ import { API_URL, DEFAULT_VERSION } from '../constants';
21
21
 
22
22
  export type AllSDKMethods<TxResponse> = {
23
23
  swap: SwapSDKMethods<TxResponse>;
24
+ /** @deprecated Limit Orders are deprecated and will be removed in a future version. */
24
25
  limitOrders: LimitOrderHandlers<TxResponse>;
26
+ /** @deprecated NFT Orders are deprecated and will be removed in a future version. */
25
27
  nftOrders: NFTOrderHandlers<TxResponse>;
26
28
  delta: DeltaOrderHandlers<TxResponse>;
27
29
  quote: GetQuoteFunctions;
@@ -13,7 +13,9 @@ import type { ApproveTokenForNFTOrderFunctions } from '../methods/nftOrders/appr
13
13
  import type { FillOrderDirectlyFunctions } from '../methods/limitOrders/fillOrderDirectly';
14
14
  import type { ApproveTokenForDeltaFunctions } from '../methods/delta/approveForDelta';
15
15
  import type { PreSignDeltaOrderFunctions } from '../methods/delta/preSignDeltaOrder';
16
+ import type { PreSignExternalDeltaOrderFunctions } from '../methods/delta/preSignExternalDeltaOrder';
16
17
  import type { DeltaTokenModuleFunctions } from '../methods/delta/deltaTokenModule';
18
+ import type { PreSignTWAPDeltaOrderFunctions } from '../methods/delta/preSignTWAPDeltaOrder';
17
19
  import { API_URL, DEFAULT_VERSION } from '../constants';
18
20
 
19
21
  export type SDKConfig<TxResponse = any> = ConstructProviderFetchInput<
@@ -54,7 +56,9 @@ type InferWithTxResponse<
54
56
  ApproveTokenForNFTOrderFunctions<TxResponse>,
55
57
  ApproveTokenForDeltaFunctions<TxResponse>,
56
58
  PreSignDeltaOrderFunctions<TxResponse>,
57
- DeltaTokenModuleFunctions<TxResponse>
59
+ PreSignExternalDeltaOrderFunctions<TxResponse>,
60
+ DeltaTokenModuleFunctions<TxResponse>,
61
+ PreSignTWAPDeltaOrderFunctions<TxResponse>
58
62
  ]
59
63
  // then merge IntersectionOfReturns<Funcs> with them recursively
60
64
  >
package/src/sdk/simple.ts CHANGED
@@ -145,12 +145,14 @@ export type SwapFetchMethods = GetBalancesFunctions &
145
145
  GetRateFunctions &
146
146
  GetSwapTxFunctions;
147
147
 
148
+ /** @deprecated Limit Orders are deprecated and will be removed in a future version. */
148
149
  export type LimitOrdersFetchMethods = GetLimitOrdersContractFunctions &
149
150
  GetLimitOrdersFunctions &
150
151
  BuildLimitOrderFunctions &
151
152
  PostLimitOrderFunctions &
152
153
  BuildLimitOrdersTxFunctions;
153
154
 
155
+ /** @deprecated NFT Orders are deprecated and will be removed in a future version. */
154
156
  export type NFTOrdersFetchMethods = GetNFTOrdersContractFunctions &
155
157
  GetNFTOrdersFunctions &
156
158
  BuildNFTOrderFunctions &
@@ -168,7 +170,9 @@ export type DeltaFetchMethods = BuildDeltaOrderFunctions &
168
170
 
169
171
  export type SimpleFetchSDK = {
170
172
  swap: SwapFetchMethods;
173
+ /** @deprecated Limit Orders are deprecated and will be removed in a future version. */
171
174
  limitOrders: LimitOrdersFetchMethods;
175
+ /** @deprecated NFT Orders are deprecated and will be removed in a future version. */
172
176
  nftOrders: NFTOrdersFetchMethods;
173
177
  delta: DeltaFetchMethods;
174
178
  quote: QuoteFetchMethods;
@@ -178,7 +182,9 @@ export type QuoteFetchMethods = GetQuoteFunctions;
178
182
 
179
183
  export type SimpleSDK = {
180
184
  swap: SwapSDKMethods<TxHash>;
185
+ /** @deprecated Limit Orders are deprecated and will be removed in a future version. */
181
186
  limitOrders: LimitOrderHandlers<TxHash>;
187
+ /** @deprecated NFT Orders are deprecated and will be removed in a future version. */
182
188
  nftOrders: NFTOrderHandlers<TxHash>;
183
189
  delta: DeltaOrderHandlers<TxHash>;
184
190
  quote: QuoteFetchMethods;