Introduce crowdfunding MVP

README.md

@@ -4,6 +4,44 @@
 
 > 'Charta' is the latin word for 'letter or document'.  We loosely appropriate this term as a codename for the smart contracts comprising the business logic of Dharma protocol.
 
+# Dharma Crowdfunding MVP
+Send repayments to arbitrarily many recipients. Crowdfund debt. Issue bonds.
+
+This overview assumes the reader has working knowledge of the Dharma Protocol.  For a primer on the protocol, check out our [docs]().
+
+### CrowdfundingToken
+#### contracts/crowdfunding/CrowdfundingToken.sol
+The Dharma `CrowdfundingToken` enables a single debtor to make repayments to multiple creditors. It takes much inspiration from the [`MinimeToken`](https://github.com/Giveth/minime).
+
+- The `CrowdfundingToken` is an ERC-20 token.
+- The `CrowdfundingToken` itself owns a Dharma `DebtToken`.  
+- The repayments made on the debt represented by the `DebtToken` are thus sent to the `CrowdfundingToken` contract.  
+- Owners of the `CrowdfundingToken` are entitled to a withdraw a portion of each repayment made to the contract.
+- Each withdrawal amount is proportionate to the number of tokens owned by a given address divided by the total supply of tokens at the time of the repayment
+  - withdrawalAllowance = repaymentAmount * (tokensOwned / totalSupply)
+
+### CrowdfundingTokenRegistry
+#### contracts/crowdfunding/CrowdfundingTokenRegistry.sol
+The `CrowdfundingTokenRegistry` is a smart contract that deploys and keeps track of `CrowdfundingToken`s.
+
+### How to Crowdfund on Dharma Protocol
+1. The issuer wanting to crowdfund creates a `DebtToken` with no principal and sets itself as both the creditor and debtor.
+2. The issuer transfers the `DebtToken` to the `CrowdfundingTokenRegistry`.
+3. On receipt of the `DebtToken`, the `CrowdfundingTokenRegistry` deploys a new `CrowdfundingToken` and passes the `DebtToken` on to the `CrowdfundingToken`.
+  - The original owner of the `DebtToken`--in this case the issuer--is the owner of the new `CrowdfundingToken` contract.
+  - The `CrowdfundingTokenRegistry` keeps track of the `CrowdfundingToken `based on the `agreementId` of the `DebtToken` it owns.
+4. The issuer mints, distributes, and/or sells tokens of the `CrowdfundingToken` as they see fit.
+5. The issuer makes repayments on their debt and registers the repayment with the `CrowdfundingToken`
+  - The repayment is routed to the `CrowdfundingToken`.
+6. The token holders make withdrawals--proportionate to their ownership of the `CrowdfundingToken` at the time the repayment--from the `CrowdfundingToken`.
+
+### Future Work
+- A custom TermsContract to meet the needs of a specific crowdfunding use case
+  - Defining custom terms, repayment schedule, etc.
+  - Combining repayment and registering repayment into a single transaction
+- Simplifying the process of distributing/purchasing `CrowdfundingToken`s
+
+------------
 
 [Dharma](https://dharma.io) is a protocol for generic tokenized debt issuance and fundraising on blockchains supporting requisite smart contract functionality (i.e. EVM blockchains).  For a full description of the protocol's mechanics, a thorough overview can be found in the [Dharma Protocol Whitepaper](https://whitepaper.dharma.io/).  This repository contains the core contracts that compromise the business logic for issuing and administering debt crypto-assets on-chain.
 

artifacts/json/AddressUtils.json

@@ -3,16 +3,16 @@
   "abi": [],
   "bytecode": "0x60606040523415600e57600080fd5b603580601b6000396000f3006060604052600080fd00a165627a7a723058201a94a5c7a3f497e8cf56df37432c210e41d7bb26c8b2dfc0b33d74a7b36b64720029",
   "deployedBytecode": "0x6060604052600080fd00a165627a7a723058201a94a5c7a3f497e8cf56df37432c210e41d7bb26c8b2dfc0b33d74a7b36b64720029",
-  "sourceMap": "86:518:29:-;;;;;;;;;;;;;;;;;",
-  "deployedSourceMap": "86:518:29:-;;;;;",
+  "sourceMap": "86:518:32:-;;;;;;;;;;;;;;;;;",
+  "deployedSourceMap": "86:518:32:-;;;;;",
   "source": "pragma solidity ^0.4.18;\n\n/**\n * Utility library of inline functions on addresses\n */\nlibrary AddressUtils {\n\n  /**\n   * Returns whether there is code in the target address\n   * @dev This function will return false if invoked during the constructor of a contract,\n   *  as the code is not actually created until after the constructor finishes.\n   * @param addr address address to check\n   * @return whether there is code in the target address\n   */\n  function isContract(address addr) internal view returns (bool) {\n    uint256 size;\n    assembly { size := extcodesize(addr) }\n    return size > 0;\n  }\n\n}\n",
   "sourcePath": "zeppelin-solidity/contracts/AddressUtils.sol",
   "ast": {
     "attributes": {
       "absolutePath": "zeppelin-solidity/contracts/AddressUtils.sol",
       "exportedSymbols": {
         "AddressUtils": [
-          8604
+          9911
         ]
       }
     },
@@ -26,9 +26,9 @@
             ".18"
           ]
         },
-        "id": 8587,
+        "id": 9894,
         "name": "PragmaDirective",
-        "src": "0:24:29"
+        "src": "0:24:32"
       },
       {
         "attributes": {
@@ -42,10 +42,10 @@
           "documentation": "Utility library of inline functions on addresses",
           "fullyImplemented": true,
           "linearizedBaseContracts": [
-            8604
+            9911
           ],
           "name": "AddressUtils",
-          "scope": 8605
+          "scope": 9912
         },
         "children": [
           {
@@ -58,7 +58,7 @@
               ],
               "name": "isContract",
               "payable": false,
-              "scope": 8604,
+              "scope": 9911,
               "stateMutability": "view",
               "superFunction": null,
               "visibility": "internal"
@@ -70,7 +70,7 @@
                     "attributes": {
                       "constant": false,
                       "name": "addr",
-                      "scope": 8603,
+                      "scope": 9910,
                       "stateVariable": false,
                       "storageLocation": "default",
                       "type": "address",
@@ -83,27 +83,27 @@
                           "name": "address",
                           "type": "address"
                         },
-                        "id": 8588,
+                        "id": 9895,
                         "name": "ElementaryTypeName",
-                        "src": "471:7:29"
+                        "src": "471:7:32"
                       }
                     ],
