Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/giveth/giveth-1-simulation
Generating giveth 1 whole state by processing network events
https://github.com/giveth/giveth-1-simulation
Last synced: 8 days ago
JSON representation
Generating giveth 1 whole state by processing network events
- Host: GitHub
- URL: https://github.com/giveth/giveth-1-simulation
- Owner: Giveth
- License: gpl-3.0
- Created: 2021-01-10T14:58:59.000Z (almost 4 years ago)
- Default Branch: develop
- Last Pushed: 2024-06-06T00:05:59.000Z (5 months ago)
- Last Synced: 2024-06-06T01:26:45.719Z (5 months ago)
- Language: TypeScript
- Size: 489 KB
- Stars: 7
- Watchers: 12
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Note: Please use `develop` branch for contributing.
This project runs to fix conflicts between the [Giveth-Feathers](https://github.com/Giveth/feathers-giveth) DB and network ( smart contracts)
## Table of content
- [Table of content](#table-of-content)
- [Getting Started](#getting-started)
- [Install](#install)
- [Run Script](#run-script)
- [What do this project](#what-do-this-project)
## Getting Started
### Install
- #### Any OS
1. Click **Star** on this repo near the top-right corner of this web page (if you want to).
2. Fork this repo by clicking **Fork** button in top-right corner of this web page. Continue to follow instruction steps from your own **giveth-1-simulation** repo.
3. The rest of these steps must be done from your machine's command line. Clone your own **giveth-1-simulation** repo. Copy the link from the "Clone or download" button near the top right of this repo's home page.
```
git clone {paste your own repo link here}
```
4. Change directories to `giveth-1-simulation`:
```
cd giveth-1-simulation
```
5. Make sure you have [NodeJS](https://nodejs.org/) (v10.23.0 or higher), [yarn](https://www.yarnpkg.com/) (v0.27.5 or higher), and npm (5.4.1 or higher) installed.
6. Install dependencies from within feathers-giveth directory:
```
npm install
```
### Run Script
1. create a folder named config, and put `develop.json` in that
with these data
```
{
"mongodb": "mongodb://localhost:27017/giveth-develop",
"givethFeathersUrl": "https://feathers.develop.giveth.io",
"logDir": "data/log",
"cacheDir": "data/cache",
"logLevel": "info",
"dryRun": false,
"emailReport": false,
"emailSimulationError": false,
"givethMaintainersEmail":["[email protected]"],
"givethDevMailList": [
"[email protected]"
],
"dappMailerUrl": "Giveth dapp mailer url",
"dappMailerSecret": "SECRET NOT IN DEFAULT.JSON",
"blockchain": {
"requiredConfirmations": 6,
"nodeUrl": "wss://rinkeby.eth.aragon.network/ws",
"homeNodeUrl": "wss://ropsten.infura.io/ws/v3/{SECRET GET THIS FROM infura.io}",
"liquidPledgingAddress": "0xf0e0F5A752f69Ee6dCfEed138520f6821357dc32",
"vaultAddress": "0x2F3788a772D6eCCEbed68D760284e7f84Af3D492"
},
"tokenWhitelist": [
{
"name": "Ropsten ETH",
"address": "0x0",
"foreignAddress": "0x387871cf72c8CC81E3a945402b0E3A2A6C0Ed38a",
"symbol": "ETH",
"decimals": 6
},
{ "name": "MiniMe Test Token",
"address": "0xE690E380740a682E2b8CEAEa33584Ea2cb59849E",
"foreignAddress": "0xe1DA0672bDBdBc469E82cCACCe9e4c7C79dAF6cf",
"symbol": "XDAI",
"decimals": 3,
"rateEqSymbol": "DAI"
}
]
}
```
2. `npm run build` This transpile the project and generate an `index.js`
3. `npm run start:develop`
### What do this project
* Getting all events from network (and cache it to in next runs
just get new ones)
* Getting all states from network (and cache it to in next runs
just get new ones)
* **Sync DACs**: If there is any dac in network and for any reason
it's not in feathers-giveth, it create these DACs
* **Sync Campaigns**: If there is any campaign in network and for any reason
it's not in feathers-giveth, it create these Campaigns
* **Sync Milestones**: If there is any milestone in network and for any reason
it's not in feathers-giveth, it create these Milestones
* **Sync donations with network**: if there is missing donations in DB
or for any reason the donations stuck in `Pending` status
it fixed it
* **Update donationsCounter**: If there is any conflict in `Milestone` or `Campaign` or
`Dac` donationsCounter and it's not up to date, this script resolve that
* **Update milestone statuses**: if the status of any milestone is not up to date and not synced with network,
the script will resolve that and update the milestone
* **Unset pendingAmountRemaining from committed donations**