opensea-js 7.3.3 → 8.0.0

package/README.md

@@ -24,6 +24,7 @@ Happy seafaring! ⛵️
 
 - [Quick Start Guide](developerDocs/quick-start.md)
 - [Getting Started Guide](developerDocs/getting-started.md)
+- [API Reference](developerDocs/api-reference.md)
 - [Advanced Use Cases](developerDocs/advanced-use-cases.md)
 - [SDK Reference](https://projectopensea.github.io/opensea-js/)
 - [Frequently Asked Questions](developerDocs/faq.md)

package/lib/api/accounts.d.ts

@@ -0,0 +1,18 @@
+import { Fetcher } from "./fetcher";
+import { Chain, OpenSeaAccount, OpenSeaPaymentToken } from "../types";
+/**
+ * Account and payment token related API operations
+ */
+export declare class AccountsAPI {
+    private fetcher;
+    private chain;
+    constructor(fetcher: Fetcher, chain: Chain);
+    /**
+     * Fetch a payment token.
+     */
+    getPaymentToken(address: string, chain?: Chain): Promise<OpenSeaPaymentToken>;
+    /**
+     * Fetch account for an address.
+     */
+    getAccount(address: string): Promise<OpenSeaAccount>;
+}

package/lib/api/accounts.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AccountsAPI = void 0;
+const apiPaths_1 = require("./apiPaths");
+const converters_1 = require("../utils/converters");
+/**
+ * Account and payment token related API operations
+ */
+class AccountsAPI {
+    constructor(fetcher, chain) {
+        this.fetcher = fetcher;
+        this.chain = chain;
+    }
+    /**
+     * Fetch a payment token.
+     */
+    async getPaymentToken(address, chain = this.chain) {
+        const json = await this.fetcher.get((0, apiPaths_1.getPaymentTokenPath)(chain, address));
+        return (0, converters_1.paymentTokenFromJSON)(json);
+    }
+    /**
+     * Fetch account for an address.
+     */
+    async getAccount(address) {
+        const json = await this.fetcher.get((0, apiPaths_1.getAccountPath)(address));
+        return (0, converters_1.accountFromJSON)(json);
+    }
+}
+exports.AccountsAPI = AccountsAPI;
+//# sourceMappingURL=accounts.js.map

package/lib/api/accounts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"accounts.js","sourceRoot":"","sources":["../../src/api/accounts.ts"],"names":[],"mappings":";;;AAAA,yCAAiE;AAGjE,oDAA4E;AAE5E;;GAEG;AACH,MAAa,WAAW;IACtB,YACU,OAAgB,EAChB,KAAY;QADZ,YAAO,GAAP,OAAO,CAAS;QAChB,UAAK,GAAL,KAAK,CAAO;IACnB,CAAC;IAEJ;;OAEG;IACH,KAAK,CAAC,eAAe,CACnB,OAAe,EACf,KAAK,GAAG,IAAI,CAAC,KAAK;QAElB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CACjC,IAAA,8BAAmB,EAAC,KAAK,EAAE,OAAO,CAAC,CACpC,CAAC;QACF,OAAO,IAAA,iCAAoB,EAAC,IAAI,CAAC,CAAC;IACpC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,UAAU,CAAC,OAAe;QAC9B,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CACjC,IAAA,yBAAc,EAAC,OAAO,CAAC,CACxB,CAAC;QACF,OAAO,IAAA,4BAAe,EAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;CACF;AA5BD,kCA4BC"}

package/lib/api/api.d.ts

@@ -1,6 +1,6 @@
-import { BuildOfferResponse, GetCollectionsResponse, ListNFTsResponse, GetNFTResponse, ListCollectionOffersResponse, GetOrdersResponse, GetBestOfferResponse, GetBestListingResponse, GetOffersResponse, GetListingsResponse, CollectionOffer, CollectionOrderByOption, CancelOrderResponse } from "./types";
 import { FulfillmentDataResponse, OrderAPIOptions, OrdersQueryOptions, OrderV2, ProtocolData } from "../orders/types";
 import { Chain, OpenSeaAPIConfig, OpenSeaAccount, OpenSeaCollection, OpenSeaCollectionStats, OpenSeaPaymentToken, OrderSide } from "../types";
