@highlightxyz/sdk 0.1.0 → 0.2.0

package/lib/v1/gen/sdk.gen.js

@@ -81,10 +81,51 @@ export class Collection extends HeyApiClient {
             },
         });
     }
+    /**
+     * Trending collections
+     *
+     * Public leaderboard of collections ranked by units minted within a rolling time window (24h / 7d / 28d), computed live from the mint ledger.
+     */
+    trending(parameters, options) {
+        const params = buildClientParams([parameters], [
+            {
+                args: [
+                    { in: "query", key: "window" },
+                    { in: "query", key: "chainId" },
+                    { in: "query", key: "limit" },
+                ],
+            },
+        ]);
+        return (options?.client ?? this.client).get({
+            url: "/collection/trending",
+            ...options,
+            ...params,
+        });
+    }
+    /**
+     * Featured collections
+     *
+     * Public curated showcase of collections for the home page, ordered by editorial position and paginated by cursor.
+     */
+    featured(parameters, options) {
+        const params = buildClientParams([parameters], [
+            {
+                args: [
+                    { in: "query", key: "limit" },
+                    { in: "query", key: "cursor" },
+                ],
+            },
+        ]);
+        return (options?.client ?? this.client).get({
+            url: "/collection/featured",
+            ...options,
+            ...params,
+        });
+    }
     /**
      * Get collection
      *
-     * Get a collection by its highlight ID.
+     * Get a collection by its highlight ID, or by a contract reference of the form `<chain>:<contractAddress>[:<editionId>]` (chain slug or numeric chainId; editionId defaults to 0), e.g. `ethereum:0x0c3dd3c403b6B5c0CCe2a97F15820a4Eae347FE7:0`.
      */
     get(parameters, options) {
         const params = buildClientParams([parameters], [{ args: [{ in: "path", key: "highlightId" }] }]);
@@ -94,6 +135,26 @@ export class Collection extends HeyApiClient {
             ...params,
         });
     }
+    /**
+     * List series previews
+     *
+     * List sample artwork for a series collection, resolved from its uploaded assets. Returns an empty list for non-series collections or when assets are not ready. Available for public collections without authentication.
+     */
+    listPreviews(parameters, options) {
+        const params = buildClientParams([parameters], [
+            {
+                args: [
+                    { in: "path", key: "highlightId" },
+                    { in: "query", key: "limit" },
+                ],
+            },
+        ]);
+        return (options?.client ?? this.client).get({
+            url: "/collection/{highlightId}/previews",
+            ...options,
+            ...params,
+        });
+    }
     /**
      * Finalize collection base URI to Arweave
      *
@@ -158,9 +219,9 @@ export class Collection extends HeyApiClient {
         });
     }
     /**
-     * Update edition draft details
+     * Update edition details
      *
-     * Update edition-specific details for an existing draft.
+     * Update edition-specific details (name, description, image, animation, attributes). For a draft collection the change is saved directly. For a live collection it returns a `setEditionURI` transaction to sign — once confirmed on-chain, the backend re-derives the edition and refreshes every token.
      */
     updateEditionDetails(parameters, options) {
         const params = buildClientParams([parameters], [
@@ -321,9 +382,9 @@ export class Collection extends HeyApiClient {
         });
     }
     /**
-     * Bid on ranked auction sale
+     * Bid on an auction sale
      *
-     * Build a bid transaction configuration for a ranked auction sale. Returns contract execution data for placing or updating a bid.
+     * Build a bid transaction configuration for an auction sale. For ranked auctions, places or updates an on-chain bid. For English auctions, returns an executor-signed bid claim plus the `AuctionManager.bid` call (with `value` = the bid amount); the optional `preferredNftRecipient` sets where the NFT is delivered if this bidder wins.
      */
     bidSale(parameters, options) {
         const params = buildClientParams([parameters], [
@@ -333,6 +394,7 @@ export class Collection extends HeyApiClient {
                     { in: "body", key: "saleId" },
                     { in: "body", key: "bidAmount" },
                     { in: "body", key: "bidId" },
+                    { in: "body", key: "preferredNftRecipient" },
                 ],
             },
         ]);
@@ -348,22 +410,22 @@ export class Collection extends HeyApiClient {
         });
     }
     /**
-     * Confirm ranked auction bid
+     * Reclaim a non-winning ranked-auction bid
      *
-     * Record a confirmed on-chain bid for a ranked auction sale. Called after the bid transaction is confirmed on-chain.
+     * Build a transaction to reclaim the funds locked in a non-winning ranked-auction bid after the auction has ended.
      */
