References
MarketplaceV3EnglishAuctions

MarketplaceV3EnglishAuctions

Handles auctions


class MarketplaceV3EnglishAuctions<
  TContract extends EnglishAuctionsLogic,
> implements DetectableFeature {}


function constructor(
  contractWrapper: ContractWrapper<TContract>,
  storage: ThirdwebStorage<IpfsUploadBatchOptions>,
): MarketplaceV3EnglishAuctions<TContract>;

Parameters

Type


let contractWrapper: ContractWrapper<TContract>;

Type


let storage: ThirdwebStorage<IpfsUploadBatchOptions>;

Returns


let returnType: MarketplaceV3EnglishAuctions<TContract>;

Methods


function getAddress(): string;

Returns


let returnType: string;

Get all english auctions

Example


const auctions = await contract.englishAuctions.getAll();


function getAll(
  filter?: MarketplaceFilterWithoutOfferor,
): Promise<Array<EnglishAuction>>;

Parameters

optional filter parameters

Type


let filter: MarketplaceFilterWithoutOfferor;

Returns


let returnType: {
  asset: NFT;
  assetContractAddress: Address;
  bidBufferBps: bigint;
  buyoutBidAmount: bigint;
  buyoutCurrencyValue: GetBalanceResult;
  creatorAddress: Address;
  currencyContractAddress: Address;
  endTimeInSeconds: bigint;
  id: bigint;
  minimumBidAmount: bigint;
  minimumBidCurrencyValue: GetBalanceResult;
  quantity: bigint;
  startTimeInSeconds: bigint;
  status: ListingStatus;
  timeBufferInSeconds: bigint;
  tokenId: bigint;
  type: "english-auction";
};

The Auction object array

Get all valid english auctions

Example


const auctions = await contract.englishAuctions.getAllValid();


function getAllValid(
  filter?: MarketplaceFilterWithoutOfferor,
): Promise<Array<EnglishAuction>>;

Parameters

optional filter parameters

Type


let filter: MarketplaceFilterWithoutOfferor;

Returns


let returnType: {
  asset: NFT;
  assetContractAddress: Address;
  bidBufferBps: bigint;
  buyoutBidAmount: bigint;
  buyoutCurrencyValue: GetBalanceResult;
  creatorAddress: Address;
  currencyContractAddress: Address;
  endTimeInSeconds: bigint;
  id: bigint;
  minimumBidAmount: bigint;
  minimumBidCurrencyValue: GetBalanceResult;
  quantity: bigint;
  startTimeInSeconds: bigint;
  status: ListingStatus;
  timeBufferInSeconds: bigint;
  tokenId: bigint;
  type: "english-auction";
};

The Auction object array

Get a single english auction

Example


const auctionId = 0;
const auction = await contract.englishAuctions.getAuction(auctionId);


function getAuction(auctionId: BigNumberish): Promise<EnglishAuction>;

Parameters

the auction Id

Type


let auctionId: BigNumberish;

Returns


let returnType: {
  asset: NFT;
  assetContractAddress: Address;
  bidBufferBps: bigint;
  buyoutBidAmount: bigint;
  buyoutCurrencyValue: GetBalanceResult;
  creatorAddress: Address;
  currencyContractAddress: Address;
  endTimeInSeconds: bigint;
  id: bigint;
  minimumBidAmount: bigint;
  minimumBidCurrencyValue: GetBalanceResult;
  quantity: bigint;
  startTimeInSeconds: bigint;
  status: ListingStatus;
  timeBufferInSeconds: bigint;
  tokenId: bigint;
  type: "english-auction";
};

The Auction object

Get the buffer for an english auction

Example


// The ID of the auction you want to get the buffer for
const auctionId = "0";
const buffer =
  await contract.englishAuctions.getBidBufferBps(auctionId);


function getBidBufferBps(auctionId: BigNumberish): Promise<number>;

Parameters

id of the auction

Type


let auctionId: BigNumberish;

Returns


let returnType: Promise<number>;

The buffer in basis points

Get the minimum next bid for an english auction

Example


