crypto-payroll-contracts

Simple way for tracking crypto payroll payments for Opolis crypto payroll. This contract is primarily for tracking verses a full payroll system for dealing with withholding and taxes.

The idea is verify when a payroll has been paid based on the user paying their payroll via our UI, where we'll programmatically submit the payrollId along with the actual payment. The other goal is to give our operations team a way to ensure 1) new member deposit in crypto are either immediately sent to Wyre, if paid in ETH, or 2) withdraw batches of new member stakes and crypto payrolls at their discretion.

Deploying:

Steps for getting up and running:

1. Pull repo from github
2. yarn install
3. Create a ./config.json and fill in using the example file
4. Run yarn test to run test coverage
5. Launch with npx hardhat run ./scripts/deploy-tests.js for tests or npx hardhat run ./scripts/deploy.js --network {{network}}

Deployments:

Please check to make sure any crypto payroll or staking payments are being made to contracts on the Current Deployments List.

Current Deployments:

• Mainnetv3 0x22a8fe0109b5457aE5C9E916838e807dd8B0A5B6

• Polygonv3: 0xAA3F190DF9E9A050ae88B2Df0aD8B70d8aF000D7

• Aurorav3 0x68De5a31D83f4280FCa75b289Ae87BCDCa2cec9C

Past & Depreciated Deployments

Mainnetv1: 0x87C91ac511688138E1452C942663f52cD5E2AbC5 (DEPRECATED)

Mainnetv2 0xaE7db356c82401B111134041533AB490906C8ED5 (DEPRECATED)

Polygonv2: 0x11d33195F1542298Ae5e3DE8395477A21B3196fe (DEPRECATED)

Mumbaiv1: 0x347434c2BbBa4193bd56184bD768f4a4139Da39c (DEPRECATED)

Mumbaiv2: 0xbA77cd256d0F650ECe87BF4CC25C425C0332F5e9 (DEPRECATED)

Mumbaiv3: 0x84ceFE79e01FF93C623d34610A651Fc221458630

** Mumbai Test Token: 0x0c6438F3f9c0aa126ef88C9A0371cFb73904Bf01

Harmonyv2 0xA6E644c1bBb0Dbb48Db66489FfC1Bc7538cF6B18

Aurorav3 0x68De5a31D83f4280FCa75b289Ae87BCDCa2cec9C

AuroraTestnetv3 0x873973E48662351c12Bf03D9e22E87A87169e141

Core Functions

payParoll() - Function to allow a transfer of whitelisted ERC20 tokens along with the corresponding payrollID for that members' payroll. We just use payrollID rather than other information to make it harder to associate a payroll with any particular member.

NB: We only expect to accept stable coins / ERC20s for payroll.

memberStake() - Function to allow a new member to make a deposit to cover their last month of benefits. Here we accept both ERC20 tokens and ETH. With ETH we want to immediately transfer it to Wyre (the destination) where it can be liquidated. For stable coins we want our Ops team to have the option to withdraw the stakes in batches when required.

withdrawPayrolls() - Function to allow our ops team to withdraw amounts of tokens associated with paid payrolls. Here we're relying on the ops team to input arrays of the correct amounts and tokens associated with each payrollID.

NB: We decided against saying a more informational payroll object for gas minimization reasons.

withdrawStakes() - Function to allow our opts team to withdraw amounts of tokens associated with paid member staking deposits. Here we're relying on the ops team to input arrays of the correct amounts and tokens associated with members' stakes.

clearBalance() - This is a safety function to withdraw all amounts of whitelisted tokens in the contract.

Modifiers

OnlyOpolis - is meant to allow either a multi-sig controlled by our Ops team or a bot that we set up to call OnlyOpolis Functions

OnlyAdmin - is meant to restrict these functions to only being called by a multi-sig that is controlled by our Ops team.

Other important info

destination - is the address provided by Wyre where we can send tokens and ETH for auto-liquidation.

supportedTokens[] - is the list of ERC20 tokens we'll accept. Admins will have the ability to update this list.