FaTS is an open-source repository for a smart contract development in the KTH course DD2485. The protocol utilizes blockchain technology to make salary information more visible (transparent). The protocol are written in Solidity and contains two contracts: CompanyFactory.sol and Company.sol
The motivation behind this development is to allow employees to gain more information about the salaries of their peers in the company they are employed at, specific salary details of connected companies, and the average salary of employees within specific sectors. There are existing initiatives for making salary information more public, transparent and available (e.g., glassdoor https://www.glassdoor.com/) but the goal here is to motivate companies (employers) to deploy FaTS as a way to be transparent about their salaries. Specific employee information is anonymized besides their employment title and their salary. To increase trust, each employee can verify that their reported salary is correct. By putting this on the blockchain, nothing will be hidden, meaning that changes within an organization (layoffs or salary changes) will be visible for everyone. The protocol aims to give employees more information when negotiating their compensation and to create more trust for specific organizations by holding them more accountable.
- Users can register a new company within a specified sector.
- The contract ensures unique company registration per cryptographic identity (e.g. digital wallet address).
- Companies can be removed by their administrators.
Sector Management
- Sectors are defined as string identifiers.
- Users can add and remove sectors dynamically.
Event Logging
- Events are emitted to log significant contract activities, such as adding companies and modifying sectors.
Query Functions
- Retrieve details about a specific company, including its sector, total employees, and average salary.
- Obtain the average salary within a specific sector.
- Get the addresses of companies within a given sector.
Deployment
- Deploy the CompanyFactory smart contract to the Sepolia blockchain.
Granting and Revoking registration rights (onlyOwner)
Granting: Call the grantRegistryRight function to grant a company within a specific sector registration right. Revoking: Call the revokeRegistryRight function with the company key as parameter input to remove that company's registration right.
Registering or Removing company (requires company specific key) Registering: Call the registerCompany function with your company key as input to register the company's name within the specified sector. Removing: Call the removeCompany function with your company key as input to remove the company's details.
Query Functions
- Retrieve company details using getCompanyDetails.
- Calculate the average salary in a sector with getAverageSalaryInSector.
- Obtain addresses of companies within a sector using getCompanyAddressesInSector.
Sector Management
- Dynamically add sectors with the addSector function.
- Remove sectors with the removeSector function.
- CompanyAdded: Logged when a new company is successfully registered.
- SectorAdded: Logged when a new sector is added.
- SectorRemoved: Logged when a sector is removed.
Employee Management
- Employers can add new employees to the company, specifying their title and salary.
- Registered employees can be removed from the company by the employer.
- Employers can update the title and salary of existing employees.
Employee Verification
- Employees can verify their own salary, providing transparency and accountability.
Average Salary Calculation
- The contract provides a function to calculate the average salary of all employees within the company.
Events
- Events are emitted for significant activities, such as adding, removing, updating employees, and verifying salaries.
Access Control
- The contract includes access control to ensure that only the employer/administrator can perform certain operations.
Deployment
- Deploy the EmployeeManagement smart contract after deploying the CompanyFactory contract.
- CompanyFactory.sol will give a specific address for the created company's contract.
Employee Management
- Use the addEmployee function to register a new employee, providing their address, title, and salary.
- Remove existing employees with the removeEmployee function.
- Update employee details with the updateEmployee function.
Verification
- Employees can verify their own salary using the verifySalary function.
Average Salary
- Retrieve the average salary of all employees in the company using the getAverageSalary function.
- EmployeeAdded: Logged when a new employee is successfully added.
- EmployeeRemoved: Logged when an employee is removed from the company.
- EmployeeUpdated: Logged when an employee's details are updated.
- SalaryVerified: Logged when an employee verifies their salary.
- The onlyEmployer modifier ensures that only the employer/administrator can execute certain functions.
The protocol can be automatically executed from the test suite and is done through Hardhat. The prerequisites include having Node.js installed on the machine, which can be downloaded on https://nodejs.org.
- Open a terminal/command prompt.
- Navigate to the project directory:
cd path/to/this/project- Initialize a new Node.js project:
npm init -y- Install Hardhat:
npm install --save-dev hardhat- Run the tests:
npx hardhat test- Coverage testing:
npx hardhat coverageSimilar initiatives to make salaries more transparent exist but mostly exist off-chain. Most on-chain efforts in this field focus on payroll management, for instance Bitwage (https://www.bitwage.com/) that allows employees and freelancers to choose if they would like to be paid in a cryptocurrency etc. Future work on this project could include contracts to be formed between the employer and the employee where currency options would be available and automated through smart contracts. OpenPayrolls (https://openpayrolls.com/) and GlassDoor (https://www.glassdoor.com/) are off-chain initiatives to make salaries more transparent.