Merge pull request #2 from change-code-io/dev

First draft on contribution guide, CC minting flow, and IOU/hypercert schemas

Author: c-georgen

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,29 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. ...
+2. ...
+3. ...
+4. ...
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Device:**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem encountered.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,23 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**List who else might be interested in this feature**
+Tell us who else might benefit from this change.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.gitignore

@@ -0,0 +1 @@
+node_modules/

change-credits/cc-minting.md

@@ -0,0 +1,61 @@
+---
+label: Minting Change Credits
+order: -2
+---
+
+Because Change Credits are only minted following confirmation of realized, tangible, and verifiable impact, there the process by which these assets are created follows a number of steps and involves multiple types of actors.
+
+### Participants
+
+Good Generator
+:   A Good Generator is the implementing organization responsible for seeing the planned impact results achieved. It is through the actions of this entity, often an NGO or social enterprise, that positive externalities are produced. Because contributions and funds can be seamlessly fractionalized and divided, a Good Generator can also be a collection of multiple contributors working collaboratively.
+
+Change Code
+:   Change Code acts to provide all necessary infrastructure for the creation and management of Change Credits through its *Changescape*. While Change Code is not involved in the measurement or verification of any results produced, it is responsible for assessing the legitimacy and compliance of any organizations seeking to mint Change Credits.
+
+Partner
+:   Partners financially contribute to the positive externalities embodied in Change Credits. They fund the delivery of impact by pre-purchasing Change Credits in advance.
+
+Verifier
+:   Verifiers exist to both validate, measure, and quantify any impact produced. Verifiers are defined by the Good Generator of the project with a focus on local context and relevant expertise. Verification can be conducted by a single individual or organization or the responsibility can be dispersed through a set of Verifiers with a specified quorum required.
+
+### Minting Flow
+
+```mermaid
+sequenceDiagram
+    actor Verifier
+    actor Good Generator
+    actor Change Code
+    Good Generator-->Change Code: propose impact goal for review
+    create participant hypercert (ERC1155)
+    Good Generator->>hypercert (ERC1155): mint impact goal
+    actor Change Code
+    create participant Token Bound Account (ERC6551)
+    Change Code->>Token Bound Account (ERC6551): deploy treasury account
+    actor partner
+    loop
+        partner->>Token Bound Account (ERC6551): send $
+        Token Bound Account (ERC6551)->>partner: mint IOUs (ERC20)
+        Token Bound Account (ERC6551)->>Good Generator: remit funding received
+    end
+    loop
+        Good Generator-->Good Generator: implement project
+        Good Generator->>hypercert (ERC1155): submit evidence
+        Verifier--xhypercert (ERC1155): review evidence
+        Change Code--xhypercert (ERC1155): assign token quantity
+        Change Code->>Token Bound Account (ERC6551): mint Change Credits (ERC721)
+    end
+    Loop
+        partner->>Token Bound Account (ERC6551): return IOUs
+        Token Bound Account (ERC6551)->>partner: receive Change Credits
+    end
+```
+
+The above sequence diagram overviews how Change Credits are created. While the system supports alternative flows to facilitate various forms of financing, we can consider this base form to have x steps.
+
+1. The Good Generator submits an impact goal and plan for review by Change Code, as part of their onboarding process. Once approved to mint via the Changescape, the Good Generator mints their hypercert, signalling the beginning for their project.
+2. After the projects' hypercert has been deployed, Change Code deploys an associated Token Bound Account (TBA) to act as a treasury for the project to receive funds into and mint tokens from.
+3. Partners begin contributing funds into the project's TBA in exchange for IOUs redeemable for Change Credits once the latter begin to be minted. These funds are then remitted to an account from which the Good Generator can spend to cover the costs of their work. This process can be done in an open-ended asynchronous manner, with funds being contributed to the project through the project's lifespan.
+4. As the Good Generator carries out their work to produce impact, they periodically submit evidence for review. This evidence is stored as records tied to their original hypercert and can be accessed by specified Verifiers.
+5. Once evidence is confirmed by Verifiers, Change Code intakes the data provided to assign a quantity of Change Credits to be created and mints them via the project's TBA.
+6. With Change Credits minted and available via the TBA, the project's Partners can redeem their IOUs and receive their proportional share of Change Credits.

change-credits/foundations.md