-                    "id": 8589,
+                    "id": 9896,
                     "name": "VariableDeclaration",
-                    "src": "471:12:29"
+                    "src": "471:12:32"
                   }
                 ],
-                "id": 8590,
+                "id": 9897,
                 "name": "ParameterList",
-                "src": "470:14:29"
+                "src": "470:14:32"
               },
               {
                 "children": [
                   {
                     "attributes": {
                       "constant": false,
                       "name": "",
-                      "scope": 8603,
+                      "scope": 9910,
                       "stateVariable": false,
                       "storageLocation": "default",
                       "type": "bool",
@@ -116,19 +116,19 @@
                           "name": "bool",
                           "type": "bool"
                         },
-                        "id": 8591,
+                        "id": 9898,
                         "name": "ElementaryTypeName",
-                        "src": "508:4:29"
+                        "src": "508:4:32"
                       }
                     ],
-                    "id": 8592,
+                    "id": 9899,
                     "name": "VariableDeclaration",
-                    "src": "508:4:29"
+                    "src": "508:4:32"
                   }
                 ],
-                "id": 8593,
+                "id": 9900,
                 "name": "ParameterList",
-                "src": "507:6:29"
+                "src": "507:6:32"
               },
               {
                 "children": [
@@ -144,7 +144,7 @@
                         "attributes": {
                           "constant": false,
                           "name": "size",
-                          "scope": 8603,
+                          "scope": 9910,
                           "stateVariable": false,
                           "storageLocation": "default",
                           "type": "uint256",
@@ -157,52 +157,52 @@
                               "name": "uint256",
                               "type": "uint256"
                             },
-                            "id": 8594,
+                            "id": 9901,
                             "name": "ElementaryTypeName",
-                            "src": "520:7:29"
+                            "src": "520:7:32"
                           }
                         ],
