Low Code Carbon Credit Implementation

.gitignore

@@ -27,4 +27,6 @@ yarn-error.log*
 target
 dist
 gallery/public
-.eslintcache
+.eslintcache
+
+*.tsbuildinfo

low-code-carbon-credits-marketplace/README.md

@@ -0,0 +1,47 @@
+# Concordium Carbon Credits Sample Implementation
+
+## Run
+
+1. Prerequisites
+   1. Install [Yarn](https://yarnpkg.com/)
+   2. Install [Docker](https://docs.docker.com/get-docker/)
+   3. Install [Docker Compose](https://docs.docker.com/compose/install/)
+   4. Install [Node.js](https://nodejs.org/en/download/)
+   5. Install [Concordium Client](https://developer.concordium.software/#/concordium-client)
+   6. Install [cargo-concordium](https://developer.concordium.software/en/mainnet/smart-contracts/guides/setup-tools.html)
+
+2. Build
+
+   ```bash
+   yarn && yarn build
+   ```
+
+3. Deploy Smart Contracts
+
+   ```bash
+   yarn deploy:contracts wallet-account
+   ```
+
+   **wallet-account** is the name of the account setup in the Concordium Client.
+
+4. Setup
+
+
+5. Run
+   1. Run [Events Listener Backend](./indexer/server/src/listener.ts)
+
+        ```bash
+        yarn debug:listener
+        ```
+
+   2. Run [Web Backend](./indexer/server/src/web.ts)
+
+        ```bash
+        yarn debug:web
+        ```
+
+   3. Run [Web Frontend](./market-ui/README.md)
+
+        ```bash
+        yarn start:ui
+        ```

low-code-carbon-credits-marketplace/contracts/.gitignore

@@ -0,0 +1 @@
+target

low-code-carbon-credits-marketplace/contracts/Cargo.toml

@@ -0,0 +1,24 @@
+[package]
+name = "carbon-credit-module"
+version = "0.1.0"
+authors = ["Stactrace Solutions <[email protected]>"]
+edition = "2021"
+license = "MPL-2.0"
+rust-version = "1.65.0"
+
+[features]
+default = ["std", "wee_alloc"]
+std = ["concordium-std/std", "concordium-cis2/std"]
+wee_alloc = ["concordium-std/wee_alloc"]
+
+[dependencies]
+concordium-std = { version="8.0.0", default-features = false }
+concordium-cis2 = { version="5.0.0", default-features = false }
+hex = "0.4.3"
+
+[lib]
+crate-type = ["cdylib", "rlib"]
+
+[profile.release]
+codegen-units = 1
+opt-level = "s"

low-code-carbon-credits-marketplace/contracts/README.md

@@ -0,0 +1,42 @@
+# Carbon Credits Market Reference Implementation
+
+## User Roles
+
+* Admin : Represents the governance of the system. The role is responsible for setting up the system and adding verifiers to the system.
+* Project Owner : Represents the owner of the Carbon Credit Project. Can mint / retract a carbon credit project or can fractionalize a carbon credit project into carbon credit tokens.
+* Verifier : Responsible for verification of a carbon credit project. Only Verified & Mature projects can be retired.
+* Buyer : Any Account which wants to buy a Carbon Credit / Carbon Credit Token from the marketplace contract.
+
+## Contracts
+
+### [`project_token`](./src/project_token/mod.rs)
+
+ CIS2 Token contract implementation for Carbon Credits Projects. In Addition to CIS2 spec functionality it has the following functionality
+
+* [`is_verified`](./src/project_token/is_verified.rs) : Can be called to check if the token is verified or not.
+* [`is_verifier`](./src/carbon_credits/is_verifier.rs) : Can be called to check if an account address is a verifier.
+* [`verifier_operations`](./src/project_token/verifier_operations.rs)
+  * `add_verifier` : Used by the contract owner to add a carbon credit verifier
+  * `remove_verifier`: Used by contract owner to remove a verifier.
+  * `verify`: Used by a verifier to mark a project token as verified.
+* [`retire`](./src/project_token/retire.rs) : Can be used by the project owner to retire a carbon credit project
+* [`retract`](./src/project_token/retract.rs) : Non Mature projects can be retracted by the verifier Or the project owner.
+
+### [`carbon_credits`](./src/carbon_credits/mod.rs)
+
+CIS2 Token contract implementation for Carbon Credits. In Addition to CIS2 specs functionality provides the following functionality.
+
+Carbon Credit Projects can be sent to this contract fo fractionalization into carbon credits. The sent project is reffered to as `collateral` in the contract's code.
+
+* [`is_verified`](./src/carbon_credits/is_verified.rs) : Can be used to check if the carbon credit is verified or not
+* [`is_verifier`](./src/carbon_credits/is_verifier.rs) : Can be called to check if an account address if a verifier.
+* [`retire`](./src/project_token/retire.rs) : Can be used by the project owner to retire a carbon credit
+* [`retract`](./src/project_token/retract.rs) : Non Mature tokens can be retracted by the verifier Or the project owner.
+
+### [`carbon_credits_market`](./src/carbon_credit_market/mod.rs)
+
+Reference marketplace implementation for Carbon Projects & Carbon Credits.
+Carbon Credit Project Or Carbon Credits can be sent to this contract to list them for a price which any one can pay and claim ownership of a carbon project / credit. The contract has the following functionality.
+
+* [`list`](./src/carbon_credit_market/list.rs) : Can be used to list a carbon project / credit on the marketplace for a price.
+* [`transfer`](./src/carbon_credit_market/transfer.rs) : Can be called with a specified amount to transfer a carbon project / credit to the payer.

low-code-carbon-credits-marketplace/contracts/package.json

@@ -0,0 +1,11 @@
+{
+  "name": "contracts",
+  "version": "1.0.0",
+  "author": "[email protected]",
+  "license": "MIT",
+  "private": true,
+  "scripts": {
+    "build": "cargo concordium build --out=module.wasm --schema-base64-out=schema_base64.txt",
+    "deploy": "concordium-client --grpc-ip node.testnet.concordium.com module deploy ./module.wasm --no-confirm --sender"
+  }
+}