https://github.com/block-foundation/solidity-material-passport
Solidity Smart Contract: Material Passport
https://github.com/block-foundation/solidity-material-passport
architecture block-foundation blockchain blockfoundation construction design eth ethereum material-passport materials smart-contracts sol solidity
Last synced: 5 months ago
JSON representation
Solidity Smart Contract: Material Passport
- Host: GitHub
- URL: https://github.com/block-foundation/solidity-material-passport
- Owner: block-foundation
- License: cc-by-sa-4.0
- Created: 2023-07-25T10:05:43.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-28T08:24:52.000Z (over 1 year ago)
- Last Synced: 2025-09-04T21:10:34.838Z (9 months ago)
- Topics: architecture, block-foundation, blockchain, blockfoundation, construction, design, eth, ethereum, material-passport, materials, smart-contracts, sol, solidity
- Language: Solidity
- Homepage: https://www.blockfoundation.io
- Size: 84 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Codeowners: .github/CODEOWNERS
- Security: .github/SECURITY.md
- Support: .github/SUPPORT.md
- Governance: .github/GOVERNANCE.md
- Authors: AUTHORS
Awesome Lists containing this project
README
[](https://github.com/block-foundation/solidity-material-passport/blob/main/LICENSE)
[](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/block-foundation/solidity-material-passport)
---
Materials Passport
Block Foundation Smart Contract Series [Solidity]
---
### Contents
- [Introduction](#introduction)
- [Colophon](#colophon)
---
[](https://github.com/block-foundation/solidity-material-passport/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected&projects=&template=bug_report.yml)
[](https://github.com/block-foundation/solidity-material-passport/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected&projects=&template=feature_request.yml)
[](https://github.com/block-foundation/solidity-material-passport/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected&projects=&template=question.yml)
[](https://github.com/block-foundation/solidity-material-passport/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected&projects=&template=suggestion.yml)
[](https://github.com/block-foundation/solidity-material-passport/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected&projects=&template=discussion.yml)
**Welcome to the Sustainable Materials Passport Project, a pioneering initiative leveraging blockchain technology to promote and streamline sustainable material management practices. Our innovative project is centered around creating a decentralized and transparent system to track the lifecycle of materials, from their origin, through their use, and ultimately to their recycling or disposal.**
## Introduction
The Sustainable Materials Passport Project presents a forward-thinking solution for numerous stakeholders, including manufacturers, consumers, recyclers, and environmental advocates. Our goal is to enhance accountability, ensure ethical sourcing, and encourage recycling through our material tracking system.
At the core of our project, we utilize Solidity smart contracts to manage and maintain the Material Passport. Each passport contains detailed information about a material, including its origin, manufacturer, recyclability, type, and lifecycle stages.
The robust functionality of our system provides capabilities such as registering a new material, transferring ownership of a material, updating the lifecycle of a material, recycling a material, and even a reward system to incentivize recycling.
The Sustainable Materials Passport Project marks a significant step towards bridging the gap between blockchain technology and sustainable resource management. Through this initiative, we aim to foster a culture of sustainability and circular economy, making the world a better place for future generations.
## Features
- **Transparency**: Each material is registered on the blockchain, ensuring its history and properties are accessible and immutable.
- **Lifecycle Management**: Track and update the lifecycle of each material.
- **Recycling Incentives**: A reward system to incentivize recycling of materials.
- **Ownership Management**: Transfer ownership of materials and maintain a clear record of each transaction.
## Getting Started
To get started with the Sustainable Materials Passport Project:
1. Clone the repository:
``` sh
git clone https://github.com/your_username/SustainableMaterialsPassport.git
```
2. Navigate into the project directory:
``` sh
cd SustainableMaterialsPassport
```
## Dependencies
- **Solidity**: ^0.8.4
- **Truffle**: Latest version
- **Ganache**: For a personal blockchain for Ethereum development that runs on your desktop.
## Usage
1. Install dependencies:
``` sh
npm install
```
2. Start Ganache and make sure it's running.
3. Compile and migrate the contracts:
``` sh
truffle compile
truffle migrate
```
4. Start the local development server:
``` sh
npm start
```
## Quick Start
> Install
``` sh
npm i
```
> Compile
``` sh
npm run compile
```
## Contract
## Development Resources
### Other Repositories
#### Block Foundation Smart Contract Series
| | `Solidity` | `Teal` |
| --------------------------------- | ----------- | ----------- |
| **Template** | [**>>>**](https://github.com/block-foundation/solidity-template) | [**>>>**](https://github.com/block-foundation/teal-template) |
| **Architectural Design** | [**>>>**](https://github.com/block-foundation/solidity-architectural-design) | [**>>>**](https://github.com/block-foundation/teal-architectural-design) |
| **Architecture Competition** | [**>>>**](https://github.com/block-foundation/solidity-architecture-competition) | [**>>>**](https://github.com/block-foundation/teal-architecture-competition) |
| **Housing Cooporative** | [**>>>**](https://github.com/block-foundation/solidity-housing-cooperative) | [**>>>**](https://github.com/block-foundation/teal-housing-cooperative) |
| **Land Registry** | [**>>>**](https://github.com/block-foundation/solidity-land-registry) | [**>>>**](https://github.com/block-foundation/teal-land-registry) |
| **Real-Estate Crowdfunding** | [**>>>**](https://github.com/block-foundation/solidity-real-estate-crowdfunding) | [**>>>**](https://github.com/block-foundation/teal-real-estate-crowdfunding) |
| **Rent-to-Own** | [**>>>**](https://github.com/block-foundation/solidity-rent-to-own) | [**>>>**](https://github.com/block-foundation/teal-rent-to-own) |
| **Self-Owning Building** | [**>>>**](https://github.com/block-foundation/solidity-self-owning-building) | [**>>>**](https://github.com/block-foundation/teal-self-owning-building) |
| **Smart Home** | [**>>>**](https://github.com/block-foundation/solidity-smart-home) | [**>>>**](https://github.com/block-foundation/teal-smart-home) |
---
## Colophon
### Authors
This is an open-source project by the **[Block Foundation](https://www.blockfoundation.io "Block Foundation website")**.
The Block Foundation mission is enabling architects to take back initiative and contribute in solving the mismatch in housing through blockchain technology. Therefore the Block Foundation seeks to unschackle the traditional constraints and construct middle ground between rent and the rigidity of traditional mortgages.
website: [www.blockfoundation.io](https://www.blockfoundation.io "Block Foundation website")
### Development Resources
#### Contributing
We'd love for you to contribute and to make this project even better than it is today!
Please refer to the [contribution guidelines](.github/CONTRIBUTING.md) for information.
### Legal Information
#### Copyright
Copyright © 2023 [Stichting Block Foundation](https://www.blockfoundation.io/ "Block Foundation website"). All Rights Reserved.
#### License
Except as otherwise noted, the content in this repository is licensed under the
[Creative Commons Attribution 4.0 International (CC BY 4.0) License](https://creativecommons.org/licenses/by/4.0/), and
code samples are licensed under the [Apache 2.0 License](http://www.apache.org/licenses/LICENSE-2.0).
Also see [LICENSE](https://github.com/block-foundation/community/blob/master/src/LICENSE) and [LICENSE-CODE](https://github.com/block-foundation/community/blob/master/src/LICENSE-CODE).
#### Disclaimer
**THIS SOFTWARE IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.**