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

Added a bunch of comments and TODOs!!!

This commit is contained in:
Griff Green 2017-12-03 22:18:31 -03:00 committed by GitHub
parent 4039a7173b
commit 09a275b50c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
contracts/LiquidPledgingBase.sol
View File

@ -1,7 +1,8 @@
pragma solidity ^0.4.11; pragma solidity ^0.4.11;
/* /*
Copyright 2017, Jordi Baylina Copyright 2017, Jordi Baylina
Contributor: Adrià Massanet <adria@codecontext.io> Contributors: Adrià Massanet <adria@codecontext.io>, RJ Ewing, Griff
Green, Arthur Lunn
This program is free software: you can redistribute it and/or modify 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 it under the terms of the GNU General Public License as published by
@ -20,15 +21,16 @@ pragma solidity ^0.4.11;
import "./ILiquidPledgingPlugin.sol"; import "./ILiquidPledgingPlugin.sol";
import "../node_modules/giveth-common-contracts/contracts/Owned.sol"; import "../node_modules/giveth-common-contracts/contracts/Owned.sol";
/// @dev `LPVault` serves as an interface to allow the `LiquidPledgingBase` /// @dev This is an interface for `LPVault` which serves as a secure storage for
/// contract to interface with a `LPVault` contract /// the ETH that backs the Pledges, only after `LiquidPledging` authorizes
contract LPVault { /// payments can Pledges be converted for ETH
contract LPVault { // TODO: This should be `interface` instead of contract????????????????????????????????????????
function authorizePayment(bytes32 _ref, address _dest, uint _amount); function authorizePayment(bytes32 _ref, address _dest, uint _amount);
function () payable; function () payable;
} }
/// @dev `LiquidPledgingBase` is the base level contract used to carry out /// @dev `LiquidPledgingBase` is the base level contract used to carry out
/// liquid pledging's most basic functions, mostly handling and searching the /// liquidPledging's most basic functions, mostly handling and searching the
/// data structures /// data structures
contract LiquidPledgingBase is Owned { contract LiquidPledgingBase is Owned {
@ -38,10 +40,10 @@ contract LiquidPledgingBase is Owned {
uint constant MAX_INTERPROJECT_LEVEL = 20; uint constant MAX_INTERPROJECT_LEVEL = 20;
enum PledgeAdminType { Giver, Delegate, Project } enum PledgeAdminType { Giver, Delegate, Project }
enum PaymentState { Pledged, Paying, Paid } enum PaymentState { Pledged, Paying, Paid } //TODO Very confusing with PaymentStatus rename to PledgeState??????????????
/// @dev This struct defines the details of a `PledgeAdmin` which are /// @dev This struct defines the details of a `PledgeAdmin` which are
/// commonly referenced by their index in the `admins` array. /// commonly referenced by their index in the `admins` array
/// and can own pledges and act as delegates /// and can own pledges and act as delegates
struct PledgeAdmin { struct PledgeAdmin {
PledgeAdminType adminType; // Giver, Delegate or Project PledgeAdminType adminType; // Giver, Delegate or Project
@ -64,7 +66,7 @@ contract LiquidPledgingBase is Owned {
uint64 intendedProject; // Used when delegates are sending to projects uint64 intendedProject; // Used when delegates are sending to projects
uint64 commitTime; // When the intendedProject will become the owner uint64 commitTime; // When the intendedProject will become the owner
uint64 oldPledge; // Points to the id that this Pledge was derived from uint64 oldPledge; // Points to the id that this Pledge was derived from
PaymentState paymentState; // Pledged, Paying, Paid PaymentState paymentState; // Pledged, Paying, Paid //TODO Very confusing with PaymentStatus rename to pledgeState??????????????
} }
Pledge[] pledges; Pledge[] pledges;
@ -427,7 +429,7 @@ contract LiquidPledgingBase is Owned {
uint64 intendedProject, uint64 intendedProject,
uint64 commitTime, uint64 commitTime,
uint64 oldPledge, uint64 oldPledge,
PaymentState paid PaymentState paid // TODO CHANGE PAID TO STATE
) internal returns (uint64) ) internal returns (uint64)
{ {
bytes32 hPledge = sha3( bytes32 hPledge = sha3(