2017-06-06 17:40:14 +00:00
pragma solidity ^ 0 . 4 . 11 ;
2017-10-24 04:09:56 +00:00
2017-10-19 21:49:53 +00:00
/*
2017-10-23 00:04:58 +00:00
Copyright 2017 , Jordi Baylina
2017-12-04 01:12:46 +00:00
Contributors : Adrià Massanet < adria @ codecontext . io > , RJ Ewing , Griff
Green , Arthur Lunn
2017-06-06 17:40:14 +00:00
2017-10-19 21:49:53 +00:00
This program is free software : you can redistribute it and / or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation , either version 3 of the License , or
( at your option ) any later version .
This program is distributed in the hope that it will be useful ,
but WITHOUT ANY WARRANTY ; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE . See the
GNU General Public License for more details .
2017-06-06 17:40:14 +00:00
2017-10-19 21:49:53 +00:00
You should have received a copy of the GNU General Public License
along with this program . If not , see < http : //www.gnu.org/licenses/>.
* /
2017-06-06 17:40:14 +00:00
2017-10-19 21:49:53 +00:00
import " ./LiquidPledgingBase.sol " ;
2017-10-24 04:09:56 +00:00
/// @dev `LiquidPleding` allows for liquid pledging through the use of
/// internal id structures and delegate chaining. All basic operations for
/// handling liquid pledging are supplied as well as plugin features
/// to allow for expanded functionality.
2017-06-06 17:40:14 +00:00
contract LiquidPledging is LiquidPledgingBase {
2017-07-13 17:21:53 +00:00
2017-06-06 17:40:14 +00:00
//////
// Constructor
//////
2017-10-23 00:04:58 +00:00
/// @notice Basic constructor for LiquidPleding, also calls the
/// LiquidPledgingBase contract
/// @dev This constructor also calls the constructor
/// for `LiquidPledgingBase`
2017-10-23 00:43:28 +00:00
/// @param _vault The vault where ETH backing this pledge is stored
2017-06-06 17:40:14 +00:00
function LiquidPledging ( address _vault ) LiquidPledgingBase ( _vault ) {
}
2017-12-04 01:12:46 +00:00
/// @notice This is how value enters the system and how pledges are created;
/// the ether is sent to the vault, an pledge for the Giver is created (or
/// found), the amount of ETH donated in wei is added to the `amount` in
/// the Giver's Pledge, and an LP transfer is done to the idReceiver for
/// the full amount
/// @param idGiver The id of the Giver donating; if 0, a new id is created
/// @param idReceiver The Admin receiving the donation; can be any Admin:
/// the Giver themselves, another Giver, a Delegate or a Project
2017-10-23 00:04:58 +00:00
function donate ( uint64 idGiver , uint64 idReceiver ) payable {
2017-10-03 10:20:23 +00:00
if ( idGiver == 0 ) {
2017-12-04 01:12:46 +00:00
// default to a 3 day (259200 seconds) commitTime
2017-10-23 00:04:58 +00:00
idGiver = addGiver ( " " , " " , 259200 , ILiquidPledgingPlugin ( 0x0 ) ) ;
2017-09-28 15:49:10 +00:00
}
2017-10-04 08:24:35 +00:00
PledgeAdmin storage sender = findAdmin ( idGiver ) ;
checkAdminOwner ( sender ) ;
require ( sender . adminType == PledgeAdminType . Giver ) ;
2017-06-06 17:40:14 +00:00
uint amount = msg . value ;
2017-07-13 17:12:45 +00:00
require ( amount > 0 ) ;
2017-12-04 01:12:46 +00:00
vault . transfer ( amount ) ; // Sends the `msg.value` (in wei) to the `vault`
2017-10-04 10:55:46 +00:00
uint64 idPledge = findOrCreatePledge (
2017-10-03 10:20:23 +00:00
idGiver ,
2017-12-04 01:12:46 +00:00
new uint64 [ ] ( 0 ) , // Creates empty array for delegationChain
2017-06-06 17:40:14 +00:00
0 ,
0 ,
0 ,
2017-12-05 20:42:59 +00:00
PledgeState . Pledged
2017-10-23 00:04:58 +00:00
) ;
2017-06-06 17:40:14 +00:00
2017-10-03 12:42:21 +00:00
Pledge storage nTo = findPledge ( idPledge ) ;
2017-06-26 17:54:28 +00:00
nTo . amount += amount ;
2017-12-04 01:12:46 +00:00
Transfer ( 0 , idPledge , amount ) ; // An event
2017-06-06 17:40:14 +00:00
2017-12-04 01:12:46 +00:00
transfer ( idGiver , idPledge , amount , idReceiver ) ; // LP accounting
2017-06-06 17:40:14 +00:00
}
2017-12-04 01:12:46 +00:00
/// @notice Transfers amounts between pledges for internal accounting
/// @param idSender Id of the Admin that is transferring the amount from
/// Pledge to Pledge; this admin must have permissions to move the value
2017-10-03 12:42:21 +00:00
/// @param idPledge Id of the pledge that's moving the value
2017-12-04 01:12:46 +00:00
/// @param amount Quantity of ETH (in wei) that this pledge is transferring
/// the authority to withdraw from the vault
2017-12-04 20:33:15 +00:00
/// @param idReceiver Destination of the `amount`, can be a Giver/Project sending
/// to a Giver, a Delegate or a Project; a Delegate sending to another
2017-12-04 01:12:46 +00:00
/// Delegate, or a Delegate pre-commiting it to a Project
function transfer (
2017-10-23 00:04:58 +00:00
uint64 idSender ,
uint64 idPledge ,
uint amount ,
uint64 idReceiver
2017-12-04 01:12:46 +00:00
) {
2017-06-06 17:40:14 +00:00
2017-10-03 12:42:21 +00:00
idPledge = normalizePledge ( idPledge ) ;
2017-06-06 17:40:14 +00:00
2017-12-05 20:47:38 +00:00
Pledge storage p = findPledge ( idPledge ) ;
2017-10-04 08:24:35 +00:00
PledgeAdmin storage receiver = findAdmin ( idReceiver ) ;
PledgeAdmin storage sender = findAdmin ( idSender ) ;
2017-06-06 17:40:14 +00:00
2017-10-04 08:24:35 +00:00
checkAdminOwner ( sender ) ;
2017-12-05 20:47:38 +00:00
require ( p . pledgeState == PledgeState . Pledged ) ;
2017-06-06 17:40:14 +00:00
2017-12-04 01:12:46 +00:00
// If the sender is the owner of the Pledge
2017-12-05 20:47:38 +00:00
if ( p . owner == idSender ) {
2017-12-05 20:55:57 +00:00
2017-10-04 08:24:35 +00:00
if ( receiver . adminType == PledgeAdminType . Giver ) {
2017-10-03 12:42:21 +00:00
transferOwnershipToGiver ( idPledge , amount , idReceiver ) ;
2017-10-04 23:27:23 +00:00
} else if ( receiver . adminType == PledgeAdminType . Project ) {
transferOwnershipToProject ( idPledge , amount , idReceiver ) ;
2017-10-04 08:24:35 +00:00
} else if ( receiver . adminType == PledgeAdminType . Delegate ) {
2017-10-23 00:04:58 +00:00
idPledge = undelegate (
idPledge ,
amount ,
2017-12-05 20:47:38 +00:00
p . delegationChain . length
2017-10-23 00:04:58 +00:00
) ;
2017-10-03 12:42:21 +00:00
appendDelegate ( idPledge , amount , idReceiver ) ;
2017-06-06 17:40:14 +00:00
} else {
2017-12-04 20:33:15 +00:00
// This should never be reached as the reciever.adminType
// should always be either a Giver, Project, or Delegate
assert ( false ) ;
2017-06-06 17:40:14 +00:00
}
return ;
}
2017-12-04 01:12:46 +00:00
// If the sender is a Delegate
2017-12-05 20:47:38 +00:00
uint senderDIdx = getDelegateIdx ( p , idSender ) ;
2017-06-06 17:40:14 +00:00
if ( senderDIdx != NOTFOUND ) {
2017-12-04 01:12:46 +00:00
// And the receiver is another Giver
2017-10-04 08:24:35 +00:00
if ( receiver . adminType == PledgeAdminType . Giver ) {
2017-12-04 20:33:15 +00:00
// Only transfer to the Giver who owns the pldege
2017-12-05 20:47:38 +00:00
assert ( p . owner == idReceiver ) ;
undelegate ( idPledge , amount , p . delegationChain . length ) ;
2017-06-06 17:40:14 +00:00
return ;
}
2017-12-04 01:12:46 +00:00
// And the receiver is another Delegate
2017-10-04 08:24:35 +00:00
if ( receiver . adminType == PledgeAdminType . Delegate ) {
2017-12-05 20:47:38 +00:00
uint receiverDIdx = getDelegateIdx ( p , idReceiver ) ;
2017-07-09 17:04:52 +00:00
2017-12-04 01:12:46 +00:00
// And not in the delegationChain
2017-06-06 17:40:14 +00:00
if ( receiverDIdx == NOTFOUND ) {
2017-10-23 00:04:58 +00:00
idPledge = undelegate (
idPledge ,
amount ,
2017-12-05 20:47:38 +00:00
p . delegationChain . length - senderDIdx - 1
2017-10-23 00:04:58 +00:00
) ;
2017-10-03 12:42:21 +00:00
appendDelegate ( idPledge , amount , idReceiver ) ;
2017-07-09 17:04:52 +00:00
2017-12-04 01:12:46 +00:00
// And part of the delegationChain and is after the sender, then
// all of the other delegates after the sender are removed and
// the receiver is appended at the end of the delegationChain
2017-06-06 17:40:14 +00:00
} else if ( receiverDIdx > senderDIdx ) {
2017-10-23 00:04:58 +00:00
idPledge = undelegate (
idPledge ,
amount ,
2017-12-05 20:47:38 +00:00
p . delegationChain . length - senderDIdx - 1
2017-10-23 00:04:58 +00:00
) ;
2017-10-03 12:42:21 +00:00
appendDelegate ( idPledge , amount , idReceiver ) ;
2017-07-09 17:04:52 +00:00
2017-12-04 01:12:46 +00:00
// And is already part of the delegate chain but is before the
// sender, then the sender and all of the other delegates after
// the RECEIVER are removed from the delegationChain
} else if ( receiverDIdx <= senderDIdx ) { //TODO Check for Game Theory issues (from Arthur) this allows the sender to sort of go komakosi and remove himself and the delegates between himself and the receiver... should this authority be allowed?
2017-10-23 00:04:58 +00:00
undelegate (
idPledge ,
amount ,
2017-12-05 20:47:38 +00:00
p . delegationChain . length - receiverDIdx - 1
2017-10-23 00:04:58 +00:00
) ;
2017-06-06 17:40:14 +00:00
}
return ;
}
2017-12-04 01:12:46 +00:00
// And the receiver is a Project, all the delegates after the sender
// are removed and the amount is pre-committed to the project
2017-10-04 23:27:23 +00:00
if ( receiver . adminType == PledgeAdminType . Project ) {
2017-10-23 00:04:58 +00:00
idPledge = undelegate (
idPledge ,
amount ,
2017-12-05 20:47:38 +00:00
p . delegationChain . length - senderDIdx - 1
2017-10-23 00:04:58 +00:00
) ;
2017-10-04 23:27:23 +00:00
proposeAssignProject ( idPledge , amount , idReceiver ) ;
2017-06-06 17:40:14 +00:00
return ;
}
}
2017-12-04 01:12:46 +00:00
assert ( false ) ; // When the sender is not an owner or a delegate
2017-06-06 17:40:14 +00:00
}
2017-12-04 01:12:46 +00:00
/// @notice Authorizes a payment be made from the `vault` can be used by the
2017-12-04 20:33:15 +00:00
/// Giver to veto a pre-committed donation from a Delegate to an
/// intendedProject
2017-10-03 12:42:21 +00:00
/// @param idPledge Id of the pledge that wants to be withdrawn.
2017-12-04 01:12:46 +00:00
/// @param amount Quantity of ether (in wei) to be authorized
2017-10-03 12:42:21 +00:00
function withdraw ( uint64 idPledge , uint amount ) {
2017-12-04 01:12:46 +00:00
idPledge = normalizePledge ( idPledge ) ; // Updates pledge info
2017-12-05 20:47:38 +00:00
Pledge storage p = findPledge ( idPledge ) ;
require ( p . pledgeState == PledgeState . Pledged ) ;
PledgeAdmin storage owner = findAdmin ( p . owner ) ;
2017-10-04 08:24:35 +00:00
checkAdminOwner ( owner ) ;
2017-06-06 17:40:14 +00:00
2017-10-04 10:55:46 +00:00
uint64 idNewPledge = findOrCreatePledge (
2017-12-05 20:47:38 +00:00
p . owner ,
p . delegationChain ,
2017-06-06 17:40:14 +00:00
0 ,
0 ,
2017-12-05 20:47:38 +00:00
p . oldPledge ,
2017-12-05 20:42:59 +00:00
PledgeState . Paying
2017-06-06 17:40:14 +00:00
) ;
2017-10-03 12:42:21 +00:00
doTransfer ( idPledge , idNewPledge , amount ) ;
2017-06-06 17:40:14 +00:00
2017-10-03 12:42:21 +00:00
vault . authorizePayment ( bytes32 ( idNewPledge ) , owner . addr , amount ) ;
2017-06-06 17:40:14 +00:00
}
2017-07-04 23:13:24 +00:00
/// @notice Method called by the vault to confirm a payment.
2017-10-03 12:42:21 +00:00
/// @param idPledge Id of the pledge that wants to be withdrawn.
2017-12-04 01:12:46 +00:00
/// @param amount Quantity of ether (in wei) to be withdrawn
2017-10-03 12:42:21 +00:00
function confirmPayment ( uint64 idPledge , uint amount ) onlyVault {
2017-12-05 20:47:38 +00:00
Pledge storage p = findPledge ( idPledge ) ;
2017-06-06 17:40:14 +00:00
2017-12-05 20:47:38 +00:00
require ( p . pledgeState == PledgeState . Paying ) ;
2017-06-06 17:40:14 +00:00
2017-10-04 10:55:46 +00:00
uint64 idNewPledge = findOrCreatePledge (
2017-12-05 20:47:38 +00:00
p . owner ,
p . delegationChain ,
2017-06-06 17:40:14 +00:00
0 ,
0 ,
2017-12-05 20:47:38 +00:00
p . oldPledge ,
2017-12-05 20:42:59 +00:00
PledgeState . Paid
2017-06-06 17:40:14 +00:00
) ;
2017-10-03 12:42:21 +00:00
doTransfer ( idPledge , idNewPledge , amount ) ;
2017-06-06 17:40:14 +00:00
}
2017-07-04 23:13:24 +00:00
/// @notice Method called by the vault to cancel a payment.
2017-10-03 12:42:21 +00:00
/// @param idPledge Id of the pledge that wants to be canceled for withdraw.
2017-12-04 01:12:46 +00:00
/// @param amount Quantity of ether (in wei) to be rolled back
2017-10-03 12:42:21 +00:00
function cancelPayment ( uint64 idPledge , uint amount ) onlyVault {
2017-12-05 20:47:38 +00:00
Pledge storage p = findPledge ( idPledge ) ;
2017-06-06 17:40:14 +00:00
2017-12-05 20:55:57 +00:00
require ( p . pledgeState == PledgeState . Paying ) ; //TODO change to revert????????????????????????????
2017-06-06 17:40:14 +00:00
2017-10-04 23:27:23 +00:00
// When a payment is canceled, never is assigned to a project.
2017-10-04 10:55:46 +00:00
uint64 oldPledge = findOrCreatePledge (
2017-12-05 20:47:38 +00:00
p . owner ,
p . delegationChain ,
2017-06-06 17:40:14 +00:00
0 ,
0 ,
2017-12-05 20:47:38 +00:00
p . oldPledge ,
2017-12-05 20:42:59 +00:00
PledgeState . Pledged
2017-06-06 17:40:14 +00:00
) ;
2017-10-03 12:42:21 +00:00
oldPledge = normalizePledge ( oldPledge ) ;
2017-06-06 17:40:14 +00:00
2017-10-03 12:42:21 +00:00
doTransfer ( idPledge , oldPledge , amount ) ;
2017-06-06 17:40:14 +00:00
}
2017-10-04 23:27:23 +00:00
/// @notice Method called to cancel this project.
/// @param idProject Id of the projct that wants to be canceled.
2017-12-04 01:12:46 +00:00
function cancelProject ( uint64 idProject ) {
2017-10-04 23:27:23 +00:00
PledgeAdmin storage project = findAdmin ( idProject ) ;
checkAdminOwner ( project ) ;
project . canceled = true ;
2017-10-03 07:52:56 +00:00
2017-10-04 23:27:23 +00:00
CancelProject ( idProject ) ;
2017-06-06 17:40:14 +00:00
}
2017-10-28 08:27:47 +00:00
/// @notice Method called to cancel specific pledge.
2017-10-19 21:49:53 +00:00
/// @param idPledge Id of the pledge that should be canceled.
2017-10-23 00:43:28 +00:00
/// @param amount Quantity of Ether that wants to be rolled back.
2017-12-04 01:12:46 +00:00
function cancelPledge ( uint64 idPledge , uint amount ) {
2017-10-03 12:42:21 +00:00
idPledge = normalizePledge ( idPledge ) ;
2017-09-18 13:43:09 +00:00
2017-12-05 20:47:38 +00:00
Pledge storage p = findPledge ( idPledge ) ;
require ( p . oldPledge != 0 ) ;
2017-09-18 13:43:09 +00:00
2017-12-05 20:47:38 +00:00
PledgeAdmin storage m = findAdmin ( p . owner ) ;
2017-10-04 08:24:35 +00:00
checkAdminOwner ( m ) ;
2017-09-18 13:43:09 +00:00
2017-12-05 20:47:38 +00:00
uint64 oldPledge = getOldestPledgeNotCanceled ( p . oldPledge ) ;
2017-10-19 17:32:06 +00:00
doTransfer ( idPledge , oldPledge , amount ) ;
2017-09-18 13:43:09 +00:00
}
2017-06-06 17:40:14 +00:00
////////
2017-10-03 12:42:21 +00:00
// Multi pledge methods
2017-06-06 17:40:14 +00:00
////////
2017-10-19 22:40:37 +00:00
// @dev This set of functions makes moving a lot of pledges around much more
2017-07-09 17:04:52 +00:00
// efficient (saves gas) than calling these functions in series
2017-10-19 21:49:53 +00:00
2017-10-19 22:40:37 +00:00
/// Bit mask used for dividing pledge amounts in Multi pledge methods
2017-06-06 17:40:14 +00:00
uint constant D64 = 0x10000000000000000 ;
2017-10-19 21:49:53 +00:00
2017-10-23 00:04:58 +00:00
/// @notice `mTransfer` allows for multiple pledges to be transferred
/// efficiently
/// @param idSender ID of the giver, delegate or project admin that is
/// transferring the funds from Pledge to Pledge. This admin must have
2017-10-28 08:27:47 +00:00
/// permissions to move the value
2017-11-01 21:03:03 +00:00
/// @param pledgesAmounts An array of pledge amounts and IDs which are extrapolated
2017-10-23 00:04:58 +00:00
/// using the D64 bitmask
/// @param idReceiver Destination of the value, can be a giver sending
/// to a giver or a delegate or a delegate to another delegate or a
2017-10-28 08:27:47 +00:00
/// project to pre-commit it to that project
2017-10-23 00:04:58 +00:00
function mTransfer (
uint64 idSender ,
uint [ ] pledgesAmounts ,
uint64 idReceiver
) {
2017-10-03 12:42:21 +00:00
for ( uint i = 0 ; i < pledgesAmounts . length ; i ++ ) {
uint64 idPledge = uint64 ( pledgesAmounts [ i ] & ( D64 - 1 ) ) ;
uint amount = pledgesAmounts [ i ] / D64 ;
2017-06-06 17:40:14 +00:00
2017-10-03 12:42:21 +00:00
transfer ( idSender , idPledge , amount , idReceiver ) ;
2017-06-06 17:40:14 +00:00
}
}
2017-10-23 00:04:58 +00:00
/// @notice `mWithdraw` allows for multiple pledges to be
/// withdrawn efficiently
2017-11-01 21:03:03 +00:00
/// @param pledgesAmounts An array of pledge amounts and IDs which are
2017-10-23 00:04:58 +00:00
/// extrapolated using the D64 bitmask
2017-10-03 12:42:21 +00:00
function mWithdraw ( uint [ ] pledgesAmounts ) {
for ( uint i = 0 ; i < pledgesAmounts . length ; i ++ ) {
uint64 idPledge = uint64 ( pledgesAmounts [ i ] & ( D64 - 1 ) ) ;
uint amount = pledgesAmounts [ i ] / D64 ;
2017-06-06 17:40:14 +00:00
2017-10-03 12:42:21 +00:00
withdraw ( idPledge , amount ) ;
2017-06-06 17:40:14 +00:00
}
}
2017-10-23 00:04:58 +00:00
/// @notice `mConfirmPayment` allows for multiple pledges to be confirmed
/// efficiently
2017-11-01 21:03:03 +00:00
/// @param pledgesAmounts An array of pledge amounts and IDs which are extrapolated
2017-10-23 00:04:58 +00:00
/// using the D64 bitmask
2017-10-03 12:42:21 +00:00
function mConfirmPayment ( uint [ ] pledgesAmounts ) {
for ( uint i = 0 ; i < pledgesAmounts . length ; i ++ ) {
uint64 idPledge = uint64 ( pledgesAmounts [ i ] & ( D64 - 1 ) ) ;
uint amount = pledgesAmounts [ i ] / D64 ;
2017-06-06 17:40:14 +00:00
2017-10-03 12:42:21 +00:00
confirmPayment ( idPledge , amount ) ;
2017-06-06 17:40:14 +00:00
}
}
2017-10-28 08:27:47 +00:00
/// @notice `mCancelPayment` allows for multiple pledges to be canceled
2017-10-23 00:04:58 +00:00
/// efficiently
2017-11-01 21:03:03 +00:00
/// @param pledgesAmounts An array of pledge amounts and IDs which are extrapolated
2017-10-23 00:04:58 +00:00
/// using the D64 bitmask
2017-10-03 12:42:21 +00:00
function mCancelPayment ( uint [ ] pledgesAmounts ) {
for ( uint i = 0 ; i < pledgesAmounts . length ; i ++ ) {
uint64 idPledge = uint64 ( pledgesAmounts [ i ] & ( D64 - 1 ) ) ;
uint amount = pledgesAmounts [ i ] / D64 ;
2017-06-06 17:40:14 +00:00
2017-10-03 12:42:21 +00:00
cancelPayment ( idPledge , amount ) ;
2017-06-06 17:40:14 +00:00
}
}
2017-10-23 00:04:58 +00:00
/// @notice `mNormalizePledge` allows for multiple pledges to be
/// normalized efficiently
2017-12-03 00:59:30 +00:00
/// @param pledges An array of pledge IDs
2017-11-10 18:54:44 +00:00
function mNormalizePledge ( uint64 [ ] pledges ) {
2017-10-03 12:42:21 +00:00
for ( uint i = 0 ; i < pledges . length ; i ++ ) {
2017-10-24 17:31:18 +00:00
normalizePledge ( pledges [ i ] ) ;
2017-09-18 13:43:09 +00:00
}
}
2017-06-06 17:40:14 +00:00
////////
// Private methods
///////
2017-10-23 00:43:28 +00:00
/// @notice `transferOwnershipToProject` allows for the transfer of
2017-12-03 00:59:30 +00:00
/// ownership to the project, but it can also be called by a project
/// to un-delegate everyone by setting one's own id for the idReceiver
2017-10-23 00:43:28 +00:00
/// @param idPledge Id of the pledge to be transfered.
/// @param amount Quantity of value that's being transfered
2017-10-28 08:27:47 +00:00
/// @param idReceiver The new owner of the project (or self to un-delegate)
2017-10-23 00:04:58 +00:00
function transferOwnershipToProject (
uint64 idPledge ,
uint amount ,
uint64 idReceiver
) internal {
2017-12-05 20:47:38 +00:00
Pledge storage p = findPledge ( idPledge ) ;
2017-07-04 23:13:24 +00:00
2017-10-23 00:43:28 +00:00
// Ensure that the pledge is not already at max pledge depth
2017-10-28 08:27:47 +00:00
// and the project has not been canceled
2017-12-05 20:47:38 +00:00
require ( getPledgeLevel ( p ) < MAX_INTERPROJECT_LEVEL ) ;
2017-10-04 23:27:23 +00:00
require ( ! isProjectCanceled ( idReceiver ) ) ;
2017-10-04 12:30:09 +00:00
2017-10-04 10:55:46 +00:00
uint64 oldPledge = findOrCreatePledge (
2017-12-05 20:47:38 +00:00
p . owner ,
p . delegationChain ,
2017-06-06 17:40:14 +00:00
0 ,
0 ,
2017-12-05 20:47:38 +00:00
p . oldPledge ,
2017-12-05 20:42:59 +00:00
PledgeState . Pledged
2017-10-23 00:43:28 +00:00
) ;
2017-10-04 10:55:46 +00:00
uint64 toPledge = findOrCreatePledge (
2017-10-23 00:43:28 +00:00
idReceiver , // Set the new owner
new uint64 [ ] ( 0 ) , // clear the delegation chain
2017-07-09 17:04:52 +00:00
0 ,
0 ,
2017-10-03 12:42:21 +00:00
oldPledge ,
2017-12-05 20:42:59 +00:00
PledgeState . Pledged
2017-10-23 00:43:28 +00:00
) ;
2017-10-03 12:42:21 +00:00
doTransfer ( idPledge , toPledge , amount ) ;
2017-10-23 00:04:58 +00:00
}
2017-06-06 17:40:14 +00:00
2017-10-23 00:50:48 +00:00
/// @notice `transferOwnershipToGiver` allows for the transfer of
/// value back to the Giver, value is placed in a pledged state
2017-10-28 08:27:47 +00:00
/// without being attached to a project, delegation chain, or time line.
2017-10-23 00:50:48 +00:00
/// @param idPledge Id of the pledge to be transfered.
/// @param amount Quantity of value that's being transfered
/// @param idReceiver The new owner of the pledge
2017-10-23 00:04:58 +00:00
function transferOwnershipToGiver (
uint64 idPledge ,
uint amount ,
uint64 idReceiver
2017-10-23 21:40:51 +00:00
) internal {
2017-10-04 10:55:46 +00:00
uint64 toPledge = findOrCreatePledge (
2017-10-23 00:50:48 +00:00
idReceiver ,
new uint64 [ ] ( 0 ) ,
0 ,
0 ,
0 ,
2017-12-05 20:42:59 +00:00
PledgeState . Pledged
2017-10-23 00:50:48 +00:00
) ;
2017-10-03 12:42:21 +00:00
doTransfer ( idPledge , toPledge , amount ) ;
2017-07-04 23:13:24 +00:00
}
2017-10-23 21:40:51 +00:00
/// @notice `appendDelegate` allows for a delegate to be added onto the
/// end of the delegate chain for a given Pledge.
/// @param idPledge Id of the pledge thats delegate chain will be modified.
/// @param amount Quantity of value that's being chained.
/// @param idReceiver The delegate to be added at the end of the chain
2017-10-23 00:04:58 +00:00
function appendDelegate (
uint64 idPledge ,
uint amount ,
uint64 idReceiver
2017-10-23 21:40:51 +00:00
) internal {
2017-12-05 20:47:38 +00:00
Pledge storage p = findPledge ( idPledge ) ;
2017-07-04 23:13:24 +00:00
2017-12-05 20:47:38 +00:00
require ( p . delegationChain . length < MAX_DELEGATES ) ;
2017-10-28 08:27:47 +00:00
uint64 [ ] memory newDelegationChain = new uint64 [ ] (
2017-12-05 20:47:38 +00:00
p . delegationChain . length + 1
2017-10-28 08:27:47 +00:00
) ;
2017-12-05 20:47:38 +00:00
for ( uint i = 0 ; i < p . delegationChain . length ; i ++ ) {
newDelegationChain [ i ] = p . delegationChain [ i ] ;
2017-06-06 17:40:14 +00:00
}
2017-07-13 17:21:53 +00:00
2017-07-09 17:04:52 +00:00
// Make the last item in the array the idReceiver
2017-12-05 20:47:38 +00:00
newDelegationChain [ p . delegationChain . length ] = idReceiver ;
2017-07-09 17:04:52 +00:00
2017-10-04 10:55:46 +00:00
uint64 toPledge = findOrCreatePledge (
2017-12-05 20:47:38 +00:00
p . owner ,
2017-10-23 21:40:51 +00:00
newDelegationChain ,
0 ,
0 ,
2017-12-05 20:47:38 +00:00
p . oldPledge ,
2017-12-05 20:42:59 +00:00
PledgeState . Pledged
2017-10-23 21:40:51 +00:00
) ;
2017-10-03 12:42:21 +00:00
doTransfer ( idPledge , toPledge , amount ) ;
2017-06-06 17:40:14 +00:00
}
2017-10-23 21:40:51 +00:00
/// @notice `appendDelegate` allows for a delegate to be added onto the
/// end of the delegate chain for a given Pledge.
/// @param idPledge Id of the pledge thats delegate chain will be modified.
/// @param amount Quantity of value that's shifted from delegates.
2017-12-04 01:12:46 +00:00
/// @param q Number (or depth) of delegates to remove
/// @return toPledge The id for the pledge being adjusted or created
2017-10-23 00:04:58 +00:00
function undelegate (
uint64 idPledge ,
uint amount ,
uint q
2017-12-05 20:55:57 +00:00
) internal returns ( uint64 )
{
2017-12-05 20:47:38 +00:00
Pledge storage p = findPledge ( idPledge ) ;
2017-10-28 08:27:47 +00:00
uint64 [ ] memory newDelegationChain = new uint64 [ ] (
2017-12-05 20:47:38 +00:00
p . delegationChain . length - q
2017-10-28 08:27:47 +00:00
) ;
2017-12-04 01:12:46 +00:00
2017-12-05 20:47:38 +00:00
for ( uint i = 0 ; i < p . delegationChain . length - q ; i ++ ) {
newDelegationChain [ i ] = p . delegationChain [ i ] ;
2017-06-06 17:40:14 +00:00
}
2017-10-04 10:55:46 +00:00
uint64 toPledge = findOrCreatePledge (
2017-12-05 20:47:38 +00:00
p . owner ,
2017-10-23 21:40:51 +00:00
newDelegationChain ,
0 ,
0 ,
2017-12-05 20:47:38 +00:00
p . oldPledge ,
2017-12-05 20:42:59 +00:00
PledgeState . Pledged
2017-10-23 21:40:51 +00:00
) ;
2017-10-03 12:42:21 +00:00
doTransfer ( idPledge , toPledge , amount ) ;
2017-10-06 10:07:25 +00:00
return toPledge ;
2017-06-06 17:40:14 +00:00
}
2017-10-23 21:40:51 +00:00
/// @notice `proposeAssignProject` proposes the assignment of a pledge
/// to a specific project.
/// @dev This function should potentially be named more specifically.
/// @param idPledge Id of the pledge that will be assigned.
/// @param amount Quantity of value this pledge leader would be assigned.
2017-10-28 08:27:47 +00:00
/// @param idReceiver The project this pledge will potentially
2017-10-23 21:40:51 +00:00
/// be assigned to.
2017-10-23 00:04:58 +00:00
function proposeAssignProject (
uint64 idPledge ,
uint amount ,
uint64 idReceiver
2017-10-23 21:40:51 +00:00
) internal {
2017-12-05 20:47:38 +00:00
Pledge storage p = findPledge ( idPledge ) ;
2017-07-04 23:13:24 +00:00
2017-12-05 20:47:38 +00:00
require ( getPledgeLevel ( p ) < MAX_SUBPROJECT_LEVEL ) ;
2017-10-04 23:27:23 +00:00
require ( ! isProjectCanceled ( idReceiver ) ) ;
2017-07-04 23:13:24 +00:00
2017-10-04 10:55:46 +00:00
uint64 toPledge = findOrCreatePledge (
2017-12-05 20:47:38 +00:00
p . owner ,
p . delegationChain ,
2017-10-23 21:40:51 +00:00
idReceiver ,
2017-12-05 20:47:38 +00:00
uint64 ( getTime ( ) + maxCommitTime ( p ) ) ,
p . oldPledge ,
2017-12-05 20:42:59 +00:00
PledgeState . Pledged
2017-10-23 21:40:51 +00:00
) ;
2017-10-03 12:42:21 +00:00
doTransfer ( idPledge , toPledge , amount ) ;
2017-06-06 17:40:14 +00:00
}
2017-10-23 21:40:51 +00:00
/// @notice `doTransfer` is designed to allow for pledge amounts to be
/// shifted around internally.
/// @param from This is the Id from which value will be transfered.
/// @param to This is the Id that value will be transfered to.
/// @param _amount The amount of value that will be transfered.
2017-09-13 12:41:08 +00:00
function doTransfer ( uint64 from , uint64 to , uint _amount ) internal {
2017-09-14 06:03:36 +00:00
uint amount = callPlugins ( true , from , to , _amount ) ;
2017-12-03 00:59:30 +00:00
if ( from == to ) {
2017-10-23 21:40:51 +00:00
return ;
2017-12-03 00:59:30 +00:00
}
if ( amount == 0 ) {
2017-10-23 21:40:51 +00:00
return ;
2017-12-03 00:59:30 +00:00
}
2017-10-03 12:42:21 +00:00
Pledge storage nFrom = findPledge ( from ) ;
Pledge storage nTo = findPledge ( to ) ;
2017-07-13 17:12:45 +00:00
require ( nFrom . amount >= amount ) ;
2017-06-06 17:40:14 +00:00
nFrom . amount -= amount ;
nTo . amount += amount ;
Transfer ( from , to , amount ) ;
2017-09-14 06:03:36 +00:00
callPlugins ( false , from , to , amount ) ;
2017-06-06 17:40:14 +00:00
}
2017-12-05 20:55:57 +00:00
/// @notice Only affects pledges with the Pledged PledgeState for 2 things:
2017-12-03 04:15:52 +00:00
/// #1: Checks if the pledge should be committed. This means that
/// if the pledge has an intendedProject and it is past the
/// commitTime, it changes the owner to be the proposed project
/// (The UI will have to read the commit time and manually do what
2017-10-23 21:40:51 +00:00
/// this function does to the pledge for the end user
/// at the expiration of the commitTime)
///
/// #2: Checks to make sure that if there has been a cancellation in the
/// chain of projects, the pledge's owner has been changed
/// appropriately.
///
/// This function can be called by anybody at anytime on any pledge.
2017-12-04 01:12:46 +00:00
/// In general it can be called to force the calls of the affected
/// plugins, which also need to be predicted by the UI
2017-10-23 21:40:51 +00:00
/// @param idPledge This is the id of the pledge that will be normalized
2017-12-04 01:12:46 +00:00
/// @return The normalized Pledge!
2017-10-03 12:42:21 +00:00
function normalizePledge ( uint64 idPledge ) returns ( uint64 ) {
2017-10-23 21:40:51 +00:00
2017-12-05 20:47:38 +00:00
Pledge storage p = findPledge ( idPledge ) ;
2017-07-09 17:04:52 +00:00
2017-10-28 08:27:47 +00:00
// Check to make sure this pledge hasn't already been used
2017-10-24 03:26:31 +00:00
// or is in the process of being used
2017-12-05 20:47:38 +00:00
if ( p . pledgeState != PledgeState . Pledged ) {
2017-10-23 21:40:51 +00:00
return idPledge ;
2017-12-03 00:59:30 +00:00
}
2017-06-06 17:40:14 +00:00
2017-10-28 08:27:47 +00:00
// First send to a project if it's proposed and committed
2017-12-05 20:47:38 +00:00
if ( ( p . intendedProject > 0 ) && ( getTime ( ) > p . commitTime ) ) {
2017-10-04 10:55:46 +00:00
uint64 oldPledge = findOrCreatePledge (
2017-12-05 20:47:38 +00:00
p . owner ,
p . delegationChain ,
2017-06-06 17:40:14 +00:00
0 ,
0 ,
2017-12-05 20:47:38 +00:00
p . oldPledge ,
2017-12-05 20:42:59 +00:00
PledgeState . Pledged
2017-12-03 00:59:30 +00:00
) ;
2017-10-04 10:55:46 +00:00
uint64 toPledge = findOrCreatePledge (
2017-12-05 20:47:38 +00:00
p . intendedProject ,
2017-06-06 17:40:14 +00:00
new uint64 [ ] ( 0 ) ,
0 ,
0 ,
2017-10-03 12:42:21 +00:00
oldPledge ,
2017-12-05 20:42:59 +00:00
PledgeState . Pledged
2017-12-03 00:59:30 +00:00
) ;
2017-12-05 20:47:38 +00:00
doTransfer ( idPledge , toPledge , p . amount ) ;
2017-10-03 12:42:21 +00:00
idPledge = toPledge ;
2017-12-05 20:47:38 +00:00
p = findPledge ( idPledge ) ;
2017-06-06 17:40:14 +00:00
}
2017-10-03 12:42:21 +00:00
toPledge = getOldestPledgeNotCanceled ( idPledge ) ; // TODO toPledge is pledge defined
if ( toPledge != idPledge ) {
2017-12-05 20:47:38 +00:00
doTransfer ( idPledge , toPledge , p . amount ) ;
2017-06-06 17:40:14 +00:00
}
2017-06-26 17:54:28 +00:00
2017-10-03 12:42:21 +00:00
return toPledge ;
2017-06-26 17:54:28 +00:00
}
2017-08-18 16:47:22 +00:00
2017-09-13 12:41:08 +00:00
/////////////
// Plugins
/////////////
2017-10-24 03:26:31 +00:00
/// @notice `callPlugin` is used to trigger the general functions in the
/// plugin for any actions needed before and after a transfer happens.
/// Specifically what this does in relation to the plugin is something
/// that largely depends on the functions of that plugin. This function
/// is generally called in pairs, once before, and once after a transfer.
2017-10-28 08:27:47 +00:00
/// @param before This toggle determines whether the plugin call is occurring
2017-10-24 03:26:31 +00:00
/// before or after a transfer.
/// @param adminId This should be the Id of the *trusted* individual
/// who has control over this plugin.
/// @param fromPledge This is the Id from which value is being transfered.
/// @param toPledge This is the Id that value is being transfered to.
/// @param context The situation that is triggering the plugin. See plugin
/// for a full description of contexts.
2017-10-24 04:09:56 +00:00
/// @param amount The amount of value that is being transfered.
2017-10-23 00:04:58 +00:00
function callPlugin (
bool before ,
uint64 adminId ,
uint64 fromPledge ,
uint64 toPledge ,
uint64 context ,
uint amount
) internal returns ( uint allowedAmount ) {
2017-10-24 03:26:31 +00:00
2017-09-14 06:03:36 +00:00
uint newAmount ;
2017-09-13 12:41:08 +00:00
allowedAmount = amount ;
2017-10-04 08:24:35 +00:00
PledgeAdmin storage admin = findAdmin ( adminId ) ;
2017-10-24 03:26:31 +00:00
// Checks admin has a plugin assigned and a non-zero amount is requested
2017-10-04 08:24:35 +00:00
if ( ( address ( admin . plugin ) != 0 ) && ( allowedAmount > 0 ) ) {
2017-10-24 03:26:31 +00:00
// There are two seperate functions called in the plugin.
// One is called before the transfer and one after
2017-09-14 06:03:36 +00:00
if ( before ) {
2017-10-23 00:04:58 +00:00
newAmount = admin . plugin . beforeTransfer (
adminId ,
fromPledge ,
toPledge ,
context ,
amount
) ;
2017-09-14 06:03:36 +00:00
require ( newAmount <= allowedAmount ) ;
allowedAmount = newAmount ;
} else {
2017-10-23 00:04:58 +00:00
admin . plugin . afterTransfer (
adminId ,
fromPledge ,
toPledge ,
context ,
amount
) ;
2017-09-14 06:03:36 +00:00
}
2017-09-13 12:41:08 +00:00
}
}
2017-10-24 04:09:56 +00:00
/// @notice `callPluginsPledge` is used to apply plugin calls to
/// the delegate chain and the intended project if there is one.
/// It does so in either a transferring or receiving context based
/// on the `idPledge` and `fromPledge` parameters.
2017-10-24 03:26:31 +00:00
/// @param before This toggle determines whether the plugin call is occuring
/// before or after a transfer.
/// @param idPledge This is the Id of the pledge on which this plugin
/// is being called.
/// @param fromPledge This is the Id from which value is being transfered.
/// @param toPledge This is the Id that value is being transfered to.
2017-11-01 21:03:03 +00:00
/// @param amount The amount of value that is being transfered.
2017-10-23 00:04:58 +00:00
function callPluginsPledge (
bool before ,
uint64 idPledge ,
uint64 fromPledge ,
uint64 toPledge ,
uint amount
) internal returns ( uint allowedAmount ) {
2017-10-24 04:09:56 +00:00
// Determine if callPlugin is being applied in a receiving
// or transferring context
2017-10-03 12:42:21 +00:00
uint64 offset = idPledge == fromPledge ? 0 : 256 ;
2017-09-13 12:41:08 +00:00
allowedAmount = amount ;
2017-12-05 20:47:38 +00:00
Pledge storage p = findPledge ( idPledge ) ;
2017-09-13 12:41:08 +00:00
2017-10-24 04:09:56 +00:00
// Always call the plugin on the owner
2017-10-23 00:04:58 +00:00
allowedAmount = callPlugin (
before ,
2017-12-05 20:47:38 +00:00
p . owner ,
2017-10-23 00:04:58 +00:00
fromPledge ,
toPledge ,
offset ,
allowedAmount
) ;
2017-09-13 12:41:08 +00:00
2017-10-24 04:09:56 +00:00
// Apply call plugin to all delegates
2017-12-05 20:47:38 +00:00
for ( uint64 i = 0 ; i < p . delegationChain . length ; i ++ ) {
2017-10-23 00:04:58 +00:00
allowedAmount = callPlugin (
before ,
2017-12-05 20:47:38 +00:00
p . delegationChain [ i ] ,
2017-10-23 00:04:58 +00:00
fromPledge ,
toPledge ,
offset + i + 1 ,
allowedAmount
) ;
2017-09-13 12:41:08 +00:00
}
2017-10-24 04:09:56 +00:00
// If there is an intended project also call the plugin in
// either a transferring or receiving context based on offset
// on the intended project
2017-12-05 20:47:38 +00:00
if ( p . intendedProject > 0 ) {
2017-10-23 00:04:58 +00:00
allowedAmount = callPlugin (
before ,
2017-12-05 20:47:38 +00:00
p . intendedProject ,
2017-10-23 00:04:58 +00:00
fromPledge ,
toPledge ,
offset + 255 ,
allowedAmount
) ;
2017-09-13 12:41:08 +00:00
}
}
2017-10-24 04:09:56 +00:00
/// @notice `callPlugins` calls `callPluginsPledge` once for the transfer
/// context and once for the receiving context. The aggregated
/// allowed amount is then returned.
/// @param before This toggle determines whether the plugin call is occuring
/// before or after a transfer.
/// @param fromPledge This is the Id from which value is being transfered.
/// @param toPledge This is the Id that value is being transfered to.
/// @param amount The amount of value that is being transfered.
2017-10-23 00:04:58 +00:00
function callPlugins (
bool before ,
uint64 fromPledge ,
uint64 toPledge ,
uint amount
) internal returns ( uint allowedAmount ) {
2017-09-13 12:41:08 +00:00
allowedAmount = amount ;
2017-10-24 04:09:56 +00:00
// Call the pledges plugins in the transfer context
2017-10-23 00:04:58 +00:00
allowedAmount = callPluginsPledge (
before ,
fromPledge ,
fromPledge ,
toPledge ,
allowedAmount
) ;
2017-10-24 04:09:56 +00:00
// Call the pledges plugins in the receive context
2017-10-23 00:04:58 +00:00
allowedAmount = callPluginsPledge (
before ,
toPledge ,
fromPledge ,
toPledge ,
allowedAmount
) ;
2017-09-13 12:41:08 +00:00
}
2017-06-26 17:54:28 +00:00
/////////////
// Test functions
/////////////
2017-10-24 04:09:56 +00:00
/// @notice Basic helper function to return the current time
2017-06-26 17:54:28 +00:00
function getTime ( ) internal returns ( uint ) {
return now ;
2017-06-06 17:40:14 +00:00
}
2017-10-24 04:09:56 +00:00
// Event Delcerations
2017-06-06 17:40:14 +00:00
event Transfer ( uint64 indexed from , uint64 indexed to , uint amount ) ;
2017-10-04 23:27:23 +00:00
event CancelProject ( uint64 indexed idProject ) ;
2017-06-06 17:40:14 +00:00
}