6.0.0 • Published 5 years ago

riftpact v6.0.0

Weekly downloads
1
License
ISC
Repository
-
Last release
5 years ago

RiftPact: OathForge Token Fracturizer

Author: GuildCrypt

Documentation generated by @GuildCrypt/solspecdown

NameType
allowance(address,address)function (constant)
constructor(address,uint256,uint256,address,uint256,uint256,uint256)constructor
Approval(address,address,uint256)event
approve(address,uint256)function (non-constant)
auctionAllowedAt()function (constant)
AuctionCompleted(address,uint256)event
auctionCompletedAt()function (constant)
AuctionStarted()event
auctionStartedAt()function (constant)
balanceOf(address)function (constant)
Bid(address,uint256)event
completeAuction()function (non-constant)
currencyAddress()function (constant)
decreaseAllowance(address,uint256)function (non-constant)
increaseAllowance(address,uint256)function (non-constant)
isBlacklisted(address)function (constant)
isOwner()function (constant)
minAuctionCompleteWait()function (constant)
minBid()function (constant)
minBidDeltaPermille()function (constant)
owner()function (constant)
OwnershipTransferred(address,address)event
parentToken()function (constant)
parentTokenId()function (constant)
PayoutTokenHolder(address,uint256)event
payoutTokenHolder(address)function (non-constant)
payoutWinner()function (non-constant)
PayoutWinner()event
renounceOwnership()function (non-constant)
setIsBlacklisted(address,bool)function (non-constant)
startAuction()function (non-constant)
submitBid(uint256)function (non-constant)
topBid()function (constant)
topBidder()function (constant)
totalSupply()function (constant)
Transfer(address,address,uint256)event
transfer(address,uint256)function (non-constant)
transferFrom(address,address,uint256)function (non-constant)
transferOwnership(address)function (non-constant)

allowance(address,address)

Function to check the amount of tokens that an owner allowed to a spender.

Inputs
TypeNameDescription
0addressowneraddress The address which owns the funds.
1addressspenderaddress The address which will spend the funds.
Outputs
TypeNameDescription
0uint256

constructor(address,uint256,uint256,address,uint256,uint256,uint256)

Inputs
TypeNameDescription
0address__parentToken
1uint256__parentTokenId
2uint256__totalSupply
3address__currencyAddress
4uint256__auctionAllowedAt
5uint256__minAuctionCompleteWait
6uint256__minBidDeltaPermille

Approval(address,address,uint256)

Inputs
TypeNameDescriptionIndexed?
0addressownertrue
1addressspendertrue
2uint256valuefalse

approve(address,uint256)

Approve the passed address to spend the specified amount of tokens on behalf of msg.sender. Beware that changing an allowance with this method brings the risk that someone may use both the old and the new allowance by unfortunate transaction ordering. One possible solution to mitigate this race condition is to first reduce the spender's allowance to 0 and set the desired value afterwards: https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729

Inputs
TypeNameDescription
0addressspenderThe address which will spend the funds.
1uint256valueThe amount of tokens to be spent.
Outputs
TypeNameDescription
0bool

auctionAllowedAt()

Returns the timestamp at which anyone can start an auction by calling startAuction()

Outputs
TypeNameDescription
0uint256

AuctionCompleted(address,uint256)

Inputs
TypeNameDescriptionIndexed?
0addresswinnerfalse
1uint256bidfalse

auctionCompletedAt()

Returns the timestamp at which an auction was completed or 0 if no auction has been completed

Outputs
TypeNameDescription
0uint256

AuctionStarted()


auctionStartedAt()

Returns the timestamp at which an auction was started or 0 if no auction has been started

Outputs
TypeNameDescription
0uint256

balanceOf(address)

Gets the balance of the specified address.

Inputs
TypeNameDescription
0addressownerThe address to query the balance of.
Outputs
TypeNameDescription
0uint256

Bid(address,uint256)

Inputs
TypeNameDescriptionIndexed?
0addressbidderfalse
1uint256bidfalse

completeAuction()

Complete auction

currencyAddress()

Returns the currency contract address.

Outputs
TypeNameDescription
0address

decreaseAllowance(address,uint256)

Decrease the amount of tokens that an owner allowed to a spender. approve should be called when allowed__spender == 0. To decrement allowed value is better to use this function to avoid 2 calls (and wait until the first transaction is mined) From MonolithDAO Token.sol

