EnglishAuction
Represents a new marketplace english-auction.
type EnglishAuction = {asset : objectOutputType<extendShape<extendShape<{ animation_url: ZodNullable<ZodOptional<ZodUnion<[ZodUnion<[ZodTypeAny, ZodObject<..., ..., ..., ..., ...>]>, ZodString]>>>; description: ZodNullable<ZodOptional<ZodNullable<ZodString>>>; image: ZodOptional<ZodNullable<ZodUnion<[ZodUnion<[ZodTypeAny, ZodObject<..., ..., ..., ..., ...>]>, ZodString]>>>; name: ZodNullable<ZodOptional<ZodUnion<[ZodString, ZodNumber]>>> }, { attributes: ZodNullable<ZodOptional<ZodUnion<[ZodEffects<ZodArray<ZodArray<..., ...>, "many">, Array<objectOutputType<..., ..., ...>>, Array<Array<...>>>, ZodArray<ZodObject<{ }, "strip", ZodUnion<...>, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, "many">, ZodObject<{ }, "strip", ZodUnion<[..., ...]>, objectOutputType<{ }, ZodUnion<...>, "strip">, objectInputType<{ }, ZodUnion<...>, "strip">>]>>>; background_color: ZodNullable<ZodOptional<ZodUnion<[ZodString, ZodEffects<ZodString, string, string>, ZodString]>>>; external_url: ZodOptional<ZodNullable<ZodUnion<[ZodUnion<[ZodTypeAny, ZodObject<..., ..., ..., ..., ...>]>, ZodString]>>>; properties: ZodNullable<ZodOptional<ZodUnion<[ZodEffects<ZodArray<ZodArray<..., ...>, "many">, Array<objectOutputType<..., ..., ...>>, Array<Array<...>>>, ZodArray<ZodObject<{ }, "strip", ZodUnion<...>, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, "many">, ZodObject<{ }, "strip", ZodUnion<[..., ...]>, objectOutputType<{ }, ZodUnion<...>, "strip">, objectInputType<{ }, ZodUnion<...>, "strip">>]>>> }>, { animation_url: ZodOptional<ZodNullable<ZodString>>; external_url: ZodOptional<ZodNullable<ZodString>>; id: ZodString; image: ZodOptional<ZodNullable<ZodString>>; uri: ZodString }>, ZodUnion<[ZodEffects<ZodUnion<[ZodBigInt, ZodType<BigNumber, ZodTypeDef, BigNumber>, ZodType<BN, ZodTypeDef, BN>]>, string, bigint | (BN) | (BigNumber)>, ZodUnknown]>, "strip">,assetContractAddress : string,bidBufferBps : number,buyoutBidAmount : string,buyoutCurrencyValue : { decimals: number; displayValue: string; name: string; symbol: string; value: BigNumber },creatorAddress : string,currencyContractAddress : string,endTimeInSeconds : number,id : string,minimumBidAmount : string,minimumBidCurrencyValue : { decimals: number; displayValue: string; name: string; symbol: string; value: BigNumber },quantity : string,startTimeInSeconds : number,status : Status,timeBufferInSeconds : number,tokenId : string}
The asset being auctioned.
type asset = objectOutputType<extendShape<extendShape<{ animation_url: ZodNullable<ZodOptional<ZodUnion<[ZodUnion<[ZodTypeAny, ZodObject<..., ..., ..., ..., ...>]>, ZodString]>>>; description: ZodNullable<ZodOptional<ZodNullable<ZodString>>>; image: ZodOptional<ZodNullable<ZodUnion<[ZodUnion<[ZodTypeAny, ZodObject<..., ..., ..., ..., ...>]>, ZodString]>>>; name: ZodNullable<ZodOptional<ZodUnion<[ZodString, ZodNumber]>>> }, { attributes: ZodNullable<ZodOptional<ZodUnion<[ZodEffects<ZodArray<ZodArray<..., ...>, "many">, Array<objectOutputType<..., ..., ...>>, Array<Array<...>>>, ZodArray<ZodObject<{ }, "strip", ZodUnion<...>, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, "many">, ZodObject<{ }, "strip", ZodUnion<[..., ...]>, objectOutputType<{ }, ZodUnion<...>, "strip">, objectInputType<{ }, ZodUnion<...>, "strip">>]>>>; background_color: ZodNullable<ZodOptional<ZodUnion<[ZodString, ZodEffects<ZodString, string, string>, ZodString]>>>; external_url: ZodOptional<ZodNullable<ZodUnion<[ZodUnion<[ZodTypeAny, ZodObject<..., ..., ..., ..., ...>]>, ZodString]>>>; properties: ZodNullable<ZodOptional<ZodUnion<[ZodEffects<ZodArray<ZodArray<..., ...>, "many">, Array<objectOutputType<..., ..., ...>>, Array<Array<...>>>, ZodArray<ZodObject<{ }, "strip", ZodUnion<...>, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, "many">, ZodObject<{ }, "strip", ZodUnion<[..., ...]>, objectOutputType<{ }, ZodUnion<...>, "strip">, objectInputType<{ }, ZodUnion<...>, "strip">>]>>> }>, { animation_url: ZodOptional<ZodNullable<ZodString>>; external_url: ZodOptional<ZodNullable<ZodString>>; id: ZodString; image: ZodOptional<ZodNullable<ZodString>>; uri: ZodString }>, ZodUnion<[ZodEffects<ZodUnion<[ZodBigInt, ZodType<BigNumber, ZodTypeDef, BigNumber>, ZodType<BN, ZodTypeDef, BN>]>, string, bigint | (BN) | (BigNumber)>, ZodUnknown]>, "strip">
The address of the asset being auctioned.
type assetContractAddress = string;
This is a buffer in basis points e.g. x%.
To be considered as a new winning bid, a bid must be at least x% greater than the current winning bid.
type bidBufferBps = number;
The buyout price of the auction.
type buyoutBidAmount = string;
The CurrencyValue
of the buyout price.
Useful for displaying the price information.
type buyoutCurrencyValue = { decimals: number; displayValue: string; name: string; symbol: string; value: BigNumber;};
The address of the creator of auction.
type creatorAddress = string;
The address of the currency to accept for the auction.
type currencyContractAddress = string;
The end time of the auction.
type endTimeInSeconds = number;
The id of the auction
type id = string;
The minimum price that a bid must be in order to be accepted.
type minimumBidAmount = string;
The CurrencyValue
of the minimum bid amount.
Useful for displaying the price information.
type minimumBidCurrencyValue = { decimals: number; displayValue: string; name: string; symbol: string; value: BigNumber;};
The quantity of tokens to include in the auction.
For ERC721s, this value should always be 1 (and will be forced internally regardless of what is passed here).
type quantity = string;
The start time of the auction.
type startTimeInSeconds = number;
Whether the listing is CREATED, COMPLETED, or CANCELLED.
This is a buffer e.g. x seconds.
If a new winning bid is made less than x seconds before expirationTimestamp, the expirationTimestamp is increased by x seconds.
type timeBufferInSeconds = number;
The ID of the token to auction.
type tokenId = string;