Read Contract
Last updated
Last updated
auctionBalance
The auctionBalance method returns the current balance associated with a specific auction. This information can also help determine whether all users have collected their funds from the given auction.
Data
Description
<input> (uint256)
The ID of the Bidding Auction for which you want to retrieve the current balance.
a. Input Bidding Auction ID
b. Return the current Balance of the Auction
auctionReferralFees
The auctionReferralFees function, with an input parameter of an auction ID, is designed to provide information about the set referral fees for the specified auction. This includes details about the referral fees configured for different referral levels.
Data
Description
<input> (uint256)
The Auction ID for which referral fee information is requested.
a. Input Bidding Auction ID
b. Returns the Fee for specific Referral level (100 = 1%)
auctionRoyaltyTeamMembers
The auctionRoyaltyTeamMembers method returns the fee assigned to a specific team member of a given INS (Initial NFT Selling) auction. This information is obtained by providing the INS ID and the user's ID associated with the team member.
Data
Description
<input> (uint256)
The unique identifier of the Bidding Auction.
<input> (uint256)
The ID associated with the specific team member.
a. Input the Auction ID
b. Input ID of a user in the team
c. Return the member address and the member Royalty fee
auctionTokenContractAddress
The method is used to retrieve the address of the token contract associated with a specific Bidding auction.
Data
Description
<input> (uint256)
The ID of the bidding auction for which we want to retrieve deposit information.
a. Input an Auction ID
b. Returns the Token Contract Address of specific auction ID
busd
This method returns the BUSD address
finalizationBlockDelay
The finalizationBlockDelay method returns the number of blocks that the auction's finalization is delayed after the auction's end. This delay period gives the auction operator time to review bids and decide whether to accept bids below the floor price.
getAllAuctions
The getAllAuctions function retrieves a collection of all created "Bidding Auctions", presenting the data in an array format. This array encapsulates crucial details including token ID, price, quantity, auction timeframe (start and end blocks), auction creator's address, multi-purchase availability, and unique token ID.
getAuctionBidsById
The getAuctionBidsById method is used to retrieve the current bids for a specific auction. To check the current bids, you need to provide the auction's ID.
Data
Description
_auctionId (uint256)
The Auction ID for which we want to get the Bids information.
a. Input an Auction ID
b. Return the Bids of a specific Auction
getAuctionById
The getAuctionById method takes an auctionId as input and returns a struct AuctionDetails that holds various details about the auction.
Data
Description
_auctionId (uint256)
The Auction ID for which we want to get the Auction Details
a. Input an Auction ID
b. Return the Bids of a specific Auction
getAuctionHeighestBid
The getAuctionHighestBid method is responsible for returning the highest bid details for a specific auction. When you provide the auction ID as an input parameter, you will receive information about the bidder's address, token quantity, bid price, block number, and whether the floor price has been exceeded.
Data
Description
_auctionId (uint256)
The Auction ID for which we want to get the Highest bid
a. Input an Auction ID
b. Return the highest Bid of a specific Auction
getAuctionTokens
The getAuctionTokens method retrieves an array of tuples containing information about all the auctions that have been created. Each tuple in the array includes the Auction ID, the address of the operator responsible for the auction, and a boolean value indicating whether the auction is active or ended.
getBatchAuctions
The getBatchAuctions method takes an array of auctionIds as input and returns an array of AuctionDetails structs, each containing information about a specific auction.
Data
Description
_auctionIds (uint256[])
The array of Auctions IDs to be checked
a. Input Auctions ID in array [ID1,ID2....]
b. Returns the information about the specific Auctions IDs
getCurrentAuctionId
The getCurrentAuctionId function requires no input parameters and is designed to provide information regarding the current auction ID sequence. This enables users to ascertain the total number of auctions that have been created thus far and obtain insight into the identifier of the upcoming auction, facilitating effective tracking of auction activities.
getRequiredToBeSoldTokenQuantity
The getRequiredToBeSoldTokenQuantity method returns information about whether there is a limit imposed on the tokens that a user can participate with for a given auction ID.
Data
Description
_auctionId (uint256)
The Auction ID for which we want to get limit of bidding tokens
a. Input an auctionID
b. Returns the information about the limit of the tokens
getTokenAuctions
The getTokenAuctions function takes a tokenId as input and returns an array of Auction structs representing the auction details that have been created for the specified token. This method allows you to retrieve all the auctions associated with a particular token and get insights into the auction details for that token.
Data
Description
_tokenId (uint256)
The token ID for which we want to get the information.
a. Input a token ID
b. Returns all auction that was created for a specific token
getWalletAuctionids
The getWalletAuctionIds function takes a walletAddress as input and returns an array of uint256 values representing the auction IDs that have been created by the specified wallet address. This method allows you to retrieve the auction IDs associated with a particular wallet address and get a list of auctions created by that address.
Data
Description
_wallet (address)
The wallet address for which we want to get the information.
a. Input a wallet address
b. Returns all auction ids that were created from a specific user
getWalletBidAcceptedTOkenQuantity
The getWalletBidAcceptedTokenQuantity function takes an _auctionId and _bidder address as inputs and returns a uint256 value. It checks whether the bid submitted by the specified bidder in the given auction has been accepted. If the bid is accepted, the function returns the number of accepted tokens.
Data
Description
_auctionId (uint256)
The Auction ID that we want to check
_bidder (address)
The Bidder address that we want to check
a. Input auction Id
b. Bidder Wallet Address
c. Returns the number of Accepted tokens
isFinalizedByOperator
The isFinalizedByOperator function accepts the _auctionId as an input parameter and returns a boolean value. It checks whether the operator of the specified auction has finalized the auction. If the operator has finalized the auction, the function returns true, indicating that the auction has been finalized. If the operator has not yet finalized the auction, the function returns false, indicating that the auction is not yet finalized. This method provides information about the finalization status of an auction by the operator.
Data
Description
_auctionId (uint256)
The Auction ID that we want to check
a. Input auction Id
b. Returns True if finalized or False if not
metaproReferral
The method allows obtaining the address of the contract that manages referral-related functionalities. This contract is responsible for tracking and handling referral rewards, calculating referral fees, and managing the referral system associated with the main contract.
metaproRoyalty
The method allows obtaining the address of the contract that manages royalty-related functionalities. This contract is responsible for handling royalty payments and managing the distribution of royalties to creators or token co-owners based on the terms and conditions specified in the smart contract.
owner
The method allows obtaining the address of the individual or entity that deployed and owns the smart contract. The contract owner has special privileges and permissions to perform certain administrative tasks or manage critical functionalities of the contract.
supporrtsInterface
This method is used to check if a given contract supports a specific interface. The interfaceId argument represents the interface identifier, which is a four-byte value. The method returns true if the contract supports the specified interface, or false if it does not.
Data
Description
interfaceId (bytes4)
Identifier of the interface you want to check.
a. Input the interface ID (you can apply the same approach to support the ERC-165 (0x01ffc9a7) interface or other interfaces. Simply change the identifier according to the interface you want to check.)
b. Response true or false if the Contract supports the Token Standard
treasuryFee
The method allows obtaining the transaction fee percentage applied to transactions within the contract. The fee is usually taken from the transaction amount and transferred to the treasury address for various purposes like funding the development, maintenance, or other operations related to the contract.
tressuryAddress
The method allows obtaining the address where the transaction fee collected from various contract interactions is transferred. Typically, the collected fees are sent to a designated treasury address, which can be managed by the contract owner or a specified entity.
