Skip to content

Instantly share code, notes, and snippets.

@ltfschoen

ltfschoen/colony.md

Created July 30, 2019 10:09
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save ltfschoen/5cb83e67a3bdf7212710c8a695fef547 to your computer and use it in GitHub Desktop.
Save ltfschoen/5cb83e67a3bdf7212710c8a695fef547 to your computer and use it in GitHub Desktop.
Download ZIP
colony.md
Raw
colony.md
  • Colony
    • About
      • Colony Network is an open source Ethereum-based protocol providing a general purpose framework to create, operate, and monetize digital companies (internet-native version of traditional organisations) by providing essential functions including: ownership, structure, authority, and human and financial management.
      • Colony infrastructure uses an upgrade pattern that is backward compatible
      • Tools to organise and incentivise a team, community or contributors. Coordinate work, manage budgets, and make decisions from users (collectively from members) according to their ability and reputation-weighted token holdings.
      • Codified structures of reputation, domains, permissions, and incentives, to coordinate working relationships within the permissionless digital companies that use smart contracts and blockchains.
    • Use Cases
      • DAOs
        • Startup wanting to meritocratically split ownership between founders
        • Musician wanting to harness passion of your fanbase
        • Community wanting to trustlessly manage the risk or reward of theft
        • Ethereum project wanting binding on-chain governance to be provided to its token holders
        • Incentivise freelance marketers to grow sales with a share of revenue
        • Strangers to collectively execute on an open-source project
    • Usage
      • Docs (Developer)
        • Go to https://docs.colony.io/colonynetwork/docs-overview
        • Click "Login" to Colony developer account
        • Connect with GitHub and MetaMask (to community Colony network on Goerli or Mainnet)
        • View Colonies and statistics (using developer dashboard that integrates wih the developer's colony and its internal token of appreciation CDEV).
        • Check token balances
        • Watch colonies
        • Create new colony, import or create your colony's internal token, create tasks and payments, organise the structures into single-level domains
      • Code
        • Connect to colonyNetwork on the Goerli using a development framework like Truffle or Remix
          • ColonyNetwork address: 0x79073fc2117dD054FCEdaCad1E7018C9CbE3ec0B
          • ColonyNetwork commit: 41b2e0b429c03d1011e1a96506dcbfe504391f2d
          • ColonyToken commit: 59cf56f18c54c0bc749ddaa8b6d77ebfd0d0aaf4
        • Compile and instantiate interfaces:
          • IColonyNetwork.sol
          • IColony.sol
          • token contract
          • dependencies
        • Dappy development
    • Contributing
      • View "Help Wanted" issues in the Colony GitHub repos via https://docs.colony.io/contribute/
      • Contribute to Colony repos using the linked developer account to earn CDEV (tokens will mean a stake in Colony's future decisions)
    • Bug Bounty
      • Ethereum Mainnet issues - report bugs to security@colony.io
      • "develop" branch issues - report with Github issue
    • Releases
      • Glider (1st release) - https://github.com/JoinColony/colonyNetwork/releases/tag/glider
        • Ethereum Mainnet address - https://etherscan.io/address/0x5346d0f80e2816fad329f2c140c870ffc3c3e2ef
        • Ethereum Goerli address - ???
        • Features implemented (initial steps toward fulfilling the Colony Protocol in the Whitepaper)
          • Reputation (using your own custom ERC20 token)
            • Exponential decay
            • Decentralised mining client
            • Passive reputation (records contributions and proportionality distributes rewards)
          • Meta Colony (and CLNY token)
          • Contract Upgradability & Recovery
          • ENS Integration
          • Extensions
          • Domains / Colonies
            • Management of multiple tokens (funding pots)
            • Reputation score for each specific domain and skill
            • Limitations - Domains are restricted to a "single-level" within the root domain (not nested levels)
          • Roles & Permissions (modular)
            • Control (granular) over ability to interact on the "domain-level" with Colony
            • Roles and modular permissions are used (rather than reputation) to control who has authority in different domains
          • Payments & Tasks
            • Transfer (secure) of funds or reputation to compensate for work tasks that have been undertaken for the colony
            • Limitations
              • Tasks are in a "trusty" state since there is work dispute resolution system to handle disputes that occur on-chain.
              • Payments are "trustful" tasks (without work ratings or reputation bonuses)
          • Funding
          • Rewards
            • Distribute periodically a set amount of a colony's revenue to its contributors (proportional to their reputation-weighed contributions to the colony)
        • Trusted (in the interim) parts of the Glider release since not yet under full decentralised/distributed control
    • Key Links
    • References
    • TODO
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment