Class StokingAuction

Class which can be used to interact with the PyroPets StokingAuction contract

Hierarchy

StokingAuction

Implements

IAuction

Index

Constructors

constructor

Properties

auction

Methods

Constructors

constructor

new StokingAuction(provider: Provider): StokingAuction

- Defined in pyropets/StokingAuction.ts:12
Parameters
- provider: Provider
Returns StokingAuction

Properties

Private auction

auction: MetrixContract

Methods

auctionEnd

auctionEnd(tokenId: string): Promise<Transaction>

Implementation of IAuction.auctionEnd
- Defined in pyropets/StokingAuction.ts:21
End an auction if the bidding time has elapsed

Parameters
- tokenId: string
Returns Promise<Transaction>

auctions

auctions(tokenId: string): Promise<Auction>

- Defined in pyropets/StokingAuction.ts:38
Returns an Auction object

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

bid

bid(tokenId: string, donor: string): Promise<Transaction>

- Defined in pyropets/StokingAuction.ts:68
Bid on a stoking auction

Parameters
- tokenId: string
  
  the auctioned pyro tokenId
- donor: string
  
  the pyro tokenId of the donorA
Returns Promise<Transaction>

cancelAuction

cancelAuction(tokenId: string): Promise<Transaction>

Implementation of IAuction.cancelAuction
- Defined in pyropets/StokingAuction.ts:84
Cancel an auction that has not been bid on yet

Parameters
- tokenId: string
Returns Promise<Transaction>

claim

claim(tokenId: string): Promise<Transaction>

Implementation of IAuction.claim
- Defined in pyropets/StokingAuction.ts:97
Claim the pyro from an auction as the winning bidder or the beneficiaryAddress if nno winning bidder

Parameters
- tokenId: string
Returns Promise<Transaction>

core

core(): Promise<string>

- Defined in pyropets/StokingAuction.ts:113
Returns the address of the PyroCore contract

Returns Promise<string>

createAuction

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

Implementation of IAuction.createAuction
- Defined in pyropets/StokingAuction.ts:118
Create a new auction

Parameters
- tokenId: string
- minimumBid: bigint
- biddingTime: bigint
- beneficiaryAddress: string
Returns Promise<Transaction>

donors

donors(tokenId: string): Promise<string>

- Defined in pyropets/StokingAuction.ts:148
Returns the donor tokenId from an auction

Parameters
- tokenId: string
Returns Promise<string>

getAuction

getAuction(tokenId: string): Promise<Auction>

Implementation of IAuction.getAuction
- Defined in pyropets/StokingAuction.ts:153
Returns an Auction object

Parameters
- tokenId: string
Returns Promise<Auction>

pendingReturns

pendingReturns(addr: string): Promise<bigint>

- Defined in pyropets/StokingAuction.ts:182
Parameters
- addr: string
Returns Promise<bigint>

stokingCost

stokingCost(donorA: string, donorB: string): Promise<bigint>

- Defined in pyropets/StokingAuction.ts:196
Parameters
- donorA: string
- donorB: string
Returns Promise<bigint>

withdraw

withdraw(): Promise<Transaction>

Implementation of IAuction.withdraw
- Defined in pyropets/StokingAuction.ts:208
Withdraw any funds available from bids which have been outbid

Returns Promise<Transaction>

Generated using TypeDoc