@opensea/sdk 10.3.1 → 10.5.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/lib/api/accounts.d.ts +29 -1
- package/lib/api/accounts.js +63 -0
- package/lib/api/accounts.js.map +1 -1
- package/lib/api/api.d.ts +129 -41
- package/lib/api/api.js +180 -48
- package/lib/api/api.js.map +1 -1
- package/lib/api/apiPaths.d.ts +29 -2
- package/lib/api/apiPaths.js +121 -6
- package/lib/api/apiPaths.js.map +1 -1
- package/lib/api/assets.d.ts +18 -0
- package/lib/api/assets.js +26 -0
- package/lib/api/assets.js.map +1 -0
- package/lib/api/collections.d.ts +19 -1
- package/lib/api/collections.js +26 -0
- package/lib/api/collections.js.map +1 -1
- package/lib/api/drops.d.ts +12 -1
- package/lib/api/drops.js +14 -0
- package/lib/api/drops.js.map +1 -1
- package/lib/api/listings.d.ts +16 -14
- package/lib/api/listings.js +21 -30
- package/lib/api/listings.js.map +1 -1
- package/lib/api/nfts.d.ts +14 -1
- package/lib/api/nfts.js +19 -0
- package/lib/api/nfts.js.map +1 -1
- package/lib/api/offers.d.ts +2 -2
- package/lib/api/offers.js +2 -9
- package/lib/api/offers.js.map +1 -1
- package/lib/api/orders.d.ts +4 -21
- package/lib/api/orders.js +15 -96
- package/lib/api/orders.js.map +1 -1
- package/lib/api/tokens.d.ts +27 -1
- package/lib/api/tokens.js +33 -0
- package/lib/api/tokens.js.map +1 -1
- package/lib/api/transactions.d.ts +16 -0
- package/lib/api/transactions.js +24 -0
- package/lib/api/transactions.js.map +1 -0
- package/lib/api/types.d.ts +147 -10
- package/lib/api/types.js.map +1 -1
- package/lib/orders/types.d.ts +0 -67
- package/lib/orders/types.js.map +1 -1
- package/lib/orders/utils.d.ts +1 -19
- package/lib/orders/utils.js +1 -62
- package/lib/orders/utils.js.map +1 -1
- package/lib/sdk/base.d.ts +6 -6
- package/lib/sdk/base.js +2 -2
- package/lib/sdk/orders.d.ts +13 -10
- package/lib/sdk/orders.js +6 -22
- package/lib/sdk/orders.js.map +1 -1
- package/lib/types.d.ts +0 -6
- package/package.json +2 -2
- package/src/api/accounts.ts +130 -0
- package/src/api/api.ts +324 -86
- package/src/api/apiPaths.ts +138 -8
- package/src/api/assets.ts +22 -0
- package/src/api/collections.ts +65 -0
- package/src/api/drops.ts +34 -1
- package/src/api/listings.ts +37 -41
- package/src/api/nfts.ts +44 -0
- package/src/api/offers.ts +8 -16
- package/src/api/orders.ts +40 -177
- package/src/api/tokens.ts +76 -0
- package/src/api/transactions.ts +28 -0
- package/src/api/types.ts +205 -15
- package/src/orders/types.ts +0 -74
- package/src/orders/utils.ts +2 -73
- package/src/sdk/base.ts +6 -6
- package/src/sdk/orders.ts +31 -32
- package/src/types.ts +0 -6
package/lib/api/listings.js
CHANGED
|
@@ -1,19 +1,15 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.ListingsAPI = void 0;
|
|
4
|
-
const utils_1 = require("../orders/utils");
|
|
5
|
-
const types_1 = require("../types");
|
|
6
4
|
const apiPaths_1 = require("./apiPaths");
|
|
7
|
-
const
|
|
5
|
+
const types_1 = require("./types");
|
|
8
6
|
/**
|
|
9
7
|
* Listing-related API operations
|
|
10
8
|
*/
|
|
11
9
|
class ListingsAPI {
|
|
12
10
|
fetcher;
|
|
13
|
-
|
|
14
|
-
constructor(fetcher, chain) {
|
|
11
|
+
constructor(fetcher) {
|
|
15
12
|
this.fetcher = fetcher;
|
|
16
|
-
this.chain = chain;
|
|
17
13
|
}
|
|
18
14
|
/**
|
|
19
15
|
* Gets all listings for a given collection.
|
|
@@ -55,30 +51,7 @@ class ListingsAPI {
|
|
|
55
51
|
...(includePrivateListings !== undefined && {
|
|
56
52
|
include_private_listings: includePrivateListings,
|
|
57
53
|
}),
|
|
58
|
-
traits: (0,
|
|
59
|
-
});
|
|
60
|
-
return response;
|
|
61
|
-
}
|
|
62
|
-
/**
|
|
63
|
-
* Gets all active listings for a specific NFT.
|
|
64
|
-
* @param assetContractAddress The NFT contract address
|
|
65
|
-
* @param tokenId The token ID
|
|
66
|
-
* @param limit The number of listings to return
|
|
67
|
-
* @param next The cursor for pagination
|
|
68
|
-
* @param chain The blockchain chain
|
|
69
|
-
* @param includePrivateListings Whether to include private listings (default: false)
|
|
70
|
-
*/
|
|
71
|
-
async getNFTListings(assetContractAddress, tokenId, limit, next, chain = this.chain, includePrivateListings) {
|
|
72
|
-
const response = await this.fetcher.get((0, apiPaths_1.getOrdersAPIPath)(chain, "seaport", types_1.OrderSide.LISTING), {
|
|
73
|
-
...(0, utils_1.serializeOrdersQueryOptions)({
|
|
74
|
-
assetContractAddress,
|
|
75
|
-
tokenIds: [tokenId],
|
|
76
|
-
limit,
|
|
77
|
-
next,
|
|
78
|
-
}),
|
|
79
|
-
...(includePrivateListings !== undefined && {
|
|
80
|
-
include_private_listings: includePrivateListings,
|
|
81
|
-
}),
|
|
54
|
+
traits: (0, types_1.encodeTraitsParam)(traits),
|
|
82
55
|
});
|
|
83
56
|
return response;
|
|
84
57
|
}
|
|
@@ -90,6 +63,24 @@ class ListingsAPI {
|
|
|
90
63
|
async getCrossChainFulfillmentData(request) {
|
|
91
64
|
return this.fetcher.post((0, apiPaths_1.getCrossChainFulfillmentDataPath)(), request);
|
|
92
65
|
}
|
|
66
|
+
/**
|
|
67
|
+
* Bulk-buy items from a collection.
|
|
68
|
+
* If a requested item becomes unavailable, the system can automatically
|
|
69
|
+
* substitute it with the next cheapest listing from the same collection
|
|
70
|
+
* (enabled by default). Returns an ordered list of transactions to execute.
|
|
71
|
+
*/
|
|
72
|
+
async sweepCollection(request) {
|
|
73
|
+
return this.fetcher.post((0, apiPaths_1.getSweepListingsPath)(), request);
|
|
74
|
+
}
|
|
75
|
+
/**
|
|
76
|
+
* Get an ordered list of blockchain actions required to create one or more
|
|
77
|
+
* listings — token approvals + a final action containing the Seaport order
|
|
78
|
+
* to sign. Useful for clients that prefer the server to compute the
|
|
79
|
+
* approval graph.
|
|
80
|
+
*/
|
|
81
|
+
async createListingActions(request) {
|
|
82
|
+
return this.fetcher.post((0, apiPaths_1.getCreateListingActionsPath)(), request);
|
|
83
|
+
}
|
|
93
84
|
}
|
|
94
85
|
exports.ListingsAPI = ListingsAPI;
|
|
95
86
|
//# sourceMappingURL=listings.js.map
|
package/lib/api/listings.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"listings.js","sourceRoot":"","sources":["../../src/api/listings.ts"],"names":[],"mappings":";;;AAAA,
|
|
1
|
+
{"version":3,"file":"listings.js","sourceRoot":"","sources":["../../src/api/listings.ts"],"names":[],"mappings":";;;AAAA,yCAOmB;AAEnB,mCAWgB;AAEhB;;GAEG;AACH,MAAa,WAAW;IACF;IAApB,YAAoB,OAAgB;QAAhB,YAAO,GAAP,OAAO,CAAS;IAAG,CAAC;IAExC;;;;;;OAMG;IACH,KAAK,CAAC,cAAc,CAClB,cAAsB,EACtB,KAAc,EACd,IAAa,EACb,sBAAgC;QAEhC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CACrC,IAAA,gCAAqB,EAAC,cAAc,CAAC,EACrC;YACE,KAAK;YACL,IAAI;YACJ,GAAG,CAAC,sBAAsB,KAAK,SAAS,IAAI;gBAC1C,wBAAwB,EAAE,sBAAsB;aACjD,CAAC;SACH,CACF,CAAA;QACD,OAAO,QAAQ,CAAA;IACjB,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,cAAc,CAClB,cAAsB,EACtB,OAAwB,EACxB,sBAAgC;QAEhC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CACrC,IAAA,gCAAqB,EAAC,cAAc,EAAE,OAAO,CAAC,EAC9C,sBAAsB,KAAK,SAAS;YAClC,CAAC,CAAC,EAAE,wBAAwB,EAAE,sBAAsB,EAAE;YACtD,CAAC,CAAC,SAAS,CACd,CAAA;QACD,OAAO,QAAQ,CAAA;IACjB,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,eAAe,CACnB,cAAsB,EACtB,KAAc,EACd,IAAa,EACb,sBAAgC,EAChC,MAAsB;QAEtB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CACrC,IAAA,iCAAsB,EAAC,cAAc,CAAC,EACtC;YACE,KAAK;YACL,IAAI;YACJ,GAAG,CAAC,sBAAsB,KAAK,SAAS,IAAI;gBAC1C,wBAAwB,EAAE,sBAAsB;aACjD,CAAC;YACF,MAAM,EAAE,IAAA,yBAAiB,EAAC,MAAM,CAAC;SAClC,CACF,CAAA;QACD,OAAO,QAAQ,CAAA;IACjB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,4BAA4B,CAChC,OAAqC;QAErC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CACtB,IAAA,2CAAgC,GAAE,EAClC,OAAO,CACR,CAAA;IACH,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,eAAe,CACnB,OAA+B;QAE/B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CACtB,IAAA,+BAAoB,GAAE,EACtB,OAAO,CACR,CAAA;IACH,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,oBAAoB,CACxB,OAAoC;QAEpC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CACtB,IAAA,sCAA2B,GAAE,EAC7B,OAAO,CACR,CAAA;IACH,CAAC;CACF;AArHD,kCAqHC"}
|
package/lib/api/nfts.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { Chain, OpenSeaCollection } from "../types";
|
|
2
2
|
import type { Fetcher } from "./fetcher";
|
|
3
|
-
import { type GetContractResponse, type GetNFTMetadataResponse, type GetNFTResponse, type ListNFTsResponse, type TraitFilter, type ValidateMetadataResponse } from "./types";
|
|
3
|
+
import { type BatchNftsRequest, type GetContractResponse, type GetNFTMetadataResponse, type GetNFTResponse, type ListNFTsResponse, type NFTOwnersArgs, type NftAnalyticsResponse, type NftBatchResponse, type OwnersPaginatedResponse, type TraitFilter, type ValidateMetadataResponse } from "./types";
|
|
4
4
|
/**
|
|
5
5
|
* NFT-related API operations
|
|
6
6
|
*/
|
|
@@ -48,4 +48,17 @@ export declare class NFTsAPI {
|
|
|
48
48
|
* and external links.
|
|
49
49
|
*/
|
|
50
50
|
getNFTMetadata(address: string, tokenId: string, chain?: Chain): Promise<GetNFTMetadataResponse>;
|
|
51
|
+
/**
|
|
52
|
+
* Fetch multiple NFTs in a single request by chain + contract + token id.
|
|
53
|
+
*/
|
|
54
|
+
getNFTsBatch(request: BatchNftsRequest): Promise<NftBatchResponse>;
|
|
55
|
+
/**
|
|
56
|
+
* Fetch owners of an NFT. For ERC-721s this is a single owner; for
|
|
57
|
+
* ERC-1155s it can be a paginated list with per-owner quantities.
|
|
58
|
+
*/
|
|
59
|
+
getNFTOwners(address: string, identifier: string, chain?: Chain, args?: NFTOwnersArgs): Promise<OwnersPaginatedResponse>;
|
|
60
|
+
/**
|
|
61
|
+
* Fetch analytics for an NFT — historical sale points used for charting.
|
|
62
|
+
*/
|
|
63
|
+
getNFTAnalytics(address: string, identifier: string, chain?: Chain): Promise<NftAnalyticsResponse>;
|
|
51
64
|
}
|
package/lib/api/nfts.js
CHANGED
|
@@ -91,6 +91,25 @@ class NFTsAPI {
|
|
|
91
91
|
const response = await this.fetcher.get((0, apiPaths_1.getNFTMetadataPath)(chain, address, tokenId));
|
|
92
92
|
return response;
|
|
93
93
|
}
|
|
94
|
+
/**
|
|
95
|
+
* Fetch multiple NFTs in a single request by chain + contract + token id.
|
|
96
|
+
*/
|
|
97
|
+
async getNFTsBatch(request) {
|
|
98
|
+
return this.fetcher.post((0, apiPaths_1.getBatchNFTsPath)(), request);
|
|
99
|
+
}
|
|
100
|
+
/**
|
|
101
|
+
* Fetch owners of an NFT. For ERC-721s this is a single owner; for
|
|
102
|
+
* ERC-1155s it can be a paginated list with per-owner quantities.
|
|
103
|
+
*/
|
|
104
|
+
async getNFTOwners(address, identifier, chain = this.chain, args) {
|
|
105
|
+
return this.fetcher.get((0, apiPaths_1.getNFTOwnersPath)(chain, address, identifier), args);
|
|
106
|
+
}
|
|
107
|
+
/**
|
|
108
|
+
* Fetch analytics for an NFT — historical sale points used for charting.
|
|
109
|
+
*/
|
|
110
|
+
async getNFTAnalytics(address, identifier, chain = this.chain) {
|
|
111
|
+
return this.fetcher.get((0, apiPaths_1.getNFTAnalyticsPath)(chain, address, identifier));
|
|
112
|
+
}
|
|
94
113
|
}
|
|
95
114
|
exports.NFTsAPI = NFTsAPI;
|
|
96
115
|
//# sourceMappingURL=nfts.js.map
|
package/lib/api/nfts.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"nfts.js","sourceRoot":"","sources":["../../src/api/nfts.ts"],"names":[],"mappings":";;;AACA,oDAAwD;AACxD,
|
|
1
|
+
{"version":3,"file":"nfts.js","sourceRoot":"","sources":["../../src/api/nfts.ts"],"names":[],"mappings":";;;AACA,oDAAwD;AACxD,yCAamB;AAEnB,mCAcgB;AAEhB;;GAEG;AACH,MAAa,OAAO;IAER;IACA;IAFV,YACU,OAAgB,EAChB,KAAY;QADZ,YAAO,GAAP,OAAO,CAAS;QAChB,UAAK,GAAL,KAAK,CAAO;IACnB,CAAC;IAEJ;;;OAGG;IACH,KAAK,CAAC,mBAAmB,CACvB,IAAY,EACZ,QAA4B,SAAS,EACrC,OAA2B,SAAS,EACpC,SAAoC,SAAS;QAE7C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CACrC,IAAA,sCAA2B,EAAC,IAAI,CAAC,EACjC,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,IAAA,yBAAiB,EAAC,MAAM,CAAC,EAAE,CACnD,CAAA;QACD,OAAO,QAAQ,CAAA;IACjB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,iBAAiB,CACrB,OAAe,EACf,QAA4B,SAAS,EACrC,OAA2B,SAAS,EACpC,QAAe,IAAI,CAAC,KAAK;QAEzB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CACrC,IAAA,oCAAyB,EAAC,KAAK,EAAE,OAAO,CAAC,EACzC;YACE,KAAK;YACL,IAAI;SACL,CACF,CAAA;QACD,OAAO,QAAQ,CAAA;IACjB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,gBAAgB,CACpB,OAAe,EACf,QAA4B,SAAS,EACrC,OAA2B,SAAS,EACpC,KAAK,GAAG,IAAI,CAAC,KAAK;QAElB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CACrC,IAAA,mCAAwB,EAAC,KAAK,EAAE,OAAO,CAAC,EACxC;YACE,KAAK;YACL,IAAI;SACL,CACF,CAAA;QAED,OAAO,QAAQ,CAAA;IACjB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CACV,OAAe,EACf,UAAkB,EAClB,KAAK,GAAG,IAAI,CAAC,KAAK;QAElB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CACrC,IAAA,qBAAU,EAAC,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,CACvC,CAAA;QACD,OAAO,QAAQ,CAAA;IACjB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,kBAAkB,CACtB,OAAe,EACf,UAAkB,EAClB,QAAe,IAAI,CAAC,KAAK;QAEzB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CACtC,IAAA,iCAAsB,EAAC,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,EAClD,EAAE,CACH,CAAA;QAED,OAAO,QAAQ,CAAA;IACjB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,WAAW,CACf,OAAe,EACf,QAAe,IAAI,CAAC,KAAK;QAEzB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CACrC,IAAA,0BAAe,EAAC,KAAK,EAAE,OAAO,CAAC,CAChC,CAAA;QACD,OAAO,QAAQ,CAAA;IACjB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,gBAAgB,CACpB,OAAe,EACf,UAAkB,EAClB,QAAe,IAAI,CAAC,KAAK,EACzB,oBAA8B;QAE9B,IAAI,IAAI,GAAG,IAAA,kCAAuB,EAAC,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,CAAA;QAC9D,IAAI,oBAAoB,KAAK,SAAS,EAAE,CAAC;YACvC,IAAI,IAAI,yBAAyB,oBAAoB,EAAE,CAAA;QACzD,CAAC;QACD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAA2B,IAAI,CAAC,CAAA;QACxE,OAAO,QAAQ,CAAA;IACjB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,gBAAgB,CACpB,OAAe,EACf,UAAkB,EAClB,QAAe,IAAI,CAAC,KAAK;QAEzB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CACrC,IAAA,+BAAoB,EAAC,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,CACjD,CAAA;QACD,OAAO,IAAA,+BAAkB,EAAC,QAAQ,CAAC,CAAA;IACrC,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,cAAc,CAClB,OAAe,EACf,OAAe,EACf,QAAe,IAAI,CAAC,KAAK;QAEzB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CACrC,IAAA,6BAAkB,EAAC,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAC5C,CAAA;QACD,OAAO,QAAQ,CAAA;IACjB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,YAAY,CAAC,OAAyB;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAmB,IAAA,2BAAgB,GAAE,EAAE,OAAO,CAAC,CAAA;IACzE,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,YAAY,CAChB,OAAe,EACf,UAAkB,EAClB,QAAe,IAAI,CAAC,KAAK,EACzB,IAAoB;QAEpB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CACrB,IAAA,2BAAgB,EAAC,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,EAC5C,IAAI,CACL,CAAA;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,eAAe,CACnB,OAAe,EACf,UAAkB,EAClB,QAAe,IAAI,CAAC,KAAK;QAEzB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CACrB,IAAA,8BAAmB,EAAC,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,CAChD,CAAA;IACH,CAAC;CACF;AA5LD,0BA4LC"}
|
package/lib/api/offers.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { ProtocolData } from "../orders/types";
|
|
2
|
-
import {
|
|
2
|
+
import type { Chain } from "../types";
|
|
3
3
|
import type { Fetcher } from "./fetcher";
|
|
4
4
|
import type { BuildOfferResponse, CollectionOffer, GetBestOfferResponse, GetOffersResponse } from "./types";
|
|
5
5
|
/**
|
|
@@ -50,5 +50,5 @@ export declare class OffersAPI {
|
|
|
50
50
|
/**
|
|
51
51
|
* Gets all active offers for a specific NFT.
|
|
52
52
|
*/
|
|
53
|
-
|
|
53
|
+
getOffersByNFT(collectionSlug: string, identifier: string | number, limit?: number, next?: string): Promise<GetOffersResponse>;
|
|
54
54
|
}
|
package/lib/api/offers.js
CHANGED
|
@@ -2,7 +2,6 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.OffersAPI = void 0;
|
|
4
4
|
const utils_1 = require("../orders/utils");
|
|
5
|
-
const types_1 = require("../types");
|
|
6
5
|
const apiPaths_1 = require("./apiPaths");
|
|
7
6
|
/**
|
|
8
7
|
* Validates trait parameters for collection offers.
|
|
@@ -110,14 +109,8 @@ class OffersAPI {
|
|
|
110
109
|
/**
|
|
111
110
|
* Gets all active offers for a specific NFT.
|
|
112
111
|
*/
|
|
113
|
-
async
|
|
114
|
-
|
|
115
|
-
assetContractAddress,
|
|
116
|
-
tokenIds: [tokenId],
|
|
117
|
-
limit,
|
|
118
|
-
next,
|
|
119
|
-
}));
|
|
120
|
-
return response;
|
|
112
|
+
async getOffersByNFT(collectionSlug, identifier, limit, next) {
|
|
113
|
+
return this.fetcher.get((0, apiPaths_1.getOffersByNFTPath)(collectionSlug, identifier), { limit, next });
|
|
121
114
|
}
|
|
122
115
|
}
|
|
123
116
|
exports.OffersAPI = OffersAPI;
|
package/lib/api/offers.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"offers.js","sourceRoot":"","sources":["../../src/api/offers.ts"],"names":[],"mappings":";;;AACA,
|
|
1
|
+
{"version":3,"file":"offers.js","sourceRoot":"","sources":["../../src/api/offers.ts"],"names":[],"mappings":";;;AACA,2CAGwB;AAExB,yCAQmB;AASnB;;;GAGG;AACH,SAAS,mBAAmB,CAC1B,SAAkB,EAClB,UAAmB,EACnB,MAA+C,EAC/C,aAAmE;IAEnE,IAAI,MAAM,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,SAAS,IAAI,UAAU,CAAC,EAAE,CAAC;QAC7D,MAAM,IAAI,KAAK,CACb,kHAAkH,CACnH,CAAA;IACH,CAAC;IACD,IAAI,SAAS,IAAI,UAAU,EAAE,CAAC;QAC5B,IAAI,CAAC,SAAS,IAAI,CAAC,UAAU,EAAE,CAAC;YAC9B,MAAM,IAAI,KAAK,CACb,kEAAkE,CACnE,CAAA;QACH,CAAC;IACH,CAAC;IACD,IAAI,MAAM,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAChC,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC3B,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;gBAChC,MAAM,IAAI,KAAK,CACb,0DAA0D,CAC3D,CAAA;YACH,CAAC;QACH,CAAC;IACH,CAAC;IACD,IAAI,aAAa,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC9C,KAAK,MAAM,KAAK,IAAI,aAAa,EAAE,CAAC;YAClC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;gBAChB,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAA;YACpE,CAAC;YACD,IAAI,KAAK,CAAC,GAAG,KAAK,SAAS,IAAI,KAAK,CAAC,GAAG,KAAK,SAAS,EAAE,CAAC;gBACvD,MAAM,IAAI,KAAK,CACb,kBAAkB,KAAK,CAAC,IAAI,6CAA6C,CAC1E,CAAA;YACH,CAAC;YACD,IACE,KAAK,CAAC,GAAG,KAAK,SAAS;gBACvB,KAAK,CAAC,GAAG,KAAK,SAAS;gBACvB,KAAK,CAAC,GAAG,GAAG,KAAK,CAAC,GAAG,EACrB,CAAC;gBACD,MAAM,IAAI,KAAK,CACb,kBAAkB,KAAK,CAAC,IAAI,aAAa,KAAK,CAAC,GAAG,uBAAuB,KAAK,CAAC,GAAG,IAAI,CACvF,CAAA;YACH,CAAC;QACH,CAAC;IACH,CAAC;AACH,CAAC;AAED;;GAEG;AACH,MAAa,SAAS;IAEV;IACA;IAFV,YACU,OAAgB,EAChB,KAAY;QADZ,YAAO,GAAP,OAAO,CAAS;QAChB,UAAK,GAAL,KAAK,CAAO;IACnB,CAAC;IAEJ;;OAEG;IACH,KAAK,CAAC,YAAY,CAChB,cAAsB,EACtB,KAAc,EACd,IAAa;QAEb,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CACrC,IAAA,8BAAmB,EAAC,cAAc,CAAC,EACnC;YACE,KAAK;YACL,IAAI;SACL,CACF,CAAA;QACD,OAAO,QAAQ,CAAA;IACjB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,cAAc,CAClB,cAAsB,EACtB,IAAY,EACZ,KAAa,EACb,KAAc,EACd,IAAa,EACb,UAAmB,EACnB,QAAiB;QAEjB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CACrC,IAAA,6BAAkB,EAAC,cAAc,CAAC,EAClC;YACE,IAAI;YACJ,KAAK;YACL,KAAK;YACL,IAAI;YACJ,WAAW,EAAE,UAAU;YACvB,SAAS,EAAE,QAAQ;SACpB,CACF,CAAA;QACD,OAAO,QAAQ,CAAA;IACjB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,YAAY,CAChB,cAAsB,EACtB,OAAwB;QAExB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CACrC,IAAA,8BAAmB,EAAC,cAAc,EAAE,OAAO,CAAC,CAC7C,CAAA;QACD,OAAO,QAAQ,CAAA;IACjB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,UAAU,CACd,cAAsB,EACtB,QAAgB,EAChB,cAAsB,EACtB,sBAAsB,GAAG,IAAI,EAC7B,SAAkB,EAClB,UAAmB,EACnB,MAA+C,EAC/C,aAAmE;QAEnE,mBAAmB,CAAC,SAAS,EAAE,UAAU,EAAE,MAAM,EAAE,aAAa,CAAC,CAAA;QACjE,MAAM,OAAO,GAAG,IAAA,sCAA8B,EAC5C,cAAc,EACd,QAAQ,EACR,cAAc,EACd,sBAAsB,EACtB,IAAI,CAAC,KAAK,EACV,SAAS,EACT,UAAU,EACV,MAAM,EACN,aAAa,CACd,CAAA;QACD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CACtC,IAAA,4BAAiB,GAAE,EACnB,OAAO,CACR,CAAA;QACD,OAAO,QAAQ,CAAA;IACjB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,mBAAmB,CACvB,IAAY,EACZ,KAAc,EACd,IAAa;QAEb,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAC3B,IAAA,kCAAuB,EAAC,IAAI,CAAC,EAC7B;YACE,KAAK;YACL,IAAI;SACL,CACF,CAAA;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,mBAAmB,CACvB,KAAmB,EACnB,IAAY,EACZ,SAAkB,EAClB,UAAmB,EACnB,MAA+C,EAC/C,aAAmE;QAEnE,mBAAmB,CAAC,SAAS,EAAE,UAAU,EAAE,MAAM,EAAE,aAAa,CAAC,CAAA;QACjE,MAAM,OAAO,GAAG,IAAA,qCAA6B,EAC3C,IAAI,EACJ,KAAK,EACL,IAAI,CAAC,KAAK,EACV,SAAS,EACT,UAAU,EACV,MAAM,EACN,aAAa,CACd,CAAA;QACD,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAC5B,IAAA,qCAA0B,GAAE,EAC5B,OAAO,CACR,CAAA;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,cAAc,CAClB,cAAsB,EACtB,UAA2B,EAC3B,KAAc,EACd,IAAa;QAEb,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CACrB,IAAA,6BAAkB,EAAC,cAAc,EAAE,UAAU,CAAC,EAC9C,EAAE,KAAK,EAAE,IAAI,EAAE,CAChB,CAAA;IACH,CAAC;CACF;AAzJD,8BAyJC"}
|
package/lib/api/orders.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
import type { FulfillmentDataResponse,
|
|
1
|
+
import type { FulfillmentDataResponse, ProtocolData } from "../orders/types";
|
|
2
2
|
import { type Chain, OrderSide } from "../types";
|
|
3
3
|
import type { Fetcher } from "./fetcher";
|
|
4
|
-
import type { CancelOrderResponse, GetOrderByHashResponse,
|
|
4
|
+
import type { CancelOrderResponse, GetOrderByHashResponse, Listing, Offer } from "./types";
|
|
5
5
|
/**
|
|
6
6
|
* Order-related API operations
|
|
7
7
|
*/
|
|
@@ -9,38 +9,21 @@ export declare class OrdersAPI {
|
|
|
9
9
|
private fetcher;
|
|
10
10
|
private chain;
|
|
11
11
|
constructor(fetcher: Fetcher, chain: Chain);
|
|
12
|
-
/**
|
|
13
|
-
* Gets an order from API based on query options.
|
|
14
|
-
* @deprecated Use collection-based endpoints instead: getAllOffers, getAllListings, getBestOffer, getBestListing.
|
|
15
|
-
*/
|
|
16
|
-
getOrder({ side, protocol, orderDirection, orderBy, ...restOptions }: Omit<OrdersQueryOptions, "limit">): Promise<OrderV2>;
|
|
17
12
|
/**
|
|
18
13
|
* Gets a single order by its order hash.
|
|
19
14
|
* Returns the raw API response which can be either an Offer or Listing.
|
|
20
15
|
*/
|
|
21
16
|
getOrderByHash(orderHash: string, protocolAddress: string, chain?: Chain): Promise<GetOrderByHashResponse>;
|
|
22
|
-
/**
|
|
23
|
-
* Gets a list of orders from API based on query options.
|
|
24
|
-
* @deprecated Use collection-based endpoints instead: getAllOffers, getAllListings, getBestOffer, getBestListing.
|
|
25
|
-
*/
|
|
26
|
-
getOrders({ side, protocol, orderDirection, orderBy, pageSize, ...restOptions }: Omit<OrdersQueryOptions, "limit"> & {
|
|
27
|
-
pageSize?: number;
|
|
28
|
-
}): Promise<GetOrdersResponse>;
|
|
29
17
|
/**
|
|
30
18
|
* Generate the data needed to fulfill a listing or an offer onchain.
|
|
31
19
|
*/
|
|
32
20
|
generateFulfillmentData(fulfillerAddress: string, orderHash: string, protocolAddress: string, side: OrderSide, assetContractAddress?: string, tokenId?: string, unitsToFill?: string, recipientAddress?: string, includeOptionalCreatorFees?: boolean): Promise<FulfillmentDataResponse>;
|
|
33
21
|
/**
|
|
34
|
-
* Post
|
|
35
|
-
* @deprecated Use postListing or postOffer instead.
|
|
36
|
-
*/
|
|
37
|
-
postOrder(order: ProtocolData, apiOptions: OrderAPIOptions): Promise<OrderV2>;
|
|
38
|
-
/**
|
|
39
|
-
* Post a listing to OpenSea. Returns the new Listing response format.
|
|
22
|
+
* Post a listing to OpenSea.
|
|
40
23
|
*/
|
|
41
24
|
postListing(order: ProtocolData, protocolAddress: string): Promise<Listing>;
|
|
42
25
|
/**
|
|
43
|
-
* Post an offer to OpenSea.
|
|
26
|
+
* Post an offer to OpenSea.
|
|
44
27
|
*/
|
|
45
28
|
postOffer(order: ProtocolData, protocolAddress: string): Promise<Offer>;
|
|
46
29
|
/**
|
package/lib/api/orders.js
CHANGED
|
@@ -14,30 +14,6 @@ class OrdersAPI {
|
|
|
14
14
|
this.fetcher = fetcher;
|
|
15
15
|
this.chain = chain;
|
|
16
16
|
}
|
|
17
|
-
/**
|
|
18
|
-
* Gets an order from API based on query options.
|
|
19
|
-
* @deprecated Use collection-based endpoints instead: getAllOffers, getAllListings, getBestOffer, getBestListing.
|
|
20
|
-
*/
|
|
21
|
-
async getOrder({ side, protocol = "seaport", orderDirection = "desc", orderBy = "created_date", ...restOptions }) {
|
|
22
|
-
// Validate eth_price orderBy requires additional parameters
|
|
23
|
-
if (orderBy === "eth_price") {
|
|
24
|
-
const hasTokenId = (restOptions.tokenIds?.length ?? 0) > 0 ||
|
|
25
|
-
restOptions.tokenId !== undefined;
|
|
26
|
-
if (!restOptions.assetContractAddress || !hasTokenId) {
|
|
27
|
-
throw new Error('When using orderBy: "eth_price", you must provide both assetContractAddress and tokenIds (or tokenId) parameters');
|
|
28
|
-
}
|
|
29
|
-
}
|
|
30
|
-
const { orders } = await this.fetcher.get((0, apiPaths_1.getOrdersAPIPath)(this.chain, protocol, side), (0, utils_1.serializeOrdersQueryOptions)({
|
|
31
|
-
limit: 1,
|
|
32
|
-
orderBy,
|
|
33
|
-
orderDirection,
|
|
34
|
-
...restOptions,
|
|
35
|
-
}));
|
|
36
|
-
if (orders.length === 0) {
|
|
37
|
-
throw new Error("Not found: no matching order found");
|
|
38
|
-
}
|
|
39
|
-
return (0, utils_1.deserializeOrder)(orders[0]);
|
|
40
|
-
}
|
|
41
17
|
/**
|
|
42
18
|
* Gets a single order by its order hash.
|
|
43
19
|
* Returns the raw API response which can be either an Offer or Listing.
|
|
@@ -46,77 +22,17 @@ class OrdersAPI {
|
|
|
46
22
|
const response = await this.fetcher.get((0, apiPaths_1.getOrderByHashPath)(chain, protocolAddress, orderHash));
|
|
47
23
|
return response.order;
|
|
48
24
|
}
|
|
49
|
-
/**
|
|
50
|
-
* Gets a list of orders from API based on query options.
|
|
51
|
-
* @deprecated Use collection-based endpoints instead: getAllOffers, getAllListings, getBestOffer, getBestListing.
|
|
52
|
-
*/
|
|
53
|
-
async getOrders({ side, protocol = "seaport", orderDirection = "desc", orderBy = "created_date", pageSize = 20, ...restOptions }) {
|
|
54
|
-
// Validate eth_price orderBy requires additional parameters
|
|
55
|
-
if (orderBy === "eth_price") {
|
|
56
|
-
const hasTokenId = (restOptions.tokenIds?.length ?? 0) > 0 ||
|
|
57
|
-
restOptions.tokenId !== undefined;
|
|
58
|
-
if (!restOptions.assetContractAddress || !hasTokenId) {
|
|
59
|
-
throw new Error('When using orderBy: "eth_price", you must provide both assetContractAddress and tokenIds (or tokenId) parameters');
|
|
60
|
-
}
|
|
61
|
-
}
|
|
62
|
-
const response = await this.fetcher.get((0, apiPaths_1.getOrdersAPIPath)(this.chain, protocol, side), (0, utils_1.serializeOrdersQueryOptions)({
|
|
63
|
-
limit: pageSize,
|
|
64
|
-
orderBy,
|
|
65
|
-
orderDirection,
|
|
66
|
-
...restOptions,
|
|
67
|
-
}));
|
|
68
|
-
return {
|
|
69
|
-
...response,
|
|
70
|
-
orders: response.orders.map(utils_1.deserializeOrder),
|
|
71
|
-
};
|
|
72
|
-
}
|
|
73
25
|
/**
|
|
74
26
|
* Generate the data needed to fulfill a listing or an offer onchain.
|
|
75
27
|
*/
|
|
76
28
|
async generateFulfillmentData(fulfillerAddress, orderHash, protocolAddress, side, assetContractAddress, tokenId, unitsToFill, recipientAddress, includeOptionalCreatorFees = false) {
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
else {
|
|
82
|
-
payload = (0, utils_1.getFulfillOfferPayload)(fulfillerAddress, orderHash, protocolAddress, this.chain, assetContractAddress, tokenId, unitsToFill, includeOptionalCreatorFees);
|
|
83
|
-
}
|
|
84
|
-
const response = await this.fetcher.post((0, utils_1.getFulfillmentDataPath)(side), payload);
|
|
85
|
-
return response;
|
|
86
|
-
}
|
|
87
|
-
/**
|
|
88
|
-
* Post an order to OpenSea.
|
|
89
|
-
* @deprecated Use postListing or postOffer instead.
|
|
90
|
-
*/
|
|
91
|
-
async postOrder(order, apiOptions) {
|
|
92
|
-
const { protocol = "seaport", side, protocolAddress } = apiOptions;
|
|
93
|
-
// Validate required fields
|
|
94
|
-
if (!side) {
|
|
95
|
-
throw new Error("apiOptions.side is required");
|
|
96
|
-
}
|
|
97
|
-
if (!protocolAddress) {
|
|
98
|
-
throw new Error("apiOptions.protocolAddress is required");
|
|
99
|
-
}
|
|
100
|
-
if (!order) {
|
|
101
|
-
throw new Error("order data is required");
|
|
102
|
-
}
|
|
103
|
-
// Validate protocol value
|
|
104
|
-
if (protocol !== "seaport") {
|
|
105
|
-
throw new Error("Currently only 'seaport' protocol is supported");
|
|
106
|
-
}
|
|
107
|
-
// Validate side value
|
|
108
|
-
if (side !== "listing" && side !== "offer") {
|
|
109
|
-
throw new Error("side must be either 'listing' or 'offer'");
|
|
110
|
-
}
|
|
111
|
-
// Validate protocolAddress format
|
|
112
|
-
if (!/^0x[a-fA-F0-9]{40}$/.test(protocolAddress)) {
|
|
113
|
-
throw new Error("Invalid protocol address format");
|
|
114
|
-
}
|
|
115
|
-
const response = await this.fetcher.post((0, apiPaths_1.getOrdersAPIPath)(this.chain, protocol, side), { ...order, protocol_address: protocolAddress });
|
|
116
|
-
return (0, utils_1.deserializeOrder)(response.order);
|
|
29
|
+
const payload = side === types_1.OrderSide.LISTING
|
|
30
|
+
? (0, utils_1.getFulfillListingPayload)(fulfillerAddress, orderHash, protocolAddress, this.chain, assetContractAddress, tokenId, unitsToFill, recipientAddress, includeOptionalCreatorFees)
|
|
31
|
+
: (0, utils_1.getFulfillOfferPayload)(fulfillerAddress, orderHash, protocolAddress, this.chain, assetContractAddress, tokenId, unitsToFill, includeOptionalCreatorFees);
|
|
32
|
+
return this.fetcher.post((0, utils_1.getFulfillmentDataPath)(side), payload);
|
|
117
33
|
}
|
|
118
34
|
/**
|
|
119
|
-
* Post a listing to OpenSea.
|
|
35
|
+
* Post a listing to OpenSea.
|
|
120
36
|
*/
|
|
121
37
|
async postListing(order, protocolAddress) {
|
|
122
38
|
if (!order) {
|
|
@@ -125,11 +41,13 @@ class OrdersAPI {
|
|
|
125
41
|
if (!protocolAddress || !/^0x[a-fA-F0-9]{40}$/.test(protocolAddress)) {
|
|
126
42
|
throw new Error("Invalid protocol address format");
|
|
127
43
|
}
|
|
128
|
-
|
|
129
|
-
|
|
44
|
+
return this.fetcher.post((0, apiPaths_1.getPostListingPath)(this.chain, "seaport"), {
|
|
45
|
+
...order,
|
|
46
|
+
protocol_address: protocolAddress,
|
|
47
|
+
});
|
|
130
48
|
}
|
|
131
49
|
/**
|
|
132
|
-
* Post an offer to OpenSea.
|
|
50
|
+
* Post an offer to OpenSea.
|
|
133
51
|
*/
|
|
134
52
|
async postOffer(order, protocolAddress) {
|
|
135
53
|
if (!order) {
|
|
@@ -138,15 +56,16 @@ class OrdersAPI {
|
|
|
138
56
|
if (!protocolAddress || !/^0x[a-fA-F0-9]{40}$/.test(protocolAddress)) {
|
|
139
57
|
throw new Error("Invalid protocol address format");
|
|
140
58
|
}
|
|
141
|
-
|
|
142
|
-
|
|
59
|
+
return this.fetcher.post((0, apiPaths_1.getPostOfferPath)(this.chain, "seaport"), {
|
|
60
|
+
...order,
|
|
61
|
+
protocol_address: protocolAddress,
|
|
62
|
+
});
|
|
143
63
|
}
|
|
144
64
|
/**
|
|
145
65
|
* Offchain cancel an order, offer or listing, by its order hash when protected by the SignedZone.
|
|
146
66
|
*/
|
|
147
67
|
async offchainCancelOrder(protocolAddress, orderHash, chain = this.chain, offererSignature) {
|
|
148
|
-
|
|
149
|
-
return response;
|
|
68
|
+
return this.fetcher.post((0, apiPaths_1.getCancelOrderPath)(chain, protocolAddress, orderHash), { offererSignature });
|
|
150
69
|
}
|
|
151
70
|
}
|
|
152
71
|
exports.OrdersAPI = OrdersAPI;
|
package/lib/api/orders.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"orders.js","sourceRoot":"","sources":["../../src/api/orders.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"orders.js","sourceRoot":"","sources":["../../src/api/orders.ts"],"names":[],"mappings":";;;AACA,2CAIwB;AACxB,oCAAgD;AAChD,yCAKmB;AASnB;;GAEG;AACH,MAAa,SAAS;IAEV;IACA;IAFV,YACU,OAAgB,EAChB,KAAY;QADZ,YAAO,GAAP,OAAO,CAAS;QAChB,UAAK,GAAL,KAAK,CAAO;IACnB,CAAC;IAEJ;;;OAGG;IACH,KAAK,CAAC,cAAc,CAClB,SAAiB,EACjB,eAAuB,EACvB,QAAe,IAAI,CAAC,KAAK;QAEzB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAEpC,IAAA,6BAAkB,EAAC,KAAK,EAAE,eAAe,EAAE,SAAS,CAAC,CAAC,CAAA;QACzD,OAAO,QAAQ,CAAC,KAAK,CAAA;IACvB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,uBAAuB,CAC3B,gBAAwB,EACxB,SAAiB,EACjB,eAAuB,EACvB,IAAe,EACf,oBAA6B,EAC7B,OAAgB,EAChB,WAAoB,EACpB,gBAAyB,EACzB,6BAAsC,KAAK;QAE3C,MAAM,OAAO,GACX,IAAI,KAAK,iBAAS,CAAC,OAAO;YACxB,CAAC,CAAC,IAAA,gCAAwB,EACtB,gBAAgB,EAChB,SAAS,EACT,eAAe,EACf,IAAI,CAAC,KAAK,EACV,oBAAoB,EACpB,OAAO,EACP,WAAW,EACX,gBAAgB,EAChB,0BAA0B,CAC3B;YACH,CAAC,CAAC,IAAA,8BAAsB,EACpB,gBAAgB,EAChB,SAAS,EACT,eAAe,EACf,IAAI,CAAC,KAAK,EACV,oBAAoB,EACpB,OAAO,EACP,WAAW,EACX,0BAA0B,CAC3B,CAAA;QACP,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CACtB,IAAA,8BAAsB,EAAC,IAAI,CAAC,EAC5B,OAAO,CACR,CAAA;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,WAAW,CACf,KAAmB,EACnB,eAAuB;QAEvB,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAA;QAC3C,CAAC;QACD,IAAI,CAAC,eAAe,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC;YACrE,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAA;QACpD,CAAC;QAED,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CACtB,IAAA,6BAAkB,EAAC,IAAI,CAAC,KAAK,EAAE,SAAS,CAAC,EACzC;YACE,GAAG,KAAK;YACR,gBAAgB,EAAE,eAAe;SAClC,CACF,CAAA;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,SAAS,CACb,KAAmB,EACnB,eAAuB;QAEvB,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAA;QAC3C,CAAC;QACD,IAAI,CAAC,eAAe,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC;YACrE,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAA;QACpD,CAAC;QAED,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAQ,IAAA,2BAAgB,EAAC,IAAI,CAAC,KAAK,EAAE,SAAS,CAAC,EAAE;YACvE,GAAG,KAAK;YACR,gBAAgB,EAAE,eAAe;SAClC,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,mBAAmB,CACvB,eAAuB,EACvB,SAAiB,EACjB,QAAe,IAAI,CAAC,KAAK,EACzB,gBAAyB;QAEzB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CACtB,IAAA,6BAAkB,EAAC,KAAK,EAAE,eAAe,EAAE,SAAS,CAAC,EACrD,EAAE,gBAAgB,EAAE,CACrB,CAAA;IACH,CAAC;CACF;AAzHD,8BAyHC"}
|
package/lib/api/tokens.d.ts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
|
+
import type { Chain } from "../types";
|
|
1
2
|
import type { Fetcher } from "./fetcher";
|
|
2
|
-
import type { GetSwapQuoteArgs, GetSwapQuoteResponse, GetTokenGroupResponse, GetTokenGroupsArgs, GetTokenGroupsResponse, GetTokenResponse, GetTokensArgs, GetTopTokensResponse, GetTrendingTokensResponse } from "./types";
|
|
3
|
+
import type { BatchTokensRequest, GetSwapQuoteArgs, GetSwapQuoteResponse, GetTokenGroupResponse, GetTokenGroupsArgs, GetTokenGroupsResponse, GetTokenResponse, GetTokensArgs, GetTopTokensResponse, GetTrendingTokensResponse, OhlcvResponse, PriceHistoryResponse, SwapExecuteRequest, SwapExecuteResponse, TokenActivityArgs, TokenBatchResponse, TokenSwapActivityPaginatedResponse, TokenTimeSeriesArgs } from "./types";
|
|
3
4
|
/**
|
|
4
5
|
* Token-related API operations
|
|
5
6
|
*/
|
|
@@ -18,6 +19,11 @@ export declare class TokensAPI {
|
|
|
18
19
|
* Gets a swap quote.
|
|
19
20
|
*/
|
|
20
21
|
getSwapQuote(args: GetSwapQuoteArgs): Promise<GetSwapQuoteResponse>;
|
|
22
|
+
/**
|
|
23
|
+
* Get executable transactions for a token swap.
|
|
24
|
+
* Supports same-chain and cross-chain swaps with multiple from/to assets.
|
|
25
|
+
*/
|
|
26
|
+
executeSwap(request: SwapExecuteRequest): Promise<SwapExecuteResponse>;
|
|
21
27
|
/**
|
|
22
28
|
* Gets details for a specific token.
|
|
23
29
|
*/
|
|
@@ -30,4 +36,24 @@ export declare class TokensAPI {
|
|
|
30
36
|
* Gets a single token group by its slug.
|
|
31
37
|
*/
|
|
32
38
|
getTokenGroup(slug: string): Promise<GetTokenGroupResponse>;
|
|
39
|
+
/**
|
|
40
|
+
* Fetch multiple tokens in a single request by chain + contract address.
|
|
41
|
+
*/
|
|
42
|
+
getTokensBatch(request: BatchTokensRequest): Promise<TokenBatchResponse>;
|
|
43
|
+
/**
|
|
44
|
+
* Fetch the price history of a token. `start_time` is required and the
|
|
45
|
+
* default `end_time` is "now".
|
|
46
|
+
*/
|
|
47
|
+
getTokenPriceHistory(chain: Chain, address: string, args: TokenTimeSeriesArgs): Promise<PriceHistoryResponse>;
|
|
48
|
+
/**
|
|
49
|
+
* Fetch OHLCV (open / high / low / close / volume) candles for a token.
|
|
50
|
+
* `start_time` and `bucket_size` are required.
|
|
51
|
+
*/
|
|
52
|
+
getTokenOhlcv(chain: Chain, address: string, args: TokenTimeSeriesArgs & {
|
|
53
|
+
bucket_size: string;
|
|
54
|
+
}): Promise<OhlcvResponse>;
|
|
55
|
+
/**
|
|
56
|
+
* Fetch recent swap activity for a token.
|
|
57
|
+
*/
|
|
58
|
+
getTokenActivity(chain: Chain, address: string, args?: TokenActivityArgs): Promise<TokenSwapActivityPaginatedResponse>;
|
|
33
59
|
}
|
package/lib/api/tokens.js
CHANGED
|
@@ -31,6 +31,13 @@ class TokensAPI {
|
|
|
31
31
|
const response = await this.fetcher.get((0, apiPaths_1.getSwapQuotePath)(), args);
|
|
32
32
|
return response;
|
|
33
33
|
}
|
|
34
|
+
/**
|
|
35
|
+
* Get executable transactions for a token swap.
|
|
36
|
+
* Supports same-chain and cross-chain swaps with multiple from/to assets.
|
|
37
|
+
*/
|
|
38
|
+
async executeSwap(request) {
|
|
39
|
+
return this.fetcher.post((0, apiPaths_1.getSwapExecutePath)(), request);
|
|
40
|
+
}
|
|
34
41
|
/**
|
|
35
42
|
* Gets details for a specific token.
|
|
36
43
|
*/
|
|
@@ -50,6 +57,32 @@ class TokensAPI {
|
|
|
50
57
|
async getTokenGroup(slug) {
|
|
51
58
|
return this.fetcher.get((0, apiPaths_1.getTokenGroupPath)(slug));
|
|
52
59
|
}
|
|
60
|
+
/**
|
|
61
|
+
* Fetch multiple tokens in a single request by chain + contract address.
|
|
62
|
+
*/
|
|
63
|
+
async getTokensBatch(request) {
|
|
64
|
+
return this.fetcher.post((0, apiPaths_1.getBatchTokensPath)(), request);
|
|
65
|
+
}
|
|
66
|
+
/**
|
|
67
|
+
* Fetch the price history of a token. `start_time` is required and the
|
|
68
|
+
* default `end_time` is "now".
|
|
69
|
+
*/
|
|
70
|
+
async getTokenPriceHistory(chain, address, args) {
|
|
71
|
+
return this.fetcher.get((0, apiPaths_1.getTokenPriceHistoryPath)(chain, address), args);
|
|
72
|
+
}
|
|
73
|
+
/**
|
|
74
|
+
* Fetch OHLCV (open / high / low / close / volume) candles for a token.
|
|
75
|
+
* `start_time` and `bucket_size` are required.
|
|
76
|
+
*/
|
|
77
|
+
async getTokenOhlcv(chain, address, args) {
|
|
78
|
+
return this.fetcher.get((0, apiPaths_1.getTokenOhlcvPath)(chain, address), args);
|
|
79
|
+
}
|
|
80
|
+
/**
|
|
81
|
+
* Fetch recent swap activity for a token.
|
|
82
|
+
*/
|
|
83
|
+
async getTokenActivity(chain, address, args) {
|
|
84
|
+
return this.fetcher.get((0, apiPaths_1.getTokenActivityPath)(chain, address), args);
|
|
85
|
+
}
|
|
53
86
|
}
|
|
54
87
|
exports.TokensAPI = TokensAPI;
|
|
55
88
|
//# sourceMappingURL=tokens.js.map
|
package/lib/api/tokens.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"tokens.js","sourceRoot":"","sources":["../../src/api/tokens.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"tokens.js","sourceRoot":"","sources":["../../src/api/tokens.ts"],"names":[],"mappings":";;;AACA,yCAYmB;AAuBnB;;GAEG;AACH,MAAa,SAAS;IACA;IAApB,YAAoB,OAAgB;QAAhB,YAAO,GAAP,OAAO,CAAS;IAAG,CAAC;IAExC;;OAEG;IACH,KAAK,CAAC,iBAAiB,CACrB,IAAoB;QAEpB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CACrC,IAAA,gCAAqB,GAAE,EACvB,IAAI,CACL,CAAA;QACD,OAAO,QAAQ,CAAA;IACjB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,YAAY,CAAC,IAAoB;QACrC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CACrC,IAAA,2BAAgB,GAAE,EAClB,IAAI,CACL,CAAA;QACD,OAAO,QAAQ,CAAA;IACjB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,YAAY,CAAC,IAAsB;QACvC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CACrC,IAAA,2BAAgB,GAAE,EAClB,IAAI,CACL,CAAA;QACD,OAAO,QAAQ,CAAA;IACjB,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,WAAW,CAAC,OAA2B;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAsB,IAAA,6BAAkB,GAAE,EAAE,OAAO,CAAC,CAAA;IAC9E,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,QAAQ,CAAC,KAAa,EAAE,OAAe;QAC3C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CACrC,IAAA,uBAAY,EAAC,KAAK,EAAE,OAAO,CAAC,CAC7B,CAAA;QACD,OAAO,QAAQ,CAAA;IACjB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,cAAc,CAClB,IAAyB;QAEzB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAyB,IAAA,6BAAkB,GAAE,EAAE,IAAI,CAAC,CAAA;IAC7E,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,aAAa,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAwB,IAAA,4BAAiB,EAAC,IAAI,CAAC,CAAC,CAAA;IACzE,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,cAAc,CAClB,OAA2B;QAE3B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAqB,IAAA,6BAAkB,GAAE,EAAE,OAAO,CAAC,CAAA;IAC7E,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,oBAAoB,CACxB,KAAY,EACZ,OAAe,EACf,IAAyB;QAEzB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CACrB,IAAA,mCAAwB,EAAC,KAAK,EAAE,OAAO,CAAC,EACxC,IAAI,CACL,CAAA;IACH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,aAAa,CACjB,KAAY,EACZ,OAAe,EACf,IAAmD;QAEnD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CACrB,IAAA,4BAAiB,EAAC,KAAK,EAAE,OAAO,CAAC,EACjC,IAAI,CACL,CAAA;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,gBAAgB,CACpB,KAAY,EACZ,OAAe,EACf,IAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CACrB,IAAA,+BAAoB,EAAC,KAAK,EAAE,OAAO,CAAC,EACpC,IAAI,CACL,CAAA;IACH,CAAC;CACF;AA5HD,8BA4HC"}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import type { Fetcher } from "./fetcher";
|
|
2
|
+
import type { TransactionReceiptRequest, TransactionReceiptResponse } from "./types";
|
|
3
|
+
/**
|
|
4
|
+
* Transaction-related API operations
|
|
5
|
+
*/
|
|
6
|
+
export declare class TransactionsAPI {
|
|
7
|
+
private fetcher;
|
|
8
|
+
constructor(fetcher: Fetcher);
|
|
9
|
+
/**
|
|
10
|
+
* Get the receipt/status for a submitted transaction.
|
|
11
|
+
* Works for all transaction types: listing fulfillments, cross-chain buys,
|
|
12
|
+
* sweeps, offer fulfillments, and token swaps. Poll this endpoint to check
|
|
13
|
+
* completion status.
|
|
14
|
+
*/
|
|
15
|
+
getTransactionReceipt(request: TransactionReceiptRequest): Promise<TransactionReceiptResponse>;
|
|
16
|
+
}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.TransactionsAPI = void 0;
|
|
4
|
+
const apiPaths_1 = require("./apiPaths");
|
|
5
|
+
/**
|
|
6
|
+
* Transaction-related API operations
|
|
7
|
+
*/
|
|
8
|
+
class TransactionsAPI {
|
|
9
|
+
fetcher;
|
|
10
|
+
constructor(fetcher) {
|
|
11
|
+
this.fetcher = fetcher;
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* Get the receipt/status for a submitted transaction.
|
|
15
|
+
* Works for all transaction types: listing fulfillments, cross-chain buys,
|
|
16
|
+
* sweeps, offer fulfillments, and token swaps. Poll this endpoint to check
|
|
17
|
+
* completion status.
|
|
18
|
+
*/
|
|
19
|
+
async getTransactionReceipt(request) {
|
|
20
|
+
return this.fetcher.post((0, apiPaths_1.getTransactionReceiptPath)(), request);
|
|
21
|
+
}
|
|
22
|
+
}
|
|
23
|
+
exports.TransactionsAPI = TransactionsAPI;
|
|
24
|
+
//# sourceMappingURL=transactions.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"transactions.js","sourceRoot":"","sources":["../../src/api/transactions.ts"],"names":[],"mappings":";;;AAAA,yCAAsD;AAOtD;;GAEG;AACH,MAAa,eAAe;IACN;IAApB,YAAoB,OAAgB;QAAhB,YAAO,GAAP,OAAO,CAAS;IAAG,CAAC;IAExC;;;;;OAKG;IACH,KAAK,CAAC,qBAAqB,CACzB,OAAkC;QAElC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CACtB,IAAA,oCAAyB,GAAE,EAC3B,OAAO,CACR,CAAA;IACH,CAAC;CACF;AAjBD,0CAiBC"}
|