+import { BuildOfferResponse, GetCollectionsResponse, ListNFTsResponse, GetNFTResponse, ListCollectionOffersResponse, GetOrdersResponse, GetBestOfferResponse, GetBestListingResponse, GetOffersResponse, GetListingsResponse, CollectionOffer, CollectionOrderByOption, CancelOrderResponse, GetEventsArgs, GetEventsResponse, GetContractResponse, GetTraitsResponse } from "./types";
 /**
  * The API class for the OpenSea SDK.
  * @category Main Classes
@@ -20,6 +20,13 @@ export declare class OpenSeaAPI {
     logger: (arg: string) => void;
     private apiKey;
     private chain;
+    private ordersAPI;
+    private offersAPI;
+    private listingsAPI;
+    private collectionsAPI;
+    private nftsAPI;
+    private accountsAPI;
+    private eventsAPI;
     /**
      * Create an instance of the OpenSeaAPI
      * @param config OpenSeaAPIConfig for setting up the API, including an optional API key, Chain name, and base URL
@@ -28,40 +35,27 @@ export declare class OpenSeaAPI {
     constructor(config: OpenSeaAPIConfig, logger?: (arg: string) => void);
     /**
      * Gets an order from API based on query options.
-     * @param options
-     * @param options.side The side of the order (listing or offer)
-     * @param options.protocol The protocol, typically seaport, to query orders for
-     * @param options.orderDirection The direction to sort the orders
-     * @param options.orderBy The field to sort the orders by
-     * @param options.limit The number of orders to retrieve
-     * @param options.maker Filter by the wallet address of the order maker
-     * @param options.taker Filter by  wallet address of the order taker
-     * @param options.asset_contract_address Address of the NFT's contract
-     * @param options.token_ids String array of token IDs to filter by.
-     * @param options.listed_after Filter by orders listed after the Unix epoch timestamp in seconds
-     * @param options.listed_before Filter by orders listed before the Unix epoch timestamp in seconds
+     * @param options Query options for fetching an order
      * @returns The first {@link OrderV2} returned by the API
      *
      * @throws An error if there are no matching orders.
      */
-    getOrder({ side, protocol, orderDirection, orderBy, ...restOptions }: Omit<OrdersQueryOptions, "limit">): Promise<OrderV2>;
+    getOrder(options: Omit<OrdersQueryOptions, "limit">): Promise<OrderV2>;
+    /**
+     * Gets a single order by its order hash.
+     * @param orderHash The hash of the order to fetch
+     * @param protocolAddress The address of the seaport contract
+     * @param chain The chain where the order is located. Defaults to the chain set in the constructor.
+     * @returns The {@link OrderV2} returned by the API
+     * @throws An error if the order is not found
+     */
+    getOrderByHash(orderHash: string, protocolAddress: string, chain?: Chain): Promise<OrderV2>;
     /**
      * Gets a list of orders from API based on query options.
-     * @param options
-     * @param options.side The side of the order (buy or sell)
-     * @param options.protocol The protocol, typically seaport, to query orders for
-     * @param options.orderDirection The direction to sort the orders
-     * @param options.orderBy The field to sort the orders by
-     * @param options.limit The number of orders to retrieve
-     * @param options.maker Filter by the wallet address of the order maker
-     * @param options.taker Filter by  wallet address of the order taker
-     * @param options.asset_contract_address Address of the NFT's contract
-     * @param options.token_ids String array of token IDs to filter by.
-     * @param options.listed_after Filter by orders listed after the Unix epoch timestamp in seconds
-     * @param options.listed_before Filter by orders listed before the Unix epoch timestamp in seconds
+     * @param options Query options for fetching orders
      * @returns The {@link GetOrdersResponse} returned by the API.
      */
-    getOrders({ side, protocol, orderDirection, orderBy, ...restOptions }: Omit<OrdersQueryOptions, "limit">): Promise<GetOrdersResponse>;
+    getOrders(options: Omit<OrdersQueryOptions, "limit">): Promise<GetOrdersResponse>;
     /**
      * Gets all offers for a given collection.
      * @param collectionSlug The slug of the collection.
@@ -126,11 +120,7 @@ export declare class OpenSeaAPI {
     /**
      * Post an order to OpenSea.
      * @param order The order to post
-     * @param apiOptions
-     * @param apiOptions.protocol The protocol, typically seaport, to post the order to.
-     * @param apiOptions.side The side of the order (buy or sell).
-     * @param apiOptions.protocolAddress The address of the seaport contract.
-     * @param options
+     * @param apiOptions API options for the order
      * @returns The {@link OrderV2} posted to the API.
      */
     postOrder(order: ProtocolData, apiOptions: OrderAPIOptions): Promise<OrderV2>;
