https://github.com/masaun/referral-system-for-work-rewards

Referral System for $WORK Rewards on Opolis platform (that the Linkdrop is also used)
https://github.com/masaun/referral-system-for-work-rewards

linkdrop opolis solidity truffle web3js

Last synced: 3 months ago
JSON representation

Referral System for $WORK Rewards on Opolis platform (that the Linkdrop is also used)

• Host: GitHub
• URL: https://github.com/masaun/referral-system-for-work-rewards
• Owner: masaun
• Created: 2021-02-06T00:56:31.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2021-02-12T16:13:08.000Z (almost 4 years ago)
• Last Synced: 2024-10-08T03:18:30.085Z (3 months ago)
• Topics: linkdrop, opolis, solidity, truffle, web3js
• Language: Solidity
• Homepage:
• Size: 213 KB
• Stars: 11
• Watchers: 4
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Referral System for $WORK Rewards

***

## 【Introduction of the Referral System for $WORK Rewards】

- This is a smart contract to deliver a functioning referral system for the $WORK token.

  - Unique, sharable referral links for each Member who is referring new Members to Opolis

  - 5M $WORK Rewards are issued per “Payroll Mining Block” to Employee Members, Coalition Members and Stakers. 

  - Blocks are mined as the Network grows by increments of $50K or 5% in periodic payroll volume, whichever is greater. 

  - Members receive 100% of the referral credit for Employee Members who join

  - Members receive 15% of the referral credit for referring Coalition Organizations who act as channel partners for referring new Employee Members. 

    - NO multi-level referral credit except for referring Organizations where the referring Member receives 15%) 

  - All members receive $WORK Rewards in perpetuity so long as the referred Member consumes services. 

  - Linkdrop is used for realizing the referral structure.

 

***

## 【Workflow】

- 【Diagram / Workflow】：In case an existing employee member refer an employee member  

https://github.com/masaun/referral-system-for-work-rewards/tree/main/doc  

![Screen Shot 2021-02-13 at 01 09 25](https://user-images.githubusercontent.com/19357502/107792279-49782800-6d98-11eb-9d37-70b4c28e4184.png)

 

***

## 【Remarks】

- Version

  - Solidity (Solc): v0.5.16

  - Truffle: v5.1.60

  - web3.js: v1.2.9

  - openzeppelin-solidity: v2.2.0

  - ganache-cli: v6.9.1 (ganache-core: 2.10.2)

 

***

## 【Setup】

### ① Install modules

- Install npm modules in the root directory

```

$ npm install

```




### ② Compile & migrate contracts (on local)

```

$ npm run migrate:local

```




### ③ Test (Mainnet-fork approach)

- 1: Start ganache-cli

```

$ ganache-cli -d

```

(※ `-d` option is the option in order to be able to use same address on Ganache-CLI every time)




- 2: Execute test of the smart-contracts (on the local)

  - Test for the contract

    - `$ npm run test:referral`

       ($ truffle test ./test/test-local/Referral.test.js)

    - `$ npm run test:payroll_mining`

       ($ truffle test ./test/test-local/PayrollMining.test.js)




***

## 【References】

- Opolis

  - Reward Structure 

    https://opolis.co/rewards/

  - Opolis bounty in the ETHDenver 2021 (OPOLIS BOUNTY: Build a Referral System for $WORK Rewards)  

    https://www.ethdenver.com/post/opolis




- Linkdrop

  - Linkdrop contract  

    https://github.com/LinkdropHQ/linkdrop-monorepo/tree/master/packages/contracts

  - Technology Overview (ERC20 & NFT Linkdrop)

    https://medium.com/volc%C3%A0/technology-overview-erc20-nft-linkdrop-c2909f9bcd19