Interface IAuction

Interface that represents an auction smart contract which implements IAuction

interface

Hierarchy

IAuction

Implemented by

Index

Methods

Methods

auctionEnd

auctionEnd(tokenId: string): Promise<Transaction>

- Defined in pyropets/interface/IAuction.ts:14
End an auction if the bidding time has elapsed

Parameters
- tokenId: string
  
  the pyro tokenId
Returns Promise<Transaction>

cancelAuction

cancelAuction(tokenId: string): Promise<Transaction>

- Defined in pyropets/interface/IAuction.ts:20
Cancel an auction that has not been bid on yet

Parameters
- tokenId: string
  
  the pyro tokenId
Returns Promise<Transaction>

claim

claim(tokenId: string): Promise<Transaction>

- Defined in pyropets/interface/IAuction.ts:26
Claim the pyro from an auction as the winning bidder or the beneficiaryAddress if nno winning bidder

Parameters
- tokenId: string
  
  the pyro tokenId
Returns Promise<Transaction>

createAuction

createAuction(tokenId: string, minimumBid: bigint, biddingTime: bigint, beneficiaryAddress: string): Promise<Transaction>

- Defined in pyropets/interface/IAuction.ts:35
Create a new auction

Parameters
- tokenId: string
  
  the pyro tokenId
- minimumBid: bigint
  
  the minimum bid amount in satoshi
- biddingTime: bigint
  
  the amount of time for bidding in seconds
- beneficiaryAddress: string
  
  the address which will be awarded the winning bid, or the pyro if no winner
Returns Promise<Transaction>

getAuction

getAuction(tokenId: string): Promise<Auction>

- Defined in pyropets/interface/IAuction.ts:46
Returns an Auction object

Parameters
- tokenId: string
  
  the pyro tokenId
Returns Promise<Auction>

withdraw

withdraw(): Promise<Transaction>

- Defined in pyropets/interface/IAuction.ts:51
Withdraw any funds available from bids which have been outbid

Returns Promise<Transaction>

Generated using TypeDoc