thirdweb 5.38.1-nightly-5fabe6661399615b393d1055a722b9de59bf19bb-20240724000323 → 5.38.1-nightly-c82c524e139d7960794e08bca838a1a1b78a3532-20240725000333

package/src/extensions/lens/read/getFullProfile.ts

@@ -12,6 +12,9 @@ import {
 } from "../consts.js";
 import type { LensProfileSchema } from "./type.js";
 
+/**
+ * @extension LENS
+ */
 export type GetFullProfileParams = {
   profileId: bigint;
   client: ThirdwebClient;
@@ -24,6 +27,9 @@ export type GetFullProfileParams = {
   };
 };
 
+/**
+ * @extension LENS
+ */
 export type FullProfileResponse = {
   handle: string;
   // Timestamp of the join date

package/src/extensions/lens/read/getHandleFromProfileId.test.ts

@@ -11,35 +11,38 @@ import { getHandleFromProfileId } from "./getHandleFromProfileId.js";
 const profileId = 1000n;
 const client = TEST_CLIENT;
 
-describe("lens/getHandleFromProfileId should return a handle for a valid profileId", () => {
-  it("should return a string in this format: lens/@<handle>", async () => {
-    const handle = await getHandleFromProfileId({ profileId, client });
-    expect(typeof handle).toBe("string");
-    // @ts-ignore expected
-    expect(handle.startsWith("lens/")).toBe(true);
-  });
+describe.runIf(process.env.TW_SECRET_KEY)(
+  "lens/getHandleFromProfileId should return a handle for a valid profileId",
+  () => {
+    it("should return a string in this format: lens/@<handle>", async () => {
+      const handle = await getHandleFromProfileId({ profileId, client });
+      expect(typeof handle).toBe("string");
+      // @ts-ignore expected
+      expect(handle.startsWith("lens/")).toBe(true);
+    });
 
-  it("should return `null` for an invalid profileId", async () => {
-    // As of Jul 2024 Lens has about 465k profiles | So trying to get handle of a max-unit256 profileId should return "null"
-    // gotta be a very long before this number is reached so we should be safe
-    const handle = await getHandleFromProfileId({
-      profileId: MAX_UINT256,
-      client,
+    it("should return `null` for an invalid profileId", async () => {
+      // As of Jul 2024 Lens has about 465k profiles | So trying to get handle of a max-unit256 profileId should return "null"
+      // gotta be a very long before this number is reached so we should be safe
+      const handle = await getHandleFromProfileId({
+        profileId: MAX_UINT256,
+        client,
+      });
+      expect(handle).toBe(null);
     });
-    expect(handle).toBe(null);
-  });
 
-  it("should work with overrides", async () => {
-    const handle = await getHandleFromProfileId({
-      profileId,
-      client,
-      overrides: {
-        lensHandleAddress: "0xe7E7EaD361f3AaCD73A61A9bD6C10cA17F38E945",
-        tokenHandleRegistryAddress:
-          "0xD4F2F33680FCCb36748FA9831851643781608844",
-      },
+    it("should work with overrides", async () => {
+      const handle = await getHandleFromProfileId({
+        profileId,
+        client,
+        overrides: {
+          lensHandleAddress: "0xe7E7EaD361f3AaCD73A61A9bD6C10cA17F38E945",
+          tokenHandleRegistryAddress:
+            "0xD4F2F33680FCCb36748FA9831851643781608844",
+        },
+      });
+      // @ts-ignore expected
+      expect(handle.startsWith("lens/")).toBe(true);
     });
-    // @ts-ignore expected
-    expect(handle.startsWith("lens/")).toBe(true);
-  });
-});
+  },
+);

package/src/extensions/lens/read/getHandleFromProfileId.ts

@@ -10,6 +10,9 @@ import {
   LENS_TOKEN_HANDLE_REGISTRY_ADDRESS,
 } from "../consts.js";
 
+/**
+ * @extension LENS
+ */
 export type GetHandleFromProfileIdParams = {
   profileId: bigint;
   client: ThirdwebClient;

package/src/extensions/lens/read/getProfileMetadata.ts

@@ -7,6 +7,9 @@ import { getProfile } from "../__generated__/LensHub/read/getProfile.js";
 import { LENS_HUB_ADDRESS } from "../consts.js";
 import type { LensProfileSchema } from "./type.js";
 
+/**
+ * @extension LENS
+ */
 export type GetProfileMetadataParams = {
   profileId: bigint;
   client: ThirdwebClient;

package/src/extensions/lens/read/type.ts

@@ -1,3 +1,6 @@
+/**
+ * @extension LENS
+ */
 export type LensProfileSchema = {
   // A cryptographic signature of the Lens metadata
   signature: string;

package/src/extensions/marketplace/direct-listings/read/currencyPriceForListing.ts

@@ -3,6 +3,9 @@ import type { BaseTransactionOptions } from "../../../../transaction/types.js";
 import { isCurrencyApprovedForListing } from "../../__generated__/IDirectListings/read/isCurrencyApprovedForListing.js";
 import { getListing } from "./getListing.js";
 
+/**
+ * @extension MARKETPLACE
+ */
 export type CurrencyPriceForListingParams = {
   listingId: bigint;
   currency: Address;

package/src/extensions/marketplace/direct-listings/read/getAllListings.ts

@@ -10,6 +10,9 @@ import { mapDirectListing } from "../utils.js";
 
 const DEFAULT_QUERY_ALL_COUNT = 100n;
 
+/**
+ * @extension MARKETPLACE
+ */
 export type GetAllListingParams = {
   /**
    * The start index of the listings to retrieve.

package/src/extensions/marketplace/direct-listings/read/getAllValidListings.ts

@@ -10,6 +10,9 @@ import { mapDirectListing } from "../utils.js";
 
 const DEFAULT_QUERY_ALL_COUNT = 100n;
 
+/**
+ * @extension MARKETPLACE
+ */
 export type GetAllValidListingParams = {
   /**
    * The start index of the listings to retrieve.

package/src/extensions/marketplace/direct-listings/read/getListing.ts

@@ -9,6 +9,9 @@ import {
 import type { DirectListing } from "../types.js";
 import { mapDirectListing } from "../utils.js";
 
+/**
+ * @extension MARKETPLACE
+ */
 export type GetListingParams = GetListingParamsGenerated;
 
 /**

package/src/extensions/marketplace/direct-listings/read/isBuyerApprovedForListing.ts

@@ -2,6 +2,9 @@ import type { Address } from "abitype";
 import type { BaseTransactionOptions } from "../../../../transaction/types.js";
 import { getListing } from "./getListing.js";
 
+/**
+ * @extension MARKETPLACE
+ */
 export type IsBuyerApprovedForListingParams = {
   listingId: bigint;
   buyer: Address;

package/src/extensions/marketplace/direct-listings/types.ts

@@ -3,6 +3,9 @@ import type { NFT } from "../../../utils/nft/parseNft.js";
 import type { GetBalanceResult } from "../../erc20/read/getBalance.js";
 import type { ListingStatus } from "../types.js";
 
+/**
+ * @extension MARKETPLACE
+ */
 export type DirectListing = {
   id: bigint;
   creatorAddress: Address;

package/src/extensions/marketplace/direct-listings/utils.ts

@@ -67,6 +67,9 @@ export async function mapDirectListing(
   };
 }
 
+/**
+ * @extension MARKETPLACE
+ */
 export type IsListingValidParams = {
   listing: DirectListing;
   quantity?: bigint;

package/src/extensions/marketplace/direct-listings/write/buyFromListing.ts

@@ -5,6 +5,9 @@ import { buyFromListing as generatedBuyFromListing } from "../../__generated__/I
 import { getListing } from "../read/getListing.js";
 import { isListingValid } from "../utils.js";
 
+/**
+ * @extension MARKETPLACE
+ */
 export type BuyFromListingParams = {
   listingId: bigint;
   quantity: bigint;

package/src/extensions/marketplace/direct-listings/write/createListing.ts

@@ -12,6 +12,9 @@ import { isERC721 } from "../../../erc721/read/isERC721.js";
 import { isERC1155 } from "../../../erc1155/read/isERC1155.js";
 import { createListing as generatedCreateListing } from "../../__generated__/IDirectListings/write/createListing.js";
 
+/**
+ * @extension MARKETPLACE
+ */
 export type CreateListingParams = {
   /**
    * The contract address of the asset being listed

package/src/extensions/marketplace/direct-listings/write/updateListing.ts

@@ -13,6 +13,9 @@ import { isERC1155 } from "../../../erc1155/read/isERC1155.js";
 import { updateListing as generatedUpdateListing } from "../../__generated__/IDirectListings/write/updateListing.js";
 import { getListing } from "../read/getListing.js";
 
+/**
+ * @extension MARKETPLACE
+ */
 export type UpdateListingParams = {
   /**
    * The ID of the listing to update

package/src/extensions/marketplace/english-auctions/read/getAllAuctions.ts

@@ -10,6 +10,9 @@ import { mapEnglishAuction } from "../utils.js";
 
 const DEFAULT_QUERY_ALL_COUNT = 100n;
 
+/**
+ * @extension MARKETPLACE
+ */
 export type GetAllAuctionParams = {
   /**
    * The start index of the listings to retrieve.

package/src/extensions/marketplace/english-auctions/read/getAllValidAuctions.ts

@@ -10,6 +10,9 @@ import { mapEnglishAuction } from "../utils.js";
 
 const DEFAULT_QUERY_ALL_COUNT = 100n;
 
+/**
+ * @extension MARKETPLACE
+ */
 export type GetAllValidAuctionParams = {
   /**
    * The start index of the listings to retrieve.

package/src/extensions/marketplace/english-auctions/read/getAuction.ts

@@ -9,6 +9,9 @@ import {
 import type { EnglishAuction } from "../types.js";
 import { mapEnglishAuction } from "../utils.js";
 
+/**
+ * @extension MARKETPLACE
+ */
 export type GetAuctionParams = GetAuctionParamsGenerated;
 
 /**

package/src/extensions/marketplace/english-auctions/read/getWinningBid.ts

@@ -6,6 +6,9 @@ import {
   getWinningBid as getWinningBidGenerated,
 } from "../../__generated__/IEnglishAuctions/read/getWinningBid.js";
 
+/**
+ * @extension MARKETPLACE
+ */
 export type GetWinningBidParams = GeneratedWinningBidParams;
 
 /**

package/src/extensions/marketplace/english-auctions/types.ts

@@ -3,6 +3,9 @@ import type { NFT } from "../../../utils/nft/parseNft.js";
 import type { GetBalanceResult } from "../../erc20/read/getBalance.js";
 import type { ListingStatus } from "../types.js";
 
+/**
+ * @extension MARKETPLACE
+ */
 export type EnglishAuction = {
   id: bigint;
   creatorAddress: Address;

package/src/extensions/marketplace/english-auctions/write/bidInAuction.ts

@@ -5,6 +5,9 @@ import { bidInAuction as generatedBidInAuction } from "../../__generated__/IEngl
 import { getAuction } from "../read/getAuction.js";
 import { getWinningBid } from "../read/getWinningBid.js";
 
+/**
+ * @extension MARKETPLACE
+ */
 export type BidInAuctionParams = {
   auctionId: bigint;
 } & (

package/src/extensions/marketplace/english-auctions/write/buyoutAuction.ts

@@ -3,6 +3,9 @@ import type { BaseTransactionOptions } from "../../../../transaction/types.js";
 import { bidInAuction as generatedBidInAuction } from "../../__generated__/IEnglishAuctions/write/bidInAuction.js";
 import { getAuction } from "../read/getAuction.js";
 
+/**
+ * @extension MARKETPLACE
+ */
 export type BuyoutAuctionParams = {
   auctionId: bigint;
 };

package/src/extensions/marketplace/english-auctions/write/cancelAuction.ts

@@ -2,6 +2,9 @@ import type { BaseTransactionOptions } from "../../../../transaction/types.js";
 import { cancelAuction as generatedCancelAuction } from "../../__generated__/IEnglishAuctions/write/cancelAuction.js";
 import { getWinningBid } from "../read/getWinningBid.js";
 
+/**
+ * @extension MARKETPLACE
+ */
 export type CancelAuctionParams = {
   auctionId: bigint;
 };

package/src/extensions/marketplace/english-auctions/write/createAuction.ts

@@ -12,6 +12,9 @@ import { isERC721 } from "../../../erc721/read/isERC721.js";
 import { isERC1155 } from "../../../erc1155/read/isERC1155.js";
 import { createAuction as generatedCreateAuction } from "../../__generated__/IEnglishAuctions/write/createAuction.js";
 
+/**
+ * @extension MARKETPLACE
+ */
 type MinimumBidAmount =
   | {
       /**
@@ -26,6 +29,9 @@ type MinimumBidAmount =
       minimumBidAmountWei: bigint;
     };
 
+/**
+ * @extension MARKETPLACE
+ */
 type BuyoutBidAmount =
   | {
       /**
@@ -40,6 +46,9 @@ type BuyoutBidAmount =
       buyoutBidAmountWei: bigint;
     };
 
+/**
+ * @extension MARKETPLACE
+ */
 export type CreateAuctionParams = {
   /**
    * The contract address of the asset being listed

package/src/extensions/marketplace/english-auctions/write/executeSale.ts

@@ -4,6 +4,9 @@ import { encodeCollectAuctionPayout } from "../../__generated__/IEnglishAuctions
 import { encodeCollectAuctionTokens } from "../../__generated__/IEnglishAuctions/write/collectAuctionTokens.js";
 import { getWinningBid } from "../read/getWinningBid.js";
 
+/**
+ * @extension MARKETPLACE
+ */
 export type ExecuteSaleParams = {
   auctionId: bigint;
 };

package/src/extensions/marketplace/offers/read/getAllOffers.ts

@@ -10,6 +10,9 @@ import { mapOffer } from "../utils.js";
 
 const DEFAULT_QUERY_ALL_COUNT = 100n;
 
+/**
+ * @extension MARKETPLACE
+ */
 export type GetAllOffersParams = {
   /**
    * The start index of the offers to retrieve.

package/src/extensions/marketplace/offers/read/getAllValidOffers.ts

@@ -10,6 +10,9 @@ import { mapOffer } from "../utils.js";
 
 const DEFAULT_QUERY_ALL_COUNT = 100n;
 
+/**
+ * @extension MARKETPLACE
+ */
 export type GetAllValidOffersParams = {
   /**
    * The start index of the offers to retrieve.

package/src/extensions/marketplace/offers/read/getOffer.ts

@@ -8,6 +8,9 @@ import {
 import type { Offer } from "../types.js";
 import { mapOffer } from "../utils.js";
 
+/**
+ * @extension MARKETPLACE
+ */
 export type GetOfferParams = GetOfferParamsGenerated;
 
 /**

package/src/extensions/marketplace/offers/types.ts

@@ -3,6 +3,9 @@ import type { NFT } from "../../../utils/nft/parseNft.js";
 import type { GetBalanceResult } from "../../erc20/read/getBalance.js";
 import type { ListingStatus } from "../types.js";
 
+/**
+ * @extension MARKETPLACE
+ */
 export type Offer = {
   id: bigint;
   offerorAddress: Address;

package/src/extensions/marketplace/offers/write/acceptOffer.ts

@@ -8,6 +8,9 @@ import {
 } from "../../__generated__/IOffers/write/acceptOffer.js";
 import { getOffer } from "../read/getOffer.js";
 
+/**
+ * @extension MARKETPLACE
+ */
 export type AcceptOfferParams = GeneratedAcceptOfferParams;
 
 /**

package/src/extensions/marketplace/offers/write/makeOffer.ts

@@ -3,6 +3,9 @@ import { isNativeTokenAddress } from "../../../../constants/addresses.js";
 import type { BaseTransactionOptions } from "../../../../transaction/types.js";
 import { makeOffer as makeOfferGenerated } from "../../__generated__/IOffers/write/makeOffer.js";
 
+/**
+ * @extension MARKETPLACE
+ */
 export type MakeOfferParams = {
   /**
    * The address of the asset contract to offer on.

package/src/extensions/marketplace/utils.ts

@@ -4,6 +4,9 @@ import { isERC721 } from "../erc721/read/isERC721.js";
 import { isERC1155 } from "../erc1155/read/isERC1155.js";
 import type { ListingStatus } from "./types.js";
 
+/**
+ * @extension MARKETPLACE
+ */
 type GetAssetParams = {
   tokenId: bigint;
 };
@@ -12,6 +15,7 @@ type GetAssetParams = {
  * Retrieves the NFT asset based on the provided options.
  * @param options The transaction options.
  * @returns A promise that resolves to the NFT asset.
+ * @extension MARKETPLACE
  * @example
  * ```ts
  * import { getNFTAsset } from "thirdweb/extensions/marketplace";

package/src/extensions/modular/ModularCore/write/installPublishedExtension.ts

@@ -5,6 +5,9 @@ import { getOrDeployInfraForPublishedContract } from "../../../../contract/deplo
 import type { Account } from "../../../../wallets/interfaces/wallet.js";
 import { installExtension } from "../../__generated__/ModularCore/write/installExtension.js";
 
+/**
+ * @extension MODULAR
+ */
 export type InstallPublishedExtensionOptions = {
   client: ThirdwebClient;
   chain: Chain;

package/src/extensions/modular/ModularCore/write/uninstallExtensionByProxy.ts

@@ -7,6 +7,9 @@ import {
 import { resolveImplementation } from "../../../../utils/bytecode/resolveImplementation.js";
 import { uninstallExtension } from "../../__generated__/ModularCore/write/uninstallExtension.js";
 
+/**
+ * @extension MODULAR
+ */
 export type UninstallExtensionByProxyOptions = {
   client: ThirdwebClient;
   chain: Chain;

package/src/extensions/modular/ModularCore/write/uninstallPublishedExtension.ts

@@ -4,6 +4,9 @@ import type { ThirdwebContract } from "../../../../contract/contract.js";
 import { getDeployedInfraContract } from "../../../../contract/deployment/utils/infra.js";
 import { uninstallExtension } from "../../__generated__/ModularCore/write/uninstallExtension.js";
 
+/**
+ * @extension MODULAR
+ */
 export type UninstallPublishedExtensionOptions = {
   client: ThirdwebClient;
   chain: Chain;

package/src/extensions/permissions/read/getAllMembers.ts

@@ -3,6 +3,9 @@ import { getRoleMember } from "../__generated__/IPermissionsEnumerable/read/getR
 import { getRoleMemberCount } from "../__generated__/IPermissionsEnumerable/read/getRoleMemberCount.js";
 import { type RoleInput, getRoleHash } from "../utils.js";
 
+/**
+ * @extension PERMISSIONS
+ */
 export type GetAllRoleMembersParams = {
   role: RoleInput;
 };

package/src/extensions/permissions/read/getRoleAdmin.ts

@@ -2,6 +2,9 @@ import type { BaseTransactionOptions } from "../../../transaction/types.js";
 import { getRoleAdmin as generatedGetRoleAdmin } from "../__generated__/IPermissions/read/getRoleAdmin.js";
 import { type RoleInput, getRoleHash } from "../utils.js";
 
+/**
+ * @extension PERMISSIONS
+ */
 export type GetRoleAdminParams = {
   role: RoleInput;
 };

package/src/extensions/permissions/read/getRoleMember.ts

@@ -2,6 +2,9 @@ import type { BaseTransactionOptions } from "../../../transaction/types.js";
 import { getRoleMember as generatedGetRoleMember } from "../__generated__/IPermissionsEnumerable/read/getRoleMember.js";
 import { type RoleInput, getRoleHash } from "../utils.js";
 
+/**
+ * @extension PERMISSIONS
+ */
 export type GetRoleMemberParams = {
   role: RoleInput;
   index: bigint;

package/src/extensions/permissions/read/getRoleMemberCount.ts

@@ -2,6 +2,9 @@ import type { BaseTransactionOptions } from "../../../transaction/types.js";
 import { getRoleMemberCount as generatedGetRoleMemberCount } from "../__generated__/IPermissionsEnumerable/read/getRoleMemberCount.js";
 import { type RoleInput, getRoleHash } from "../utils.js";
 
+/**
+ * @extension PERMISSIONS
+ */
 export type GetRoleMemberCountParams = {
   role: RoleInput;
 };

package/src/extensions/permissions/read/hasRole.ts

@@ -2,6 +2,9 @@ import type { BaseTransactionOptions } from "../../../transaction/types.js";
 import { hasRole as hasRoleGenerated } from "../__generated__/IPermissions/read/hasRole.js";
 import { type RoleInput, getRoleHash } from "../utils.js";
 
+/**
+ * @extension PERMISSIONS
+ */
 export type HasRoleParams = {
   role: RoleInput;
   targetAccountAddress: string;

package/src/extensions/permissions/utils.ts

@@ -20,6 +20,9 @@ export const roleMap = {
   migration: "MIGRATION_ROLE",
 } as const;
 
+/**
+ * @extension PERMISSIONS
+ */
 export type ThirdwebContractRole = keyof typeof roleMap;
 
 export const ALL_ROLES = /* @__PURE__ */ (() =>
@@ -45,6 +48,7 @@ const roleCache = new LruMap<Hex>(128);
  * ```ts
  * const adminRoleHash = getRoleHash("admin"); // 0x0000000...000000
  * ```
+ * @extension PERMISSIONS
  */
 export function getRoleHash(role: RoleInput) {
   if (roleCache.has(role)) {

package/src/extensions/permissions/write/grant.ts

@@ -3,6 +3,9 @@ import type { BaseTransactionOptions } from "../../../transaction/types.js";
 import { grantRole as generatedGrantRole } from "../__generated__/IPermissions/write/grantRole.js";
 import { type RoleInput, getRoleHash } from "../utils.js";
 
+/**
+ * @extension PERMISSIONS
+ */
 export type GrantRoleParams = {
   role: RoleInput;
   targetAccountAddress: Address;

package/src/extensions/permissions/write/renounceRole.ts

@@ -3,6 +3,9 @@ import type { BaseTransactionOptions } from "../../../transaction/types.js";
 import { renounceRole as generatedRenounceRole } from "../__generated__/IPermissions/write/renounceRole.js";
 import { type RoleInput, getRoleHash } from "../utils.js";
 
+/**
+ * @extension PERMISSIONS
+ */
 export type RenounceRoleParams = {
   role: RoleInput;
   targetAccountAddress: Address;

package/src/extensions/permissions/write/revokeRole.ts

@@ -3,6 +3,9 @@ import type { BaseTransactionOptions } from "../../../transaction/types.js";
 import { revokeRole as generatedRevokeRole } from "../__generated__/IPermissions/write/revokeRole.js";
 import { type RoleInput, getRoleHash } from "../utils.js";
 
+/**
+ * @extension PERMISSIONS
+ */
 export type RevokeRoleParams = {
   role: RoleInput;
   targetAccountAddress: Address;

package/src/extensions/prebuilts/deploy-erc1155.ts

@@ -9,8 +9,14 @@ import type { ClientAndChainAndAccount } from "../../utils/types.js";
 import { initialize as initDropERC1155 } from "./__generated__/DropERC1155/write/initialize.js";
 import { initialize as initTokenERC1155 } from "./__generated__/TokenERC1155/write/initialize.js";
 
+/**
+ * @extension DEPLOY
+ */
 export type ERC1155ContractType = "DropERC1155" | "TokenERC1155";
 
+/**
+ * @extension DEPLOY
+ */
 export type ERC1155ContractParams = {
   name: string;
   description?: string;
@@ -28,6 +34,9 @@ export type ERC1155ContractParams = {
   trustedForwarders?: string[];
 };
 
+/**
+ * @extension DEPLOY
+ */
 export type DeployERC1155ContractOptions = Prettify<
   ClientAndChainAndAccount & {
     type: ERC1155ContractType;

package/src/extensions/prebuilts/deploy-erc20.ts

@@ -11,6 +11,9 @@ import { initialize as initTokenERC20 } from "./__generated__/TokenERC20/write/i
 
 export type ERC20ContractType = "DropERC20" | "TokenERC20";
 
+/**
+ * @extension DEPLOY
+ */
 export type ERC20ContractParams = {
   name: string;
   description?: string;
@@ -26,6 +29,9 @@ export type ERC20ContractParams = {
   trustedForwarders?: string[];
 };
 
+/**
+ * @extension DEPLOY
+ */
 export type DeployERC20ContractOptions = Prettify<
   ClientAndChainAndAccount & {
     type: ERC20ContractType;