# @intercoin/voting

> Smart contract for facilitating voting and polling

Latest version **1.0.1** (published 2024-08-19) · ISC license · 0 weekly downloads

## Install

```sh
npm install @intercoin/voting
pnpm add @intercoin/voting
yarn add @intercoin/voting
bun add @intercoin/voting
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2024-08-19 |
| First published | 2024-08-19 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 108.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | artman325, gregmozart |

## Links

- npm: https://www.npmjs.com/package/@intercoin/voting
- Repository: https://github.com/Intercoin/VotingContract
- Homepage: https://github.com/Intercoin/VotingContract#readme
- Issues: https://github.com/Intercoin/VotingContract/issues
- npm.io page: https://npm.io/package/@intercoin/voting

## Dependencies (4)

- [@intercoin/community](https://npm.io/package/@intercoin/community.md) ^1.2.2
- [@openzeppelin/contracts](https://npm.io/package/@openzeppelin/contracts.md) ^4.7.3
- [@intercoin/releasemanager](https://npm.io/package/@intercoin/releasemanager.md) ^2.2.1
- [@openzeppelin/contracts-upgradeable](https://npm.io/package/@openzeppelin/contracts-upgradeable.md) ^4.7.3

## Recent versions

- 1.0.1 (latest) — 2024-08-19
- 1.0.0 — 2024-08-19

## README

![#f03c15](https://via.placeholder.com/15/f03c15/000000?text=+) `README.MD is out of date.`
# VotingContract
Smart contract for facilitating voting and polling

# Installation
### Node
`npm install @openzeppelin/contracts-ethereum-package`

# Deploy
when deploy it is need to pass parameters in to init method
Params:
name  | type | description
--|--|--
InitSettings|tuple| see <a href="#initsettings">InitSettings</a>
contractAddress|address|contract's address which will call after user vote. contract nede to implement method with params: ((string,uint256)[],uint256). (tuples of tag:value, user weight)
communityAddress|address|address of community contract
communitySettings|tuple[]| see <a href="#communitysettings">CommunitySettings</a>

# Overview
once installed will be use methods:
<table>
<thead>
	<tr>
		<th>method name</th>
		<th>called by</th>
		<th>description</th>
	</tr>
</thead>
<tbody>
    <tr>
		<td><a href="#init">init</a></td>
		<td>anyone</td>
		<td>need to initialize after contract deploy</td>
	</tr>
	<tr>
		<td><a href="#setweight">setWeight</a></td>
		<td>owner</td>
		<td>[TBD] ability to owner setup weight for role community</td>
	</tr>
	<tr>
		<td><a href="#vote">vote</a></td>
		<td>only which roles specified at Community Contract</td>
		<td>vote method</td>
	</tr>
    <tr>
		<td><a href="#waseligible">wasEligible</a></td>
		<td>anyone</td>
		<td>is block eligible for sender or not</td>
	</tr>
	<tr>
		<td><a href="#getvoterinfo">getVoterInfo</a></td>
		<td>anyone</td>
		<td>return voter info</td>
	</tr>
	<tr>
		<td><a href="#getvoters">getVoters</a></td>
		<td>anyone</td>
		<td>return voter's addresses</td>
	</tr>
</tbody>
</table>

## Methods

### wasEligible

Checking if the user was eligible in  `blockNumber` block

Params:
name  | type | description
--|--|--
addr|address|user's address
blockNumber|uint256|Block number

### vote

user can vote if he hasn't vote before and he has was eligible in `blockNumber` block

Params:
name  | type | description
--|--|--
blockNumber|uint256|Block number
voterData|array of tuples| see <a href="#voterdata">voterData</a>

### getVoterInfo
Return voter info. tuple of <a href="#voter">voter</a>
Params:
name  | type | description
--|--|--
addr|address|user's address

### setWeight
[TBD] setup weight for community role
Params:
name  | type | description
--|--|--
role|string|role name
weight|uint256|weight value


### getVoters
return all addresses which already voted

## Tuples

### InitSettings
name  | type | description
--|--|--
voteTitle|string|Vote title
blockNumberStart|uint256|vote will start from `blockNumberStart`
blockNumberEnd|uint256|vote will end at `blockNumberEnd`
voteWindowBlocks|uint256|period in blocks then we check eligible

### CommunitySettings
name  | type | description
--|--|--
communityRole|string|community role of participants which allowance to vote
communityFraction|uint256|fraction (percents mul by 1e6). setup if minimum/memberCount too low
communityMinimum|uint256|community minimum

### voterData
name  | type | description
--|--|--
name|string| string
value|uint256| uint256

### voter
name  | type | description
--|--|--
contractAddress|address| contract address
contractMethodName|string| contract method name
voterData|tuple| see <a href="#voterdata">voterData</a>
alreadyVoted|bool| true if voter is already voted


## Lifecycle of Vote
* deploy( or got) contract which method `vote` we will be call from voting contract. for example `<address contract1>`
* got contract of Community and roles name. for example `<address community>` and role "members"
* creation VotingContract and call init method with params 
   *   initSettings = ["My First Vote",11105165,11155165,100] ([`<voteTitle>`, `<blockNumberStart>`, `<blockNumberEnd>`, `<voteWindowBlocks>`])
   *   contractAddress = `<address contract1>`
   *   communityAddress = `<address community>`
   *   communitySettings = [['members',150000,20]]  ([`<communityRole>`, `<communityFraction>`, `<communityMinimum>`])
   
* now any user which contain in contract community with role 'members' can vote in period from `blockNumberStart` to `blockNumberEnd` if was eligible in `blockNumber` block
calling vote with Params
    * blockNumber = 11105222
    * methodName = 'vote'
    * voterData = [["orange",12],["blackberry",34],["lemon",56]]

* each successful vote will call method `vote(tuple(name,value)[], weight)` of `<address contract1>`. [TBD] weight = 1 unless owner will set new value for role calling `setWeight`

---
_Source: https://npm.io/package/@intercoin/voting · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._