// The ID of the auction you want to get the minimum next bid for
const auctionId = "0";
const minimumNextBid =
  await contract.englishAuctions.getMinimumNextBid(auctionId);


function getMinimumNextBid(
  auctionId: BigNumberish,
): Promise<{
  decimals: number;
  displayValue: string;
  name: string;
  symbol: string;
  value: BigNumber;
}>;

Parameters

id of the auction

Type


let auctionId: BigNumberish;

Returns


let returnType: Promise<{
  decimals: number;
  displayValue: string;
  name: string;
  symbol: string;
  value: BigNumber;
}>;

The minimum bid a user can place to outbid the previous highest bid

Get the total number of english auctions

Example


const totalAuctions = await contract.englishAuctions.getTotalCount();


function getTotalCount(): Promise<BigNumber>;

Returns


let returnType: Promise<BigNumber>;

Returns the total number of auctions created.

Get the winner for a specific english auction

Get the winner of the auction after an auction ends.

Example


// The auction ID of a closed english auction
const auctionId = 0;
const auctionWinner =
  await contract.englishAuctions.getWinner(auctionId);


function getWinner(auctionId: BigNumberish): Promise<string>;

Parameters

the auction Id

Type


let auctionId: BigNumberish;

Returns


let returnType: Promise<string>;

The address of the auction winner

Get winning bid of an english auction

Get the current highest bid of an active auction.

Example


// The ID of the auction
const auctionId = 0;
const winningBid =
  await contract.englishAuctions.getWinningBid(auctionId);


function getWinningBid(
  auctionId: BigNumberish,
): Promise<undefined | Bid>;

Parameters

the auction Id

Type


let auctionId: BigNumberish;

Returns


let returnType: Promise<undefined | Bid>;

Check if a bid is or will be a winning bid

Example


const auctionId = 0;
const bidAmount = 100;
const isWinningBid = await contract.englishAuctions.isWinningBid(
  auctionId,
  bidAmount,
);


function isWinningBid(
  auctionId: BigNumberish,
  bidAmount: BigNumberish,
): Promise<boolean>;

Parameters

Auction Id

Type


let auctionId: BigNumberish;

Amount to bid

Type


let bidAmount: BigNumberish;

Returns


let returnType: Promise<boolean>;

true if the bid is or will be a winning bid


function buyoutAuction(auctionId: BigNumberish): Promise<TResult>;

Parameters

Type


let auctionId: BigNumberish;

Returns


let returnType: Promise<TResult>;

The transaction result

Preparable

You can also prepare the transaction without executing it by calling buyoutAuction.prepare() with same arguments. Learn more


function cancelAuction(auctionId: BigNumberish): Promise<TResult>;

Parameters

Type


let auctionId: BigNumberish;

Returns


let returnType: Promise<TResult>;

The transaction result

Preparable

You can also prepare the transaction without executing it by calling cancelAuction.prepare() with same arguments. Learn more


function closeAuctionForBidder(
  auctionId: BigNumberish,
  closeFor: string,
): Promise<TResult>;

Parameters

Type


let auctionId: BigNumberish;

Type


let closeFor: string;

Returns


let returnType: Promise<TResult>;

The transaction result

Preparable

You can also prepare the transaction without executing it by calling closeAuctionForBidder.prepare() with same arguments. Learn more


function closeAuctionForSeller(
  auctionId: BigNumberish,
): Promise<TResult>;

Parameters

Type


let auctionId: BigNumberish;

Returns


let returnType: Promise<TResult>;

The transaction result

Preparable

You can also prepare the transaction without executing it by calling closeAuctionForSeller.prepare() with same arguments. Learn more


function createAuction(auction: {
  assetContractAddress: string;
  bidBufferBps?: string | number | bigint | BigNumber;
  buyoutBidAmount: string | number;
  currencyContractAddress?: string;
  endTimestamp?: number | Date;
  minimumBidAmount: string | number;
  quantity?: string | number | bigint | BigNumber;
  startTimestamp?: number | Date;
  timeBufferInSeconds?: string | number | bigint | BigNumber;
  tokenId: string | number | bigint | BigNumber;
}): Promise<TResult>;

