Skip to content

Commit 06b3464

Browse files
phil-ociraptorphil-ociraptor
authored
Rename {Rfqt=>Rfq} for types in Asset Swapper (0xProject#179)
* Rename {Rfqt=>Rfq} for types in Asset Swapper * PR edit 1 - fix build errors * PR edit 2 - rename mocked types used in tests * PR edit 3 - fix broken test build * PR edit 4 - rename SwapQuoterRfqOpts and add changelog entry
1 parent bbaa90b commit 06b3464

File tree

12 files changed

+81
-77
lines changed

12 files changed

+81
-77
lines changed

‎packages/asset-swapper/CHANGELOG.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@
99
{
1010
"note": "Add a cancel token to ensure timeouts are respected",
1111
"pr": 176
12+
},
13+
{
14+
"note": "Rename {Rfqt=>Rfq} for many types in Asset Swapper",
15+
"pr": 179
1216
}
1317
]
1418
},

‎packages/asset-swapper/src/constants.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import {
88
LogFunction,
99
OrderPrunerOpts,
1010
OrderPrunerPermittedFeeTypes,
11-
RfqtRequestOpts,
11+
RfqRequestOpts,
1212
SwapQuoteGetOutputOpts,
1313
SwapQuoteRequestOpts,
1414
SwapQuoterOpts,
@@ -79,7 +79,7 @@ const DEFAULT_SWAP_QUOTE_REQUEST_OPTS: SwapQuoteRequestOpts = {
7979
...DEFAULT_GET_MARKET_ORDERS_OPTS,
8080
};
8181

82-
const DEFAULT_RFQT_REQUEST_OPTS: Partial<RfqtRequestOpts> = {
82+
const DEFAULT_RFQT_REQUEST_OPTS: Partial<RfqRequestOpts> = {
8383
makerEndpointMaxResponseTimeMs: 1000,
8484
};
8585

‎packages/asset-swapper/src/index.ts

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ export { SwapQuoteConsumer } from './quote_consumers/swap_quote_consumer';
7575
export { SwapQuoter, Orderbook } from './swap_quoter';
7676
export {
7777
AltOffering,
78-
AltRfqtMakerAssetOfferings,
78+
AltRfqMakerAssetOfferings,
7979
AffiliateFeeType,
8080
AffiliateFeeAmount,
8181
AssetSwapperContractAddresses,
@@ -87,11 +87,11 @@ export {
8787
MarketBuySwapQuote,
8888
MarketOperation,
8989
MarketSellSwapQuote,
90-
MockedRfqtQuoteResponse,
90+
MockedRfqQuoteResponse,
9191
OrderPrunerPermittedFeeTypes,
92-
RfqtMakerAssetOfferings,
93-
RfqtFirmQuoteValidator,
94-
RfqtRequestOpts,
92+
RfqMakerAssetOfferings,
93+
RfqFirmQuoteValidator,
94+
RfqRequestOpts,
9595
SamplerOverrides,
9696
SignedNativeOrder,
9797
SignedOrder,
@@ -106,7 +106,7 @@ export {
106106
SwapQuoteRequestOpts,
107107
SwapQuoterError,
108108
SwapQuoterOpts,
109-
SwapQuoterRfqtOpts,
109+
SwapQuoterRfqOpts,
110110
} from './types';
111111
export { affiliateFeeUtils } from './utils/affiliate_fee_utils';
112112
export {
@@ -133,7 +133,7 @@ export {
133133
FeeSchedule,
134134
Fill,
135135
FillData,
136-
GetMarketOrdersRfqtOpts,
136+
GetMarketOrdersRfqOpts,
137137
KyberFillData,
138138
LiquidityProviderFillData,
139139
LiquidityProviderRegistry,

‎packages/asset-swapper/src/swap_quoter.ts

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@ import {
1414
MarketBuySwapQuote,
1515
MarketOperation,
1616
OrderPrunerPermittedFeeTypes,
17-
RfqtRequestOpts,
17+
RfqRequestOpts,
1818
SignedNativeOrder,
1919
SwapQuote,
2020
SwapQuoteInfo,
2121
SwapQuoteOrdersBreakdown,
2222
SwapQuoteRequestOpts,
2323
SwapQuoterOpts,
24-
SwapQuoterRfqtOpts,
24+
SwapQuoterRfqOpts,
2525
} from './types';
2626
import { assert } from './utils/assert';
2727
import { MarketOperationUtils } from './utils/market_operation_utils';
@@ -72,7 +72,7 @@ export class SwapQuoter {
7272
private readonly _contractAddresses: AssetSwapperContractAddresses;
7373
private readonly _protocolFeeUtils: ProtocolFeeUtils;
7474
private readonly _marketOperationUtils: MarketOperationUtils;
75-
private readonly _rfqtOptions?: SwapQuoterRfqtOpts;
75+
private readonly _rfqtOptions?: SwapQuoterRfqOpts;
7676
private readonly _quoteRequestorHttpClient: AxiosInstance;
7777

7878
/**
@@ -334,7 +334,7 @@ export class SwapQuoter {
334334
// Get SRA orders (limit orders)
335335
const shouldSkipOpenOrderbook =
336336
!sourceFilters.isAllowed(ERC20BridgeSource.Native) ||
337-
(opts.rfqt && opts.rfqt.nativeExclusivelyRFQT === true);
337+
(opts.rfqt && opts.rfqt.nativeExclusivelyRFQ === true);
338338
const nativeOrders = shouldSkipOpenOrderbook
339339
? await Promise.resolve([])
340340
: await this.orderbook.getOrdersAsync(makerToken, takerToken, this._limitOrderPruningFn);
@@ -420,17 +420,17 @@ export class SwapQuoter {
420420

421421
private _validateRfqtOpts(
422422
sourceFilters: SourceFilters,
423-
rfqt: RfqtRequestOpts | undefined,
424-
): RfqtRequestOpts | undefined {
423+
rfqt: RfqRequestOpts | undefined,
424+
): RfqRequestOpts | undefined {
425425
if (!rfqt) {
426426
return rfqt;
427427
}
428428
// tslint:disable-next-line: boolean-naming
429-
const { apiKey, nativeExclusivelyRFQT, intentOnFilling, txOrigin } = rfqt;
430-
// If RFQT is enabled and `nativeExclusivelyRFQT` is set, then `ERC20BridgeSource.Native` should
429+
const { apiKey, nativeExclusivelyRFQ, intentOnFilling, txOrigin } = rfqt;
430+
// If RFQ-T is enabled and `nativeExclusivelyRFQ` is set, then `ERC20BridgeSource.Native` should
431431
// never be excluded.
432-
if (nativeExclusivelyRFQT === true && !sourceFilters.isAllowed(ERC20BridgeSource.Native)) {
433-
throw new Error('Native liquidity cannot be excluded if "rfqt.nativeExclusivelyRFQT" is set');
432+
if (nativeExclusivelyRFQ === true && !sourceFilters.isAllowed(ERC20BridgeSource.Native)) {
433+
throw new Error('Native liquidity cannot be excluded if "rfqt.nativeExclusivelyRFQ" is set');
434434
}
435435

436436
// If an API key was provided, but the key is not whitelisted, raise a warning and disable RFQ

‎packages/asset-swapper/src/types.ts

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -227,34 +227,34 @@ export type SwapQuoteOrdersBreakdown = Partial<
227227
>;
228228

229229
/**
230-
* nativeExclusivelyRFQT: if set to `true`, Swap quote will exclude Open Orderbook liquidity.
231-
* If set to `true` and `ERC20BridgeSource.Native` is part of the `excludedSources`
232-
* array in `SwapQuoteRequestOpts`, an Error will be raised.
230+
* nativeExclusivelyRFQ: if set to `true`, Swap quote will exclude Open Orderbook liquidity.
231+
* If set to `true` and `ERC20BridgeSource.Native` is part of the `excludedSources`
232+
* array in `SwapQuoteRequestOpts`, an Error will be raised.
233233
*/
234-
export interface RfqtRequestOpts {
234+
export interface RfqRequestOpts {
235235
takerAddress: string;
236236
txOrigin: string;
237237
apiKey: string;
238238
intentOnFilling: boolean;
239239
isIndicative?: boolean;
240240
makerEndpointMaxResponseTimeMs?: number;
241-
nativeExclusivelyRFQT?: boolean;
242-
altRfqtAssetOfferings?: AltRfqtMakerAssetOfferings;
241+
nativeExclusivelyRFQ?: boolean;
242+
altRfqAssetOfferings?: AltRfqMakerAssetOfferings;
243243
}
244244

245245
/**
246246
* gasPrice: gas price to determine protocolFee amount, default to ethGasStation fast amount
247247
*/
248248
export interface SwapQuoteRequestOpts extends GetMarketOrdersOpts {
249249
gasPrice?: BigNumber;
250-
rfqt?: RfqtRequestOpts;
250+
rfqt?: RfqRequestOpts;
251251
}
252252

253253
/**
254-
* A mapping from RFQ-T quote provider URLs to the trading pairs they support.
254+
* A mapping from RFQ-T/M quote provider URLs to the trading pairs they support.
255255
* The value type represents an array of supported asset pairs, with each array element encoded as a 2-element array of token addresses.
256256
*/
257-
export interface RfqtMakerAssetOfferings {
257+
export interface RfqMakerAssetOfferings {
258258
[endpoint: string]: Array<[string, string]>;
259259
}
260260

@@ -265,7 +265,7 @@ export interface AltOffering {
265265
baseAssetDecimals: number;
266266
quoteAssetDecimals: number;
267267
}
268-
export interface AltRfqtMakerAssetOfferings {
268+
export interface AltRfqMakerAssetOfferings {
269269
[endpoint: string]: AltOffering[];
270270
}
271271
export enum RfqPairType {
@@ -279,13 +279,13 @@ export interface TypedMakerUrl {
279279

280280
export type LogFunction = (obj: object, msg?: string, ...args: any[]) => void;
281281

282-
export interface RfqtFirmQuoteValidator {
282+
export interface RfqFirmQuoteValidator {
283283
getRfqtTakerFillableAmountsAsync(quotes: RfqOrder[]): Promise<BigNumber[]>;
284284
}
285285

286-
export interface SwapQuoterRfqtOpts {
286+
export interface SwapQuoterRfqOpts {
287287
takerApiKeyWhitelist: string[];
288-
makerAssetOfferings: RfqtMakerAssetOfferings;
288+
makerAssetOfferings: RfqMakerAssetOfferings;
289289
txOriginBlacklist: Set<string>;
290290
altRfqCreds?: {
291291
altRfqApiKey: string;
@@ -314,7 +314,7 @@ export interface SwapQuoterOpts extends OrderPrunerOpts {
314314
samplerGasLimit?: number;
315315
multiBridgeAddress?: string;
316316
ethGasStationUrl?: string;
317-
rfqt?: SwapQuoterRfqtOpts;
317+
rfqt?: SwapQuoterRfqOpts;
318318
samplerOverrides?: SamplerOverrides;
319319
tokenAdjacencyGraph?: TokenAdjacencyGraph;
320320
liquidityProviderRegistry?: LiquidityProviderRegistry;
@@ -360,9 +360,9 @@ export enum OrderPrunerPermittedFeeTypes {
360360
}
361361

362362
/**
363-
* Represents a mocked RFQT maker responses.
363+
* Represents a mocked RFQ-T/M maker responses.
364364
*/
365-
export interface MockedRfqtQuoteResponse {
365+
export interface MockedRfqQuoteResponse {
366366
endpoint: string;
367367
requestApiKey: string;
368368
requestParams: TakerRequestQueryParams;
@@ -372,9 +372,9 @@ export interface MockedRfqtQuoteResponse {
372372
}
373373

374374
/**
375-
* Represents a mocked RFQT maker responses.
375+
* Represents a mocked RFQ-T/M alternative maker responses.
376376
*/
377-
export interface AltMockedRfqtQuoteResponse {
377+
export interface AltMockedRfqQuoteResponse {
378378
endpoint: string;
379379
mmApiKey: string;
380380
requestData: AltQuoteRequestData;

‎packages/asset-swapper/src/utils/alt_mm_implementation_utils.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import {
1111
AltQuoteModel,
1212
AltQuoteRequestData,
1313
AltQuoteSide,
14-
AltRfqtMakerAssetOfferings,
14+
AltRfqMakerAssetOfferings,
1515
} from '../types';
1616

1717
function getAltMarketInfo(
@@ -119,13 +119,13 @@ export async function returnQuoteFromAltMMAsync<ResponseT>(
119119
makerToken: string,
120120
takerToken: string,
121121
maxResponseTimeMs: number,
122-
altRfqtAssetOfferings: AltRfqtMakerAssetOfferings,
122+
altRfqAssetOfferings: AltRfqMakerAssetOfferings,
123123
takerRequestQueryParams: TakerRequestQueryParams,
124124
axiosInstance: AxiosInstance,
125125
cancelToken: CancelToken,
126126
): Promise<{ data: ResponseT; status: number }> {
127127
const altPair = getAltMarketInfo(
128-
altRfqtAssetOfferings[url],
128+
altRfqAssetOfferings[url],
129129
takerRequestQueryParams.buyTokenAddress,
130130
takerRequestQueryParams.sellTokenAddress,
131131
);

‎packages/asset-swapper/src/utils/market_operation_utils/types.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import { V4RFQIndicativeQuote } from '@0x/quote-server';
77
import { MarketOperation } from '@0x/types';
88
import { BigNumber } from '@0x/utils';
99

10-
import { NativeOrderWithFillableAmounts, RfqtFirmQuoteValidator, RfqtRequestOpts } from '../../types';
10+
import { NativeOrderWithFillableAmounts, RfqFirmQuoteValidator, RfqRequestOpts } from '../../types';
1111
import { QuoteRequestor } from '../../utils/quote_requestor';
1212
import { QuoteReport } from '../quote_report_generator';
1313

@@ -267,9 +267,9 @@ export type OptimizedMarketOrder =
267267
| OptimizedMarketOrderBase<NativeLimitOrderFillData>
268268
| OptimizedMarketOrderBase<NativeRfqOrderFillData>;
269269

270-
export interface GetMarketOrdersRfqtOpts extends RfqtRequestOpts {
270+
export interface GetMarketOrdersRfqOpts extends RfqRequestOpts {
271271
quoteRequestor?: QuoteRequestor;
272-
firmQuoteValidator?: RfqtFirmQuoteValidator;
272+
firmQuoteValidator?: RfqFirmQuoteValidator;
273273
}
274274

275275
export type FeeEstimate = (fillData: FillData) => number | BigNumber;
@@ -343,7 +343,7 @@ export interface GetMarketOrdersOpts {
343343
/**
344344
* Options for RFQT such as takerAddress, intent on filling
345345
*/
346-
rfqt?: GetMarketOrdersRfqtOpts;
346+
rfqt?: GetMarketOrdersRfqOpts;
347347
/**
348348
* Whether to generate a quote report
349349
*/

‎packages/asset-swapper/src/utils/quote_requestor.ts

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ import axios, { AxiosInstance } from 'axios';
77
import { constants } from '../constants';
88
import {
99
AltQuoteModel,
10-
AltRfqtMakerAssetOfferings,
10+
AltRfqMakerAssetOfferings,
1111
LogFunction,
1212
MarketOperation,
1313
RfqPairType,
14-
RfqtMakerAssetOfferings,
15-
RfqtRequestOpts,
14+
RfqMakerAssetOfferings,
15+
RfqRequestOpts,
1616
SignedNativeOrder,
1717
TypedMakerUrl,
1818
} from '../types';
@@ -125,7 +125,7 @@ export class QuoteRequestor {
125125
}
126126

127127
constructor(
128-
private readonly _rfqtAssetOfferings: RfqtMakerAssetOfferings,
128+
private readonly _rfqtAssetOfferings: RfqMakerAssetOfferings,
129129
private readonly _quoteRequestorHttpClient: AxiosInstance,
130130
private readonly _altRfqCreds?: { altRfqApiKey: string; altRfqProfile: string },
131131
private readonly _warningLogger: LogFunction = constants.DEFAULT_WARNING_LOGGER,
@@ -141,9 +141,9 @@ export class QuoteRequestor {
141141
assetFillAmount: BigNumber,
142142
marketOperation: MarketOperation,
143143
comparisonPrice: BigNumber | undefined,
144-
options: RfqtRequestOpts,
144+
options: RfqRequestOpts,
145145
): Promise<SignedNativeOrder[]> {
146-
const _opts: RfqtRequestOpts = { ...constants.DEFAULT_RFQT_REQUEST_OPTS, ...options };
146+
const _opts: RfqRequestOpts = { ...constants.DEFAULT_RFQT_REQUEST_OPTS, ...options };
147147
if (!_opts.txOrigin || [undefined, '', '0x', NULL_ADDRESS].includes(_opts.txOrigin)) {
148148
throw new Error('RFQ-T firm quotes require the presence of a tx origin');
149149
}
@@ -222,9 +222,9 @@ export class QuoteRequestor {
222222
assetFillAmount: BigNumber,
223223
marketOperation: MarketOperation,
224224
comparisonPrice: BigNumber | undefined,
225-
options: RfqtRequestOpts,
225+
options: RfqRequestOpts,
226226
): Promise<V4RFQIndicativeQuote[]> {
227-
const _opts: RfqtRequestOpts = { ...constants.DEFAULT_RFQT_REQUEST_OPTS, ...options };
227+
const _opts: RfqRequestOpts = { ...constants.DEFAULT_RFQT_REQUEST_OPTS, ...options };
228228
// Originally a takerAddress was required for indicative quotes, but
229229
// now we've eliminated that requirement. @0x/quote-server, however,
230230
// is still coded to expect a takerAddress. So if the client didn't
@@ -317,7 +317,7 @@ export class QuoteRequestor {
317317
typedMakerUrl: TypedMakerUrl,
318318
makerToken: string,
319319
takerToken: string,
320-
altMakerAssetOfferings: AltRfqtMakerAssetOfferings | undefined,
320+
altMakerAssetOfferings: AltRfqMakerAssetOfferings | undefined,
321321
): boolean {
322322
if (typedMakerUrl.pairType === RfqPairType.Standard) {
323323
for (const assetPair of this._rfqtAssetOfferings[typedMakerUrl.url]) {
@@ -353,7 +353,7 @@ export class QuoteRequestor {
353353
assetFillAmount: BigNumber,
354354
marketOperation: MarketOperation,
355355
comparisonPrice: BigNumber | undefined,
356-
options: RfqtRequestOpts,
356+
options: RfqRequestOpts,
357357
quoteType: 'firm' | 'indicative',
358358
): Promise<Array<RfqQuote<ResponseT>>> {
359359
const requestParams = QuoteRequestor.makeQueryParameters(
@@ -382,8 +382,8 @@ export class QuoteRequestor {
382382
return { pairType: RfqPairType.Standard, url: mm };
383383
},
384384
);
385-
const altUrls = options.altRfqtAssetOfferings
386-
? Object.keys(options.altRfqtAssetOfferings).map(
385+
const altUrls = options.altRfqAssetOfferings
386+
? Object.keys(options.altRfqAssetOfferings).map(
387387
(mm: string): TypedMakerUrl => {
388388
return { pairType: RfqPairType.Alt, url: mm };
389389
},
@@ -410,7 +410,7 @@ export class QuoteRequestor {
410410
if (isBlacklisted) {
411411
this._infoLogger({ rfqtMakerInteraction: { ...partialLogEntry } });
412412
return;
413-
} else if (!this._makerSupportsPair(typedMakerUrl, makerToken, takerToken, options.altRfqtAssetOfferings)) {
413+
} else if (!this._makerSupportsPair(typedMakerUrl, makerToken, takerToken, options.altRfqAssetOfferings)) {
414414
return;
415415
} else {
416416
// make request to MM
@@ -452,7 +452,7 @@ export class QuoteRequestor {
452452
makerToken,
453453
takerToken,
454454
timeoutMs,
455-
options.altRfqtAssetOfferings || {},
455+
options.altRfqAssetOfferings || {},
456456
requestParams,
457457
this._quoteRequestorHttpClient,
458458
cancelTokenSource.token,

0 commit comments

Comments
 (0)