Support for multiple organizations (Closes #50)

README.md

@@ -20,35 +20,6 @@ yarn install
 yarn chain
 ```
 
-> Make a copy of `.sample.env` and rename to `.env` in `packages/react-app`. Don't forget to fill in the variables.
-<table>
-    <thead>
-        <th>Variable</th>
-        <th>Description</th>
-    </thead>
-    <tbody>
-        <tr>
-            <td><code>REACT_APP_NETWORK</code></td>
-            <td>The ethereum network to run on, by default "mainnet"</td>
-        </tr>
-        <tr>
-            <td><code>REACT_APP_INFURA_ID</code></td>
-            <td>Your Infura project ID.</td>
-        </tr>
-        <tr>
-            <td><code>REACT_APP_ETHERSCAN_ID</code></td>
-            <td>Your Etherscan API key token.</td>
-        </tr>
-        <tr>
-            <td><code>REACT_APP_PROVIDER</code></td>
-            <td>Provider endpoint, typically Infura endpoint.</td>
-        </tr>
-        <tr>
-            <td><code>REACT_APP_MAINNET_RPC_ENDPOINT</code></td>
-            <td>Can be used to override the mainnet RPC provider endpoint (typically Alchemy endpoint).</td>
-        </tr>
-    </tbody>
-</table>
 > in a second terminal window, start your 📱 frontend:
 
 ```bash
@@ -57,30 +28,6 @@ yarn start
 ```
 
 > Make a copy of `.sample.env` and rename to `.env` in `packages/hardhat`. Don't forget to fill in the variables.
-<table>
-    <thead>
-        <th>Variable</th>
-        <th>Description</th>
-    </thead>
-    <tbody>
-        <tr>
-            <td><code>STREAM_FACTORY_OWNER</code></td>
-            <td>Owner address of the stream factory contract <code>packages/hardhat/contracts/StreamFactory.sol</code></td>
-        </tr>
-        <tr>
-            <td><code>STREAM_FACTORY_ADMINS</code></td>
-            <td>Admin addresses of the stream factory contract constructor arg <code>packages/hardhat/contracts/StreamFactory.sol</code></td>
-        </tr>
-        <tr>
-            <td><code>DEPLOY_ENDPOINT_RINKEBY</code></td>
-            <td>Your Infura / Alchemy endpoint for tokenstream on Rinkeby network</td>
-        </tr>
-        <tr>
-            <td><code>DEPLOY_ACCOUNT_RINKEBY</code></td>
-            <td>Your wallet account. For metamask, the private key can be extracted by clicking on the three dots button next to the account icon, then on "Account Details" and then on "Export private key".</td>
-        </tr>
-    </tbody>
-</table>
 > in a third terminal window, 🛰 deploy your contract:
 
 ```bash

packages/hardhat/.sample.env

@@ -1,4 +1,3 @@
-STREAM_FACTORY_OWNER=0x0000000000000000000000000000000000000000
-STREAM_FACTORY_ADMINS=["0x0000000000000000000000000000000000000000", "0x0000000000000000000000000000000000000000"]
-DEPLOY_ENDPOINT_RINKEBY=https://rinkeby.infura.io/v3/[YOUR_ID]
-DEPLOY_ACCOUNT_RINKEBY=my super secret key that i promise never ever to share
+DEVELOPER=0x0000000000000000000000000000000000000000
+MANAGER1=0x0000000000000000000000000000000000000000
+MANAGER2=0x0000000000000000000000000000000000000000

packages/hardhat/contracts/OrgFactoryDeployer.sol

@@ -0,0 +1,82 @@
+//SPDX-License-Identifier: MIT
+pragma solidity >=0.8.0 <0.9.0;
+
+import "./StreamFactory.sol";
+import "./SimpleStream.sol";
+
+contract OrgFactoryDeployer {
+
+    /// @dev emitted when a new org is created.
+    event OrganizationsDeployed(
+
+        address indexed tokenAddress,
+        address indexed ownerAddress,
+        string organizationName
+    );
+
+    address[] public organizations;
+
+    /// @dev deploys a stream factory contract for a specified organization.
+    function deployOrganization(
+        string memory _orgName,
+        string memory _logoURI,
+        string memory _orgDescription,
+        address owner,
+        address[] calldata admins
+
+    ) public {
+        StreamFactory deployedOrganization = new StreamFactory(
+            _orgName,
+            _logoURI,
+            _orgDescription,
+            owner,
+            admins
+        );
+
+        organizations.push(address(deployedOrganization));
+
+        emit OrganizationsDeployed(
+            address(deployedOrganization),
+            msg.sender,
+            string(_orgName)
+        );
+
+    }
+
+    /// @dev gets a page of organizations
+    function getOrganizations(
+        uint256 _page,
+        uint256 _resultsPerPage
+    )
+        external
+        view
+        returns (address[] memory)
+    {
+        uint256 _orgIndex = _resultsPerPage * _page - _resultsPerPage;
+
+        if (
+            organizations.length == 0 ||
+            _orgIndex > organizations.length - 1
+        ) {
+            return new address[](0);
+        }
+
+        address[] memory _orgs = new address[](_resultsPerPage);
+        uint256 _returnCounter = 0;
+
+        for (
+            _orgIndex;
+            _orgIndex < _resultsPerPage * _page;
+            _orgIndex++
+        ) {
+            if (_orgIndex <= organizations.length - 1) {
+                _orgs[_returnCounter] = organizations[_orgIndex];
+            } else {
+                _orgs[_returnCounter] = address(0);
+            }
+            _returnCounter++;
+        }
+        return _orgs;
+    }
+
+}

packages/hardhat/contracts/StreamFactory.sol

@@ -20,6 +20,29 @@ contract StreamFactory is AccessControl, Ownable {
         bool hasStream;
     }
 
+    struct OrgInfo {
+        /// @dev name of organization
+        string orgName;
+        /// @dev discription of the organization
+        string orgDescription;
+        /// @dev github URI of organization
+        string orgGithubURI;
+        /// @dev twitter URI of the organization
+        string orgTwitterURI;
+        /// @dev the website URI of organization
+        string orgWebURI;
+        /// @dev discord URI organization
+        string orgDiscordURI;
+        /// @dev URI to the logo of organization
+        string logoURI;
+        /// @dev total streams in organization
+        uint256 streamsCount;
+        /// @dev total amount paid out by organization
+        uint256 totalPaidOut;
+    }
+
+    OrgInfo public orgInfo;
+
     /// @dev StreamAdded event to track the streams after creation
     event StreamAdded(address creator, address user, address stream);
 
@@ -34,11 +57,28 @@ contract StreamFactory is AccessControl, Ownable {
         _;
     }
 
-    constructor(address owner, address[] memory admins) {
+    constructor(
+        string memory _orgName,
+        string memory _logoURI,
+        string memory _orgDescription,
+        address owner,
+        address[] memory admins
+    ) {
         for (uint256 i = 0; i < admins.length; i++) {
             _setupRole(DEFAULT_ADMIN_ROLE, admins[i]);
             _setupRole(FACTORY_MANAGER, admins[i]);
         }
+        orgInfo = OrgInfo(
+            _orgName,
+            _orgDescription,
+            '', // github URI
+            '', // twitter URI
+            '', // website URI
+            '', // discord URI
+            _logoURI,
+            0, // streams count
+            0  // total paid out
+        );
         transferOwnership(owner);
     }
 
@@ -72,6 +112,7 @@ contract StreamFactory is AccessControl, Ownable {
         // map user to new stream
         userStreams[_toAddress] = streamAddress;
 
+        orgInfo.streamsCount++;
         emit StreamAdded(msg.sender, _toAddress, streamAddress);
     }
 
@@ -115,6 +156,8 @@ contract StreamFactory is AccessControl, Ownable {
     }
 
     function releaseUserStream(address user) public isPermittedFactoryManager {
+
         SimpleStream(userStreams[user]).transferOwnership(user);
+        orgInfo.streamsCount--;
     }
 }

packages/hardhat/deploy/00_deploy_stream_factory.js

@@ -8,10 +8,7 @@ module.exports = async ({ getNamedAccounts, getChainId, deployments }) => {
 
   const GTC = { address: "0xde30da39c46104798bb5aa3fe8b9e0e1f348163f" };
 
-  const owner = process.env.STREAM_FACTORY_OWNER;
-  const admins = JSON.parse(process.env.STREAM_FACTORY_ADMINS);
-  admins.push(owner); // the owner is also an admin
-
+  //const owner = process.env.STREAM_FACTORY_OWNER;
   // // deploy dummy GTC on non-mainnet networks
   // if (chainId !== "1") {
   //   GTC = await deploy("GTC", {
@@ -21,26 +18,24 @@ module.exports = async ({ getNamedAccounts, getChainId, deployments }) => {
   //   });
   // }
 
-  // deploy the stream factory
-  const streamFactory = await deploy("StreamFactory", {
+  // deploy the Org Factory 
+  const orgFactory = await deploy("OrgFactoryDeployer", {
     from: deployer,
-    args: [owner, admins],
     log: true,
   });
 
-  // log the GTC and StreamFactory addresses
+  // log the GTC and orgFactoryDeployer addresses
   console.log({
     GTC: GTC.address,
-    streamFactory: streamFactory.address,
+    orgFactory: orgFactory.address,
   });
 
   if (chainId !== "31337") {
     await run("verify:verify", {
-      address: streamFactory.address,
-      contract: "contracts/StreamFactory.sol:StreamFactory",
-      constructorArguments: [owner, admins],
+      address: orgFactory.address,
+      contract: "contracts/OrgFactoryDeployer.sol:OrgFactoryDeployer",
     });
   }
 };
 
-module.exports.tags = ["GTC", "StreamFactory", "SimpleStream"];
+module.exports.tags = ["GTC", "OrgFactoryDeployer"];

packages/hardhat/hardhat.config.js

@@ -2,7 +2,6 @@ const { utils } = require("ethers");
 const fs = require("fs");
 const chalk = require("chalk");
 
-require("dotenv").config();
 require("@nomiclabs/hardhat-waffle");
 require("@tenderly/hardhat-tenderly");
 require("hardhat-deploy");
@@ -35,11 +34,11 @@ module.exports = {
       url: "http://localhost:8545",
     },
     rinkeby: {
-      url: process.env.DEPLOY_ENDPOINT_RINKEBY, // <---- YOUR INFURA ID! (or it won't work)
+      url: "https://rinkeby.infura.io/v3/460f40a260564ac4a4f4b3fffb032dad", // <---- YOUR INFURA ID! (or it won't work)
       //    url: "https://speedy-nodes-nyc.moralis.io/XXXXXXXXXXXXXXXXXXXXXXX/eth/rinkeby", // <---- YOUR MORALIS ID! (not limited to infura)
-      accounts: [
-        process.env.DEPLOY_ACCOUNT_RINKEBY
-      ],
+      accounts: {
+        mnemonic: mnemonic(),
+      },
     },
     kovan: {
       url: "https://kovan.infura.io/v3/460f40a260564ac4a4f4b3fffb032dad", // <---- YOUR INFURA ID! (or it won't work)

packages/react-app/.sample.env

@@ -1,5 +1,6 @@
+REACT_APP_PROVIDER=https://rinkeby.infura.io/v3/2717afb6bf164045b5d5468031b93f87
 REACT_APP_INFURA_ID=INFURA-PROJECT-ID
 REACT_APP_RINKEBY_PROVIDER=https://rinkeby.infura.io/v3/INFURA-PROJECT-ID
 REACT_APP_ETHERSCAN_ID=YOUR Etherscan API key token
 REACT_APP_MAINNET_RPC_ENDPOINT=https://eth-mainnet.alchemyapi.io/v2/ALCHEMY-ID
-REACT_APP_NETWORK=rinkeby
+REACT_APP_NETWORK=rinkeby