Skip to main content

Interface: AuctionCreateTangleRequest

Request object to create an auction.

Properties​

auctionFloorPrice​

• auctionFloorPrice: number

Floor price of the auction. Minimum 1000000, maximum 1000000000000

auctionFrom​

• auctionFrom: Date

Starting date of the auction. Can not be sooner then 10 minutes.

auctionLength​

• auctionLength: number

Millisecond value of the auction length. Minimum 240000, maximum 2678400000

extendAuctionWithin​

• Optional extendAuctionWithin: number

Auction will be extended if a bid happens this many milliseconds before auction ends. Default value is 300000 minutes

extendedAuctionLength​

• Optional extendedAuctionLength: number

If set, auction will automatically extended by this length if a bid comes in within extendAuctionWithin before the end of the auction.

maxBids​

• maxBids: number

Specifies the maximum number of active bids. Minimum 1, maximum 10

minimalBidIncrement​

• Optional minimalBidIncrement: number

Defines the minimum increment of a subsequent bid. Minimum 1000000, maximum 1000000000000

network​

• network: "iota" | "atoi" | "smr" | "rms"

Network on which this auction accepts bids.

requestType​

• requestType: "CREATE_AUCTION"

Type of the tangle request.

space​

• space: string

Build5 id of the space

targetAddress​

• Optional targetAddress: string

A valid network address where funds will be sent.

topUpBased​

• Optional topUpBased: boolean

If set to true, consequent bids from the same user will be treated as topups