@opensea/sdk 10.4.0 → 11.0.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 +72 -5
- package/lib/api/accounts.js.map +1 -1
- package/lib/api/api.d.ts +116 -9
- package/lib/api/api.js +186 -17
- package/lib/api/api.js.map +1 -1
- package/lib/api/apiPaths.d.ts +22 -0
- package/lib/api/apiPaths.js +97 -1
- 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 +33 -15
- 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/fetcher.d.ts +35 -5
- package/lib/api/listings.d.ts +8 -1
- package/lib/api/listings.js +12 -3
- package/lib/api/listings.js.map +1 -1
- package/lib/api/nfts.d.ts +15 -2
- package/lib/api/nfts.js +21 -5
- package/lib/api/nfts.js.map +1 -1
- package/lib/api/offers.d.ts +11 -0
- package/lib/api/offers.js +14 -11
- package/lib/api/offers.js.map +1 -1
- package/lib/api/orders.d.ts +16 -1
- package/lib/api/orders.js +17 -3
- package/lib/api/orders.js.map +1 -1
- package/lib/api/tokens.d.ts +22 -1
- package/lib/api/tokens.js +26 -0
- package/lib/api/tokens.js.map +1 -1
- package/lib/api/types.d.ts +296 -341
- package/lib/api/types.js +2 -1
- package/lib/api/types.js.map +1 -1
- package/lib/orders/types.d.ts +2 -2
- package/lib/orders/utils.d.ts +53 -13
- package/lib/orders/utils.js +33 -50
- package/lib/orders/utils.js.map +1 -1
- package/lib/sdk/base.d.ts +11 -4
- package/lib/sdk/base.js +4 -4
- package/lib/sdk/base.js.map +1 -1
- package/lib/sdk/cancellation.d.ts +3 -1
- package/lib/sdk/cancellation.js +12 -6
- package/lib/sdk/cancellation.js.map +1 -1
- package/lib/sdk/fulfillment.js +7 -4
- package/lib/sdk/fulfillment.js.map +1 -1
- package/lib/sdk/orders.js +1 -1
- package/lib/sdk/orders.js.map +1 -1
- package/lib/types.d.ts +22 -122
- package/lib/types.js.map +1 -1
- package/lib/utils/case.d.ts +63 -0
- package/lib/utils/case.js +83 -0
- package/lib/utils/case.js.map +1 -0
- package/lib/utils/utils.d.ts +0 -1
- package/lib/utils/utils.js +0 -1
- package/lib/utils/utils.js.map +1 -1
- package/package.json +2 -2
- package/src/api/accounts.ts +141 -5
- package/src/api/api.ts +328 -23
- package/src/api/apiPaths.ts +112 -0
- package/src/api/assets.ts +22 -0
- package/src/api/collections.ts +71 -20
- package/src/api/drops.ts +34 -1
- package/src/api/fetcher.ts +41 -6
- package/src/api/listings.ts +21 -3
- package/src/api/nfts.ts +47 -7
- package/src/api/offers.ts +17 -10
- package/src/api/orders.ts +29 -5
- package/src/api/tokens.ts +65 -0
- package/src/api/types.ts +382 -354
- package/src/orders/types.ts +2 -2
- package/src/orders/utils.ts +57 -79
- package/src/sdk/base.ts +4 -4
- package/src/sdk/cancellation.ts +16 -6
- package/src/sdk/fulfillment.ts +7 -6
- package/src/sdk/orders.ts +1 -1
- package/src/types.ts +33 -120
- package/src/utils/case.ts +150 -0
- package/src/utils/utils.ts +0 -1
- package/lib/utils/converters.d.ts +0 -37
- package/lib/utils/converters.js +0 -137
- package/lib/utils/converters.js.map +0 -1
- package/src/utils/converters.ts +0 -145
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,sBAAsB;aACvB,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,sBAAsB,EAAE;YAC5B,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,sBAAsB;aACvB,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
|
*/
|
|
@@ -28,7 +28,7 @@ export declare class NFTsAPI {
|
|
|
28
28
|
/**
|
|
29
29
|
* Force refresh the metadata for an NFT.
|
|
30
30
|
*/
|
|
31
|
-
refreshNFTMetadata(address: string, identifier: string, chain?: Chain): Promise<
|
|
31
|
+
refreshNFTMetadata(address: string, identifier: string, chain?: Chain): Promise<Record<string, unknown>>;
|
|
32
32
|
/**
|
|
33
33
|
* Fetch smart contract information for a given chain and address.
|
|
34
34
|
*/
|
|
@@ -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
|
@@ -1,7 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.NFTsAPI = void 0;
|
|
4
|
-
const converters_1 = require("../utils/converters");
|
|
5
4
|
const apiPaths_1 = require("./apiPaths");
|
|
6
5
|
const types_1 = require("./types");
|
|
7
6
|
/**
|
|
@@ -53,8 +52,7 @@ class NFTsAPI {
|
|
|
53
52
|
* Force refresh the metadata for an NFT.
|
|
54
53
|
*/
|
|
55
54
|
async refreshNFTMetadata(address, identifier, chain = this.chain) {
|
|
56
|
-
|
|
57
|
-
return response;
|
|
55
|
+
return this.fetcher.post((0, apiPaths_1.getRefreshMetadataPath)(chain, address, identifier), {});
|
|
58
56
|
}
|
|
59
57
|
/**
|
|
60
58
|
* Fetch smart contract information for a given chain and address.
|
|
@@ -80,8 +78,7 @@ class NFTsAPI {
|
|
|
80
78
|
* which collection the NFT belongs to.
|
|
81
79
|
*/
|
|
82
80
|
async getNFTCollection(address, identifier, chain = this.chain) {
|
|
83
|
-
|
|
84
|
-
return (0, converters_1.collectionFromJSON)(response);
|
|
81
|
+
return this.fetcher.get((0, apiPaths_1.getNFTCollectionPath)(chain, address, identifier));
|
|
85
82
|
}
|
|
86
83
|
/**
|
|
87
84
|
* Get detailed metadata for an NFT including name, description, image, traits,
|
|
@@ -91,6 +88,25 @@ class NFTsAPI {
|
|
|
91
88
|
const response = await this.fetcher.get((0, apiPaths_1.getNFTMetadataPath)(chain, address, tokenId));
|
|
92
89
|
return response;
|
|
93
90
|
}
|
|
91
|
+
/**
|
|
92
|
+
* Fetch multiple NFTs in a single request by chain + contract + token id.
|
|
93
|
+
*/
|
|
94
|
+
async getNFTsBatch(request) {
|
|
95
|
+
return this.fetcher.post((0, apiPaths_1.getBatchNFTsPath)(), request);
|
|
96
|
+
}
|
|
97
|
+
/**
|
|
98
|
+
* Fetch owners of an NFT. For ERC-721s this is a single owner; for
|
|
99
|
+
* ERC-1155s it can be a paginated list with per-owner quantities.
|
|
100
|
+
*/
|
|
101
|
+
async getNFTOwners(address, identifier, chain = this.chain, args) {
|
|
102
|
+
return this.fetcher.get((0, apiPaths_1.getNFTOwnersPath)(chain, address, identifier), args);
|
|
103
|
+
}
|
|
104
|
+
/**
|
|
105
|
+
* Fetch analytics for an NFT — historical sale points used for charting.
|
|
106
|
+
*/
|
|
107
|
+
async getNFTAnalytics(address, identifier, chain = this.chain) {
|
|
108
|
+
return this.fetcher.get((0, apiPaths_1.getNFTAnalyticsPath)(chain, address, identifier));
|
|
109
|
+
}
|
|
94
110
|
}
|
|
95
111
|
exports.NFTsAPI = NFTsAPI;
|
|
96
112
|
//# 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,
|
|
1
|
+
{"version":3,"file":"nfts.js","sourceRoot":"","sources":["../../src/api/nfts.ts"],"names":[],"mappings":";;;AACA,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,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CACtB,IAAA,iCAAsB,EAAC,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,EAClD,EAAE,CACH,CAAA;IACH,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,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CACrB,IAAA,+BAAoB,EAAC,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,CACjD,CAAA;IACH,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;AAzLD,0BAyLC"}
|
package/lib/api/offers.d.ts
CHANGED
|
@@ -23,6 +23,12 @@ export declare class OffersAPI {
|
|
|
23
23
|
getBestOffer(collectionSlug: string, tokenId: string | number): Promise<GetBestOfferResponse>;
|
|
24
24
|
/**
|
|
25
25
|
* Build a OpenSea collection offer.
|
|
26
|
+
*
|
|
27
|
+
* The body uses mixed casing per the OpenSea OpenAPI spec: the outer
|
|
28
|
+
* envelope (`protocol_address`, `offer_protection_enabled`) is snake_case,
|
|
29
|
+
* but `criteria.numericTraits` keeps its camelCase key on the wire per
|
|
30
|
+
* the {@link CriteriaObject} schema. Opt out of automatic snakeize and
|
|
31
|
+
* emit the body in exact wire shape.
|
|
26
32
|
*/
|
|
27
33
|
buildOffer(offererAddress: string, quantity: number, collectionSlug: string, offerProtectionEnabled?: boolean, traitType?: string, traitValue?: string, traits?: Array<{
|
|
28
34
|
type: string;
|
|
@@ -38,6 +44,11 @@ export declare class OffersAPI {
|
|
|
38
44
|
getCollectionOffers(slug: string, limit?: number, next?: string): Promise<GetOffersResponse>;
|
|
39
45
|
/**
|
|
40
46
|
* Post a collection offer to OpenSea.
|
|
47
|
+
*
|
|
48
|
+
* Mixed-casing body: outer `protocol_address`, `protocol_data` are
|
|
49
|
+
* snake_case, but `protocol_data.parameters` (Seaport struct) and
|
|
50
|
+
* `criteria.numericTraits` keep their camelCase keys on the wire. Opt out
|
|
51
|
+
* of automatic snakeize and emit the body in exact wire shape.
|
|
41
52
|
*/
|
|
42
53
|
postCollectionOffer(order: ProtocolData, slug: string, traitType?: string, traitValue?: string, traits?: Array<{
|
|
43
54
|
type: string;
|
package/lib/api/offers.js
CHANGED
|
@@ -63,15 +63,7 @@ class OffersAPI {
|
|
|
63
63
|
* Gets trait offers for a given collection.
|
|
64
64
|
*/
|
|
65
65
|
async getTraitOffers(collectionSlug, type, value, limit, next, floatValue, intValue) {
|
|
66
|
-
|
|
67
|
-
type,
|
|
68
|
-
value,
|
|
69
|
-
limit,
|
|
70
|
-
next,
|
|
71
|
-
float_value: floatValue,
|
|
72
|
-
int_value: intValue,
|
|
73
|
-
});
|
|
74
|
-
return response;
|
|
66
|
+
return this.fetcher.get((0, apiPaths_1.getTraitOffersPath)(collectionSlug), { type, value, limit, next, floatValue, intValue });
|
|
75
67
|
}
|
|
76
68
|
/**
|
|
77
69
|
* Gets the best offer for a given token.
|
|
@@ -82,11 +74,17 @@ class OffersAPI {
|
|
|
82
74
|
}
|
|
83
75
|
/**
|
|
84
76
|
* Build a OpenSea collection offer.
|
|
77
|
+
*
|
|
78
|
+
* The body uses mixed casing per the OpenSea OpenAPI spec: the outer
|
|
79
|
+
* envelope (`protocol_address`, `offer_protection_enabled`) is snake_case,
|
|
80
|
+
* but `criteria.numericTraits` keeps its camelCase key on the wire per
|
|
81
|
+
* the {@link CriteriaObject} schema. Opt out of automatic snakeize and
|
|
82
|
+
* emit the body in exact wire shape.
|
|
85
83
|
*/
|
|
86
84
|
async buildOffer(offererAddress, quantity, collectionSlug, offerProtectionEnabled = true, traitType, traitValue, traits, numericTraits) {
|
|
87
85
|
validateTraitParams(traitType, traitValue, traits, numericTraits);
|
|
88
86
|
const payload = (0, utils_1.getBuildCollectionOfferPayload)(offererAddress, quantity, collectionSlug, offerProtectionEnabled, this.chain, traitType, traitValue, traits, numericTraits);
|
|
89
|
-
const response = await this.fetcher.post((0, apiPaths_1.getBuildOfferPath)(), payload);
|
|
87
|
+
const response = await this.fetcher.post((0, apiPaths_1.getBuildOfferPath)(), payload, undefined, { snakeizeBody: false });
|
|
90
88
|
return response;
|
|
91
89
|
}
|
|
92
90
|
/**
|
|
@@ -100,11 +98,16 @@ class OffersAPI {
|
|
|
100
98
|
}
|
|
101
99
|
/**
|
|
102
100
|
* Post a collection offer to OpenSea.
|
|
101
|
+
*
|
|
102
|
+
* Mixed-casing body: outer `protocol_address`, `protocol_data` are
|
|
103
|
+
* snake_case, but `protocol_data.parameters` (Seaport struct) and
|
|
104
|
+
* `criteria.numericTraits` keep their camelCase keys on the wire. Opt out
|
|
105
|
+
* of automatic snakeize and emit the body in exact wire shape.
|
|
103
106
|
*/
|
|
104
107
|
async postCollectionOffer(order, slug, traitType, traitValue, traits, numericTraits) {
|
|
105
108
|
validateTraitParams(traitType, traitValue, traits, numericTraits);
|
|
106
109
|
const payload = (0, utils_1.getPostCollectionOfferPayload)(slug, order, this.chain, traitType, traitValue, traits, numericTraits);
|
|
107
|
-
return await this.fetcher.post((0, apiPaths_1.getPostCollectionOfferPath)(), payload);
|
|
110
|
+
return await this.fetcher.post((0, apiPaths_1.getPostCollectionOfferPath)(), payload, undefined, { snakeizeBody: false });
|
|
108
111
|
}
|
|
109
112
|
/**
|
|
110
113
|
* Gets all active offers for a specific NFT.
|
package/lib/api/offers.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
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,
|
|
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,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CACrB,IAAA,6BAAkB,EAAC,cAAc,CAAC,EAClC,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,CACnD,CAAA;IACH,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;;;;;;;;OAQG;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,EACP,SAAS,EACT,EAAE,YAAY,EAAE,KAAK,EAAE,CACxB,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;;;;;;;OAOG;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,EACP,SAAS,EACT,EAAE,YAAY,EAAE,KAAK,EAAE,CACxB,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;AAhKD,8BAgKC"}
|
package/lib/api/orders.d.ts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import type { FulfillmentDataResponse, ProtocolData } from "../orders/types";
|
|
2
2
|
import { type Chain, OrderSide } from "../types";
|
|
3
|
+
import type { Camelize } from "../utils/case";
|
|
3
4
|
import type { Fetcher } from "./fetcher";
|
|
4
5
|
import type { CancelOrderResponse, GetOrderByHashResponse, Listing, Offer } from "./types";
|
|
5
6
|
/**
|
|
@@ -17,17 +18,31 @@ export declare class OrdersAPI {
|
|
|
17
18
|
/**
|
|
18
19
|
* Generate the data needed to fulfill a listing or an offer onchain.
|
|
19
20
|
*/
|
|
20
|
-
generateFulfillmentData(fulfillerAddress: string, orderHash: string, protocolAddress: string, side: OrderSide, assetContractAddress?: string, tokenId?: string, unitsToFill?: string, recipientAddress?: string, includeOptionalCreatorFees?: boolean): Promise<FulfillmentDataResponse
|
|
21
|
+
generateFulfillmentData(fulfillerAddress: string, orderHash: string, protocolAddress: string, side: OrderSide, assetContractAddress?: string, tokenId?: string, unitsToFill?: string, recipientAddress?: string, includeOptionalCreatorFees?: boolean): Promise<Camelize<FulfillmentDataResponse>>;
|
|
21
22
|
/**
|
|
22
23
|
* Post a listing to OpenSea.
|
|
24
|
+
*
|
|
25
|
+
* The body uses mixed casing per the OpenSea OpenAPI spec: the outer
|
|
26
|
+
* envelope (`protocol_address`) is snake_case, but the inner Seaport
|
|
27
|
+
* struct (`parameters.startTime`, `parameters.orderType`, `offer[].itemType`,
|
|
28
|
+
* etc.) mirrors the on-chain struct names and must stay camelCase on the
|
|
29
|
+
* wire. We pass `snakeizeBody: false` and emit the body in exact wire shape.
|
|
23
30
|
*/
|
|
24
31
|
postListing(order: ProtocolData, protocolAddress: string): Promise<Listing>;
|
|
25
32
|
/**
|
|
26
33
|
* Post an offer to OpenSea.
|
|
34
|
+
*
|
|
35
|
+
* Same mixed-casing wire shape as {@link postListing}: outer
|
|
36
|
+
* `protocol_address` is snake_case but the inner Seaport struct stays
|
|
37
|
+
* camelCase. We opt out of automatic snakeize so `parameters` is sent
|
|
38
|
+
* verbatim.
|
|
27
39
|
*/
|
|
28
40
|
postOffer(order: ProtocolData, protocolAddress: string): Promise<Offer>;
|
|
29
41
|
/**
|
|
30
42
|
* Offchain cancel an order, offer or listing, by its order hash when protected by the SignedZone.
|
|
43
|
+
*
|
|
44
|
+
* The OpenSea OpenAPI `CancelRequest` schema uses camelCase
|
|
45
|
+
* `offererSignature`, so we opt out of automatic snakeize.
|
|
31
46
|
*/
|
|
32
47
|
offchainCancelOrder(protocolAddress: string, orderHash: string, chain?: Chain, offererSignature?: string): Promise<CancelOrderResponse>;
|
|
33
48
|
}
|
package/lib/api/orders.js
CHANGED
|
@@ -33,6 +33,12 @@ class OrdersAPI {
|
|
|
33
33
|
}
|
|
34
34
|
/**
|
|
35
35
|
* Post a listing to OpenSea.
|
|
36
|
+
*
|
|
37
|
+
* The body uses mixed casing per the OpenSea OpenAPI spec: the outer
|
|
38
|
+
* envelope (`protocol_address`) is snake_case, but the inner Seaport
|
|
39
|
+
* struct (`parameters.startTime`, `parameters.orderType`, `offer[].itemType`,
|
|
40
|
+
* etc.) mirrors the on-chain struct names and must stay camelCase on the
|
|
41
|
+
* wire. We pass `snakeizeBody: false` and emit the body in exact wire shape.
|
|
36
42
|
*/
|
|
37
43
|
async postListing(order, protocolAddress) {
|
|
38
44
|
if (!order) {
|
|
@@ -44,10 +50,15 @@ class OrdersAPI {
|
|
|
44
50
|
return this.fetcher.post((0, apiPaths_1.getPostListingPath)(this.chain, "seaport"), {
|
|
45
51
|
...order,
|
|
46
52
|
protocol_address: protocolAddress,
|
|
47
|
-
});
|
|
53
|
+
}, undefined, { snakeizeBody: false });
|
|
48
54
|
}
|
|
49
55
|
/**
|
|
50
56
|
* Post an offer to OpenSea.
|
|
57
|
+
*
|
|
58
|
+
* Same mixed-casing wire shape as {@link postListing}: outer
|
|
59
|
+
* `protocol_address` is snake_case but the inner Seaport struct stays
|
|
60
|
+
* camelCase. We opt out of automatic snakeize so `parameters` is sent
|
|
61
|
+
* verbatim.
|
|
51
62
|
*/
|
|
52
63
|
async postOffer(order, protocolAddress) {
|
|
53
64
|
if (!order) {
|
|
@@ -59,13 +70,16 @@ class OrdersAPI {
|
|
|
59
70
|
return this.fetcher.post((0, apiPaths_1.getPostOfferPath)(this.chain, "seaport"), {
|
|
60
71
|
...order,
|
|
61
72
|
protocol_address: protocolAddress,
|
|
62
|
-
});
|
|
73
|
+
}, undefined, { snakeizeBody: false });
|
|
63
74
|
}
|
|
64
75
|
/**
|
|
65
76
|
* Offchain cancel an order, offer or listing, by its order hash when protected by the SignedZone.
|
|
77
|
+
*
|
|
78
|
+
* The OpenSea OpenAPI `CancelRequest` schema uses camelCase
|
|
79
|
+
* `offererSignature`, so we opt out of automatic snakeize.
|
|
66
80
|
*/
|
|
67
81
|
async offchainCancelOrder(protocolAddress, orderHash, chain = this.chain, offererSignature) {
|
|
68
|
-
return this.fetcher.post((0, apiPaths_1.getCancelOrderPath)(chain, protocolAddress, orderHash), { offererSignature });
|
|
82
|
+
return this.fetcher.post((0, apiPaths_1.getCancelOrderPath)(chain, protocolAddress, orderHash), { offererSignature }, undefined, { snakeizeBody: false });
|
|
69
83
|
}
|
|
70
84
|
}
|
|
71
85
|
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":";;;AACA,2CAIwB;AACxB,oCAAgD;
|
|
1
|
+
{"version":3,"file":"orders.js","sourceRoot":"","sources":["../../src/api/orders.ts"],"names":[],"mappings":";;;AACA,2CAIwB;AACxB,oCAAgD;AAEhD,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;;;;;;;;OAQG;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,EACD,SAAS,EACT,EAAE,YAAY,EAAE,KAAK,EAAE,CACxB,CAAA;IACH,CAAC;IAED;;;;;;;OAOG;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,CACtB,IAAA,2BAAgB,EAAC,IAAI,CAAC,KAAK,EAAE,SAAS,CAAC,EACvC;YACE,GAAG,KAAK;YACR,gBAAgB,EAAE,eAAe;SAClC,EACD,SAAS,EACT,EAAE,YAAY,EAAE,KAAK,EAAE,CACxB,CAAA;IACH,CAAC;IAED;;;;;OAKG;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,EACpB,SAAS,EACT,EAAE,YAAY,EAAE,KAAK,EAAE,CACxB,CAAA;IACH,CAAC;CACF;AAhJD,8BAgJC"}
|
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, SwapExecuteRequest, SwapExecuteResponse } 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
|
*/
|
|
@@ -35,4 +36,24 @@ export declare class TokensAPI {
|
|
|
35
36
|
* Gets a single token group by its slug.
|
|
36
37
|
*/
|
|
37
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
|
+
* `startTime` and `bucketSize` are required.
|
|
51
|
+
*/
|
|
52
|
+
getTokenOhlcv(chain: Chain, address: string, args: TokenTimeSeriesArgs & {
|
|
53
|
+
bucketSize: string;
|
|
54
|
+
}): Promise<OhlcvResponse>;
|
|
55
|
+
/**
|
|
56
|
+
* Fetch recent swap activity for a token.
|
|
57
|
+
*/
|
|
58
|
+
getTokenActivity(chain: Chain, address: string, args?: TokenActivityArgs): Promise<TokenSwapActivityPaginatedResponse>;
|
|
38
59
|
}
|
package/lib/api/tokens.js
CHANGED
|
@@ -57,6 +57,32 @@ class TokensAPI {
|
|
|
57
57
|
async getTokenGroup(slug) {
|
|
58
58
|
return this.fetcher.get((0, apiPaths_1.getTokenGroupPath)(slug));
|
|
59
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
|
+
* `startTime` and `bucketSize` 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
|
+
}
|
|
60
86
|
}
|
|
61
87
|
exports.TokensAPI = TokensAPI;
|
|
62
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,IAAkD;QAElD,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"}
|