@@ -0,0 +1,38 @@
+---
+label: Foundations
+order: -1
+---
+
+Change Credits are a novel *financial* primitive supporting resource allocation, verification, and tracking of positive externalities (social and environmental impact).
+
+They are the basis and grounding of Change Code's economic engine, providing a real-world tangible link to underpin a new form of beneficial currency.
+
+## Supporting Primitives and Infrastructure
+
+Before expanding on the architecture and processes involved in Change Credits directly, we should first recap (or introduce) some of the existing open-source tools and standards leveraged here.
+
+### Hypercerts
+
+Hypercerts are on-chain, tokenized claims of positive impact. To be more precise, hypercerts represent *claims* of *work* done toward some beneficial outcome, be that work toward social or environmental impact or the building of a public good.
+
+A complete list of the on-chain token data and off-chain metadata included in a hypercert can be found in the [documentation](https://hypercerts.org/docs/implementation/metadata). Importantly for our purposes and designs, there is no included support for verification that the work was completed or efficacious. This will therefore be addressed using another foundation public good, the Ethereum Attestation Service (EAS). However, the hypercerts specification does include a field for a list of contributors. Change Credits takes advantage of this encoding to record contributions of the actual work being done, while tracking *financial partners* through ownership of Change Credits themselves.
+
+### Ethereum Attestation Service (EAS)
+
+Change Code leverages the EAS to allow experts and representatives of affected communities to verify (attest to) any work done that is claimed to be impactful or contribute to a public good.
+
+While not tokens themselves (more on that [here](https://docs.attest.org/docs/core--concepts/attestations-vs-x)), these attestations are cryptographically secured and can be used by project partners and the public to confirm all verifications of a project's work.
+
+### Token Standards
+
+To maintain maximum compatibility across existing wallets and infrastructure, the Change Credits architecture leverages only broadly accepted ERC token standards. Change Credits themselves are minted as NFTs (non-fungible tokens) through the ERC721 standard.
+
++++ ERC721
+ERC721 is the most widely adopted token standard for NFTs. The standard is well tested, and enjoys near universal support across wallet implementations.
++++ ERC1155
+Hypercerts adhere to the ERC1155 standard for semi-fungible tokens. This mixed standard, existing in the divide between fungible and non-fungible tokens, offers ideal flexibility for the unique requirements of the hypercerts standard.
++++ ERC20
+ERC20 tokens are fully fungible and well suited for liquidity and open exchange. IOUs issued in anticipation of Change Credits are minted as ERC20 tokens to support the emergence of free exchange by holders who may wish to access liquidity.
++++ ERC6551
+Referred to as "token bound accounts" (TBAs), ERC6551 tokens function as a form of smart contract wallet where an account is simultaneously able hold or mint tokens itself and be considered a token (an NFT more specifically) in its own right. Change Code leverages TBAs to serve as *treasury accounts* for the receipt of funds into projects and the minting of Change Credits.
++++

change-credits/index.yml

@@ -0,0 +1,4 @@
+icon: container
+expanded: true
+order: -3
+label: Change Credits

contributing/community-conduct.md

@@ -0,0 +1,52 @@
+---
+label: Community Code of Conduct
+order: -1
+---
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people;
+* Being respectful of differing opinions, viewpoints, and experiences;
+* Giving and gracefully accepting constructive feedback;
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience;
+* Focusing on what is best not just for us as individuals, but for the overall community;
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of any kind;
+* Trolling, insulting or derogatory comments, and personal or political attacks;
+* Public or private harassment;
+* Publishing others' private information, such as a physical or email address, or revealing any pseudonymous identity without their explicit permission;
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Enforcement Responsibilities
+
+Change Code's leadership is responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Change Code has the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+Enforcement of this code will sometimes be a challenging exercise in judgement and conflicting values. We recognize that members may not always agree with a given course of action or remedy, but Change Code commits to always being transparent in how decisions have been made.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces.
+
+Examples of representing our community include using an official email address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to Change Code's leadership at [[email protected]](mailto:[email protected]). All complaints will be reviewed and investigated promptly and fairly.
+
+Change Code is committed to respecting the privacy and security of the reporter of any incident.
+
+## Attribution
+
+This Code of Conduct is modified from the Contributor Covenant, version 2.1, available [here](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html).

contributing/contribution-guide.md

@@ -0,0 +1,31 @@
+---
+label: Contribution Guide
+order: -2
+---
+
+## Community Conduct
+
+We are all people, all community members first, and developers second. All developers and other contributors agree to uphold Change Code's rules of [Community Conduct](./community-conduct.md).
+
+## Contributing
+
+Change Code strives to work in public and release code as open source whenever possible. If you would like to contribute to any of our repositories just follow the steps below.
+
+1. Fork the repository.
+2. Create a new branch (`git checkout -b feature-branch-name`).
+3. Make your changes
+4. Commit any changes you've made (`git commit -am 'commit description'`).
+5. Push the code to your forked origin (`git push origin feature-branch-name`)
+6. Navigate back to the Change Code repository you forked from and create a new pull request.
+
+When making a pull request, do your best to describe the changes made and your motivations for doing so. While we're excited for your to participate alongside us, please understand that certain changes may not align with the our current roadmap or requirements. If we're unable to incorporate your work, we'll always do our best to explain why.
+
+To join our discussions, you can find us over on [Console](https://app.console.xyz/c/changecode). We always welcome new voices!
+
+## Issue Reporting
+
+If you have a feature request or encounter a bug in any of our work, we invite you to report it with a Github issue in the relevant repository. We've provided pre-templates to help improve reporting.
+
+## Commitment to Open Source Code
+
+Change Code is committed to open source code. The majority of our work is released under the [Mozilla Public License 2.0 (MPL2)](https://www.mozilla.org/en-US/MPL/2.0/).

contributing/index.yml

@@ -0,0 +1,4 @@
+icon: code-of-conduct
+expanded: true
+order: -6
+label: Community Conduct and Contributor Guide

data-schemas/hypercerts.md

@@ -0,0 +1,81 @@
+---
+label: Hypercerts
+order: -1
+---
+
+Change Code leverages the Hypercerts protocol, in turn developed from the ERC1155 token standard for semi-fungible tokens. While adhering to the requirements of the standard, Change Code modifies *how* some of the schema fields are used, adapting them to our theory of change and implementation needs.
+
+## ERC1155 Fields
+
+Name | `CC Hypercert | {Good Generator} {Index}`
+:   The Hypercert name mirrors the name used for a project's IOUs. The concept of an index is again used to support single organizations working across multiple initiatives.   
+
+Description
+:   A description, not exceeding 200 characters, of the work to be done by the project.
+
+Image
+:   While the image field is required by the Hypercerts standard, we do not believe a single immutable image to be valuable for the purposes of serious impact validation. To satisfy this requirement, the Changescape backend will automatically generate and provide an image to satisfy the requirement.
+
+## Hypercert Dimensions
+
+work_scope
+:   A list of tasks to be done by the project. In development parlance this is a list of *outputs*--e.g. # of solar panels installed, kilos of supplies, $ of direct aid, # of vaccines.
+
+work_timeframe
+:   The time period during which the work for the project is to be carried out. In line with the Hypercerts standard, this is represented as an ordered pair of UTC timestamps.
+
+impact_scope
+:   Inside the Changescape `impact scope` is used to refer thematically to projects by category. For example, the [UN Sustainable Development Goals (SDGs)](https://sdgs.un.org/goals) or the [Ecological Benefits Framework (EBF)](https://ebfcommons.org/lex-icons/). Because the Hypercerts data is only aspirational, it would be premature to immutably publish indicators, which are instead reserved to be published only once verified inside Change Credits.
+
+impact_timeframe
+:   The time period during which impact *outcomes* will be measured and calculated. For Hypercerts inside the Changescape, the start time is set equal to the start time for the `work_timeframe` while the end time is set for the end of the work period plus five (5) years. Again this data is represented as an ordered pair of UTC timestamps.
+
+contributors
+:   A list of participants (organizations) that are contributing to the work done in the project. Each element in the list is composed of an on-chain address, a name, and a weight. The purpose of the weight is to signal relative contribution and may optionally be used to weight distributions among contributors.
+
+rights
+:   As of version 1.0 of the Hypercerts standard, this value can only be set to *public display*. As it is a required field, Change Code simply applies the default value but does not otherwise use this information.
+
+hidden_properties
+:   In development
+
+## Example Hypercert Dimensions
+
+```
+"hypercert": {
+    "work_scope": {
+        "name": "Work Scope",
+        "value": ["sustainable land management"],
+        "excludes": [],
+        "display_value": "sustainable land management"
+    },
+    "impact_scope": {
+        "name": "Impact Scope",
+        "value": [SDG 13], [SDG 15]
+        "excludes": [],
+        "display_value": "SDG 13 - Climate Action", "SDG 15 - Life on Land"
+    },    
+    "work_timeframe": {
+        "name": "Work Timeframe",
+        "value": [1704096000, 1735711200],
+        "display_value": "2024-01-01 -> 2024-12-31"
+    },
+    "impact_timeframe": {
+        "name": "Impact Timeframe",
+        "value": [1704096000, 1893477600],
+        "display_value": "2024-01-01 -> 2030-12-31"
+    },
+    "contributors": {
+        "name": "Contributors",
+        "value": ["0xa1fa1fa000000000000000000000000000000000", "Project Developer", 0.9], ["0xa1fa1fa000000000000000000000000000000000", "Carbon Standards Body", 0.1]
+        "display_value": "Project Developer", "Carbon Standards Body"
+    },
+    "rights": {
+        "name": "Rights",
+        "value": ["Public Display"],
+        "display_value": "Public Display"
+    }
+}
+```
+
+Additional details on the Hypercerts implementation itself can be found in the documentation [here](https://hypercerts.org/docs/implementation/metadata).

data-schemas/index.yml

@@ -0,0 +1,4 @@
+icon: ruby
+expanded: true
+order: -5
+label: Token Implementations and Data Schemas