Inputs
TypeNameDescription
0addressspenderThe address which will spend the funds.
1uint256subtractedValueThe amount of tokens to decrease the allowance by.
Outputs
TypeNameDescription
0bool

increaseAllowance(address,uint256)

Increase the amount of tokens that an owner allowed to a spender. approve should be called when allowed__spender == 0. To increment allowed value is better to use this function to avoid 2 calls (and wait until the first transaction is mined) From MonolithDAO Token.sol Emits an Approval event.

Inputs
TypeNameDescription
0addressspenderThe address which will spend the funds.
1uint256addedValueThe amount of tokens to increase the allowance by.
Outputs
TypeNameDescription
0bool

isBlacklisted(address)

Returns if an address is blacklisted

Inputs
TypeNameDescription
0addresstoThe address to check
Outputs
TypeNameDescription
0bool

isOwner()

Outputs
TypeNameDescription
0bool

minAuctionCompleteWait()

Returns the minimum amount of time (in seconds) between when a bid is placed and when an auction can be completed.

Outputs
TypeNameDescription
0uint256

minBid()

Returns the minimum bid in currency

Outputs
TypeNameDescription
0uint256

minBidDeltaPermille()

Returns the minimum increase (expressed as 1/1000ths of the current bid) that a subsequent bid must be

Outputs
TypeNameDescription
0uint256

owner()

Outputs
TypeNameDescription
0address

OwnershipTransferred(address,address)

Inputs
TypeNameDescriptionIndexed?
0addresspreviousOwnertrue
1addressnewOwnertrue

parentToken()

Returns the OathForge contract address. UI should check for phishing..

Outputs
TypeNameDescription
0address

parentTokenId()

Returns the OathForge token id. Does not imply RiftPact has ownership over token.

Outputs
TypeNameDescription
0uint256

PayoutTokenHolder(address,uint256)

Inputs
TypeNameDescriptionIndexed?
0addresstokenHolderfalse
1uint256balancefalse

payoutTokenHolder(address)

Payout token holder (with currency) after auction completed

Inputs
TypeNameDescription
0addresstokenHolder

payoutWinner()

Payout winner (with parent token) after auction completed

PayoutWinner()


renounceOwnership()

Allows the current owner to relinquish control of the contract.

setIsBlacklisted(address,bool)

Set if an address is blacklisted

Inputs
TypeNameDescription
0addresstoThe address to change
1bool__isBlacklistedTrue if the address should be blacklisted, false otherwise

startAuction()

Start an auction

submitBid(uint256)

Submit a bid. Must have sufficient funds approved in currency contract (bid * totalSupply).

Inputs
TypeNameDescription
0uint256bidBid in currency

topBid()

Returns the top bid or 0 if no bids have been placed

Outputs
TypeNameDescription
0uint256

topBidder()

Returns the top bidder or address(0) if no bids have been placed

Outputs
TypeNameDescription
0address

totalSupply()

Total number of tokens in existence

Outputs
TypeNameDescription
0uint256

Transfer(address,address,uint256)

Inputs
TypeNameDescriptionIndexed?
0addressfromtrue
1addresstotrue
2uint256valuefalse

transfer(address,uint256)

Transfer token for a specified address

Inputs
TypeNameDescription
0addresstoThe address to transfer to.
1uint256valueThe amount to be transferred.
Outputs
TypeNameDescription
0bool

transferFrom(address,address,uint256)

Transfer tokens from one address to another. Note that while this function emits an Approval event, this is not required as per the specification, and other compliant implementations may not emit the event.

Inputs
TypeNameDescription
0addressfromaddress The address which you want to send tokens from
1addresstoaddress The address which you want to transfer to
2uint256valueuint256 the amount of tokens to be transferred
Outputs
TypeNameDescription
0bool

transferOwnership(address)

Allows the current owner to transfer control of the contract to a newOwner.

Inputs
TypeNameDescription
0addressnewOwnerThe address to transfer ownership to.

6.0.0

5 years ago

5.0.3

5 years ago

5.0.2

5 years ago

5.0.1

5 years ago

4.0.2

5 years ago

4.0.1

5 years ago

4.0.0

5 years ago

3.0.3

5 years ago

3.0.2

5 years ago

3.0.1

5 years ago

3.0.0

5 years ago

1.0.1

5 years ago

1.0.0

5 years ago