Parameters

Type


let auction: {
  assetContractAddress: string;
  bidBufferBps?: string | number | bigint | BigNumber;
  buyoutBidAmount: string | number;
  currencyContractAddress?: string;
  endTimestamp?: number | Date;
  minimumBidAmount: string | number;
  quantity?: string | number | bigint | BigNumber;
  startTimestamp?: number | Date;
  timeBufferInSeconds?: string | number | bigint | BigNumber;
  tokenId: string | number | bigint | BigNumber;
};

Returns


let returnType: Promise<TResult>;

The transaction hash and the auction id

Preparable

You can also prepare the transaction without executing it by calling createAuction.prepare() with same arguments. Learn more


function createAuctionsBatch(
  listings: Array<{
    assetContractAddress: string;
    bidBufferBps?: string | number | bigint | BigNumber;
    buyoutBidAmount: string | number;
    currencyContractAddress?: string;
    endTimestamp?: number | Date;
    minimumBidAmount: string | number;
    quantity?: string | number | bigint | BigNumber;
    startTimestamp?: number | Date;
    timeBufferInSeconds?: string | number | bigint | BigNumber;
    tokenId: string | number | bigint | BigNumber;
  }>,
): Promise<TResult>;

Parameters

Type


let listings: Array<{
  assetContractAddress: string;
  bidBufferBps?: string | number | bigint | BigNumber;
  buyoutBidAmount: string | number;
  currencyContractAddress?: string;
  endTimestamp?: number | Date;
  minimumBidAmount: string | number;
  quantity?: string | number | bigint | BigNumber;
  startTimestamp?: number | Date;
  timeBufferInSeconds?: string | number | bigint | BigNumber;
  tokenId: string | number | bigint | BigNumber;
}>;

Returns


let returnType: Promise<TResult>;

Preparable

You can also prepare the transaction without executing it by calling createAuctionsBatch.prepare() with same arguments. Learn more


function executeSale(auctionId: BigNumberish): Promise<TResult>;

Parameters

Type


let auctionId: BigNumberish;

Returns


let returnType: Promise<TResult>;

The transaction result

Preparable

You can also prepare the transaction without executing it by calling executeSale.prepare() with same arguments. Learn more


function makeBid(
  auctionId: BigNumberish,
  bidAmount: string | number,
): Promise<TResult>;

Parameters

Type


let auctionId: BigNumberish;

Type


let bidAmount: string | number;

Returns


let returnType: Promise<TResult>;

The transaction result

Preparable

You can also prepare the transaction without executing it by calling makeBid.prepare() with same arguments. Learn more

Properties


let encoder: ContractEncoder<EnglishAuctionsLogic>;


let estimator: GasCostEstimator<EnglishAuctionsLogic>;


let events: ContractEvents<EnglishAuctionsLogic>;


let featureName: "EnglishAuctions";


let interceptor: ContractInterceptor<EnglishAuctionsLogic>;

Was this page helpful?

Need help?
Visit our support site
Watch our
Video Tutorials
View our
Changelog

Subscribe for the latest dev updates

MarketplaceV3EnglishAuctions

Signature

Constructor

Signature

Parameters

contractWrapper

Type

storage

Type

Returns

Return Type

Methods

getAddress

Signature

Returns

Return Type

getAll

Example

Signature

Parameters

filter

Type

Returns

Return Type

getAllValid

Example

Signature

Parameters

filter

Type

Returns

Return Type

getAuction

Example

Signature

Parameters

auctionId

Type

Returns

Return Type

getBidBufferBps

Example

Signature

Parameters

auctionId

Type

Returns

Return Type

getMinimumNextBid

Example

Signature

Parameters

auctionId

Type

Returns

Return Type

getTotalCount

Example

Signature

Returns

Return Type

getWinner

Example

Signature

Parameters

auctionId

Type

Returns

Return Type

getWinningBid

Example

Signature

Parameters

auctionId

Type

Returns

Return Type

isWinningBid

Example

Signature