-    confirmBid(parameters, options) {
+    reclaimBid(parameters, options) {
         const params = buildClientParams([parameters], [
             {
                 args: [
                     { in: "path", key: "highlightId" },
                     { in: "body", key: "saleId" },
-                    { in: "body", key: "txHash" },
+                    { in: "body", key: "bidId" },
                 ],
             },
         ]);
         return (options?.client ?? this.client).post({
-            url: "/collection/{highlightId}/sales/bid/confirm",
+            url: "/collection/{highlightId}/sales/reclaim",
             ...options,
             ...params,
             headers: {
@@ -374,22 +436,66 @@ export class Collection extends HeyApiClient {
         });
     }
     /**
-     * Confirm sale deployment
+     * Withdraw ranked-auction earnings
      *
-     * Confirm on-chain deployment of a public sale added to a live collection. Extracts the vector ID from the transaction receipt and sets the sale status to Live.
+     * Build a transaction to withdraw a ranked auction's cumulative earnings to the payment recipient after the auction has ended. Native-currency auctions only.
      */
-    confirmSale(parameters, options) {
+    claimAuctionEarnings(parameters, options) {
+        const params = buildClientParams([parameters], [
+            {
+                args: [
+                    { in: "path", key: "highlightId" },
+                    { in: "body", key: "saleId" },
+                ],
+            },
+        ]);
+        return (options?.client ?? this.client).post({
+            url: "/collection/{highlightId}/sales/earnings",
+            ...options,
+            ...params,
+            headers: {
+                "Content-Type": "application/json",
+                ...options?.headers,
+                ...params.headers,
+            },
+        });
+    }
+    /**
+     * Get ranked-auction live standings
+     *
+     * Public read-model for a ranked auction: the current clearing price and each bid's winning/losing status (provisional while live, frozen once settled). Includes the authenticated viewer's winning-bid count and tokens left to claim when a bearer token is supplied.
+     */
+    rankedAuctionStandings(parameters, options) {
         const params = buildClientParams([parameters], [
             {
                 args: [
                     { in: "path", key: "highlightId" },
                     { in: "path", key: "saleId" },
-                    { in: "body", key: "txHash" },
+                ],
+            },
+        ]);
+        return (options?.client ?? this.client).get({
+            url: "/collection/{highlightId}/sales/{saleId}/standings",
+            ...options,
+            ...params,
+        });
+    }
+    /**
+     * Fulfill (settle) an English auction
+     *
+     * Build the permissionless `AuctionManager.fulfillAuction` transaction. After the auction's end time anyone may settle it: the contract delivers the escrowed NFT to the winner's preferred recipient and splits the proceeds (95% recipient / 5% platform).
+     */
+    fulfillEnglishAuction(parameters, options) {
+        const params = buildClientParams([parameters], [
+            {
+                args: [
+                    { in: "path", key: "highlightId" },
+                    { in: "body", key: "saleId" },
                 ],
             },
         ]);
         return (options?.client ?? this.client).post({
-            url: "/collection/{highlightId}/sales/{saleId}/confirm",
+            url: "/collection/{highlightId}/sales/auction/fulfill",
             ...options,
             ...params,
             headers: {
@@ -399,6 +505,71 @@ export class Collection extends HeyApiClient {
             },
         });
     }
+    /**
+     * Cancel an English auction
+     *
+     * Build the `AuctionManager.cancelAuctionOnChain` transaction. The contract enforces owner-only and that no reserve-meeting bid has landed; any escrowed NFT is returned to the owner. Creator only.
+     */
+    cancelEnglishAuction(parameters, options) {
+        const params = buildClientParams([parameters], [
+            {
+                args: [
+                    { in: "path", key: "highlightId" },
+                    { in: "body", key: "saleId" },
+                ],
+            },
+        ]);
+        return (options?.client ?? this.client).post({
+            url: "/collection/{highlightId}/sales/auction/cancel",
+            ...options,
+            ...params,
+            headers: {
+                "Content-Type": "application/json",
+                ...options?.headers,
+                ...params.headers,
+            },
+        });
+    }
+    /**
+     * Get English auction standings
+     *
+     * Public read-model for an English auction: lifecycle state, reserve, current highest bid/bidder, end time, escrowed token, and creator earnings — served from the chain-reconciled projection. Includes whether the authenticated viewer is the current highest bidder when a bearer token is supplied.
+     */
+    englishAuctionStanding(parameters, options) {
+        const params = buildClientParams([parameters], [
+            {
+                args: [
+                    { in: "path", key: "highlightId" },
+                    { in: "path", key: "saleId" },
+                ],
+            },
+        ]);
+        return (options?.client ?? this.client).get({
+            url: "/collection/{highlightId}/sales/{saleId}/auction",
+            ...options,
+            ...params,
+        });
+    }
+    /**
+     * Get English auction bid history
+     *
+     * Public read-model: the English auction's bid history (newest first), sourced from the indexer's `Bid`-event ledger. Amounts are raw on-chain base units (wei) in the sale's currency.
+     */
+    englishAuctionBids(parameters, options) {
+        const params = buildClientParams([parameters], [
+            {
+                args: [
+                    { in: "path", key: "highlightId" },
+                    { in: "path", key: "saleId" },
+                ],
+            },
+        ]);
+        return (options?.client ?? this.client).get({
+            url: "/collection/{highlightId}/sales/{saleId}/auction/bids",
+            ...options,
+            ...params,
+        });
+    }
     /**
      * Initiate collection deployment
      *
@@ -426,28 +597,16 @@ export class Collection extends HeyApiClient {
         });
     }
     /**
-     * Confirm deployment transaction
+     * Cancel a deployment
      *
-     * Submit the transaction hash for a deployment awaiting confirmation.
+     * Cancel a deployment that has not yet completed. Terminates the running workflow, deletes the deployment row, and rolls the collection back to Draft. On contracts shared with other collections the contract is left unchanged; otherwise it is reset to Draft. After cancelling, the collection can be re-deployed from scratch.
      */
-    deployConfirm(parameters, options) {
-        const params = buildClientParams([parameters], [
-            {
-                args: [
-                    { in: "path", key: "highlightId" },
-                    { in: "body", key: "txHash" },
-                ],
-            },
-        ]);
+    deployCancel(parameters, options) {
+        const params = buildClientParams([parameters], [{ args: [{ in: "path", key: "highlightId" }] }]);
         return (options?.client ?? this.client).post({
-            url: "/collection/{highlightId}/deploy/confirm",
+            url: "/collection/{highlightId}/deploy/cancel",
             ...options,
             ...params,
-            headers: {
-                "Content-Type": "application/json",
-                ...options?.headers,
-                ...params.headers,
-            },
         });
     }
 }
@@ -455,7 +614,7 @@ export class Token extends HeyApiClient {
     /**
      * List tokens
      *
-     * Get a paginated list of minted tokens for a collection. Returns tokens for public collections without authentication. Supports filtering by owner address.
+     * Get a paginated list of minted tokens for a collection. Returns tokens for public collections without authentication. Supports filtering by owner address and by trait attributes.
      */
     list(parameters, options) {
         const params = buildClientParams([parameters], [
@@ -468,6 +627,7 @@ export class Token extends HeyApiClient {
                     { in: "query", key: "order" },
                     { in: "query", key: "ownerAddress" },
                     { in: "query", key: "search" },
+                    { in: "query", key: "attributes" },
                 ],
             },
         ]);
@@ -477,6 +637,19 @@ export class Token extends HeyApiClient {
             ...params,
         });
     }
+    /**
+     * List token attribute facets
+     *
+     * Get the trait/value facets with token counts for a collection — the data a filter sidebar renders. Available for public collections without authentication.
+     */
+    attributeFacets(parameters, options) {
+        const params = buildClientParams([parameters], [{ args: [{ in: "path", key: "highlightId" }] }]);
+        return (options?.client ?? this.client).get({
+            url: "/collection/{highlightId}/tokens/attributes",
+            ...options,
+            ...params,
+        });
+    }
     /**
      * Get token
      *
@@ -497,6 +670,26 @@ export class Token extends HeyApiClient {
             ...params,
         });
     }
+    /**
+     * List token owners
+     *
+     * Get the current owners of a minted token with their balances. A single entry for ERC721 tokens; ERC1155 tokens can have many. Available for public collections without authentication.
+     */
+    listOwners(parameters, options) {
+        const params = buildClientParams([parameters], [
+            {
+                args: [
+                    { in: "path", key: "highlightId" },
+                    { in: "path", key: "tokenId" },
+                ],
+            },
+        ]);
+        return (options?.client ?? this.client).get({
+            url: "/collection/{highlightId}/tokens/{tokenId}/owners",
+            ...options,
+            ...params,
+        });
+    }
 }
 export class Config extends HeyApiClient {
     /**
@@ -657,6 +850,122 @@ export class Gate extends HeyApiClient {
             },
         });
     }
+    /**
+     * Preview a collection
+     *
+     * Resolve an NFT contract for the gate builder — a Highlight collection if we host it, otherwise external NFT data.
+     */
+    previewCollection(parameters, options) {
+        const params = buildClientParams([parameters], [
+            {
+                args: [
+                    { in: "path", key: "chainId" },
+                    { in: "path", key: "address" },
+                ],
+            },
+        ]);
+        return (options?.client ?? this.client).get({
+            url: "/gate/preview/collection/{chainId}/{address}",
+            ...options,
+            ...params,
+        });
+    }
+    /**
+     * Preview collection attributes
+     *
+     * List a collection's trait types and values for the TOKEN_ATTRIBUTE builder.
+     */
+    previewAttributes(parameters, options) {
+        const params = buildClientParams([parameters], [
+            {
+                args: [
+                    { in: "path", key: "chainId" },
+                    { in: "path", key: "address" },
+                ],
+            },
+        ]);
+        return (options?.client ?? this.client).get({
+            url: "/gate/preview/collection/{chainId}/{address}/attributes",
+            ...options,
+            ...params,
+        });
+    }
+    /**
+     * Preview collection tokens
+     *
+     * Page through a collection's tokens for the SPECIFIC_TOKEN builder.
+     */
+    previewTokens(parameters, options) {
+        const params = buildClientParams([parameters], [
+            {
+                args: [
+                    { in: "path", key: "chainId" },
+                    { in: "path", key: "address" },
+                    { in: "query", key: "cursor" },
+                    { in: "query", key: "limit" },
+                ],
+            },
+        ]);
+        return (options?.client ?? this.client).get({
+            url: "/gate/preview/collection/{chainId}/{address}/tokens",
+            ...options,
+            ...params,
+        });
+    }
+    /**
+     * Preview a token
+     *
+     * Resolve a single token to confirm a SPECIFIC_TOKEN condition.
+     */
+    previewToken(parameters, options) {
+        const params = buildClientParams([parameters], [
+            {
+                args: [
+                    { in: "path", key: "chainId" },
+                    { in: "path", key: "address" },
+                    { in: "path", key: "tokenId" },
+                ],
+            },
+        ]);
+        return (options?.client ?? this.client).get({
+            url: "/gate/preview/collection/{chainId}/{address}/token/{tokenId}",
+            ...options,
+            ...params,
+        });
+    }
+    /**
+     * Preview a currency
+     *
+     * Resolve the native gas token (no contractAddress) or an ERC-20 for the CURRENCY_BALANCE builder.
+     */
+    previewCurrency(parameters, options) {
+        const params = buildClientParams([parameters], [
+            {
+                args: [
+                    { in: "path", key: "chainId" },
+                    { in: "query", key: "contractAddress" },
+                ],
+            },
+        ]);
+        return (options?.client ?? this.client).get({
+            url: "/gate/preview/currency/{chainId}",
+            ...options,
+            ...params,
+        });
+    }
+    /**
+     * Preview a Farcaster user
+     *
+     * Resolve a numeric fid or @handle to a Farcaster user for the FARCASTER_FOLLOW builder.
+     */
+    previewFarcaster(parameters, options) {
+        const params = buildClientParams([parameters], [{ args: [{ in: "query", key: "query" }] }]);
+        return (options?.client ?? this.client).get({
+            url: "/gate/preview/farcaster/user",
+            ...options,
+            ...params,
+        });
+    }
 }
 export class Mechanic extends HeyApiClient {
     /**
@@ -918,7 +1227,7 @@ export class Media extends HeyApiClient {
     /**
      * Get a child File Entity by path
      *
-     * Returns the child File's full Entity (with locations and status). Use `entity.url` to fetch bytes directly from the storage provider.
+     * Returns the child File's full Entity (with locations and status). Use a location's `url` to fetch bytes directly from the storage provider.
      */
     getChild(parameters, options) {
         const params = buildClientParams([parameters], [
@@ -936,6 +1245,48 @@ export class Media extends HeyApiClient {
         });
     }
 }
+export class Tx extends HeyApiClient {
+    /**
+     * Get transaction finalization status
+     *
+     * Returns the current finalization status for a transaction: the set of domain milestones (e.g. collection going live, sale going live) it must complete, and whether each is done. Overall is `Ready` only when every expected milestone is done. Use the `/ws` variant for live push updates instead of polling.
+     */
+    status(parameters, options) {
+        const params = buildClientParams([parameters], [
+            {
+                args: [
+                    { in: "path", key: "chainId" },
+                    { in: "path", key: "txHash" },
+                ],
+            },
+        ]);
+        return (options?.client ?? this.client).get({
+            url: "/tx/{chainId}/{txHash}",
+            ...options,
+            ...params,
+        });
+    }
+    /**
+     * Submit a transaction for tracking
+     *
+     * Hand a broadcast transaction hash to the backend so it is processed end-to-end (collection/sale/bid/mint effects) and its finalization milestones become available. Returns the current status snapshot; subscribe to the `/ws` variant to await finalization.
+     */
+    submit(parameters, options) {
+        const params = buildClientParams([parameters], [
+            {
+                args: [
+                    { in: "path", key: "chainId" },
+                    { in: "path", key: "txHash" },
+                ],
+            },
+        ]);
+        return (options?.client ?? this.client).post({
+            url: "/tx/{chainId}/{txHash}",
+            ...options,
+            ...params,
+        });
+    }
+}
 export class Siwe extends HeyApiClient {
     /**
      * Issue a SIWE nonce
@@ -1101,6 +1452,10 @@ export class HighlightClient extends HeyApiClient {
     get media() {
         return (this._media ??= new Media({ client: this.client }));
     }
+    _tx;
+    get tx() {
+        return (this._tx ??= new Tx({ client: this.client }));
+    }
     _user;
     get user() {
         return (this._user ??= new User({ client: this.client }));