thirdweb 5.31.0 → 5.31.1-nightly-a1d6a3c93e9a7b0433076a3e321183b09cfc0054-20240702000343

package/src/extensions/erc1155/drops/write/setClaimConditions.ts

@@ -17,8 +17,9 @@ export type SetClaimConditionsParams = {
  * @example
  * ```ts
  * import { setClaimConditions } from "thirdweb/extensions/erc1155";
+ * import { sendTransaction } from "thirdweb";
  *
- * const tx = setClaimConditions({
+ * const transaction = setClaimConditions({
  *  contract,
  *  tokenId: 0n,
  *  phases: [
@@ -31,6 +32,8 @@ export type SetClaimConditionsParams = {
  *    },
  *   ],
  * });
+ *
+ * await sendTransaction({ transaction, account });
  * ```
  */
 export function setClaimConditions(

package/src/extensions/erc1155/drops/write/updateMetadata.ts

@@ -101,6 +101,7 @@ export async function getUpdateMetadataParams(
  * @example
  * ```ts
  * import { updateMetadata } from "thirdweb/extensions/erc1155";
+ * import { sendTransaction } from "thirdweb";
  *
  * const transaction = updateMetadata({
  *  contract,
@@ -112,6 +113,8 @@ export async function getUpdateMetadataParams(
  *    // ...
  *  }
  * });
+ *
+ * await sendTransaction({ transaction, account });
  * ```
  */
 export function updateMetadata(

package/src/extensions/erc1155/write/lazyMint.ts

@@ -36,8 +36,9 @@ export type LazyMintParams = {
  * @example
  * ```ts
  * import { lazyMint } from "thirdweb/extensions/erc1155";
+ * import { sendTransaction } from "thirdweb";
  *
- * const tx = await lazyMint({
+ * const transaction = lazyMint({
  * contract,
  * nfts: [
  *    {
@@ -47,6 +48,8 @@ export type LazyMintParams = {
  *    },
  *  ],
  * });
+ *
+ * await sendTransaction({ transaction, account });
  * ```
  */
 export function lazyMint(options: BaseTransactionOptions<LazyMintParams>) {

package/src/extensions/erc1155/write/mintAdditionalSupplyTo.ts

@@ -16,6 +16,8 @@ export type MintAdditionalSupplyToParams = {
  * @example
  * ```ts
  * import { mintAdditionalSupplyTo } from "thirdweb/extensions/erc1155";
+ * import { sendTransaction } from "thirdweb";
+ *
  * const transaction = mintAdditionalSupplyTo({
  *  contract,
  *  to: "0x...",
@@ -23,7 +25,7 @@ export type MintAdditionalSupplyToParams = {
  *  supply: 10n,
  * });
  *
- * const { transactionHash } = await sendTransaction({ transaction, account });
+ * await sendTransaction({ transaction, account });
  *
  * ```
  */

package/src/extensions/erc1155/write/mintTo.ts

@@ -22,6 +22,8 @@ export type MintToParams = WithOverrides<{
  * @example
  * ```ts
  * import { mintTo } from "thirdweb/extensions/erc1155";
+ * import { sendTransaction } from "thirdweb";
+ *
  * const transaction = mintTo({
  *  contract,
  *  to: "0x...",
@@ -33,8 +35,7 @@ export type MintToParams = WithOverrides<{
  *  },
  * });
  *
- * const { transactionHash } = await sendTransaction({ transaction, account });
- *
+ * await sendTransaction({ transaction, account });
  * ```
  */
 export function mintTo(options: BaseTransactionOptions<MintToParams>) {

package/src/extensions/erc1155/write/sigMint.ts

@@ -23,6 +23,7 @@ import {
  * @example
  * ```ts
  * import { mintWithSignature, generateMintSignature } from "thirdweb/extensions/erc1155";
+ * import { sendTransaction } from "thirdweb";
  *
  * const { payload, signature } = await generateMintSignature(...)
  *

package/src/extensions/erc20/drops/write/claimTo.ts

@@ -19,11 +19,15 @@ export type ClaimToParams = {
  * @example
  * ```ts
  * import { claimTo } from "thirdweb/extensions/erc20";
- * const tx = await claimTo({
+ * import { sendTransaction } from "thirdweb";
+ *
+ * const transaction = claimTo({
  *   contract,
  *   to: "0x...",
  *   quantity: 100n,
  * });
+ *
+ * await sendTransaction({ transaction, account });
  * ```
  * @throws If no claim condition is set
  * @returns A promise that resolves with the submitted transaction hash.

package/src/extensions/erc20/drops/write/setClaimConditions.ts

@@ -17,8 +17,9 @@ export type SetClaimConditionsParams = {
  * @example
  * ```ts
  * import { setClaimConditions } from "thirdweb/extensions/erc20";
+ * import { sendTransaction } from "thirdweb";
  *
- * const tx = setClaimConditions({
+ * const transaction = setClaimConditions({
  *  contract,
  *  phases: [
  *    {
@@ -30,6 +31,8 @@ export type SetClaimConditionsParams = {
  *    },
  *   ],
  * });
+ *
+ * await sendTransaction({ transaction, account });
  * ```
  */
 export function setClaimConditions(

package/src/extensions/erc20/write/approve.ts

@@ -26,11 +26,15 @@ export type ApproveParams = Prettify<
  * @example
  * ```ts
  * import { approve } from "thirdweb/extensions/erc20";
- * const tx = await approve({
+ * import { sendTransaction } from "thirdweb";
+ *
+ * const transaction = await approve({
  *  contract,
  *  spender: "0x...",
  *  amount: 100,
  * });
+ *
+ * await sendTransaction({ transaction, account });
  * ```
  */
 export function approve(options: BaseTransactionOptions<ApproveParams>) {

package/src/extensions/erc20/write/deposit.ts

@@ -10,19 +10,18 @@ export type DepositParams =
   | { amountWei: bigint };
 
 /**
- * Calls the "deposit" function on the contract.
+ * Calls the "deposit" function on the contract (useful to wrap ETH).
  * @param options - The options for the "deposit" function.
  * @returns A prepared transaction object.
  * @extension ERC20
  * @example
  * ```ts
  * import { deposit } from "thirdweb/extensions/erc20";
+ * import { sendTransaction } from "thirdweb";
  *
- * const transaction = deposit();
- *
- * // Send the transaction
- * ...
+ * const transaction = deposit({ contract, amount: "0.1" });
  *
+ * await sendTransaction({ transaction, account });
  * ```
  */
 export function deposit(options: BaseTransactionOptions<DepositParams>) {

package/src/extensions/erc20/write/mintTo.ts

@@ -29,11 +29,15 @@ export type MintToParams = Prettify<
  * @example
  * ```ts
  * import { mintTo } from "thirdweb/extensions/erc20";
- * const tx = await mintTo({
+ * import { sendTransaction } from "thirdweb";
+ *
+ * const transaction = mintTo({
  *  contract,
  *  to: "0x...",
  *  amount: 100,
  * });
+ *
+ * await sendTransaction({ transaction, account });
  * ```
  */
 export function mintTo(options: BaseTransactionOptions<MintToParams>) {

package/src/extensions/erc20/write/sigMint.ts

@@ -21,6 +21,7 @@ import {
  * @example
  * ```ts
  * import { mintWithSignature, generateMintSignature } from "thirdweb/extensions/erc20";
+ * import { sendTransaction } from "thirdweb";
  *
  * const { payload, signature } = await generateMintSignature(...)
  *
@@ -29,6 +30,7 @@ import {
  *   payload,
  *   signature,
  * });
+ *
  * await sendTransaction({ transaction, account });
  * ```
  * @extension ERC20

package/src/extensions/erc20/write/transfer.ts

@@ -24,11 +24,15 @@ export type TransferParams = Prettify<
  * @example
  * ```ts
  * import { transfer } from "thirdweb/extensions/erc20";
- * const tx = await transfer({
+ * import { sendTransaction } from "thirdweb";
+ *
+ * const transaction = transfer({
  *  contract,
  *  to: "0x...",
  *  amount: 100,
  * });
+ *
+ * await sendTransaction({ transaction, account });
  * ```
  */
 export function transfer(options: BaseTransactionOptions<TransferParams>) {

package/src/extensions/erc20/write/transferFrom.ts

@@ -26,6 +26,7 @@ export type TransferFromParams = Prettify<
  * @example
  * ```ts
  * import { transferFrom } from "thirdweb/extensions/erc20";
+ * import { sendTransaction } from "thirdweb";
  *
  * const transaction = transferFrom({
  *  contract: USDC_CONTRACT,
@@ -33,6 +34,8 @@ export type TransferFromParams = Prettify<
  *  to: "0x5678...",
  *  amount: 100,
  * });
+ *
+ * await sendTransaction({ transaction, account });
  * ```
  */
 export function transferFrom(

package/src/extensions/erc4337/account/addAdmin.ts

@@ -21,12 +21,14 @@ export type AddAdminOptions = {
  * @example
  * ```ts
  * import { addAdmin } from 'thirdweb/extensions/erc4337';
+ * import { sendTransaction } from 'thirdweb';
  *
  * const transaction = addAdmin({
  * contract,
  * account,
  * adminAddress: '0x...'
  * });
+ *
  * await sendTransaction({ transaction, account });
  * ```
  * @extension ERC4337

package/src/extensions/erc4337/account/addSessionKey.ts

@@ -26,6 +26,7 @@ export type AddSessionKeyOptions = {
  * @example
  * ```ts
  * import { addSessionKey } from 'thirdweb/extensions/erc4337';
+ * import { sendTransaction } from 'thirdweb';
  *
  * const transaction = addSessionKey({
  * contract,
@@ -38,6 +39,7 @@ export type AddSessionKeyOptions = {
  *  permissionEndTimestamp: new Date(Date.now() + 1000 * 60 * 60 * 24 * 365), // 1 year from now
  * }
  * });
+ *
  * await sendTransaction({ transaction, account });
  * ```
  * @extension ERC4337

package/src/extensions/erc4337/account/removeAdmin.ts

@@ -21,12 +21,14 @@ export type RemoveAdminOptions = {
  * @example
  * ```ts
  * import { removeAdmin } from 'thirdweb/extensions/erc4337';
+ * import { sendTransaction } from 'thirdweb';
  *
  * const transaction = removeAdmin({
  *  contract,
  *  account,
  *  adminAddress: '0x...'
  * });
+ *
  * await sendTransaction({ transaction, account });
  * ```
  * @extension ERC4337

package/src/extensions/erc4337/account/removeSessionKey.ts

@@ -21,12 +21,14 @@ export type RemoveSessionKeyOptions = {
  * @example
  * ```ts
  * import { removeSessionKey } from 'thirdweb/extensions/erc4337';
+ * import { sendTransaction } from 'thirdweb';
  *
  * const transaction = removeSessionKey({
  * contract,
  * account,
  * sessionKeyAddress
  * });
+ *
  * await sendTransaction({ transaction, account });
  * ```
  * @extension ERC4337

package/src/extensions/erc721/drops/write/claimTo.ts

@@ -18,11 +18,15 @@ export type ClaimToParams = {
  * @example
  * ```ts
  * import { claimTo } from "thirdweb/extensions/erc721";
- * const tx = await claimTo({
+ * import { sendTransaction } from "thirdweb";
+ *
+ * const transaction = claimTo({
  *   contract,
  *   to: "0x...",
  *   quantity: 1n,
  * });
+ *
+ * await sendTransaction({ transaction, account });
  * ```
  * @throws If no claim condition is set
  * @returns A promise that resolves with the submitted transaction hash.

package/src/extensions/erc721/drops/write/setClaimConditions.ts

@@ -16,8 +16,9 @@ export type SetClaimConditionsParams = {
  * @example
  * ```ts
  * import { setClaimConditions } from "thirdweb/extensions/erc721";
+ * import { sendTransaction } from "thirdweb";
  *
- * const tx = setClaimConditions({
+ * const transaction = setClaimConditions({
  *  contract,
  *  phases: [
  *    {
@@ -29,6 +30,8 @@ export type SetClaimConditionsParams = {
  *    },
  *   ],
  * });
+ *
+ * await sendTransaction({ transaction, account });
  * ```
  */
 export function setClaimConditions(

package/src/extensions/erc721/write/lazyMint.ts

@@ -36,8 +36,9 @@ export type LazyMintParams = {
  * @example
  * ```ts
  * import { lazyMint } from "thirdweb/extensions/erc721";
+ * import { sendTransaction } from "thirdweb";
  *
- * const tx = lazyMint({
+ * const transaction = lazyMint({
  *   contract,
  *   nfts: [
  *     {
@@ -47,6 +48,8 @@ export type LazyMintParams = {
  *     },
  *   ],
  * });
+ *
+ * await sendTransaction({ transaction, account });
  * ```
  */
 export function lazyMint(options: BaseTransactionOptions<LazyMintParams>) {

package/src/extensions/erc721/write/mintTo.ts

@@ -20,6 +20,8 @@ export type MintToParams = WithOverrides<{
  * @example
  * ```ts
  * import { mintTo } from "thirdweb/extensions/erc721";
+ * import { sendTransaction } from "thirdweb";
+ *
  * const transaction = mintTo({
  *  contract,
  *  to: "0x...",
@@ -30,8 +32,7 @@ export type MintToParams = WithOverrides<{
  *  },
  * });
  *
- * const { transactionHash } = await sendTransaction({ transaction, account });
- *
+ * await sendTransaction({ transaction, account });
  * ```
  */
 export function mintTo(options: BaseTransactionOptions<MintToParams>) {

package/src/extensions/erc721/write/sigMint.ts

@@ -22,6 +22,7 @@ import {
  * @example
  * ```ts
  * import { mintWithSignature, generateMintSignature } from "thirdweb/extensions/erc721";
+ * import { sendTransaction } from "thirdweb";
  *
  * const { payload, signature } = await generateMintSignature(...)
  *
@@ -30,6 +31,7 @@ import {
  *   payload,
  *   signature,
  * });
+ *
  * await sendTransaction({ transaction, account });
  * ```
  * @extension ERC721

package/src/extensions/farcaster/write/addSigner.ts

@@ -44,11 +44,15 @@ export type AddSignerParams = Prettify<
  * @example
  * ```ts
  * import { addSigner } from "thirdweb/extensions/farcaster";
- * const tx = await addSigner({
+ * import { sendTransaction } from "thirdweb";
+ *
+ * const transaction = addSigner({
  *  client,
  * 	appAccount,
  *  signerPublicKey
  * });
+ *
+ * await sendTransaction({ transaction, account });
  * ```
  */
 export function addSigner(options: AddSignerParams) {

package/src/extensions/farcaster/write/addSignerFor.ts

@@ -56,12 +56,16 @@ export type AddSignerForParams = Prettify<
  * @example
  * ```ts
  * import { addSignerFor } from "thirdweb/extensions/farcaster";
- * const tx = await addSignerFor({
+ * import { sendTransaction } from "thirdweb";
+ *
+ * const transaction = addSignerFor({
  *  client,
  * 	appAccount,
  * 	userAccount,
  *  signerPublicKey
  * });
+ *
+ * await sendTransaction({ transaction, account });
  * ```
  */
 export function addSignerFor(options: AddSignerForParams) {

package/src/extensions/farcaster/write/registerFid.ts

@@ -24,10 +24,14 @@ export type RegisterFidParams = {
  * @example
  * ```ts
  * import { registerFid } from "thirdweb/extensions/farcaster";
- * const tx = await registerFid({
+ * import { sendTransaction } from "thirdweb";
+ *
+ * const transaction = registerFid({
  *  client,
  * 	recoveryAddress
  * });
+ *
+ * await sendTransaction({ transaction, account });
  * ```
  */
 export function registerFid(options: RegisterFidParams) {

package/src/extensions/farcaster/write/registerFidAndSigner.ts

@@ -59,13 +59,17 @@ export type RegisterFidAndSignerParams = Prettify<
  * @example
  * ```ts
  * import { registerFidAndSigner } from "thirdweb/extensions/farcaster";
- * const tx = await registerFidAndSigner({
+ * import { sendTransaction } from "thirdweb";
+ *
+ * const transaction = registerFidAndSigner({
  *  client,
  *  userAccount,
  *  appAccount,
  * 	recoveryAddress,
  *  signerPublicKey
  * });
+ *
+ * await sendTransaction({ transaction, account });
  * ```
  */
 export function registerFidAndSigner(options: RegisterFidAndSignerParams) {

package/src/extensions/farcaster/write/rentStorage.ts

@@ -24,11 +24,15 @@ export type RentStorageParams = {
  * @example
  * ```ts
  * import { rentStorage } from "thirdweb/extensions/farcaster";
- * const tx = await rentStorage({
+ * import { sendTransaction } from "thirdweb";
+ *
+ * const transaction = rentStorage({
  *  client,
  * 	fid,
  *  units,
  * });
+ *
+ * await sendTransaction({ transaction, account });
  * ```
  */
 export function rentStorage(options: RentStorageParams) {

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

@@ -20,13 +20,16 @@ export type BuyFromListingParams = {
  * @example
  * ```ts
  * import { buyFromListing } from "thirdweb/extensions/marketplace";
+ * import { sendTransaction } from "thirdweb";
  *
- * const result = await buyFromListing({
+ * const transaction = buyFromListing({
  *  contract,
  *  listingId: 1n,
  *  quantity: 1n,
  *  recipient: "0x...",
  * });
+ *
+ * await sendTransaction({ transaction, account });
  * ```
  */
 export function buyFromListing(

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

@@ -71,10 +71,11 @@ export type CreateListingParams = {
  * @example
  * ```typescript
  * import { createListing } from "thirdweb/extensions/marketplace";
+ * import { sendTransaction } from "thirdweb";
  *
  * const transaction = createListing({...});
  *
- * const { transactionHash } = await sendTransaction({ transaction, account });
+ * await sendTransaction({ transaction, account });
  * ```
  */
 export function createListing(

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

@@ -76,10 +76,11 @@ export type UpdateListingParams = {
  * @example
  * ```typescript
  * import { updateListing } from "thirdweb/extensions/marketplace";
+ * import { sendTransaction } from "thirdweb";
  *
  * const transaction = updateListing({...});
  *
- * const { transactionHash } = await sendTransaction({ transaction, account });
+ * await sendTransaction({ transaction, account });
  * ```
  */
 export function updateListing(

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

@@ -22,12 +22,15 @@ export type BidInAuctionParams = {
  * @example
  * ```ts
  * import { bidInAuction } from "thirdweb/extensions/marketplace";
+ * import { sendTransaction } from "thirdweb";
  *
  * const transaction = bidInAuction({
  *  contract,
  *  auctionId: 0n,
  *  bidAmount: "100",
  * });
+ *
+ * await sendTransaction({ transaction, account });
  * ```
  */
 export function bidInAuction(

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

@@ -15,11 +15,14 @@ export type BuyoutAuctionParams = {
  * @example
  * ```ts
  * import { buyoutAuction } from "thirdweb/extensions/marketplace";
+ * import { sendTransaction } from "thirdweb";
  *
  * const transaction = buyoutAuction({
  *  contract,
  *  auctionId: 0n
  * });
+ *
+ * await sendTransaction({ transaction, account });
  * ```
  */
 export function buyoutAuction(

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

@@ -16,11 +16,14 @@ export type CancelAuctionParams = {
  * @example
  * ```ts
  * import { cancelAuction } from "thirdweb/extensions/marketplace";
+ * import { sendTransaction } from "thirdweb";
  *
  * const transaction = cancelAuction({
  *  contract,
  *  auctionId: 0n,
  * });
+ *
+ * await sendTransaction({ transaction, account });
  * ```
  */
 export function cancelAuction(

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

@@ -100,11 +100,11 @@ export type CreateAuctionParams = {
  * @example
  * ```typescript
  * import { createAuction } from "thirdweb/extensions/marketplace";
+ * import { sendTransaction } from "thirdweb";
  *
  * const transaction = createAuction({...});
  *
- * const { transactionHash } = await sendTransaction({ transaction, account });
- *
+ * await sendTransaction({ transaction, account });
  * ```
  */
 export function createAuction(

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

@@ -18,11 +18,14 @@ export type ExecuteSaleParams = {
  * @example
  * ```ts
  * import { executeSale } from "thirdweb/extensions/marketplace";
+ * import { sendTransaction } from "thirdweb";
  *
  * const transaction = executeSale({
  *  contract,
  *  auctionId: 0n,
  * });
+ *
+ * await sendTransaction({ transaction, account });
  * ```
  */
 export function executeSale(

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

@@ -23,11 +23,14 @@ export type AcceptOfferParams = GeneratedAcceptOfferParams;
  * @example
  * ```ts
  * import { acceptOffer } from "thirdweb/extensions/marketplace";
+ * import { sendTransaction } from "thirdweb";
  *
  * const acceptOfferTx = acceptOffer({
  *  contract,
  *  offerId: 1n,
  * });
+ *
+ * await sendTransaction({ transaction, account });
  * ```
  */
 export function acceptOffer(