solidity-neighbourhood-participation

Solidity Smart Contract: Neighbourhood Participation

https://github.com/block-foundation/solidity-neighbourhood-participation

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (7.2%) to scientific vocabulary

Keywords

architecture block-foundation blockchain blockfoundation city eth ethereum governance hardhat neighbourhood-participation participation smart-contracts sol solidity urban-planning
Last synced: 4 months ago · JSON representation ·

Repository

Solidity Smart Contract: Neighbourhood Participation

Basic Info
  • Host: GitHub
  • Owner: block-foundation
  • License: cc-by-sa-4.0
  • Language: TypeScript
  • Default Branch: main
  • Homepage: https://www.blockfoundation.io
  • Size: 89.8 KB
Statistics
  • Stars: 0
  • Watchers: 2
  • Forks: 0
  • Open Issues: 5
  • Releases: 0
Topics
architecture block-foundation blockchain blockfoundation city eth ethereum governance hardhat neighbourhood-participation participation smart-contracts sol solidity urban-planning
Created over 2 years ago · Last pushed about 1 year ago
Metadata Files
Readme Changelog Contributing Funding License Code of conduct Citation Codeowners Security Support Governance Authors

README.md

[![GitHub License](https://img.shields.io/github/license/block-foundation/blocktxt?style=flat-square&logo=readthedocs&logoColor=FFFFFF&label=&labelColor=%23041B26&color=%23041B26&link=LICENSE)](https://github.com/block-foundation/solidity-neighbourhood-participation/blob/main/LICENSE) [![devContainer](https://img.shields.io/badge/Container-Remote?style=flat-square&logo=visualstudiocode&logoColor=%23FFFFFF&label=Remote&labelColor=%23041B26&color=%23041B26)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/block-foundation/solidity-neighbourhood-participation)

Block Foundation Logo

Neighbourhood Participation

Block Foundation Smart Contract Series [Solidity]


Block Foundation Brand

Contents



[![Report a Bug](https://img.shields.io/badge/Report%20a%20Bug-GitHub?style=flat-square&&logoColor=%23FFFFFF&color=%23E1E4E5)](https://github.com/block-foundation/solidity-neighbourhood-participation/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected&projects=&template=bug_report.yml) [![Request a Feature](https://img.shields.io/badge/Request%20a%20Feature-GitHub?style=flat-square&&logoColor=%23FFFFFF&color=%23E1E4E5)](https://github.com/block-foundation/solidity-neighbourhood-participation/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected&projects=&template=feature_request.yml) [![Ask a Question](https://img.shields.io/badge/Ask%20a%20Question-GitHub?style=flat-square&&logoColor=%23FFFFFF&color=%23E1E4E5)](https://github.com/block-foundation/solidity-neighbourhood-participation/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected&projects=&template=question.yml) [![Make a Suggestion](https://img.shields.io/badge/Make%20a%20Suggestion-GitHub?style=flat-square&&logoColor=%23FFFFFF&color=%23E1E4E5)](https://github.com/block-foundation/solidity-neighbourhood-participation/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected&projects=&template=suggestion.yml) [![Start a Discussion](https://img.shields.io/badge/Start%20a%20Discussion-GitHub?style=flat-square&&logoColor=%23FFFFFF&color=%23E1E4E5)](https://github.com/block-foundation/solidity-neighbourhood-participation/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected&projects=&template=discussion.yml)

Introduction

The Neighborhood Participation smart contract, written in Solidity for the Ethereum blockchain, is designed to facilitate decision-making and participation within a neighbourhood community. It provides a decentralized platform for community members to propose initiatives, vote on them, and check their status.

In this smart contract, each community or neighborhood has a manager, typically the person who deploys the contract. This manager can invite new participants to join the community. Once an individual is invited, they can accept the invitation to join the neighborhood.

Any participant can propose a new initiative. These initiatives then can be voted upon by the community members. The voting mechanism is a simple binary vote, meaning each participant can vote either in favor (yes) or against (no) an initiative.

The contract has a quorum mechanism in place to automatically approve or reject initiatives. If the number of 'yes' votes exceeds the predefined quorum, the initiative gets approved. Similarly, if 'no' votes exceed the quorum, the initiative gets rejected.

Each initiative in the contract holds its description, the address of the initiator, the count of yes and no votes, and its current state (proposed, approved, or rejected).

Remember, while this contract provides core functionalities for community decision-making, it's only a starting point. Depending on the specific requirements, further features can be added and improvements can be made. Also, it's crucial to thoroughly test and audit any smart contract before deploying it to a live network to ensure its security and functionality.

Quick Start

Install

sh npm i

Compile

sh npm run compile

Contract


Colophon

Authors

This is an open-source project by the Block Foundation.

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

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 for information.

Legal Information

Copyright

Copyright © 2023 Stichting Block Foundation. 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, and code samples are licensed under the Apache 2.0 License.

Also see LICENSE and 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.

Owner

  • Name: Block Foundation
  • Login: block-foundation
  • Kind: organization
  • Email: info@blockfoundation.io
  • Location: Netherlands

The Block Foundation mission is enabling architects to take back initiative and contribute in solving the mismatch in housing through blockchain technology.

Citation (CITATION.cff)

cff-version: 1.2.0
title: solidity-neighbourhood-participation
version: 0.0.1
date-released: 2023-07-01
url: "https://github.com/block-foundation/solidity-neighbourhood-participation"
message: >-
  If you use this software, please cite it using
  the metadata from this file.
type: software
authors:
  - given-names: Lars Bastiaan
    family-names: van Vianen
    email: lars@blockfoundation.io
    affiliation: Block Foundation
    orcid: "https://orcid.org/0000-0002-8790-8630"

GitHub Events

Total
  • Delete event: 4
  • Issue comment event: 8
  • Pull request event: 6
  • Create event: 4
Last Year
  • Delete event: 4
  • Issue comment event: 8
  • Pull request event: 6
  • Create event: 4

Committers

Last synced: almost 2 years ago

All Time
  • Total Commits: 85
  • Total Committers: 1
  • Avg Commits per committer: 85.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 85
  • Committers: 1
  • Avg Commits per committer: 85.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Lars van Vianen l****s@v****m 85
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: almost 2 years ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • dependabot[bot] (1)
Pull Request Authors
  • dependabot[bot] (15)
Top Labels
Issue Labels
Pull Request Labels

Dependencies

.devcontainer/Dockerfile docker
  • blockfoundation/ethereum-solidity-devcontainer latest build
.devcontainer/docker-compose.yml docker
package.json npm
  • @nomicfoundation/hardhat-chai-matchers ^2.0.1 development
  • @nomicfoundation/hardhat-toolbox ^3.0.0 development
  • @openzeppelin/hardhat-upgrades ^2.0.1 development
  • @typechain/ethers-v6 ^0.4.3 development
  • @types/chai ^4.3.5 development
  • @types/mocha ^10.0.1 development
  • @types/node ^20.4.4 development
  • chai ^4.3.7 development
  • dotenv ^16.3.1 development
  • eslint ^8.41.0 development
  • ethers ^6.6.5 development
  • hardhat ^2.17.0 development
  • prettier ^2.8.8 development
  • solhint ^3.4.1 development
  • solidity-coverage ^0.8.4 development
  • ts-node ^10.9.1 development
  • typechain ^8.3.1 development
  • typescript ^5.1.6 development
  • web3 ^4.0.3 development
  • webpack ^5.88.2 development
  • @openzeppelin/contracts ^4.9.2
  • @openzeppelin/contracts-upgradeable ^4.9.2
  • hardhat-abi-exporter ^2.10.1
  • keccak256 ^1.0.6
  • merkletreejs ^0.3.10
  • web3-utils ^4.0.3