@morpho-org/midnight-sdk 1.8.0 → 2.1.0-next.0
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/MIGRATION-v1-to-v2.md +6 -0
- package/README.md +17 -15
- package/lib/cjs/abis.d.ts +1870 -1461
- package/lib/cjs/abis.js +2151 -1626
- package/lib/cjs/api/MidnightApi.d.ts +10 -8
- package/lib/cjs/api/MidnightApi.js +13 -11
- package/lib/cjs/api/helpers.d.ts +2 -18
- package/lib/cjs/api/helpers.js +4 -5
- package/lib/cjs/api/types.d.ts +6 -5
- package/lib/cjs/api/version.generated.d.ts +1 -1
- package/lib/cjs/api/version.generated.js +2 -2
- package/lib/cjs/bundlesV2.d.ts +15 -0
- package/lib/cjs/bundlesV2.js +2 -0
- package/lib/cjs/errors.d.ts +13 -27
- package/lib/cjs/errors.js +8 -39
- package/lib/cjs/fetch/Ratifier.js +1 -0
- package/lib/cjs/index.d.ts +1 -0
- package/lib/cjs/position/PositionUtils.js +11 -35
- package/lib/esm/abis.d.ts +1870 -1461
- package/lib/esm/abis.js +2150 -1625
- package/lib/esm/api/MidnightApi.d.ts +10 -8
- package/lib/esm/api/MidnightApi.js +13 -11
- package/lib/esm/api/helpers.d.ts +2 -18
- package/lib/esm/api/helpers.js +8 -5
- package/lib/esm/api/types.d.ts +6 -5
- package/lib/esm/api/version.generated.d.ts +1 -1
- package/lib/esm/api/version.generated.js +2 -2
- package/lib/esm/bundlesV2.d.ts +15 -0
- package/lib/esm/bundlesV2.js +1 -0
- package/lib/esm/errors.d.ts +13 -27
- package/lib/esm/errors.js +8 -36
- package/lib/esm/fetch/Ratifier.js +1 -0
- package/lib/esm/index.d.ts +1 -0
- package/lib/esm/position/PositionUtils.js +12 -36
- package/package.json +8 -7
|
@@ -142,7 +142,7 @@ export declare class MidnightApi {
|
|
|
142
142
|
* @param params.request - Optional fetch options forwarded to this request.
|
|
143
143
|
* @returns ABI-ready take objects mapped from the API response.
|
|
144
144
|
* @throws {MidnightApiError} when the API returns a non-2xx response.
|
|
145
|
-
* @throws {InvalidMidnightApiResponseError} when the API success response is not JSON, when a returned offer cannot be mapped (malformed numeric or hex fields), when its `market_id` does not match, or cannot be derived from, its embedded market, when it falls outside the requested filters, when its `receiverIfMakerIsSeller` is not a well-formed address,
|
|
145
|
+
* @throws {InvalidMidnightApiResponseError} when the API success response is not JSON, when a returned offer cannot be mapped (malformed numeric or hex fields), when its `market_id` does not match, or cannot be derived from, its embedded market, when it falls outside the requested filters, when its `receiverIfMakerIsSeller` is not a well-formed address, when its caps or buy-side receiver are not executable, or when its units exceed its offer `maxUnits`.
|
|
146
146
|
* @example
|
|
147
147
|
* ```ts
|
|
148
148
|
* import { MidnightApi } from "@morpho-org/midnight-sdk/api";
|
|
@@ -170,11 +170,12 @@ export declare class MidnightApi {
|
|
|
170
170
|
* @param params.baseUrl - Optional Midnight API base URL override.
|
|
171
171
|
* @param params.fetch - Optional fetch implementation override.
|
|
172
172
|
* @param params.request - Optional fetch options forwarded to this request.
|
|
173
|
-
* @returns Quote and
|
|
173
|
+
* @returns Quote and ABI-ready take caps. `averageWorstPrice` equals the caller's guard when provided,
|
|
174
|
+
* otherwise the API's guard.
|
|
174
175
|
* @throws {InvalidMidnightApiQuoteTargetError} when the runtime input does not set exactly one of `units` or `assets`.
|
|
175
176
|
* @throws {NegativeValueError} when `settlementFee` is negative.
|
|
176
177
|
* @throws {MidnightApiError} when the API returns a non-2xx response.
|
|
177
|
-
* @throws {InvalidMidnightApiResponseError} when the API success response is not JSON, when a returned offer cannot be mapped (malformed numeric or hex fields), when its `market_id` does not match, or cannot be derived from, its embedded market, when it falls outside the requested filters, when its `receiverIfMakerIsSeller` is not a well-formed address, when its caps or buy-side receiver are not executable, or when the returned offers imply a rounded aggregate settlement price outside the effective average-worst-price guard.
|
|
178
|
+
* @throws {InvalidMidnightApiResponseError} when the API success response is not JSON, when a returned offer cannot be mapped (malformed numeric or hex fields), when its `market_id` does not match, or cannot be derived from, its embedded market, when it falls outside the requested filters, when its `receiverIfMakerIsSeller` is not a well-formed address, when its caps or buy-side receiver are not executable, when its units exceed its offer `maxUnits`, or when the returned offers imply a rounded aggregate settlement price outside the effective average-worst-price guard.
|
|
178
179
|
* @throws {SettlementFeeExceedsPriceError} when a bid's settlement fee exceeds its offer price.
|
|
179
180
|
* @example
|
|
180
181
|
* ```ts
|
|
@@ -205,7 +206,7 @@ export declare class MidnightApi {
|
|
|
205
206
|
* @param params.request - Optional fetch options forwarded to this request.
|
|
206
207
|
* @returns Paginated ABI-ready take objects mapped from the API response.
|
|
207
208
|
* @throws {MidnightApiError} when the API returns a non-2xx response.
|
|
208
|
-
* @throws {InvalidMidnightApiResponseError} when the API success response is not JSON, when a returned offer cannot be mapped (malformed numeric or hex fields), when its `market_id` does not match, or cannot be derived from, its embedded market, when it falls outside the requested filters, when its `receiverIfMakerIsSeller` is not a well-formed address,
|
|
209
|
+
* @throws {InvalidMidnightApiResponseError} when the API success response is not JSON, when a returned offer cannot be mapped (malformed numeric or hex fields), when its `market_id` does not match, or cannot be derived from, its embedded market, when it falls outside the requested filters, when its `receiverIfMakerIsSeller` is not a well-formed address, when its caps or buy-side receiver are not executable, or when its units exceed its offer `maxUnits`.
|
|
209
210
|
* @example
|
|
210
211
|
* ```ts
|
|
211
212
|
* import { MidnightApi } from "@morpho-org/midnight-sdk/api";
|
|
@@ -390,7 +391,7 @@ export declare class MidnightApi {
|
|
|
390
391
|
* @param params.side - Book side to query.
|
|
391
392
|
* @returns ABI-ready take objects mapped from the API response.
|
|
392
393
|
* @throws {MidnightApiError} when the API returns a non-2xx response.
|
|
393
|
-
* @throws {InvalidMidnightApiResponseError} when the API success response is not JSON, when a returned offer cannot be mapped (malformed numeric or hex fields), when its `market_id` does not match, or cannot be derived from, its embedded market, when it falls outside the requested filters, when its `receiverIfMakerIsSeller` is not a well-formed address,
|
|
394
|
+
* @throws {InvalidMidnightApiResponseError} when the API success response is not JSON, when a returned offer cannot be mapped (malformed numeric or hex fields), when its `market_id` does not match, or cannot be derived from, its embedded market, when it falls outside the requested filters, when its `receiverIfMakerIsSeller` is not a well-formed address, when its caps or buy-side receiver are not executable, or when its units exceed its offer `maxUnits`.
|
|
394
395
|
* @example
|
|
395
396
|
* ```ts
|
|
396
397
|
* import { MidnightApi } from "@morpho-org/midnight-sdk/api";
|
|
@@ -416,11 +417,12 @@ export declare class MidnightApi {
|
|
|
416
417
|
* @param params.averageWorstPrice - Optional WAD-scaled average worst price guard. Mutually exclusive with `params.slippage`.
|
|
417
418
|
* @param params.slippage - Optional slippage percentage used to derive the guard. Mutually exclusive with `params.averageWorstPrice`.
|
|
418
419
|
* @param params.settlementFee - Optional current WAD-scaled settlement fee used for local guard validation. Defaults to zero.
|
|
419
|
-
* @returns Quote and
|
|
420
|
+
* @returns Quote and ABI-ready take caps. `averageWorstPrice` equals the caller's guard when provided,
|
|
421
|
+
* otherwise the API's guard.
|
|
420
422
|
* @throws {InvalidMidnightApiQuoteTargetError} when the runtime input does not set exactly one of `units` or `assets`.
|
|
421
423
|
* @throws {NegativeValueError} when `settlementFee` is negative.
|
|
422
424
|
* @throws {MidnightApiError} when the API returns a non-2xx response.
|
|
423
|
-
* @throws {InvalidMidnightApiResponseError} when the API success response is not JSON, when a returned offer cannot be mapped (malformed numeric or hex fields), when its `market_id` does not match, or cannot be derived from, its embedded market, when it falls outside the requested filters, when its `receiverIfMakerIsSeller` is not a well-formed address, when its caps or buy-side receiver are not executable, or when the returned offers imply a rounded aggregate settlement price outside the effective average-worst-price guard.
|
|
425
|
+
* @throws {InvalidMidnightApiResponseError} when the API success response is not JSON, when a returned offer cannot be mapped (malformed numeric or hex fields), when its `market_id` does not match, or cannot be derived from, its embedded market, when it falls outside the requested filters, when its `receiverIfMakerIsSeller` is not a well-formed address, when its caps or buy-side receiver are not executable, when its units exceed its offer `maxUnits`, or when the returned offers imply a rounded aggregate settlement price outside the effective average-worst-price guard.
|
|
424
426
|
* @throws {SettlementFeeExceedsPriceError} when a bid's settlement fee exceeds its offer price.
|
|
425
427
|
* @example
|
|
426
428
|
* ```ts
|
|
@@ -448,7 +450,7 @@ export declare class MidnightApi {
|
|
|
448
450
|
* @param params.cursor - Optional opaque pagination cursor from a previous response.
|
|
449
451
|
* @returns Paginated ABI-ready take objects mapped from the API response.
|
|
450
452
|
* @throws {MidnightApiError} when the API returns a non-2xx response.
|
|
451
|
-
* @throws {InvalidMidnightApiResponseError} when the API success response is not JSON, when a returned offer cannot be mapped (malformed numeric or hex fields), when its `market_id` does not match, or cannot be derived from, its embedded market, when it falls outside the requested filters, when its `receiverIfMakerIsSeller` is not a well-formed address,
|
|
453
|
+
* @throws {InvalidMidnightApiResponseError} when the API success response is not JSON, when a returned offer cannot be mapped (malformed numeric or hex fields), when its `market_id` does not match, or cannot be derived from, its embedded market, when it falls outside the requested filters, when its `receiverIfMakerIsSeller` is not a well-formed address, when its caps or buy-side receiver are not executable, or when its units exceed its offer `maxUnits`.
|
|
452
454
|
* @example
|
|
453
455
|
* ```ts
|
|
454
456
|
* import { MidnightApi } from "@morpho-org/midnight-sdk/api";
|
|
@@ -207,7 +207,7 @@ class MidnightApi {
|
|
|
207
207
|
* @param params.request - Optional fetch options forwarded to this request.
|
|
208
208
|
* @returns ABI-ready take objects mapped from the API response.
|
|
209
209
|
* @throws {MidnightApiError} when the API returns a non-2xx response.
|
|
210
|
-
* @throws {InvalidMidnightApiResponseError} when the API success response is not JSON, when a returned offer cannot be mapped (malformed numeric or hex fields), when its `market_id` does not match, or cannot be derived from, its embedded market, when it falls outside the requested filters, when its `receiverIfMakerIsSeller` is not a well-formed address,
|
|
210
|
+
* @throws {InvalidMidnightApiResponseError} when the API success response is not JSON, when a returned offer cannot be mapped (malformed numeric or hex fields), when its `market_id` does not match, or cannot be derived from, its embedded market, when it falls outside the requested filters, when its `receiverIfMakerIsSeller` is not a well-formed address, when its caps or buy-side receiver are not executable, or when its units exceed its offer `maxUnits`.
|
|
211
211
|
* @example
|
|
212
212
|
* ```ts
|
|
213
213
|
* import { MidnightApi } from "@morpho-org/midnight-sdk/api";
|
|
@@ -252,11 +252,12 @@ class MidnightApi {
|
|
|
252
252
|
* @param params.baseUrl - Optional Midnight API base URL override.
|
|
253
253
|
* @param params.fetch - Optional fetch implementation override.
|
|
254
254
|
* @param params.request - Optional fetch options forwarded to this request.
|
|
255
|
-
* @returns Quote and
|
|
255
|
+
* @returns Quote and ABI-ready take caps. `averageWorstPrice` equals the caller's guard when provided,
|
|
256
|
+
* otherwise the API's guard.
|
|
256
257
|
* @throws {InvalidMidnightApiQuoteTargetError} when the runtime input does not set exactly one of `units` or `assets`.
|
|
257
258
|
* @throws {NegativeValueError} when `settlementFee` is negative.
|
|
258
259
|
* @throws {MidnightApiError} when the API returns a non-2xx response.
|
|
259
|
-
* @throws {InvalidMidnightApiResponseError} when the API success response is not JSON, when a returned offer cannot be mapped (malformed numeric or hex fields), when its `market_id` does not match, or cannot be derived from, its embedded market, when it falls outside the requested filters, when its `receiverIfMakerIsSeller` is not a well-formed address, when its caps or buy-side receiver are not executable, or when the returned offers imply a rounded aggregate settlement price outside the effective average-worst-price guard.
|
|
260
|
+
* @throws {InvalidMidnightApiResponseError} when the API success response is not JSON, when a returned offer cannot be mapped (malformed numeric or hex fields), when its `market_id` does not match, or cannot be derived from, its embedded market, when it falls outside the requested filters, when its `receiverIfMakerIsSeller` is not a well-formed address, when its caps or buy-side receiver are not executable, when its units exceed its offer `maxUnits`, or when the returned offers imply a rounded aggregate settlement price outside the effective average-worst-price guard.
|
|
260
261
|
* @throws {SettlementFeeExceedsPriceError} when a bid's settlement fee exceeds its offer price.
|
|
261
262
|
* @example
|
|
262
263
|
* ```ts
|
|
@@ -301,8 +302,8 @@ class MidnightApi {
|
|
|
301
302
|
: "slippage" in input && input.slippage != null
|
|
302
303
|
? response.data.average_worst_price
|
|
303
304
|
: undefined;
|
|
304
|
-
|
|
305
|
-
|
|
305
|
+
const guard = averageWorstPrice == null ? undefined : BigInt(averageWorstPrice);
|
|
306
|
+
if (guard != null) {
|
|
306
307
|
let filledUnits = 0n;
|
|
307
308
|
let filledAssets = 0n;
|
|
308
309
|
if ("units" in input && input.units != null) {
|
|
@@ -359,7 +360,7 @@ class MidnightApi {
|
|
|
359
360
|
return {
|
|
360
361
|
data: {
|
|
361
362
|
averageBestPrice: response.data.average_best_price,
|
|
362
|
-
averageWorstPrice: response.data.average_worst_price,
|
|
363
|
+
averageWorstPrice: guard?.toString() ?? response.data.average_worst_price,
|
|
363
364
|
availableAssets: response.data.available_assets,
|
|
364
365
|
availableUnits: response.data.available_units,
|
|
365
366
|
takeableOffers,
|
|
@@ -381,7 +382,7 @@ class MidnightApi {
|
|
|
381
382
|
* @param params.request - Optional fetch options forwarded to this request.
|
|
382
383
|
* @returns Paginated ABI-ready take objects mapped from the API response.
|
|
383
384
|
* @throws {MidnightApiError} when the API returns a non-2xx response.
|
|
384
|
-
* @throws {InvalidMidnightApiResponseError} when the API success response is not JSON, when a returned offer cannot be mapped (malformed numeric or hex fields), when its `market_id` does not match, or cannot be derived from, its embedded market, when it falls outside the requested filters, when its `receiverIfMakerIsSeller` is not a well-formed address,
|
|
385
|
+
* @throws {InvalidMidnightApiResponseError} when the API success response is not JSON, when a returned offer cannot be mapped (malformed numeric or hex fields), when its `market_id` does not match, or cannot be derived from, its embedded market, when it falls outside the requested filters, when its `receiverIfMakerIsSeller` is not a well-formed address, when its caps or buy-side receiver are not executable, or when its units exceed its offer `maxUnits`.
|
|
385
386
|
* @example
|
|
386
387
|
* ```ts
|
|
387
388
|
* import { MidnightApi } from "@morpho-org/midnight-sdk/api";
|
|
@@ -629,7 +630,7 @@ class MidnightApi {
|
|
|
629
630
|
* @param params.side - Book side to query.
|
|
630
631
|
* @returns ABI-ready take objects mapped from the API response.
|
|
631
632
|
* @throws {MidnightApiError} when the API returns a non-2xx response.
|
|
632
|
-
* @throws {InvalidMidnightApiResponseError} when the API success response is not JSON, when a returned offer cannot be mapped (malformed numeric or hex fields), when its `market_id` does not match, or cannot be derived from, its embedded market, when it falls outside the requested filters, when its `receiverIfMakerIsSeller` is not a well-formed address,
|
|
633
|
+
* @throws {InvalidMidnightApiResponseError} when the API success response is not JSON, when a returned offer cannot be mapped (malformed numeric or hex fields), when its `market_id` does not match, or cannot be derived from, its embedded market, when it falls outside the requested filters, when its `receiverIfMakerIsSeller` is not a well-formed address, when its caps or buy-side receiver are not executable, or when its units exceed its offer `maxUnits`.
|
|
633
634
|
* @example
|
|
634
635
|
* ```ts
|
|
635
636
|
* import { MidnightApi } from "@morpho-org/midnight-sdk/api";
|
|
@@ -660,11 +661,12 @@ class MidnightApi {
|
|
|
660
661
|
* @param params.averageWorstPrice - Optional WAD-scaled average worst price guard. Mutually exclusive with `params.slippage`.
|
|
661
662
|
* @param params.slippage - Optional slippage percentage used to derive the guard. Mutually exclusive with `params.averageWorstPrice`.
|
|
662
663
|
* @param params.settlementFee - Optional current WAD-scaled settlement fee used for local guard validation. Defaults to zero.
|
|
663
|
-
* @returns Quote and
|
|
664
|
+
* @returns Quote and ABI-ready take caps. `averageWorstPrice` equals the caller's guard when provided,
|
|
665
|
+
* otherwise the API's guard.
|
|
664
666
|
* @throws {InvalidMidnightApiQuoteTargetError} when the runtime input does not set exactly one of `units` or `assets`.
|
|
665
667
|
* @throws {NegativeValueError} when `settlementFee` is negative.
|
|
666
668
|
* @throws {MidnightApiError} when the API returns a non-2xx response.
|
|
667
|
-
* @throws {InvalidMidnightApiResponseError} when the API success response is not JSON, when a returned offer cannot be mapped (malformed numeric or hex fields), when its `market_id` does not match, or cannot be derived from, its embedded market, when it falls outside the requested filters, when its `receiverIfMakerIsSeller` is not a well-formed address, when its caps or buy-side receiver are not executable, or when the returned offers imply a rounded aggregate settlement price outside the effective average-worst-price guard.
|
|
669
|
+
* @throws {InvalidMidnightApiResponseError} when the API success response is not JSON, when a returned offer cannot be mapped (malformed numeric or hex fields), when its `market_id` does not match, or cannot be derived from, its embedded market, when it falls outside the requested filters, when its `receiverIfMakerIsSeller` is not a well-formed address, when its caps or buy-side receiver are not executable, when its units exceed its offer `maxUnits`, or when the returned offers imply a rounded aggregate settlement price outside the effective average-worst-price guard.
|
|
668
670
|
* @throws {SettlementFeeExceedsPriceError} when a bid's settlement fee exceeds its offer price.
|
|
669
671
|
* @example
|
|
670
672
|
* ```ts
|
|
@@ -697,7 +699,7 @@ class MidnightApi {
|
|
|
697
699
|
* @param params.cursor - Optional opaque pagination cursor from a previous response.
|
|
698
700
|
* @returns Paginated ABI-ready take objects mapped from the API response.
|
|
699
701
|
* @throws {MidnightApiError} when the API returns a non-2xx response.
|
|
700
|
-
* @throws {InvalidMidnightApiResponseError} when the API success response is not JSON, when a returned offer cannot be mapped (malformed numeric or hex fields), when its `market_id` does not match, or cannot be derived from, its embedded market, when it falls outside the requested filters, when its `receiverIfMakerIsSeller` is not a well-formed address,
|
|
702
|
+
* @throws {InvalidMidnightApiResponseError} when the API success response is not JSON, when a returned offer cannot be mapped (malformed numeric or hex fields), when its `market_id` does not match, or cannot be derived from, its embedded market, when it falls outside the requested filters, when its `receiverIfMakerIsSeller` is not a well-formed address, when its caps or buy-side receiver are not executable, or when its units exceed its offer `maxUnits`.
|
|
701
703
|
* @example
|
|
702
704
|
* ```ts
|
|
703
705
|
* import { MidnightApi } from "@morpho-org/midnight-sdk/api";
|
package/lib/cjs/api/helpers.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { type Address, type Hash } from "viem";
|
|
2
|
-
import { type ApiBookMarketResponse, type
|
|
2
|
+
import { type ApiBookMarketResponse, type ApiPriceLevelResponse, type ApiRequestParams, type ApiTakeableOfferResponse, type MempoolPayloadValidationResult, type MidnightApiBookMarket, type MidnightApiBookSide, type MidnightApiPriceLevel, type MidnightApiTake } from "./types.js";
|
|
3
3
|
/** @internal Sends one Midnight API request and maps non-2xx responses to SDK errors. */
|
|
4
4
|
export declare function requestMidnightApi<Response = unknown>(params: ApiRequestParams): Promise<Response>;
|
|
5
5
|
/** @internal Builds a book endpoint path with encoded path segments. */
|
|
@@ -8,16 +8,6 @@ export declare function buildBookPath(params: {
|
|
|
8
8
|
readonly side?: MidnightApiBookSide;
|
|
9
9
|
readonly suffix?: "quote" | "takeable-offers";
|
|
10
10
|
}): string;
|
|
11
|
-
/**
|
|
12
|
-
* @internal Maps a book market API payload to the SDK response shape, rejecting any
|
|
13
|
-
* response whose advertised `market_id` cannot be derived from — or does not match —
|
|
14
|
-
* its own market params. Recomputing the id with `MarketUtils.toId` (mirroring the
|
|
15
|
-
* takeable-offers path) stops a hostile API from pairing a trusted id with foreign
|
|
16
|
-
* metadata; every book flows through here, so both bound paths reject the same substitution.
|
|
17
|
-
* Collaterals are returned in the protocol's canonical order so their array index matches
|
|
18
|
-
* the onchain `collateralIndex`.
|
|
19
|
-
*/
|
|
20
|
-
export declare function mapBookMarket(book: ApiBookMarketResponse): MidnightApiBookMarket;
|
|
21
11
|
/** @internal Maps a book market, binding its verified id to the requested market. */
|
|
22
12
|
export declare function mapBoundBookMarket(book: ApiBookMarketResponse, requestedMarketId: Hash): MidnightApiBookMarket;
|
|
23
13
|
/** @internal Requested `fetchBooks` filters that every returned book must satisfy. */
|
|
@@ -30,14 +20,8 @@ export interface BookFilterContext {
|
|
|
30
20
|
}
|
|
31
21
|
/** @internal Maps listed book markets, binding each verified id to requested filters when present. */
|
|
32
22
|
export declare function mapBoundBooks(books: readonly ApiBookMarketResponse[], context?: BookFilterContext): MidnightApiBookMarket[];
|
|
33
|
-
/** @internal Maps a collateral API payload to the SDK response shape. */
|
|
34
|
-
export declare function mapCollateral(collateral: ApiCollateralResponse): MidnightApiCollateral;
|
|
35
|
-
/** @internal Maps a price-level API payload to the SDK response shape. */
|
|
36
|
-
export declare function mapPriceLevel(level: ApiPriceLevelResponse): MidnightApiPriceLevel;
|
|
37
23
|
/** @internal Maps API price levels and sorts them best first: asks by ascending tick, bids by descending tick. */
|
|
38
24
|
export declare function mapPriceLevels(levels: readonly ApiPriceLevelResponse[], side: MidnightApiBookSide): MidnightApiPriceLevel[];
|
|
39
|
-
/** @internal Maps a takeable-offer API payload to the SDK response shape. */
|
|
40
|
-
export declare function mapTakeableOffer(takeableOffer: ApiTakeableOfferResponse): MidnightApiTake;
|
|
41
25
|
/** @internal API response context required for a takeable offer to be executable for the caller's request. */
|
|
42
26
|
export interface TakeableOfferContext {
|
|
43
27
|
readonly marketId?: Hash;
|
|
@@ -46,7 +30,7 @@ export interface TakeableOfferContext {
|
|
|
46
30
|
readonly marketIds?: readonly Hash[];
|
|
47
31
|
readonly groups?: readonly Hash[];
|
|
48
32
|
}
|
|
49
|
-
/** @internal Maps, validates, and best-price-sorts API takeable offers. */
|
|
33
|
+
/** @internal Maps, validates offer caps and units, and best-price-sorts API takeable offers. */
|
|
50
34
|
export declare function mapBoundTakeableOffers(takeableOffers: readonly ApiTakeableOfferResponse[], context: TakeableOfferContext): MidnightApiTake[];
|
|
51
35
|
/** @internal Parses the mempool validation response envelope. */
|
|
52
36
|
export declare function parseValidationResponse(response: unknown): MempoolPayloadValidationResult;
|
package/lib/cjs/api/helpers.js
CHANGED
|
@@ -2,13 +2,9 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.requestMidnightApi = requestMidnightApi;
|
|
4
4
|
exports.buildBookPath = buildBookPath;
|
|
5
|
-
exports.mapBookMarket = mapBookMarket;
|
|
6
5
|
exports.mapBoundBookMarket = mapBoundBookMarket;
|
|
7
6
|
exports.mapBoundBooks = mapBoundBooks;
|
|
8
|
-
exports.mapCollateral = mapCollateral;
|
|
9
|
-
exports.mapPriceLevel = mapPriceLevel;
|
|
10
7
|
exports.mapPriceLevels = mapPriceLevels;
|
|
11
|
-
exports.mapTakeableOffer = mapTakeableOffer;
|
|
12
8
|
exports.mapBoundTakeableOffers = mapBoundTakeableOffers;
|
|
13
9
|
exports.parseValidationResponse = parseValidationResponse;
|
|
14
10
|
const morpho_ts_1 = require("@morpho-org/morpho-ts");
|
|
@@ -254,7 +250,7 @@ function mapTakeableOffer(takeableOffer) {
|
|
|
254
250
|
ratifierData: takeableOffer.ratifier_data,
|
|
255
251
|
};
|
|
256
252
|
}
|
|
257
|
-
/** @internal Maps, validates, and best-price-sorts API takeable offers. */
|
|
253
|
+
/** @internal Maps, validates offer caps and units, and best-price-sorts API takeable offers. */
|
|
258
254
|
function mapBoundTakeableOffers(takeableOffers, context) {
|
|
259
255
|
const mapped = takeableOffers.map((takeableOffer) => {
|
|
260
256
|
let take;
|
|
@@ -289,6 +285,9 @@ function mapBoundTakeableOffers(takeableOffers, context) {
|
|
|
289
285
|
throw cause;
|
|
290
286
|
throw new errors_js_1.InvalidMidnightApiResponseError(`Midnight API takeable offer for market_id "${take.marketId}" is not executable: ${cause.message}`, { cause });
|
|
291
287
|
}
|
|
288
|
+
if (maxUnits > 0n && take.units > maxUnits) {
|
|
289
|
+
throw new errors_js_1.InvalidMidnightApiResponseError(`Midnight API takeable offer for market_id "${take.marketId}" reports units "${take.units}" above offer maxUnits "${maxUnits}".`);
|
|
290
|
+
}
|
|
292
291
|
if (context.marketId != null &&
|
|
293
292
|
!(0, morpho_ts_1.isHexEqual)(take.marketId, context.marketId)) {
|
|
294
293
|
throw new errors_js_1.InvalidMidnightApiResponseError(`Midnight API takeable offer market_id "${take.marketId}" does not match requested market "${context.marketId}".`);
|
package/lib/cjs/api/types.d.ts
CHANGED
|
@@ -409,7 +409,7 @@ export interface MidnightApiBookPriceLevelsResult {
|
|
|
409
409
|
export interface MidnightApiQuote {
|
|
410
410
|
/** Weighted average price for the requested size before any guard. */
|
|
411
411
|
readonly averageBestPrice: string;
|
|
412
|
-
/**
|
|
412
|
+
/** Equals the caller's `averageWorstPrice` when provided, otherwise the API's guard. */
|
|
413
413
|
readonly averageWorstPrice: string;
|
|
414
414
|
/** Maximum assets available from the returned take caps. */
|
|
415
415
|
readonly availableAssets: string;
|
|
@@ -440,9 +440,9 @@ export interface MidnightApiTakeableOffersResult {
|
|
|
440
440
|
readonly data: readonly MidnightApiTake[];
|
|
441
441
|
}
|
|
442
442
|
/** @internal HTTP method owned by Midnight API helpers. */
|
|
443
|
-
|
|
443
|
+
type ApiMethod = "GET" | "POST";
|
|
444
444
|
/** @internal Query values serializable by Midnight API helpers. */
|
|
445
|
-
|
|
445
|
+
type QueryValue = string | number | bigint | boolean | Date | readonly string[] | readonly number[] | undefined;
|
|
446
446
|
/** @internal Request descriptor consumed by the Midnight API HTTP helper. */
|
|
447
447
|
export type ApiRequestParams = MidnightApiConfig & {
|
|
448
448
|
readonly method: ApiMethod;
|
|
@@ -493,7 +493,7 @@ export type ApiPriceLevelsResponse = {
|
|
|
493
493
|
readonly data: readonly ApiPriceLevelResponse[];
|
|
494
494
|
};
|
|
495
495
|
/** @internal Offer market response shape returned by the API. */
|
|
496
|
-
|
|
496
|
+
type ApiOfferMarketResponse = {
|
|
497
497
|
readonly chain_id: number;
|
|
498
498
|
readonly midnight: Address;
|
|
499
499
|
readonly loan_token: Address;
|
|
@@ -504,7 +504,7 @@ export type ApiOfferMarketResponse = {
|
|
|
504
504
|
readonly liquidator_gate: Address;
|
|
505
505
|
};
|
|
506
506
|
/** @internal Inline offer response shape returned by the API. */
|
|
507
|
-
|
|
507
|
+
type ApiOfferResponse = {
|
|
508
508
|
readonly market: ApiOfferMarketResponse;
|
|
509
509
|
readonly buy: boolean;
|
|
510
510
|
readonly maker: Address;
|
|
@@ -547,3 +547,4 @@ export type ApiTakeableOffersResponse = {
|
|
|
547
547
|
readonly cursor: string | null;
|
|
548
548
|
readonly data: readonly ApiTakeableOfferResponse[];
|
|
549
549
|
};
|
|
550
|
+
export {};
|
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
/** @internal Installed Midnight SDK package version. */
|
|
2
|
-
export declare const MIDNIGHT_SDK_VERSION = "1.
|
|
2
|
+
export declare const MIDNIGHT_SDK_VERSION = "2.1.0-next.0";
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
|
-
// Generated by scripts/
|
|
2
|
+
// Generated by scripts/generate-midnight-package-version.ts. Do not edit.
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
4
|
exports.MIDNIGHT_SDK_VERSION = void 0;
|
|
5
5
|
/** @internal Installed Midnight SDK package version. */
|
|
6
|
-
exports.MIDNIGHT_SDK_VERSION = "1.
|
|
6
|
+
exports.MIDNIGHT_SDK_VERSION = "2.1.0-next.0";
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import type { Hex } from "viem";
|
|
2
|
+
/** `MidnightBundlesV2` group cancellation: marks `group` fully consumed if its consumption is at most `maxConsumed`. */
|
|
3
|
+
export interface GroupCancellation {
|
|
4
|
+
/** Offer group id. */
|
|
5
|
+
readonly group: Hex;
|
|
6
|
+
/** Largest current group consumption accepted (uint128); the whole call reverts above it. */
|
|
7
|
+
readonly maxConsumed: bigint;
|
|
8
|
+
}
|
|
9
|
+
/** `MidnightBundlesV2` collateral transfer: `assets` of the market collateral at `collateralIndex`. */
|
|
10
|
+
export interface CollateralTransfer {
|
|
11
|
+
/** Index of the collateral in the market's `collateralParams`. */
|
|
12
|
+
readonly collateralIndex: bigint;
|
|
13
|
+
/** Collateral assets. */
|
|
14
|
+
readonly assets: bigint;
|
|
15
|
+
}
|
package/lib/cjs/errors.d.ts
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { InvalidPositionAccrualStateError as SharedInvalidPositionAccrualStateError, InvalidPositionAccrualTimestampError as SharedInvalidPositionAccrualTimestampError, InvalidPositionLossFactorError as SharedInvalidPositionLossFactorError } from "@morpho-org/morpho-ts";
|
|
1
2
|
import type { Address } from "viem";
|
|
2
3
|
import type { MempoolPayloadValidationIssue } from "./api/types.js";
|
|
3
4
|
/**
|
|
@@ -70,42 +71,27 @@ export declare class SettlementFeeExceedsPriceError extends Error {
|
|
|
70
71
|
/**
|
|
71
72
|
* Thrown when a local position accrual is requested for an impossible timestamp.
|
|
72
73
|
*
|
|
73
|
-
* @
|
|
74
|
-
* ```ts
|
|
75
|
-
* import { InvalidPositionAccrualTimestampError } from "@morpho-org/midnight-sdk";
|
|
76
|
-
*
|
|
77
|
-
* throw new InvalidPositionAccrualTimestampError(1n, 2n);
|
|
78
|
-
* ```
|
|
74
|
+
* @deprecated Import `InvalidPositionAccrualTimestampError` from `@morpho-org/morpho-ts`. Removed in the next major.
|
|
79
75
|
*/
|
|
80
|
-
export declare
|
|
81
|
-
|
|
82
|
-
|
|
76
|
+
export declare const InvalidPositionAccrualTimestampError: typeof SharedInvalidPositionAccrualTimestampError;
|
|
77
|
+
/** @deprecated Import `InvalidPositionAccrualTimestampError` from `@morpho-org/morpho-ts`. Removed in the next major. */
|
|
78
|
+
export type InvalidPositionAccrualTimestampError = SharedInvalidPositionAccrualTimestampError;
|
|
83
79
|
/**
|
|
84
80
|
* Thrown when a local position accrual sees a market loss factor older than the position.
|
|
85
81
|
*
|
|
86
|
-
* @
|
|
87
|
-
* ```ts
|
|
88
|
-
* import { InvalidPositionLossFactorError } from "@morpho-org/midnight-sdk";
|
|
89
|
-
*
|
|
90
|
-
* throw new InvalidPositionLossFactorError(1n, 2n);
|
|
91
|
-
* ```
|
|
82
|
+
* @deprecated Import `InvalidPositionLossFactorError` from `@morpho-org/morpho-ts`. Removed in the next major.
|
|
92
83
|
*/
|
|
93
|
-
export declare
|
|
94
|
-
|
|
95
|
-
|
|
84
|
+
export declare const InvalidPositionLossFactorError: typeof SharedInvalidPositionLossFactorError;
|
|
85
|
+
/** @deprecated Import `InvalidPositionLossFactorError` from `@morpho-org/morpho-ts`. Removed in the next major. */
|
|
86
|
+
export type InvalidPositionLossFactorError = SharedInvalidPositionLossFactorError;
|
|
96
87
|
/**
|
|
97
88
|
* Thrown when local position accrual inputs violate Midnight accounting invariants.
|
|
98
89
|
*
|
|
99
|
-
* @
|
|
100
|
-
* ```ts
|
|
101
|
-
* import { InvalidPositionAccrualStateError } from "@morpho-org/midnight-sdk";
|
|
102
|
-
*
|
|
103
|
-
* throw new InvalidPositionAccrualStateError("Pending fee exceeds credit.");
|
|
104
|
-
* ```
|
|
90
|
+
* @deprecated Import `InvalidPositionAccrualStateError` from `@morpho-org/morpho-ts`. Removed in the next major.
|
|
105
91
|
*/
|
|
106
|
-
export declare
|
|
107
|
-
|
|
108
|
-
|
|
92
|
+
export declare const InvalidPositionAccrualStateError: typeof SharedInvalidPositionAccrualStateError;
|
|
93
|
+
/** @deprecated Import `InvalidPositionAccrualStateError` from `@morpho-org/morpho-ts`. Removed in the next major. */
|
|
94
|
+
export type InvalidPositionAccrualStateError = SharedInvalidPositionAccrualStateError;
|
|
109
95
|
/**
|
|
110
96
|
* Thrown when a market parameter cannot satisfy Midnight protocol rules.
|
|
111
97
|
*
|
package/lib/cjs/errors.js
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.InvalidMidnightApiQuoteTargetError = exports.InvalidMidnightApiResponseError = exports.MidnightApiError = exports.InvalidEcrecoverSignatureVError = exports.InvalidTypedDataSignatureError = exports.MidnightMempoolValidationError = exports.ChainIdMismatchError = exports.RatifierV1TakerNotAllowedError = exports.InvalidRatifierV1AddressError = exports.InvalidRateRatifierV1TimeError = exports.InvalidRateRatifierV1TickError = exports.RateRatifierV1BoundOverflowError = exports.InvalidRateRatifierV1RateError = exports.InvalidTreeError = exports.InvalidTreeHeightError = exports.PayloadDecodeError = exports.InvalidOfferParameterError = exports.UnknownCollateralIndexError = exports.InvalidMarketParameterError = exports.InvalidPositionAccrualStateError = exports.InvalidPositionLossFactorError = exports.InvalidPositionAccrualTimestampError = exports.SettlementFeeExceedsPriceError = exports.InvalidTickSpacingError = exports.PriceGreaterThanOneError = exports.TickOutOfRangeError = exports.InvalidOfferGroupError = void 0;
|
|
4
|
+
const morpho_ts_1 = require("@morpho-org/morpho-ts");
|
|
4
5
|
/**
|
|
5
6
|
* Thrown when a Midnight offer group violates protocol-level group mechanics.
|
|
6
7
|
*
|
|
@@ -89,57 +90,25 @@ class SettlementFeeExceedsPriceError extends Error {
|
|
|
89
90
|
}
|
|
90
91
|
}
|
|
91
92
|
exports.SettlementFeeExceedsPriceError = SettlementFeeExceedsPriceError;
|
|
93
|
+
// Temporary compatibility exception for these shared morpho-ts errors.
|
|
92
94
|
/**
|
|
93
95
|
* Thrown when a local position accrual is requested for an impossible timestamp.
|
|
94
96
|
*
|
|
95
|
-
* @
|
|
96
|
-
* ```ts
|
|
97
|
-
* import { InvalidPositionAccrualTimestampError } from "@morpho-org/midnight-sdk";
|
|
98
|
-
*
|
|
99
|
-
* throw new InvalidPositionAccrualTimestampError(1n, 2n);
|
|
100
|
-
* ```
|
|
97
|
+
* @deprecated Import `InvalidPositionAccrualTimestampError` from `@morpho-org/morpho-ts`. Removed in the next major.
|
|
101
98
|
*/
|
|
102
|
-
|
|
103
|
-
constructor(timestamp, lastAccrual) {
|
|
104
|
-
super(`Position accrual timestamp "${timestamp}" is before last accrual "${lastAccrual}". Use a timestamp greater than or equal to last accrual.`);
|
|
105
|
-
this.name = "InvalidPositionAccrualTimestampError";
|
|
106
|
-
}
|
|
107
|
-
}
|
|
108
|
-
exports.InvalidPositionAccrualTimestampError = InvalidPositionAccrualTimestampError;
|
|
99
|
+
exports.InvalidPositionAccrualTimestampError = morpho_ts_1.InvalidPositionAccrualTimestampError;
|
|
109
100
|
/**
|
|
110
101
|
* Thrown when a local position accrual sees a market loss factor older than the position.
|
|
111
102
|
*
|
|
112
|
-
* @
|
|
113
|
-
* ```ts
|
|
114
|
-
* import { InvalidPositionLossFactorError } from "@morpho-org/midnight-sdk";
|
|
115
|
-
*
|
|
116
|
-
* throw new InvalidPositionLossFactorError(1n, 2n);
|
|
117
|
-
* ```
|
|
103
|
+
* @deprecated Import `InvalidPositionLossFactorError` from `@morpho-org/morpho-ts`. Removed in the next major.
|
|
118
104
|
*/
|
|
119
|
-
|
|
120
|
-
constructor(marketLossFactor, positionLossFactor) {
|
|
121
|
-
super(`Market loss factor "${marketLossFactor}" is below position loss factor "${positionLossFactor}". Fetch a consistent market and position at the same block.`);
|
|
122
|
-
this.name = "InvalidPositionLossFactorError";
|
|
123
|
-
}
|
|
124
|
-
}
|
|
125
|
-
exports.InvalidPositionLossFactorError = InvalidPositionLossFactorError;
|
|
105
|
+
exports.InvalidPositionLossFactorError = morpho_ts_1.InvalidPositionLossFactorError;
|
|
126
106
|
/**
|
|
127
107
|
* Thrown when local position accrual inputs violate Midnight accounting invariants.
|
|
128
108
|
*
|
|
129
|
-
* @
|
|
130
|
-
* ```ts
|
|
131
|
-
* import { InvalidPositionAccrualStateError } from "@morpho-org/midnight-sdk";
|
|
132
|
-
*
|
|
133
|
-
* throw new InvalidPositionAccrualStateError("Pending fee exceeds credit.");
|
|
134
|
-
* ```
|
|
109
|
+
* @deprecated Import `InvalidPositionAccrualStateError` from `@morpho-org/morpho-ts`. Removed in the next major.
|
|
135
110
|
*/
|
|
136
|
-
|
|
137
|
-
constructor(reason) {
|
|
138
|
-
super(`Invalid Midnight position accrual state. ${reason}`);
|
|
139
|
-
this.name = "InvalidPositionAccrualStateError";
|
|
140
|
-
}
|
|
141
|
-
}
|
|
142
|
-
exports.InvalidPositionAccrualStateError = InvalidPositionAccrualStateError;
|
|
111
|
+
exports.InvalidPositionAccrualStateError = morpho_ts_1.InvalidPositionAccrualStateError;
|
|
143
112
|
/**
|
|
144
113
|
* Thrown when a market parameter cannot satisfy Midnight protocol rules.
|
|
145
114
|
*
|
|
@@ -42,6 +42,7 @@ async function fetchRatifierInfo(client, params) {
|
|
|
42
42
|
const chainId = await (0, utils_js_1.resolveChainId)(client);
|
|
43
43
|
const ecrecoverRatifier = (0, morpho_ts_1.getChainAddress)(chainId, "ecrecoverRatifier");
|
|
44
44
|
const setterRatifier = (0, morpho_ts_1.getChainAddress)(chainId, "setterRatifier");
|
|
45
|
+
// eth_getCode is trusted; the returned ratifier is a suggestion the caller commits to on Offer.create. See THREAT_MODEL.md, RPC.
|
|
45
46
|
const bytecode = await (0, actions_1.getBytecode)(client, {
|
|
46
47
|
...(params.blockNumber != null
|
|
47
48
|
? { blockNumber: params.blockNumber }
|
package/lib/cjs/index.d.ts
CHANGED
|
@@ -2,7 +2,6 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.PositionUtils = void 0;
|
|
4
4
|
const morpho_ts_1 = require("@morpho-org/morpho-ts");
|
|
5
|
-
const errors_js_1 = require("../errors.js");
|
|
6
5
|
/**
|
|
7
6
|
* Domain helpers for Midnight positions.
|
|
8
7
|
*
|
|
@@ -135,40 +134,17 @@ var PositionUtils;
|
|
|
135
134
|
*/
|
|
136
135
|
function accrueInterest(params) {
|
|
137
136
|
const timestamp = BigInt(params.timestamp);
|
|
138
|
-
const credit = BigInt(params.position.credit);
|
|
139
|
-
const pendingFee = BigInt(params.position.pendingFee);
|
|
140
|
-
const lastLossFactor = BigInt(params.position.lastLossFactor);
|
|
141
|
-
const lastAccrual = BigInt(params.position.lastAccrual);
|
|
142
137
|
const marketLossFactor = BigInt(params.market.lossFactor);
|
|
143
|
-
if (timestamp < lastAccrual) {
|
|
144
|
-
throw new errors_js_1.InvalidPositionAccrualTimestampError(timestamp, lastAccrual);
|
|
145
|
-
}
|
|
146
|
-
if (marketLossFactor < lastLossFactor) {
|
|
147
|
-
throw new errors_js_1.InvalidPositionLossFactorError(marketLossFactor, lastLossFactor);
|
|
148
|
-
}
|
|
149
|
-
if (pendingFee > credit) {
|
|
150
|
-
throw new errors_js_1.InvalidPositionAccrualStateError("Pending fee must be less than or equal to credit.");
|
|
151
|
-
}
|
|
152
|
-
const postSlashCredit = lastLossFactor < morpho_ts_1.MathLib.MAX_UINT_128
|
|
153
|
-
? morpho_ts_1.MathLib.mulDivDown(credit, morpho_ts_1.MathLib.MAX_UINT_128 - marketLossFactor, morpho_ts_1.MathLib.MAX_UINT_128 - lastLossFactor)
|
|
154
|
-
: 0n;
|
|
155
|
-
if (postSlashCredit > credit) {
|
|
156
|
-
throw new errors_js_1.InvalidPositionAccrualStateError("Post-slash credit cannot exceed stored credit.");
|
|
157
|
-
}
|
|
158
|
-
const creditDecrease = credit - postSlashCredit;
|
|
159
|
-
const pendingFeeDecrease = credit > 0n ? morpho_ts_1.MathLib.mulDivUp(pendingFee, creditDecrease, credit) : 0n;
|
|
160
|
-
if (pendingFeeDecrease > pendingFee) {
|
|
161
|
-
throw new errors_js_1.InvalidPositionAccrualStateError("Pending-fee decrease cannot exceed pending fee.");
|
|
162
|
-
}
|
|
163
|
-
const postSlashPendingFee = pendingFee - pendingFeeDecrease;
|
|
164
138
|
const maturity = BigInt(params.market.params.maturity);
|
|
165
|
-
const
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
:
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
139
|
+
const { credit, pendingFee, accruedFee } = morpho_ts_1.MidnightPositionLib.accrue({
|
|
140
|
+
credit: params.position.credit,
|
|
141
|
+
pendingFee: params.position.pendingFee,
|
|
142
|
+
lastLossFactor: params.position.lastLossFactor,
|
|
143
|
+
lastAccrual: params.position.lastAccrual,
|
|
144
|
+
marketLossFactor,
|
|
145
|
+
maturity,
|
|
146
|
+
timestamp,
|
|
147
|
+
});
|
|
172
148
|
const collateral = params.position.collateral.map((assets) => BigInt(assets));
|
|
173
149
|
const collateralParams = params.market.params.collateralParams.map((collateralParam) => ({
|
|
174
150
|
token: collateralParam.token,
|
|
@@ -199,8 +175,8 @@ var PositionUtils;
|
|
|
199
175
|
position: {
|
|
200
176
|
user: params.position.user,
|
|
201
177
|
marketId: params.position.marketId,
|
|
202
|
-
credit
|
|
203
|
-
pendingFee
|
|
178
|
+
credit,
|
|
179
|
+
pendingFee,
|
|
204
180
|
lastLossFactor: marketLossFactor,
|
|
205
181
|
lastAccrual: timestamp,
|
|
206
182
|
debt: BigInt(params.position.debt),
|