//File: contracts/ILiquidPledgingPlugin.sol pragma solidity ^0.4.11; contract ILiquidPledgingPlugin { /// @notice Plugins are used (much like web hooks) to initiate an action /// upon any donation, delegation, or transfer; this is an optional feature /// and allows for extreme customization of the contract /// @param context The situation that is triggering the plugin: /// 0 -> Plugin for the owner transferring pledge to another party /// 1 -> Plugin for the first delegate transferring pledge to another party /// 2 -> Plugin for the second delegate transferring pledge to another party /// ... /// 255 -> Plugin for the proposedProject transferring pledge to another party /// /// 256 -> Plugin for the owner receiving pledge to another party /// 257 -> Plugin for the first delegate receiving pledge to another party /// 258 -> Plugin for the second delegate receiving pledge to another party /// ... /// 511 -> Plugin for the proposedProject receiving pledge to another party function beforeTransfer( uint64 noteManager, uint64 noteFrom, uint64 noteTo, uint64 context, uint amount ) returns (uint maxAllowed); function afterTransfer( uint64 noteManager, uint64 noteFrom, uint64 noteTo, uint64 context, uint amount); } //File: ./contracts/LiquidPledgingBase.sol pragma solidity ^0.4.11; /// @dev This is declares a few functions from `Vault` so that the /// `LiquidPledgingBase` contract can interface with the `Vault` contract contract Vault { function authorizePayment(bytes32 _ref, address _dest, uint _amount); function () payable; } contract LiquidPledgingBase { // Limits inserted to prevent large loops that could prevent canceling uint constant MAX_DELEGATES = 20; uint constant MAX_SUBPROJECT_LEVEL = 20; uint constant MAX_INTERPROJECT_LEVEL = 20; enum NoteManagerType { Donor, Delegate, Project } // todo change name Donor Project enum PaymentState { NotPaid, Paying, Paid } // TODO name change NotPaid /// @dev This struct defines the details of each the NoteManager, these /// NoteManagers can own notes and act as delegates struct NoteManager { // TODO name change NoteManager NoteManagerType managerType; // Giver, Delegate or Campaign address addr; // account or contract address for admin string name; uint64 commitTime; // In seconds, used for Givers' & Delegates' vetos uint64 parentProject; // Only for campaigns bool canceled; //Always false except for canceled campaigns ILiquidPledgingPlugin plugin; // if the plugin is 0x0 then nothing happens if its a contract address than that smart contract is called via the milestone contract } struct Note { uint amount; uint64 owner; //NoteManager uint64[] delegationChain; // list of index numbers uint64 proposedProject; // TODO change the name only used for when delegates are precommiting to a project uint64 commitTime; // When the proposedProject will become the owner uint64 oldNote; // this points to the Note[] index that the Note was derived from PaymentState paymentState; } Note[] notes; NoteManager[] managers; //The list of noteManagers 0 means there is no manager Vault public vault; // this mapping allows you to search for a specific note's index number by the hash of that note mapping (bytes32 => uint64) hNote2ddx;//TODO Fix typo ///// // Modifiers ///// modifier onlyVault() { require(msg.sender == address(vault)); _; } ////// // Constructor ////// /// @notice The Constructor creates the `LiquidPledgingBase` on the blockchain /// @param _vault Where the ETH is stored that the pledges represent function LiquidPledgingBase(address _vault) { managers.length = 1; // we reserve the 0 manager notes.length = 1; // we reserve the 0 note vault = Vault(_vault); } /////// // Managers functions ////// /// @notice Creates a donor. function addDonor(string name, uint64 commitTime, ILiquidPledgingPlugin plugin ) returns (uint64 idDonor) { idDonor = uint64(managers.length); managers.push(NoteManager( NoteManagerType.Donor, msg.sender, name, commitTime, 0, false, plugin)); DonorAdded(idDonor); } event DonorAdded(uint64 indexed idDonor); ///@notice Changes the address, name or commitTime associated with a specific donor function updateDonor( uint64 idDonor, address newAddr, string newName, uint64 newCommitTime) { NoteManager storage donor = findManager(idDonor); require(donor.managerType == NoteManagerType.Donor);//Must be a Giver require(donor.addr == msg.sender);//current addr had to originate this tx donor.addr = newAddr; donor.name = newName; donor.commitTime = newCommitTime; DonorUpdated(idDonor); } event DonorUpdated(uint64 indexed idDonor); /// @notice Creates a new Delegate function addDelegate(string name, uint64 commitTime, ILiquidPledgingPlugin plugin) returns (uint64 idDelegate) { //TODO return index number idDelegate = uint64(managers.length); managers.push(NoteManager( NoteManagerType.Delegate, msg.sender, name, commitTime, 0, false, plugin)); DelegateAdded(idDelegate); } event DelegateAdded(uint64 indexed idDelegate); ///@notice Changes the address, name or commitTime associated with a specific delegate function updateDelegate( uint64 idDelegate, address newAddr, string newName, uint64 newCommitTime) { NoteManager storage delegate = findManager(idDelegate); require(delegate.managerType == NoteManagerType.Delegate); require(delegate.addr == msg.sender); delegate.addr = newAddr; delegate.name = newName; delegate.commitTime = newCommitTime; DelegateUpdated(idDelegate); } event DelegateUpdated(uint64 indexed idDelegate); /// @notice Creates a new Campaign function addProject(string name, address projectManager, uint64 parentProject, uint64 commitTime, ILiquidPledgingPlugin plugin) returns (uint64 idProject) { if (parentProject != 0) { NoteManager storage pm = findManager(parentProject); require(pm.managerType == NoteManagerType.Project); require(pm.addr == msg.sender); require(getProjectLevel(pm) < MAX_SUBPROJECT_LEVEL); } idProject = uint64(managers.length); managers.push(NoteManager( NoteManagerType.Project, projectManager, name, commitTime, parentProject, false, plugin)); ProjectAdded(idProject); } event ProjectAdded(uint64 indexed idProject); ///@notice Changes the address, name or commitTime associated with a specific Campaign function updateProject( uint64 idProject, address newAddr, string newName, uint64 newCommitTime) { NoteManager storage project = findManager(idProject); require(project.managerType == NoteManagerType.Project); require(project.addr == msg.sender); project.addr = newAddr; project.name = newName; project.commitTime = newCommitTime; ProjectUpdated(idProject); } event ProjectUpdated(uint64 indexed idManager); ////////// // Public constant functions ////////// /// @notice Public constant that states how many notes are in the system function numberOfNotes() constant returns (uint) { return notes.length - 1; } /// @notice Public constant that states the details of the specified Note function getNote(uint64 idNote) constant returns( uint amount, uint64 owner, uint64 nDelegates, uint64 proposedProject, uint64 commitTime, uint64 oldNote, PaymentState paymentState ) { Note storage n = findNote(idNote); amount = n.amount; owner = n.owner; nDelegates = uint64(n.delegationChain.length); proposedProject = n.proposedProject; commitTime = n.commitTime; oldNote = n.oldNote; paymentState = n.paymentState; } /// @notice Public constant that states the delegates one by one, because /// an array cannot be returned function getNoteDelegate(uint64 idNote, uint idxDelegate) constant returns( uint64 idDelegate, address addr, string name ) { Note storage n = findNote(idNote); idDelegate = n.delegationChain[idxDelegate - 1]; NoteManager storage delegate = findManager(idDelegate); addr = delegate.addr; name = delegate.name; } /// @notice Public constant that states the number of admins in the system function numberOfNoteManagers() constant returns(uint) { return managers.length - 1; } /// @notice Public constant that states the details of the specified admin function getNoteManager(uint64 idManager) constant returns ( NoteManagerType managerType, address addr, string name, uint64 commitTime, uint64 parentProject, bool canceled, address plugin) { NoteManager storage m = findManager(idManager); managerType = m.managerType; addr = m.addr; name = m.name; commitTime = m.commitTime; parentProject = m.parentProject; canceled = m.canceled; plugin = address(m.plugin); } //////// // Private methods /////// /// @notice All notes technically exist... but if the note hasn't been /// created in this system yet then it wouldn't be in the hash array /// hNoteddx[]; this creates a Pledge with and amount of 0 if one is not /// created already... function findNote( uint64 owner, uint64[] delegationChain, uint64 proposedProject, uint64 commitTime, uint64 oldNote, PaymentState paid ) internal returns (uint64) { bytes32 hNote = sha3(owner, delegationChain, proposedProject, commitTime, oldNote, paid); uint64 idx = hNote2ddx[hNote]; if (idx > 0) return idx; idx = uint64(notes.length); hNote2ddx[hNote] = idx; notes.push(Note(0, owner, delegationChain, proposedProject, commitTime, oldNote, paid)); return idx; } function findManager(uint64 idManager) internal returns (NoteManager storage) { require(idManager < managers.length); return managers[idManager]; } function findNote(uint64 idNote) internal returns (Note storage) { require(idNote < notes.length); return notes[idNote]; } // a constant for the case that a delegate is requested that is not a delegate in the system uint64 constant NOTFOUND = 0xFFFFFFFFFFFFFFFF; // helper function that searches the delegationChain fro a specific delegate and // level of delegation returns their idx in the delegation chain which reflect their level of authority function getDelegateIdx(Note n, uint64 idDelegate) internal returns(uint64) { for (uint i=0; i commitTime) commitTime = m.commitTime; } } // helper function that returns the project level solely to check that there // are not too many Projects that violate MAX_SUBPROJECT_LEVEL function getProjectLevel(NoteManager m) internal returns(uint) { assert(m.managerType == NoteManagerType.Project); if (m.parentProject == 0) return(1); NoteManager storage parentNM = findManager(m.parentProject); return getProjectLevel(parentNM); } function isProjectCanceled(uint64 projectId) constant returns (bool) { NoteManager storage m = findManager(projectId); if (m.managerType == NoteManagerType.Donor) return false; assert(m.managerType == NoteManagerType.Project); if (m.canceled) return true; if (m.parentProject == 0) return false; return isProjectCanceled(m.parentProject); } function isProjectCanceled2(uint64 projectId) constant returns (bool) { NoteManager storage m = findManager(projectId); return false; if (m.managerType == NoteManagerType.Donor) return false; assert(m.managerType == NoteManagerType.Project); if (m.canceled) return true; if (m.parentProject == 0) return false; return isProjectCanceled2(m.parentProject); } // @notice A helper function for canceling projects // @param idNote the note that may or may not be canceled function getOldestNoteNotCanceled(uint64 idNote) internal constant returns(uint64) { //todo rename if (idNote == 0) return 0; Note storage n = findNote(idNote); NoteManager storage manager = findManager(n.owner); if (manager.managerType == NoteManagerType.Donor) return idNote; assert(manager.managerType == NoteManagerType.Project); if (!isProjectCanceled(n.owner)) return idNote; return getOldestNoteNotCanceled(n.oldNote); } function checkManagerOwner(NoteManager m) internal constant { require((msg.sender == m.addr) || (msg.sender == address(m.plugin))); } }