- Hacken
- Audits
- soul-society
- [SCA] Soul Society | ERC20 + ERC721 | Nov2023
Audit name:
[SCA] Soul Society | ERC20 + ERC721 | Nov2023
Date:
Nov 16, 2023
Table of Content
Introduction
We express our gratitude to the Soul Society team for the collaborative engagement that enabled the execution of this Smart Contract Security Assessment.
SOUL_SOCIETY is a Growth-Type Soul-Bound Tokens (SBTs) protocol.
| title | content |
|---|---|
| Platform | Ethereum |
| Language | Solidity |
| Tags | ERC20, ERC721, SoulBound |
| Timeline | 01/10/2023 - 15/11/2023 |
| Methodology | https://hackenio.cc/sc_methodology→ |
Review Scope | |
|---|---|
| Repository | https://github.com/SoulSocietyDev/soulsociety-sbt-contract/tree/7684979dab221d52ad4020313269b8cb93136cca→ |
| Commit | 76d55f5 |
Review Scope
- Commit
- 76d55f5
Audit Summary
10/10
0%
10/10
10/10
The system users should acknowledge all the risks summed up in the risks section of the report
Document Information
This report may contain confidential information about IT systems and the intellectual property of the Customer, as well as information about potential vulnerabilities and methods of their exploitation.
The report can be disclosed publicly after prior consent by another Party. Any subsequent publication of this report shall be without mandatory consent.
Document | |
|---|---|
| Name | Smart Contract Code Review and Security Analysis Report for Soul Society |
| Audited By | Hacken |
| Changelog | 06/10/2023 – Initial Review |
| 31/10/2023 – Second Review | |
| 10/11/2023 – Third Review | |
| 15/11/2023 – Fourth Review |
Document
- Name
- Smart Contract Code Review and Security Analysis Report for Soul Society
- Audited By
- Hacken
- Changelog
- 06/10/2023 – Initial Review
- 31/10/2023 – Second Review
- 10/11/2023 – Third Review
- 15/11/2023 – Fourth Review
System Overview
SOUL_SOCIETY is a Growth-Type Soul-Bound Tokens (SBTs) protocol:
Users can engage in several activities and acquire SBTs that define their identities. A user can own several SBTs.
SBTs minted through Soul Society can be viewed by anyone and be applied to third-party services.
Growth-Type (level) feature of SBTs:
Growth-Type Attribute: indication of the Level of engagement (1,2,3,...,N).
Growth-Type Achievement History: URI that links to history information about when, where and how the Level was achieved.
The project presents the following contracts:
HONToken - ERC20 token contract.
SoulSocietySBT - custom SBT contract.
Privileged roles
SoulSocietySBT contract Owner - can mint, burn and grow SBTs.
HONToken contract Owner - can mint and burn HON Tokens as well as transfer Ownership.
Executive Summary
Documentation quality
The total Documentation quality score is 10 out of 10.
The purpose of the contracts is described.
The project’s features are provided.
Business logic is included.
Use Cases are described.
The technical description is complete.
Environment configuration is provided.
Code quality
The total Code quality score is 10 out of 10.
The development environment is configured.
Best practices are followed.
Test coverage
Code coverage of the project is 0% (branch coverage).
For a project with less than 250 LOC (Lines of Code) the test coverage is not mandatory, and it is not accounted for in the final score.
Security score
Upon auditing, the code was found to contain 0 critical, 3 high, 2 medium, and 4 low severity issues. Out of these, 9 issues have been addressed and resolved, leading to a security score of 10 out of 10.
All identified issues are detailed in the “Findings” section of this report.
Summary
The comprehensive audit of the customer's smart contract yields an overall score of 10. This score reflects the combined evaluation of documentation, code quality, test coverage, and security aspects of the project.
Risks
No risks have been identified during the audit review.
Findings
Code ― | Title | Status | Severity | |
|---|---|---|---|---|
| F-2023-1535 | Too Highly Permissive Role Allows Owner To Burn Tokens From Users Without Their Consent Or Previous Notice | fixed | High | |
| F-2023-1534 | Token Burn Does Not Follow ERC721 Standard And Leads To Inconsistencies | fixed | High | |
| F-2023-1533 | Requirements Violation: The Supply of HON Tokens Is Not Limited | fixed | High | |
| F-2023-153 | Missing User Approval For Growth Level Update Results In Highly Centralized Growth System | fixed | Medium | |
| F-2023-153 | Missing Safety Check for Non-EOA Receivers of Tokens Can Lead to Locked Tokens | fixed | Medium | |
| F-2023-154 | Inefficient Checks in setProtected() Result In Inefficient Code | fixed | Low | |
| F-2023-154 | Missing URI Length Check | fixed | Low | |
| F-2023-1539 | Missing Events for Critical Value Updates | fixed | Low | |
| F-2023-1538 | Floating Pragma | fixed | Low | |
| I-2023-039 | Style Guide Violation: Order Of Layout | fixed | Observation |
Appendix 1. Severity Definitions
When auditing smart contracts, Hacken is using a risk-based approach that considers Likelihood, Impact, Exploitability and Complexity metrics to evaluate findings and score severities.
Reference on how risk scoring is done is available through the repository in our Github organization:
Severity | Description |
|---|---|
Critical | Critical vulnerabilities are usually straightforward to exploit and can lead to the loss of user funds or contract state manipulation. |
High | High vulnerabilities are usually harder to exploit, requiring specific conditions, or have a more limited scope, but can still lead to the loss of user funds or contract state manipulation. |
Medium | Medium vulnerabilities are usually limited to state manipulations and, in most cases, cannot lead to asset loss. Contradictions and requirements violations. Major deviations from best practices are also in this category. |
Low | Major deviations from best practices or major Gas inefficiency. These issues will not have a significant impact on code execution, do not affect security score but can affect code quality score. |
Severity
- Critical
Description
- Critical vulnerabilities are usually straightforward to exploit and can lead to the loss of user funds or contract state manipulation.
Severity
- High
Description
- High vulnerabilities are usually harder to exploit, requiring specific conditions, or have a more limited scope, but can still lead to the loss of user funds or contract state manipulation.
Severity
- Medium
Description
- Medium vulnerabilities are usually limited to state manipulations and, in most cases, cannot lead to asset loss. Contradictions and requirements violations. Major deviations from best practices are also in this category.
Severity
- Low
Description
- Major deviations from best practices or major Gas inefficiency. These issues will not have a significant impact on code execution, do not affect security score but can affect code quality score.
Appendix 2. Scope
The scope of the project includes the following smart contracts from the provided repository:
Scope Details | |
|---|---|
| Repository | https://github.com/SoulSocietyDev/soulsociety-sbt-contract/tree/7684979dab221d52ad4020313269b8cb93136cca→ |
| Commit | 76d55f5 |
| Whitepaper | Provided |
| Requirements | Provided |
| Technical Requirements | Provided→ |
Scope Details
- Commit
- 76d55f5
- Whitepaper
- Provided
- Requirements
- Provided
- Technical Requirements
- Provided→