https://github.com/block-foundation/solidity-community-land-trust
Solidity Smart Contract: Community Land Trust (CLT)
https://github.com/block-foundation/solidity-community-land-trust
block-foundation blockchain blockfoundation clt community community-land-trust eth ethereum real-estate real-estate-management sol solidity
Last synced: 5 months ago
JSON representation
Solidity Smart Contract: Community Land Trust (CLT)
- Host: GitHub
- URL: https://github.com/block-foundation/solidity-community-land-trust
- Owner: block-foundation
- License: cc-by-sa-4.0
- Created: 2023-07-25T09:21:37.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-28T08:39:00.000Z (over 1 year ago)
- Last Synced: 2025-09-04T22:33:23.114Z (9 months ago)
- Topics: block-foundation, blockchain, blockfoundation, clt, community, community-land-trust, eth, ethereum, real-estate, real-estate-management, sol, solidity
- Language: Solidity
- Homepage: https://www.blockfoundation.io
- Size: 79.1 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- 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-community-land-trust/blob/main/LICENSE)
[](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/block-foundation/solidity-community-land-trust)
---
Community Land Trust
Block Foundation Smart Contract Series [Solidity]
---
### Contents
1. [Introduction](#introduction)
2. [Features](#features)
3. [Quick start](#quick-start)
4. [Setup and Installation](#setup-and-installation)
5. [Usage](#usage)
6. [Contribution](#contribution)
7. [License](#license)
7. [Colophon](#colophon)
---
[](https://github.com/block-foundation/solidity-community-land-trust/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected&projects=&template=bug_report.yml)
[](https://github.com/block-foundation/solidity-community-land-trust/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected&projects=&template=feature_request.yml)
[](https://github.com/block-foundation/solidity-community-land-trust/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected&projects=&template=question.yml)
[](https://github.com/block-foundation/solidity-community-land-trust/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected&projects=&template=suggestion.yml)
[](https://github.com/block-foundation/solidity-community-land-trust/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected&projects=&template=discussion.yml)
**The `CommunityLandTrust` smart contract facilitates the management and operations of land parcels within a decentralized land trust community. It allows users to buy and sell land parcels, transfer ownership, and provides an administrative interface for trustees and the contract owner.**
## Introduction
In this community land trust smart contract, we explore a sophisticated example of land management on the Ethereum blockchain. The CLT contract encapsulates multiple unique aspects of a trust, including land as unique parcels rather than indistinguishable units, trustees who have special privileges, dynamic pricing, and operations like land purchase, sale, and transfer among users.
The Community Land Trust contract models the sale and purchase of land as transactions on the Ethereum blockchain. Instead of treating land as indistinguishable units, the contract recognizes each land parcel as a unique entity, with an ID and an owner. This allows for more realistic representation and tracking of land ownership.
The contract recognizes the role of trustees in a land trust. Trustees have the power to change the price of land parcels. The owner of the contract, usually the trust, has the power to add or remove trustees. All these operations trigger events that provide transparency and traceability.
Users can buy available land parcels from the trust. When a land parcel is purchased, it is assigned to the buyer and can no longer be bought by others. Owners of land parcels have the flexibility to sell the parcels back to the trust or transfer ownership to other users. This allows for dynamic changes in the distribution of land ownership within the community land trust.
While this contract offers a robust and realistic representation of a community land trust, it serves as a starting point and should be customized according to the specific needs of the trust. As with any blockchain contract, it is critical to thoroughly test and audit the contract code before deploying it on the mainnet.
In summary, the Community Land Trust contract provides a sophisticated example of using Ethereum for managing real-world assets and transactions, demonstrating the immense potential of blockchain technology in revolutionizing how we handle and exchange value.
## Features
- **Purchase Land**: Users can purchase available land parcels by sending the specified Ether amount.
- **Sell Land**: Landowners can sell their parcels back to the trust.
- **Transfer Ownership**: Landowners can transfer their land parcels to another Ethereum address.
- **Admin Functions**: The contract owner and trustees have special permissions:
- Set the price of land parcels.
- Add or remove trustees.
- Withdraw contract balance.
### Functions
This contract includes:
- `LandParcel`: A struct that represents a unique land parcel with an ID and owner.
- `landParcels`: A mapping from a land parcel ID to the LandParcel struct.
- `landOwners`: A mapping from an address to an array of land parcel IDs owned by that address.
- `purchaseLand`: A function for buying land parcels from the trust.
- `sellLand`: A function for selling land parcels back to the trust.
- `transferLand`: A function for transferring ownership of a land parcel to another user.
- `getLandParcels`: A function that returns all land parcel IDs owned by a user.
## Quick Start
> Install
``` sh
npm i
```
> Compile
``` sh
npm run compile
```
## Setup and Installation
### Prerequisites
- [Node.js](https://nodejs.org/)
- [Truffle Framework](https://www.trufflesuite.com/)
- [MetaMask](https://metamask.io/) or similar Ethereum web3 provider
### Steps
1. Clone this repository:
```bash
git clone [Repository Link]
```
2. Change into the directory:
```bash
cd CommunityLandTrustContract
```
3. Install dependencies:
```bash
npm install
```
4. Compile the contract:
```bash
truffle compile
```
5. Deploy the contract to a local Ethereum network using Truffle:
```bash
truffle migrate --reset
```
Of course! Here's an expanded "Usage" section for the `README.md` detailing more function calls:
---
## Usage
1. **Buying Land**:
``` javascript
contractInstance.purchaseLand({value: etherAmount});
```
2. **Selling Land**:
``` javascript
contractInstance.sellLand(parcelId);
```
3. **Transferring Land**:
``` javascript
contractInstance.transferLand(parcelId, recipientAddress);
```
4. **Setting Land Price (Trustees only)**:
``` javascript
contractInstance.setLandPrice(newPrice);
```
5. **Fetching Land Parcels Owned by an Address**:
``` javascript
let parcelsOwned = await contractInstance.getLandParcels(ownerAddress);
console.log("Land Parcels:", parcelsOwned);
```
6. **Adding a Trustee (Owner only)**:
``` javascript
contractInstance.addTrustee(newTrusteeAddress);
```
7. **Removing a Trustee (Owner only)**:
``` javascript
contractInstance.removeTrustee(trusteeAddress);
```
8. **Withdrawing Contract Balance (Owner only)**:
``` javascript
contractInstance.withdraw();
```
9. **Fetching Land Details by Parcel ID**:
``` javascript
let landParcel = await contractInstance.landParcels(parcelId);
console.log("Land Owner:", landParcel.owner);
```
10. **Checking Trustee Status**:
``` javascript
let isTrustee = await contractInstance.trustees(addressToCheck);
console.log("Is Trustee:", isTrustee);
```
---
## 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
### 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) |
#### 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.**