riftpact

6.0.0 • Public • Published

RiftPact: OathForge Token Fracturizer

Author: GuildCrypt

Documentation generated by @GuildCrypt/solspecdown

Name Type
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
Type Name Description
0 address owner address The address which owns the funds.
1 address spender address The address which will spend the funds.
Outputs
Type Name Description
0 uint256

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

Inputs
Type Name Description
0 address __parentToken
1 uint256 __parentTokenId
2 uint256 __totalSupply
3 address __currencyAddress
4 uint256 __auctionAllowedAt
5 uint256 __minAuctionCompleteWait
6 uint256 __minBidDeltaPermille

Approval(address,address,uint256)

Inputs
Type Name Description Indexed?
0 address owner true
1 address spender true
2 uint256 value false

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
Type Name Description
0 address spender The address which will spend the funds.
1 uint256 value The amount of tokens to be spent.
Outputs
Type Name Description
0 bool

auctionAllowedAt()

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

Outputs
Type Name Description
0 uint256

AuctionCompleted(address,uint256)

Inputs
Type Name Description Indexed?
0 address winner false
1 uint256 bid false

auctionCompletedAt()

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

Outputs
Type Name Description
0 uint256

AuctionStarted()


auctionStartedAt()

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

Outputs
Type Name Description
0 uint256

balanceOf(address)

Gets the balance of the specified address.

Inputs
Type Name Description
0 address owner The address to query the balance of.
Outputs
Type Name Description
0 uint256

Bid(address,uint256)

Inputs
Type Name Description Indexed?
0 address bidder false
1 uint256 bid false

completeAuction()

Complete auction

currencyAddress()

Returns the currency contract address.

Outputs
Type Name Description
0 address

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
Type Name Description
0 address spender The address which will spend the funds.
1 uint256 subtractedValue The amount of tokens to decrease the allowance by.
Outputs
Type Name Description
0 bool

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
Type Name Description
0 address spender The address which will spend the funds.
1 uint256 addedValue The amount of tokens to increase the allowance by.
Outputs
Type Name Description
0 bool

isBlacklisted(address)

Returns if an address is blacklisted

Inputs
Type Name Description
0 address to The address to check
Outputs
Type Name Description
0 bool

isOwner()

Outputs
Type Name Description
0 bool

minAuctionCompleteWait()

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

Outputs
Type Name Description
0 uint256

minBid()

Returns the minimum bid in currency

Outputs
Type Name Description
0 uint256

minBidDeltaPermille()

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

Outputs
Type Name Description
0 uint256

owner()

Outputs
Type Name Description
0 address

OwnershipTransferred(address,address)

Inputs
Type Name Description Indexed?
0 address previousOwner true
1 address newOwner true

parentToken()

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

Outputs
Type Name Description
0 address

parentTokenId()

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

Outputs
Type Name Description
0 uint256

PayoutTokenHolder(address,uint256)

Inputs
Type Name Description Indexed?
0 address tokenHolder false
1 uint256 balance false

payoutTokenHolder(address)

Payout token holder (with currency) after auction completed

Inputs
Type Name Description
0 address tokenHolder

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
Type Name Description
0 address to The address to change
1 bool __isBlacklisted True 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
Type Name Description
0 uint256 bid Bid in currency

topBid()

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

Outputs
Type Name Description
0 uint256

topBidder()

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

Outputs
Type Name Description
0 address

totalSupply()

Total number of tokens in existence

Outputs
Type Name Description
0 uint256

Transfer(address,address,uint256)

Inputs
Type Name Description Indexed?
0 address from true
1 address to true
2 uint256 value false

transfer(address,uint256)

Transfer token for a specified address

Inputs
Type Name Description
0 address to The address to transfer to.
1 uint256 value The amount to be transferred.
Outputs
Type Name Description
0 bool

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
Type Name Description
0 address from address The address which you want to send tokens from
1 address to address The address which you want to transfer to
2 uint256 value uint256 the amount of tokens to be transferred
Outputs
Type Name Description
0 bool

transferOwnership(address)

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

Inputs
Type Name Description
0 address newOwner The address to transfer ownership to.

Readme

Keywords

none

Package Sidebar

Install

npm i riftpact

Weekly Downloads

5

Version

6.0.0

License

ISC

Unpacked Size

52.7 kB

Total Files

19

Last publish

Collaborators

  • aakilfernandes