diff --git a/src/methods/limitOrders/approveForOrder.ts b/src/methods/limitOrders/approveForOrder.ts index f1da4ba6..95584b2d 100644 --- a/src/methods/limitOrders/approveForOrder.ts +++ b/src/methods/limitOrders/approveForOrder.ts @@ -3,6 +3,7 @@ import { ApproveToken, approveTokenMethodFactory } from '../../helpers/approve'; import { constructApproveToken } from '../swap/approve'; import { constructGetSpender } from '../swap/spender'; +/** @deprecated Limit Orders are deprecated and will be removed in a future version. */ export type ApproveTokenForLimitOrderFunctions = { /** @description approving AugustusRFQ as spender for makerAsset */ approveMakerTokenForLimitOrder: ApproveToken; @@ -14,6 +15,7 @@ export type ApproveTokenForLimitOrderFunctions = { // returns whatever `contractCaller` returns // to allow for better versatility +/** @deprecated Limit Orders are deprecated and will be removed in a future version. */ export const constructApproveTokenForLimitOrder = ( options: ConstructProviderFetchInput ): ApproveTokenForLimitOrderFunctions => { diff --git a/src/methods/limitOrders/buildOrder.ts b/src/methods/limitOrders/buildOrder.ts index 9469bc46..fe3eefb4 100644 --- a/src/methods/limitOrders/buildOrder.ts +++ b/src/methods/limitOrders/buildOrder.ts @@ -8,6 +8,7 @@ import { } from './helpers/buildOrderData'; export * from './helpers/buildOrderData'; +/** @deprecated Limit Orders are deprecated and will be removed in a future version. */ export type BuildLimitOrderInput = Omit< BuildOrderDataInput, 'chainId' | 'verifyingContract' | 'AugustusAddress' | 'AppVersion' @@ -18,11 +19,13 @@ type BuildLimitOrder = ( requestParams?: RequestParameters ) => Promise; +/** @deprecated Limit Orders are deprecated and will be removed in a future version. */ export type BuildLimitOrderFunctions = { /** @description Build Orders that will be excuted through AugustusSwapper */ buildLimitOrder: BuildLimitOrder; }; +/** @deprecated Limit Orders are deprecated and will be removed in a future version. */ export const constructBuildLimitOrder = ( options: ConstructFetchInput ): BuildLimitOrderFunctions => { diff --git a/src/methods/limitOrders/cancelOrder.ts b/src/methods/limitOrders/cancelOrder.ts index 8e7b02cb..65dbe3ee 100644 --- a/src/methods/limitOrders/cancelOrder.ts +++ b/src/methods/limitOrders/cancelOrder.ts @@ -18,6 +18,7 @@ export type CancelOrderBulk = ( requestParams?: RequestParameters ) => Promise; +/** @deprecated Limit Orders are deprecated and will be removed in a future version. */ export type CancelLimitOrderFunctions = { cancelLimitOrder: CancelOrder; cancelLimitOrderBulk: CancelOrderBulk; @@ -57,6 +58,7 @@ type AvailableMethods = ExtractAbiMethodNames; // returns whatever `contractCaller` returns // to allow for better versatility +/** @deprecated Limit Orders are deprecated and will be removed in a future version. */ export const constructCancelLimitOrder = ( options: ConstructProviderFetchInput ): CancelLimitOrderFunctions => { diff --git a/src/methods/limitOrders/fillOrderDirectly.ts b/src/methods/limitOrders/fillOrderDirectly.ts index 729409fc..177f30ad 100644 --- a/src/methods/limitOrders/fillOrderDirectly.ts +++ b/src/methods/limitOrders/fillOrderDirectly.ts @@ -12,6 +12,7 @@ import { encodeEIP_2612PermitFunctionInput, } from '../common/orders/encoding'; +/** @deprecated Limit Orders are deprecated and will be removed in a future version. */ export type FillOrderDirectlyFunctions = { fillOrderDirectly: FillOrderDirectly; }; @@ -204,6 +205,7 @@ type FillOrderMethods = ExtractAbiMethodNames; // returns whatever `contractCaller` returns // to allow for better versatility +/** @deprecated Limit Orders are deprecated and will be removed in a future version. */ export function constructFillOrderDirectly( options: ConstructProviderFetchInput ): FillOrderDirectlyFunctions { diff --git a/src/methods/limitOrders/getOrders.ts b/src/methods/limitOrders/getOrders.ts index d0896ced..b59db93c 100644 --- a/src/methods/limitOrders/getOrders.ts +++ b/src/methods/limitOrders/getOrders.ts @@ -52,6 +52,7 @@ type GetRequiredBalance = ( requestParams?: RequestParameters ) => Promise>; +/** @deprecated Limit Orders are deprecated and will be removed in a future version. */ export type GetLimitOrdersFunctions = { getLimitOrders: GetLimitOrders; getLimitOrderByHash: GetLimitOrderByHash; @@ -67,6 +68,7 @@ export type GetLimitOrdersFunctions = { getRequiredBalance: GetRequiredBalance; }; +/** @deprecated Limit Orders are deprecated and will be removed in a future version. */ export const constructGetLimitOrders = ({ apiURL = API_URL, chainId, diff --git a/src/methods/limitOrders/getOrdersContract.ts b/src/methods/limitOrders/getOrdersContract.ts index 310dd4d7..ae7c3201 100644 --- a/src/methods/limitOrders/getOrdersContract.ts +++ b/src/methods/limitOrders/getOrdersContract.ts @@ -1,11 +1,13 @@ import type { ConstructFetchInput } from '../../types'; import { constructGetSpender, GetSpender } from '../swap/spender'; +/** @deprecated Limit Orders are deprecated and will be removed in a future version. */ export type GetLimitOrdersContractFunctions = { getLimitOrdersContract: GetSpender; getTokenTransferProxy: GetSpender; }; +/** @deprecated Limit Orders are deprecated and will be removed in a future version. */ export const constructGetLimitOrdersContract = ( options: ConstructFetchInput ): GetLimitOrdersContractFunctions => { diff --git a/src/methods/limitOrders/index.ts b/src/methods/limitOrders/index.ts index 5c62cb3b..624860c4 100644 --- a/src/methods/limitOrders/index.ts +++ b/src/methods/limitOrders/index.ts @@ -45,11 +45,13 @@ type SubmitP2POrder = ( requestParams?: RequestParameters ) => Promise; +/** @deprecated Limit Orders are deprecated and will be removed in a future version. */ export type SubmitLimitOrderFuncs = { submitLimitOrder: SubmitLimitOrder; submitP2POrder: SubmitP2POrder; }; +/** @deprecated Limit Orders are deprecated and will be removed in a future version. */ export const constructSubmitLimitOrder = ( options: ConstructProviderFetchInput ): SubmitLimitOrderFuncs => { @@ -106,6 +108,7 @@ export const constructSubmitLimitOrder = ( return { submitLimitOrder, submitP2POrder }; }; +/** @deprecated Limit Orders are deprecated and will be removed in a future version. */ export type LimitOrderHandlers = SubmitLimitOrderFuncs & BuildLimitOrderFunctions & SignLimitOrderFunctions & @@ -117,7 +120,10 @@ export type LimitOrderHandlers = SubmitLimitOrderFuncs & ApproveTokenForLimitOrderFunctions & FillOrderDirectlyFunctions; -/** @description construct SDK with every LimitOrders-related method, fetching from API and contract calls */ +/** + * @description construct SDK with every LimitOrders-related method, fetching from API and contract calls + * @deprecated Limit Orders are deprecated and will be removed in a future version. + */ export const constructAllLimitOrdersHandlers = ( options: ConstructProviderFetchInput< TxResponse, diff --git a/src/methods/limitOrders/postOrder.ts b/src/methods/limitOrders/postOrder.ts index f52f4761..1ef8b973 100644 --- a/src/methods/limitOrders/postOrder.ts +++ b/src/methods/limitOrders/postOrder.ts @@ -13,11 +13,13 @@ type PostLimitOrder = ( requestParams?: RequestParameters ) => Promise; +/** @deprecated Limit Orders are deprecated and will be removed in a future version. */ export type PostLimitOrderFunctions = { postLimitOrder: PostLimitOrder; postP2POrder: PostLimitOrder; }; +/** @deprecated Limit Orders are deprecated and will be removed in a future version. */ export const constructPostLimitOrder = ({ apiURL = API_URL, chainId, diff --git a/src/methods/limitOrders/signOrder.ts b/src/methods/limitOrders/signOrder.ts index ff94ef95..c66e999b 100644 --- a/src/methods/limitOrders/signOrder.ts +++ b/src/methods/limitOrders/signOrder.ts @@ -2,12 +2,14 @@ import type { ConstructProviderFetchInput } from '../../types'; import type { SignableOrderData } from './buildOrder'; import { sanitizeOrderData } from './helpers/misc'; +/** @deprecated Limit Orders are deprecated and will be removed in a future version. */ export type SignLimitOrderFunctions = { signLimitOrder: (signableOrderData: SignableOrderData) => Promise; }; // returns whatever `contractCaller` returns // to allow for better versatility +/** @deprecated Limit Orders are deprecated and will be removed in a future version. */ export const constructSignLimitOrder = ( options: Pick< ConstructProviderFetchInput, diff --git a/src/methods/limitOrders/transaction.ts b/src/methods/limitOrders/transaction.ts index 5ca90bc9..99f9c759 100644 --- a/src/methods/limitOrders/transaction.ts +++ b/src/methods/limitOrders/transaction.ts @@ -44,6 +44,7 @@ type BuildLimitOrdersTx = ( requestParams?: RequestParameters ) => Promise; +/** @deprecated Limit Orders are deprecated and will be removed in a future version. */ export type BuildLimitOrdersTxFunctions = { getLimitOrdersRate: GetLimitOrdersRate; buildLimitOrderTx: BuildLimitOrdersTx; @@ -57,6 +58,7 @@ type GetLimitOrdersRate = ( requestParams?: RequestParameters ) => Promise; +/** @deprecated Limit Orders are deprecated and will be removed in a future version. */ export const constructBuildLimitOrderTx = ({ apiURL = API_URL, version = DEFAULT_VERSION, diff --git a/src/methods/nftOrders/approveForOrder.ts b/src/methods/nftOrders/approveForOrder.ts index ab7fc866..a1b75664 100644 --- a/src/methods/nftOrders/approveForOrder.ts +++ b/src/methods/nftOrders/approveForOrder.ts @@ -15,6 +15,7 @@ type ApproveNFT = ( requestParams?: RequestParameters ) => Promise; +/** @deprecated NFT Orders are deprecated and will be removed in a future version. */ export type ApproveTokenForNFTOrderFunctions = { /** @description approving AugustusSwapper as spender for takerAsset (ERC20) for Limit Orders that will be executed through it */ approveERC20ForNFTOrder: ApproveToken; @@ -47,6 +48,7 @@ type ApprovalMethods = ExtractAbiMethodNames; // returns whatever `contractCaller` returns // to allow for better versatility +/** @deprecated NFT Orders are deprecated and will be removed in a future version. */ export const constructApproveTokenForNFTOrder = ( options: ConstructProviderFetchInput ): ApproveTokenForNFTOrderFunctions => { diff --git a/src/methods/nftOrders/buildOrder.ts b/src/methods/nftOrders/buildOrder.ts index fa58fd2f..07127bbf 100644 --- a/src/methods/nftOrders/buildOrder.ts +++ b/src/methods/nftOrders/buildOrder.ts @@ -7,6 +7,7 @@ import { } from './helpers/buildOrderData'; export * from './helpers/buildOrderData'; +/** @deprecated NFT Orders are deprecated and will be removed in a future version. */ export type BuildNFTOrderInput = Omit< BuildNFTOrderDataInput, 'chainId' | 'verifyingContract' | 'AugustusAddress' @@ -17,11 +18,13 @@ type BuildNFTOrder = ( requestParams?: RequestParameters ) => Promise; +/** @deprecated NFT Orders are deprecated and will be removed in a future version. */ export type BuildNFTOrderFunctions = { /** @description Build Orders that will be excuted through AugustusSwapper */ buildNFTOrder: BuildNFTOrder; }; +/** @deprecated NFT Orders are deprecated and will be removed in a future version. */ export const constructBuildNFTOrder = ( options: ConstructFetchInput ): BuildNFTOrderFunctions => { diff --git a/src/methods/nftOrders/cancelOrder.ts b/src/methods/nftOrders/cancelOrder.ts index b67601c0..ef70de7f 100644 --- a/src/methods/nftOrders/cancelOrder.ts +++ b/src/methods/nftOrders/cancelOrder.ts @@ -5,12 +5,14 @@ import { constructCancelLimitOrder, } from '../limitOrders/cancelOrder'; +/** @deprecated NFT Orders are deprecated and will be removed in a future version. */ export type CancelNFTOrderFunctions = { cancelNFTOrder: CancelOrder; cancelNFTOrderBulk: CancelOrderBulk; }; // should work the same as for LimitOrders +/** @deprecated NFT Orders are deprecated and will be removed in a future version. */ export const constructCancelNFTOrder = ( options: ConstructProviderFetchInput ): CancelNFTOrderFunctions => { diff --git a/src/methods/nftOrders/getOrders.ts b/src/methods/nftOrders/getOrders.ts index 7fe2bcf6..f207821a 100644 --- a/src/methods/nftOrders/getOrders.ts +++ b/src/methods/nftOrders/getOrders.ts @@ -28,11 +28,13 @@ type GetNFTOrders = ( requestParams?: RequestParameters ) => Promise; +/** @deprecated NFT Orders are deprecated and will be removed in a future version. */ export type GetNFTOrdersFunctions = { getNFTOrders: GetNFTOrders; getNFTOrderByHash: GetNFTOrderByHash; }; +/** @deprecated NFT Orders are deprecated and will be removed in a future version. */ export const constructGetNFTOrders = ({ apiURL = API_URL, chainId, diff --git a/src/methods/nftOrders/getOrdersContract.ts b/src/methods/nftOrders/getOrdersContract.ts index a848f1e6..dab457f8 100644 --- a/src/methods/nftOrders/getOrdersContract.ts +++ b/src/methods/nftOrders/getOrdersContract.ts @@ -1,12 +1,14 @@ import type { ConstructFetchInput } from '../../types'; import { constructGetSpender, GetSpender } from '../swap/spender'; +/** @deprecated NFT Orders are deprecated and will be removed in a future version. */ export type GetNFTOrdersContractFunctions = { getNFTOrdersContract: GetSpender; getTokenTransferProxy: GetSpender; }; // should work the same as LimitOrders +/** @deprecated NFT Orders are deprecated and will be removed in a future version. */ export const constructGetNFTOrdersContract = ( options: ConstructFetchInput ): GetNFTOrdersContractFunctions => { diff --git a/src/methods/nftOrders/helpers/misc.ts b/src/methods/nftOrders/helpers/misc.ts index 1b5b8690..8a74e06c 100644 --- a/src/methods/nftOrders/helpers/misc.ts +++ b/src/methods/nftOrders/helpers/misc.ts @@ -18,6 +18,7 @@ import { // ERC721 = 2, // } +/** @deprecated NFT Orders are deprecated and will be removed in a future version. */ export const AssetType = { ERC20: 0, ERC1155: 1, diff --git a/src/methods/nftOrders/index.ts b/src/methods/nftOrders/index.ts index e3666d83..796e3d04 100644 --- a/src/methods/nftOrders/index.ts +++ b/src/methods/nftOrders/index.ts @@ -34,11 +34,13 @@ type SubmitNFTOrder = ( requestParams?: RequestParameters ) => Promise; +/** @deprecated NFT Orders are deprecated and will be removed in a future version. */ export type SubmitNFTOrderFuncs = { submitNFTOrder: SubmitNFTOrder; submitP2POrder: SubmitNFTOrder; }; +/** @deprecated NFT Orders are deprecated and will be removed in a future version. */ export const constructSubmitNFTOrder = ( options: ConstructProviderFetchInput ): SubmitNFTOrderFuncs => { @@ -95,6 +97,7 @@ export const constructSubmitNFTOrder = ( return { submitNFTOrder, submitP2POrder }; }; +/** @deprecated NFT Orders are deprecated and will be removed in a future version. */ export type NFTOrderHandlers = SubmitNFTOrderFuncs & BuildNFTOrderFunctions & SignNFTOrderFunctions & @@ -105,7 +108,10 @@ export type NFTOrderHandlers = SubmitNFTOrderFuncs & CancelNFTOrderFunctions & ApproveTokenForNFTOrderFunctions; -/** @description construct SDK with every NFTOrders-related method, fetching from API and contract calls */ +/** + * @description construct SDK with every NFTOrders-related method, fetching from API and contract calls + * @deprecated NFT Orders are deprecated and will be removed in a future version. + */ export const constructAllNFTOrdersHandlers = ( options: ConstructProviderFetchInput< TxResponse, diff --git a/src/methods/nftOrders/postOrder.ts b/src/methods/nftOrders/postOrder.ts index a4deb5db..8f2c899b 100644 --- a/src/methods/nftOrders/postOrder.ts +++ b/src/methods/nftOrders/postOrder.ts @@ -13,11 +13,13 @@ type PostNFTOrder = ( requestParams?: RequestParameters ) => Promise; +/** @deprecated NFT Orders are deprecated and will be removed in a future version. */ export type PostNFTOrderFunctions = { postNFTLimitOrder: PostNFTOrder; postNFTP2POrder: PostNFTOrder; }; +/** @deprecated NFT Orders are deprecated and will be removed in a future version. */ export const constructPostNFTOrder = ({ apiURL = API_URL, chainId, diff --git a/src/methods/nftOrders/signOrder.ts b/src/methods/nftOrders/signOrder.ts index 364207b9..714c628a 100644 --- a/src/methods/nftOrders/signOrder.ts +++ b/src/methods/nftOrders/signOrder.ts @@ -2,12 +2,14 @@ import type { ConstructProviderFetchInput } from '../../types'; import type { SignableNFTOrderData } from './buildOrder'; import { sanitizeOrderData } from './helpers/misc'; +/** @deprecated NFT Orders are deprecated and will be removed in a future version. */ export type SignNFTOrderFunctions = { signNFTOrder: (signableOrderData: SignableNFTOrderData) => Promise; }; // returns whatever `contractCaller` returns // to allow for better versatility +/** @deprecated NFT Orders are deprecated and will be removed in a future version. */ export const constructSignNFTOrder = ( options: Pick< ConstructProviderFetchInput, diff --git a/src/methods/nftOrders/transaction.ts b/src/methods/nftOrders/transaction.ts index 3088c3c9..4cb8c43a 100644 --- a/src/methods/nftOrders/transaction.ts +++ b/src/methods/nftOrders/transaction.ts @@ -43,6 +43,7 @@ type BuildNFTOrdersTx = ( requestParams?: RequestParameters ) => Promise; +/** @deprecated NFT Orders are deprecated and will be removed in a future version. */ export type BuildNFTOrdersTxFunctions = { getNFTOrdersRate: GetNFTOrdersRate; buildNFTOrderTx: BuildNFTOrdersTx; @@ -56,6 +57,7 @@ type GetNFTOrdersRate = ( requestParams?: RequestParameters ) => Promise; +/** @deprecated NFT Orders are deprecated and will be removed in a future version. */ export const constructBuildNFTOrderTx = ({ apiURL = API_URL, version = DEFAULT_VERSION, diff --git a/src/sdk/full.ts b/src/sdk/full.ts index 4f5b8666..e6d2dde5 100644 --- a/src/sdk/full.ts +++ b/src/sdk/full.ts @@ -21,7 +21,9 @@ import { API_URL, DEFAULT_VERSION } from '../constants'; export type AllSDKMethods = { swap: SwapSDKMethods; + /** @deprecated Limit Orders are deprecated and will be removed in a future version. */ limitOrders: LimitOrderHandlers; + /** @deprecated NFT Orders are deprecated and will be removed in a future version. */ nftOrders: NFTOrderHandlers; delta: DeltaOrderHandlers; quote: GetQuoteFunctions; diff --git a/src/sdk/simple.ts b/src/sdk/simple.ts index 9fe76ac8..8d16a186 100644 --- a/src/sdk/simple.ts +++ b/src/sdk/simple.ts @@ -145,12 +145,14 @@ export type SwapFetchMethods = GetBalancesFunctions & GetRateFunctions & GetSwapTxFunctions; +/** @deprecated Limit Orders are deprecated and will be removed in a future version. */ export type LimitOrdersFetchMethods = GetLimitOrdersContractFunctions & GetLimitOrdersFunctions & BuildLimitOrderFunctions & PostLimitOrderFunctions & BuildLimitOrdersTxFunctions; +/** @deprecated NFT Orders are deprecated and will be removed in a future version. */ export type NFTOrdersFetchMethods = GetNFTOrdersContractFunctions & GetNFTOrdersFunctions & BuildNFTOrderFunctions & @@ -168,7 +170,9 @@ export type DeltaFetchMethods = BuildDeltaOrderFunctions & export type SimpleFetchSDK = { swap: SwapFetchMethods; + /** @deprecated Limit Orders are deprecated and will be removed in a future version. */ limitOrders: LimitOrdersFetchMethods; + /** @deprecated NFT Orders are deprecated and will be removed in a future version. */ nftOrders: NFTOrdersFetchMethods; delta: DeltaFetchMethods; quote: QuoteFetchMethods; @@ -178,7 +182,9 @@ export type QuoteFetchMethods = GetQuoteFunctions; export type SimpleSDK = { swap: SwapSDKMethods; + /** @deprecated Limit Orders are deprecated and will be removed in a future version. */ limitOrders: LimitOrderHandlers; + /** @deprecated NFT Orders are deprecated and will be removed in a future version. */ nftOrders: NFTOrderHandlers; delta: DeltaOrderHandlers; quote: QuoteFetchMethods;