This repository contains our implementation of EIP4973, EIP5114, and our final contracts, namely Soul ID and Soul Badge. By using Openzeppelin UUPS upgradeable contract design, our Soulbound Solution features a future-proof product with infinite possibilities.
This is the first of its kind Soulbound application for the NFT space, which is designed and deployed by Sharkz Entertainment.
- Contract data is stored in proxy contract, improvement or bugfix can be done by just deploying new implementation contract.
- When compared to Transparent proxy and Diamond proxy, UUPS is the most gas efficient proxy pattern for token owners.
- Since upgrade method resides in the implementation contract, UUPS provides flexibility to remove upgradeability, preventing unexpected future change in the contract.
In the current world of Web3, most people create their social identity with only EOA wallet. However, by design, a wallet is meant to be an asset holder, not an identity holder, it lacks many features for a real-life identity.
Inspired by the concept of Soulbound discussed by Vitalik Buterin, we build our Soulbound Solution (Soul ID) purely with smart contracts. It provides a socially secured, censorship-free and recoverable identity, allowing identity owner (token owner) to easily store social reputation scores within our NFT ecosystem, we think this technology will help to form the future of decentralized society, where each separated community identities can inter-exchange social scores by a common interface, scores can be aggregated into a parent identity and form a society.
Above diagram demonstrates how the contract system works. Soul ID is a single Soul identity, it is a custom ERC4973 implementation enforcing 1:1 binding to an EOA wallet address, it can store social scores attached from multiple internal / external badge contracts. Badge contracts support both the ERC721 NFT token and our ERC5114-Soul Badges. Soul Badges are designed to work and mint with Soul ID, without any knowledge of EOA wallet owner, in this way, Soul Badges can be securely and permanently attached to a Soul at mint time, maintaining the relationship during any event of Soul ID relocation or recovery.
When someone loses their wallet, the Soul ID can be relocated to a different wallet. We call it Social Recovery. You can set a number of Guardian wallet addresses after you have claimed the Soul ID.
Your guardian submits a renewal request of your lost Soul ID. He or she now serves as your requester for the recovery. After reaching the approval quorums (1/N + 1 approvals, the N approvers included token owner and guardians), your Requester from now on is solely responsible for assigning your Soul ID to a new wallet address.
- Token is binding to one wallet address and acts like a single Soul and UID.
- As defined by EIP4973, Soul ID implements ERC721 Metadata interface without any ERC721 transfer functions; token meta is viewable on the NFT marketplaces while remaining non-tradable.
- Token includes a dynamic score trait, the value will be increased by collecting more badges.
- Contract admins can link or unlink any supported badge contracts (ERC721, Soul Badge), and scores will be updated.
- Scores will come from all linked badges. For Soul ID v2, we plan to support Soul ID as a badge, allowing aggregated scores for every linked Soul ID from other communities.
- Token images are 100% on-chain generated, and displaying data is customizable by token owner.
- Token owners can set up guardians; the approval quorum can safeguard the identity data from change requests.
- Support token relocation to a new wallet address by the token owner, using the guardian approval workflow.
- Support token social-recovery by other guardians, using the guradian approval workflow.
This implementation includes many features for practical usage, by including ERC721 Metadata extension, we allow NFT platforms to recognize the token name, symbol and token metadata, e.g. token image, token traits. By design, transfer related functions, ERC721 transfer, operator, and approval functions are all removed, making it non-transferrable by design.
This implementation features a badge-like ownership design, token is attached to a Soul ID (ERC4973 token) by linking internal token ID to an external contract address and token number, as a Soul will eventually resolve to a wallet owner, there is no need to have the Soul Badge token to store wallet address. During a Soul relocation or recovery, the linkage between Soul Badge and Soul ID will be naturally maintained.
After downloading the repo, please first install all necessary NPM modules. Copy the .env-sample as .env, and fill in all API and test keys.
npm install
npx hardhat testThis repo includes both standard and UUPS upgradeable version of ERC4973 related contracts, and our final product, Soul ID and Soul Badge contracts.
This project is available under the MIT license.