Class SimpleAuction

Hierarchy (view full)

Constructors

constructor

Properties

abi address bytecode provider

Methods

auctionEnd balance bid call cancelAuction claim core createAuction getAuction getEventLogs owner pause paused pendingReturns renounceOwnership send transferOwnership unpause withdraw

Constructors

constructor

Properties

abi

abi: any[]

address

address: string

bytecode

bytecode: undefined | string

provider

provider: Provider

Methods

auctionEnd

  • auctionEnd(assetAddress, tokenId): Promise<Transaction>

  • End an auction once it has expired. During this step the beneficiary is paid

    Parameters

    • assetAddress: string

      the EVM adddress of the MRC721 contract

    • tokenId: bigint

      the uint256 id of the token

    Returns Promise<Transaction>

    an array of TransactionReceipt objects

balance

bid

  • bid(assetAddress, tokenId, bidAmount?): Promise<Transaction>

  • Bid on a MRC721 token that is for auction

    Parameters

    • assetAddress: string

      the EVM adddress of the MRC721 contract

    • tokenId: bigint

      the uint256 id of the token

    • bidAmount: undefined | string = '0'

      the amount in MRX as a string

    Returns Promise<Transaction>

    an array of TransactionReceipt objects

call

  • call(method, args): Promise<undefined | Result>

  • Perform calltocontract

    Parameters

    • method: string

      The contract method to call

    • args: any[]

      The arguments

    Returns Promise<undefined | Result>

    see Result

cancelAuction

  • cancelAuction(assetAddress, tokenId): Promise<Transaction>

  • Cancels an MRC721 auction if has not been bid on yet

    Parameters

    • assetAddress: string

      the EVM adddress of the MRC721 contract

    • tokenId: bigint

      the uint256 id of the token

    Returns Promise<Transaction>

    an array of TransactionReceipt objects

claim

  • claim(assetAddress, tokenId, gasLimit?): Promise<Transaction>

  • Claim the asset from an ended auction

    Parameters

    • assetAddress: string

      the EVM adddress of the MRC721 contract

    • tokenId: bigint

      the uint256 id of the token

    • gasLimit: undefined | number = 300000

      optionally the maximum units of gas which can be consumed

    Returns Promise<Transaction>

    an array of TransactionReceipt objects

core

createAuction

  • createAuction(assetAddress, tokenId, minimumBid, biddingTime, beneficiaryAddress, gasLimit?): Promise<Transaction>

  • Create a new MRC721 auction

    Parameters

    • assetAddress: string

      the EVM adddress of the MRC721 contract

    • tokenId: bigint

      the uint256 id of the token

    • minimumBid: bigint

      the minimum bit in satoshi MRX

    • biddingTime: bigint

      the bidding time in seconds

    • beneficiaryAddress: string

      the EVM adddress which the proceeds will go to

    • gasLimit: undefined | number = 300000

      optionally the maximum units of gas which can be consumed

    Returns Promise<Transaction>

    an array of TransactionReceipt objects

getAuction

  • getAuction(assetAddress, tokenId): Promise<[tokenId: bigint, winningBid: bigint, minimumBid: bigint, biddingTime: bigint, startTime: bigint, winningBidder: string, beneficiaryAddress: string, ended: boolean]>

  • Get a auction object from the contract state

    Parameters

    • assetAddress: string

      the EVM adddress of the MRC721 contract

    • tokenId: bigint

      the uint256 id of the token

    Returns Promise<[tokenId: bigint, winningBid: bigint, minimumBid: bigint, biddingTime: bigint, startTime: bigint, winningBidder: string, beneficiaryAddress: string, ended: boolean]>

    the Sale object

getEventLogs

owner

pause

paused

pendingReturns

  • pendingReturns(address): Promise<bigint>

  • Get the balance of MRX in the auction contract if the address has been outbid

    Parameters

    • address: string

    Returns Promise<bigint>

    the satoshi amount of MRX

renounceOwnership

send

  • send(method, args, value?, gasLimit?, gasPrice?): Promise<{
        hash160: string;
        sender: string;
        txid: string;
    }>

  • Perform sendtocontract

    Parameters

    • method: string

      The contract method to send to

    • args: any[]

      The arguments to use

    • value: undefined | string = '0'

      The amount to send to the contract

    • gasLimit: undefined | number = 250000

      The amount of gas units allowed

    • gasPrice: undefined | number = 5000

      The satoshi price per gas

    Returns Promise<{
        hash160: string;
        sender: string;
        txid: string;
    }>

    see Result

transferOwnership

unpause

withdraw

Settings

Member Visibility

On This Page

Constructors
Properties
Methods