@@ -219,16 +209,15 @@ export declare class OpenSeaAPI {
     getCollectionStats(slug: string): Promise<OpenSeaCollectionStats>;
     /**
      * Fetch a payment token.
-     * @param query Query to use for getting tokens. See {@link OpenSeaPaymentTokenQuery}.
-     * @param next The cursor for the next page of results. This is returned from a previous request.
+     * @param address The address of the payment token
+     * @param chain The chain of the payment token
      * @returns The {@link OpenSeaPaymentToken} returned by the API.
      */
     getPaymentToken(address: string, chain?: Chain): Promise<OpenSeaPaymentToken>;
     /**
      * Fetch account for an address.
-     * @param query Query to use for getting tokens. See {@link OpenSeaPaymentTokenQuery}.
-     * @param next The cursor for the next page of results. This is returned from a previous request.
-     * @returns The {@link GetAccountResponse} returned by the API.
+     * @param address The address to fetch the account for
+     * @returns The {@link OpenSeaAccount} returned by the API.
      */
     getAccount(address: string): Promise<OpenSeaAccount>;
     /**
@@ -255,14 +244,76 @@ export declare class OpenSeaAPI {
      */
     offchainCancelOrder(protocolAddress: string, orderHash: string, chain?: Chain, offererSignature?: string): Promise<CancelOrderResponse>;
     /**
-     * Generic fetch method for any API endpoint
+     * Gets a list of events based on query parameters.
+     * @param args Query parameters for filtering events.
+     * @returns The {@link GetEventsResponse} returned by the API.
+     */
+    getEvents(args?: GetEventsArgs): Promise<GetEventsResponse>;
+    /**
+     * Gets a list of events for a specific account.
+     * @param address The account address.
+     * @param args Query parameters for filtering events.
+     * @returns The {@link GetEventsResponse} returned by the API.
+     */
+    getEventsByAccount(address: string, args?: GetEventsArgs): Promise<GetEventsResponse>;
+    /**
+     * Gets a list of events for a specific collection.
+     * @param collectionSlug The slug (identifier) of the collection.
+     * @param args Query parameters for filtering events.
+     * @returns The {@link GetEventsResponse} returned by the API.
+     */
+    getEventsByCollection(collectionSlug: string, args?: GetEventsArgs): Promise<GetEventsResponse>;
+    /**
+     * Gets a list of events for a specific NFT.
+     * @param chain The chain where the NFT is located.
+     * @param address The contract address of the NFT.
+     * @param identifier The token identifier.
+     * @param args Query parameters for filtering events.
+     * @returns The {@link GetEventsResponse} returned by the API.
+     */
+    getEventsByNFT(chain: Chain, address: string, identifier: string, args?: GetEventsArgs): Promise<GetEventsResponse>;
+    /**
+     * Fetch smart contract information for a given chain and address.
+     * @param address The contract address.
+     * @param chain The chain where the contract is deployed. Defaults to the chain set in the constructor.
+     * @returns The {@link GetContractResponse} returned by the API.
+     */
+    getContract(address: string, chain?: Chain): Promise<GetContractResponse>;
+    /**
+     * Fetch all traits for a collection with their possible values and counts.
+     * @param collectionSlug The slug (identifier) of the collection.
+     * @returns The {@link GetTraitsResponse} returned by the API.
+     */
+    getTraits(collectionSlug: string): Promise<GetTraitsResponse>;
+    /**
+     * Gets all active offers for a specific NFT (not just the best offer).
+     * @param assetContractAddress The NFT contract address.
+     * @param tokenId The token identifier.
+     * @param limit The number of offers to return. Must be between 1 and 100.
+     * @param next The cursor for the next page of results. This is returned from a previous request.
+     * @param chain The chain where the NFT is located. Defaults to the chain set in the constructor.
+     * @returns The {@link GetOffersResponse} returned by the API.
+     */
+    getNFTOffers(assetContractAddress: string, tokenId: string, limit?: number, next?: string, chain?: Chain): Promise<GetOffersResponse>;
+    /**
+     * Gets all active listings for a specific NFT (not just the best listing).
+     * @param assetContractAddress The NFT contract address.
+     * @param tokenId The token identifier.
+     * @param limit The number of listings to return. Must be between 1 and 100.
+     * @param next The cursor for the next page of results. This is returned from a previous request.
+     * @param chain The chain where the NFT is located. Defaults to the chain set in the constructor.
+     * @returns The {@link GetListingsResponse} returned by the API.
+     */
+    getNFTListings(assetContractAddress: string, tokenId: string, limit?: number, next?: string, chain?: Chain): Promise<GetListingsResponse>;
+    /**
+     * Generic fetch method for any API endpoint with automatic rate limit retry
      * @param apiPath Path to URL endpoint under API
      * @param query URL query params. Will be used to create a URLSearchParams object.
      * @returns @typeParam T The response from the API.
      */
     get<T>(apiPath: string, query?: object): Promise<T>;
     /**
-     * Generic post method for any API endpoint.
+     * Generic post method for any API endpoint with automatic rate limit retry
      * @param apiPath Path to URL endpoint under API
      * @param body Data to send.
      * @param opts ethers ConnectionInfo, similar to Fetch API.
@@ -283,9 +334,9 @@ export declare class OpenSeaAPI {
      */
     private _parseRetryAfter;
     /**
-     * Creates a rate limit error with retry-after information for backwards compatibility.
+     * Creates a rate limit error with status code and retry-after information.
      * @param response The HTTP response object from the API
-     * @returns An enhanced Error object with retryAfter and responseBody properties
+     * @returns An enhanced Error object with statusCode, retryAfter and responseBody properties
      */
     private _createRateLimitError;
 }