-                        "id": 8595,
+                        "id": 9902,
                         "name": "VariableDeclaration",
-                        "src": "520:12:29"
+                        "src": "520:12:32"
                       }
                     ],
-                    "id": 8596,
+                    "id": 9903,
                     "name": "VariableDeclarationStatement",
-                    "src": "520:12:29"
+                    "src": "520:12:32"
                   },
                   {
                     "attributes": {
                       "externalReferences": [
                         {
                           "size": {
-                            "declaration": 8595,
+                            "declaration": 9902,
                             "isOffset": false,
                             "isSlot": false,
-                            "src": "549:4:29",
+                            "src": "549:4:32",
                             "valueSize": 1
                           }
                         },
                         {
                           "addr": {
-                            "declaration": 8589,
+                            "declaration": 9896,
                             "isOffset": false,
                             "isSlot": false,
-                            "src": "569:4:29",
+                            "src": "569:4:32",
                             "valueSize": 1
                           }
                         }
                       ],
                       "operations": "{\n    size := extcodesize(addr)\n}"
                     },
                     "children": [],
-                    "id": 8597,
+                    "id": 9904,
                     "name": "InlineAssembly",
-                    "src": "538:49:29"
+                    "src": "538:49:32"
                   },
                   {
                     "attributes": {
-                      "functionReturnParameters": 8593
+                      "functionReturnParameters": 9900
                     },
                     "children": [
                       {
@@ -226,13 +226,13 @@
                               "overloadedDeclarations": [
                                 null
                               ],
-                              "referencedDeclaration": 8595,
+                              "referencedDeclaration": 9902,
                               "type": "uint256",
                               "value": "size"
                             },
-                            "id": 8598,
+                            "id": 9905,
                             "name": "Identifier",
-                            "src": "588:4:29"
+                            "src": "588:4:32"
                           },
                           {
                             "attributes": {
@@ -247,45 +247,45 @@
                               "type": "int_const 0",
                               "value": "0"
                             },
-                            "id": 8599,
+                            "id": 9906,
                             "name": "Literal",
-                            "src": "595:1:29"
+                            "src": "595:1:32"
                           }
                         ],
-                        "id": 8600,
+                        "id": 9907,
                         "name": "BinaryOperation",
-                        "src": "588:8:29"
+                        "src": "588:8:32"
                       }
                     ],
-                    "id": 8601,
+                    "id": 9908,
                     "name": "Return",
-                    "src": "581:15:29"
+                    "src": "581:15:32"
                   }
                 ],
-                "id": 8602,
+                "id": 9909,
                 "name": "Block",
-                "src": "514:87:29"
+                "src": "514:87:32"
               }
             ],
-            "id": 8603,
+            "id": 9910,
             "name": "FunctionDefinition",
-            "src": "451:150:29"
+            "src": "451:150:32"
           }
         ],
-        "id": 8604,
+        "id": 9911,
         "name": "ContractDefinition",
-        "src": "86:518:29"
+        "src": "86:518:32"
       }
     ],
-    "id": 8605,
+    "id": 9912,
     "name": "SourceUnit",
-    "src": "0:605:29"
+    "src": "0:605:32"
   },
   "compiler": {
     "name": "solc",
     "version": "0.4.18+commit.9cf6e910.Emscripten.clang"
   },
   "networks": {},
   "schemaVersion": "1.0.1",
-  "updatedAt": "2018-07-02T23:10:02.088Z"
+  "updatedAt": "2018-07-24T01:55:45.041Z"
 }