status-im
/
liquid-funding
mirror of https://github.com/status-im/liquid-funding.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #6 from Giveth/GriffGreen-patch-3 

Added comments and a few other small things
This commit is contained in:
Jordi Baylina 2017-10-03 10:56:09 +02:00 committed by GitHub
parent b5c0686ff4 885678c078
commit 104b857736
1 changed files with 44 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

78
contracts/LiquidPledgingBase.sol
View File

@ -2,43 +2,46 @@ pragma solidity ^0.4.11;
import "./ILiquidPledgingPlugin.sol";
/// @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
enum PaymentState { NotPaid, Paying, Paid }
enum NoteManagerType { Donor, Delegate, Project } // todo change name Donor Project
enum PaymentState { NotPaid, Paying, Paid } // TODO name change NotPaid
// This struct defines the details of each the NoteManager, these NoteManagers can create
struct NoteManager {// change manager
NoteManagerType managerType;
address addr;
string name;
uint64 commitTime; // Only used in donors and projects, its the precommitment time
uint64 parentProject; // Only for projects
bool canceled; // Only for project
ILiquidPledgingPlugin plugin; // Handler that is called when one call is affected.
/// @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;
uint64[] delegationChain; //index numbers!!!!!
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; // At what time the upcoming time will become an owner.
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 all the note managers 0 is reserved for no manager
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
@ -59,6 +62,8 @@ contract LiquidPledgingBase {
// 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
@ -70,7 +75,9 @@ contract LiquidPledgingBase {
// Managers functions
//////
function addDonor(string name, uint64 commitTime, ILiquidPledgingPlugin plugin) returns (uint64 idDonor) {//Todo return idManager
/// @notice Creates a donor.
function addDonor(string name, uint64 commitTime, ILiquidPledgingPlugin plugin
) returns (uint64 idDonor) {//Todo return idManager
idDonor = uint64(managers.length);
@ -88,6 +95,7 @@ contract LiquidPledgingBase {
event DonorAdded(uint64 indexed idDonor);
///@notice Changes the address, name or commitTime associated with a specific donor
function updateDonor(
uint64 idDonor,
address newAddr,
@ -95,8 +103,8 @@ contract LiquidPledgingBase {
uint64 newCommitTime)
{
NoteManager storage donor = findManager(idDonor);
require(donor.managerType == NoteManagerType.Donor);
require(donor.addr == msg.sender);
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;
@ -105,6 +113,7 @@ contract LiquidPledgingBase {
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);
@ -123,6 +132,7 @@ contract LiquidPledgingBase {
event DeegateAdded(uint64 indexed idDelegate);
///@notice Changes the address, name or commitTime associated with a specific delegate
function updateDelegate(
uint64 idDelegate,
address newAddr,
@ -139,6 +149,7 @@ contract LiquidPledgingBase {
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);
@ -164,6 +175,7 @@ contract LiquidPledgingBase {
event ProjectAdded(uint64 indexed idProject);
///@notice Changes the address, name or commitTime associated with a specific Campaign
function updateProject(
uint64 idProject,
address newAddr,
@ -186,11 +198,11 @@ contract LiquidPledgingBase {
// 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,
@ -209,7 +221,8 @@ contract LiquidPledgingBase {
oldNote = n.oldNote;
paymentState = n.paymentState;
}
// This is to return the delegates one by one, because you can not return an array
/// @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,
@ -221,11 +234,11 @@ contract LiquidPledgingBase {
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,
@ -249,9 +262,10 @@ contract LiquidPledgingBase {
// Private methods
///////
// All notes exist... but if the note hasn't been created in this system yet then it wouldn't
// be in the hash array hNoteddx[]
// this function creates a balloon if one is not created already... this ballon has 0 for the amount
/// @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,
@ -284,7 +298,7 @@ contract LiquidPledgingBase {
uint64 constant NOTFOUND = 0xFFFFFFFFFFFFFFFF;
// helper function that searches the delegationChain fro a specific delegate and
// level of delegation returns their idx in the delegation cahin which reflect their level of authority
// 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<n.delegationChain.length; i++) {
if (n.delegationChain[i] == idDelegate) return uint64(i);
@ -340,8 +354,8 @@ contract LiquidPledgingBase {
return isProjectCanceled2(m.parentProject);
}
// this makes it easy to cancel projects
// @param idNote the note that may or may not be cancelled
// @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);
@ -358,8 +372,4 @@ contract LiquidPledgingBase {
function checkManagerOwner(NoteManager m) internal constant {
require((msg.sender == m.addr) || (msg.sender == address(m.plugin)));
}
}