{"id":38151981,"url":"https://github.com/block-foundation/solidity-private-city","last_synced_at":"2026-01-16T23:02:33.440Z","repository":{"id":184728342,"uuid":"670540699","full_name":"block-foundation/solidity-private-city","owner":"block-foundation","description":"Solidity Smart Contract: Private City","archived":false,"fork":false,"pushed_at":"2024-11-11T08:22:31.000Z","size":92,"stargazers_count":0,"open_issues_count":5,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2026-01-11T10:25:57.502Z","etag":null,"topics":["architecture","block-foundation","blockchain","blockfoundation","city","eth","ethereum","governance","hardhat","private-city","smart-contracts","sol","solidity","urban-planning","urbanism"],"latest_commit_sha":null,"homepage":"https://www.blockfoundation.io","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc-by-sa-4.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/block-foundation.png","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","threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":".github/CODEOWNERS","security":".github/SECURITY.md","support":".github/SUPPORT.md","governance":".github/GOVERNANCE.md","roadmap":null,"authors":"AUTHORS","dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":"block-foundation","open_collective":"block"}},"created_at":"2023-07-25T09:27:39.000Z","updated_at":"2024-08-28T19:34:36.000Z","dependencies_parsed_at":null,"dependency_job_id":"a0ce0058-1adf-46fc-8832-815c9c9c8e6d","html_url":"https://github.com/block-foundation/solidity-private-city","commit_stats":{"total_commits":81,"total_committers":1,"mean_commits":81.0,"dds":0.0,"last_synced_commit":"47e837e4336133729500693ca89979cd2c974b0e"},"previous_names":["block-foundation/solidity-private-city"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/block-foundation/solidity-private-city","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/block-foundation%2Fsolidity-private-city","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/block-foundation%2Fsolidity-private-city/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/block-foundation%2Fsolidity-private-city/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/block-foundation%2Fsolidity-private-city/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/block-foundation","download_url":"https://codeload.github.com/block-foundation/solidity-private-city/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/block-foundation%2Fsolidity-private-city/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28487098,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-16T22:54:02.790Z","status":"ssl_error","status_checked_at":"2026-01-16T22:50:10.344Z","response_time":107,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["architecture","block-foundation","blockchain","blockfoundation","city","eth","ethereum","governance","hardhat","private-city","smart-contracts","sol","solidity","urban-planning","urbanism"],"created_at":"2026-01-16T23:02:32.089Z","updated_at":"2026-01-16T23:02:33.377Z","avatar_url":"https://github.com/block-foundation.png","language":"TypeScript","funding_links":["https://github.com/sponsors/block-foundation","https://opencollective.com/block"],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"right\"\u003e\n\n[![GitHub License](https://img.shields.io/github/license/block-foundation/blocktxt?style=flat-square\u0026logo=readthedocs\u0026logoColor=FFFFFF\u0026label=\u0026labelColor=%23041B26\u0026color=%23041B26\u0026link=LICENSE)](https://github.com/block-foundation/solidity-private-city/blob/main/LICENSE)\n[![devContainer](https://img.shields.io/badge/Container-Remote?style=flat-square\u0026logo=visualstudiocode\u0026logoColor=%23FFFFFF\u0026label=Remote\u0026labelColor=%23041B26\u0026color=%23041B26)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/block-foundation/solidity-private-city)\n\n\u003c/div\u003e\n\n---\n\n\u003cdiv\u003e\n    \u003cimg align=\"right\" src=\"https://raw.githubusercontent.com/block-foundation/brand/master/src/logo/logo_gray.png\" width=\"96\" alt=\"Block Foundation Logo\"\u003e\n    \u003ch1 align=\"left\"\u003ePrivate City\u003c/h1\u003e\n    \u003ch3 align=\"left\"\u003eBlock Foundation Smart Contract Series [Solidity]\u003c/h3\u003e\n\u003c/div\u003e\n\n---\n\n\u003cimg align=\"right\" width=\"75%\" src=\"https://raw.githubusercontent.com/block-foundation/brand/master/src/image/repository_cover/block_foundation-structure-03-accent.jpg\"  alt=\"Block Foundation Brand\"\u003e\n\n### Contents\n\n- [Introduction](#introduction)\n- [Colophon](#colophon)\n\n\u003cbr clear=\"both\"/\u003e\n\n---\n\n\u003cdiv align=\"right\"\u003e\n\n[![Report a Bug](https://img.shields.io/badge/Report%20a%20Bug-GitHub?style=flat-square\u0026\u0026logoColor=%23FFFFFF\u0026color=%23E1E4E5)](https://github.com/block-foundation/solidity-private-city/issues/new?assignees=\u0026labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected\u0026projects=\u0026template=bug_report.yml)\n[![Request a Feature](https://img.shields.io/badge/Request%20a%20Feature-GitHub?style=flat-square\u0026\u0026logoColor=%23FFFFFF\u0026color=%23E1E4E5)](https://github.com/block-foundation/solidity-private-city/issues/new?assignees=\u0026labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected\u0026projects=\u0026template=feature_request.yml)\n[![Ask a Question](https://img.shields.io/badge/Ask%20a%20Question-GitHub?style=flat-square\u0026\u0026logoColor=%23FFFFFF\u0026color=%23E1E4E5)](https://github.com/block-foundation/solidity-private-city/issues/new?assignees=\u0026labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected\u0026projects=\u0026template=question.yml)\n[![Make a Suggestion](https://img.shields.io/badge/Make%20a%20Suggestion-GitHub?style=flat-square\u0026\u0026logoColor=%23FFFFFF\u0026color=%23E1E4E5)](https://github.com/block-foundation/solidity-private-city/issues/new?assignees=\u0026labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected\u0026projects=\u0026template=suggestion.yml)\n[![Start a Discussion](https://img.shields.io/badge/Start%20a%20Discussion-GitHub?style=flat-square\u0026\u0026logoColor=%23FFFFFF\u0026color=%23E1E4E5)](https://github.com/block-foundation/solidity-private-city/issues/new?assignees=\u0026labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected\u0026projects=\u0026template=discussion.yml)\n\n\u003c/div\u003e\n\n**Private City: A Blockchain-Based City Governance System**\nThis repository contains the smart contract code, test cases, and deployment scripts for a decentralized application representing a private city management system on the Ethereum blockchain.\n\n## Introduction\n\nWelcome to Private City, a cutting-edge city governance system powered by Ethereum Blockchain technology. In an era where transparency, efficiency, and decentralization are increasingly becoming important, we are harnessing the power of Blockchain to redefine city governance.\n\nPrivateCity is a first-of-its-kind initiative aimed at simulating the operations of a private city using a Solidity smart contract. At its core, it leverages the transparent and immutable nature of blockchain technology to record, track, and manage various aspects of city governance such as citizenship, property ownership, tax payments, and city treasury management.\n\nThe project's smart contract includes a variety of features that mirror real-life city operations:\n\n- Citizenship Management: A system to add or remove citizens, where each citizen has a unique identity, and associated properties.\n- Property Management: A system that records and tracks property ownership, allowing properties to be added, removed, or transferred between citizens.\n- City Treasury: A city treasury to accumulate tax payments, which are calculated based on property ownership.\n- Decentralized Finance: A basic decentralized finance system where citizens can deposit and withdraw Ether, and pay taxes based on their property holdings.\n\nThe overarching goal of PrivateCity is to explore how blockchain technology can be utilized to create efficient, transparent, and secure systems for city governance. The project aims to stimulate conversations about the potential of blockchain technology in managing not just digital assets, but also tangible assets in real-world environments.\n\n## Overview\n\n`PrivateCity` is a Solidity-based smart contract system that allows:\n\n1. **Citizenship management:** Add or remove citizens.\n2. **Property management:** Add, remove, or transfer properties.\n3. **Financial system:** Citizens can deposit and withdraw Ether, and pay property taxes.\n\n## Installation\n\n### Prerequisites\n\nMake sure you have `node` and `npm` installed. You also need to have Ethereum wallet software, like [Metamask](https://metamask.io/), set up.\n\n### Steps\n\n1. Clone the repository:\n\n```bash\ngit clone [repository_url] privatecity\ncd privatecity\n```\n\n2. Install dependencies:\n\n```bash\nnpm install\n```\n\n3. Compile the contracts:\n\n```bash\nnpx hardhat compile\n```\n\n## Usage\n\n### Local Development\n\nStart a local Ethereum development network:\n\n```bash\nnpx hardhat node\n```\n\nThis will start a local Ethereum network for development purposes.\n\n## Testing\n\nRun the tests with:\n\n```bash\nnpx hardhat test\n```\n\nThis command will execute the TypeScript test cases using the Hardhat testing environment.\n\n## Deployment\n\nTo deploy the contract on your local Ethereum network:\n\n```bash\nnpx hardhat run scripts/deploy.ts --network localhost\n```\n\nReplace `localhost` with another network configuration in `hardhat.config.ts` if you want to deploy to a different network.\\\n\n## Quick Start\n\n\u003e Install\n\n``` sh\nnpm i\n```\n\n\u003e Compile\n\n``` sh\nnpm run compile\n```\n\n## Contract\n\n## Development Resources\n\n### Other Repositories\n\n#### Block Foundation Smart Contract Series\n\n|                                   | `Solidity`  | `Teal`      |\n| --------------------------------- | ----------- | ----------- |\n| **Template**                      | [**\u003e\u003e\u003e**](https://github.com/block-foundation/solidity-template) | [**\u003e\u003e\u003e**](https://github.com/block-foundation/teal-template) |\n| **Architectural Design**          | [**\u003e\u003e\u003e**](https://github.com/block-foundation/solidity-architectural-design) | [**\u003e\u003e\u003e**](https://github.com/block-foundation/teal-architectural-design) |\n| **Architecture Competition**      | [**\u003e\u003e\u003e**](https://github.com/block-foundation/solidity-architecture-competition) | [**\u003e\u003e\u003e**](https://github.com/block-foundation/teal-architecture-competition) |\n| **Housing Cooporative**           | [**\u003e\u003e\u003e**](https://github.com/block-foundation/solidity-housing-cooperative) | [**\u003e\u003e\u003e**](https://github.com/block-foundation/teal-housing-cooperative) |\n| **Land Registry**                 | [**\u003e\u003e\u003e**](https://github.com/block-foundation/solidity-land-registry) | [**\u003e\u003e\u003e**](https://github.com/block-foundation/teal-land-registry) |\n| **Real-Estate Crowdfunding**      | [**\u003e\u003e\u003e**](https://github.com/block-foundation/solidity-real-estate-crowdfunding) | [**\u003e\u003e\u003e**](https://github.com/block-foundation/teal-real-estate-crowdfunding) |\n| **Rent-to-Own**                   | [**\u003e\u003e\u003e**](https://github.com/block-foundation/solidity-rent-to-own) | [**\u003e\u003e\u003e**](https://github.com/block-foundation/teal-rent-to-own) |\n| **Self-Owning Building**          | [**\u003e\u003e\u003e**](https://github.com/block-foundation/solidity-self-owning-building) | [**\u003e\u003e\u003e**](https://github.com/block-foundation/teal-self-owning-building) |\n| **Smart Home**                    | [**\u003e\u003e\u003e**](https://github.com/block-foundation/solidity-smart-home) | [**\u003e\u003e\u003e**](https://github.com/block-foundation/teal-smart-home) |\n\n---\n\n## Colophon\n\n### Authors\n\nThis is an open-source project by the **[Block Foundation](https://www.blockfoundation.io \"Block Foundation website\")**.\n\nThe 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.\n\nwebsite: [www.blockfoundation.io](https://www.blockfoundation.io \"Block Foundation website\")\n\n### Development Resources\n\n#### Contributing\n\nWe'd love for you to contribute and to make this project even better than it is today!\nPlease refer to the [contribution guidelines](.github/CONTRIBUTING.md) for information.\n\n### Legal Information\n\n#### Copyright\n\nCopyright \u0026copy; 2023 [Stichting Block Foundation](https://www.blockfoundation.io/ \"Block Foundation website\"). All Rights Reserved.\n\n#### License\n\nExcept as otherwise noted, the content in this repository is licensed under the\n[Creative Commons Attribution 4.0 International (CC BY 4.0) License](https://creativecommons.org/licenses/by/4.0/), and\ncode samples are licensed under the [Apache 2.0 License](http://www.apache.org/licenses/LICENSE-2.0).\n\nAlso 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).\n\n#### Disclaimer\n\n**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.**\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblock-foundation%2Fsolidity-private-city","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fblock-foundation%2Fsolidity-private-city","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblock-foundation%2Fsolidity-private-city/lists"}