Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/softstack/w3-now-soulbound-nft
Soulbound NFT for W3NOW Study" is a blockchain project aimed at recognizing and verifying participation in the W3NOW study through a unique, non-transferable NFT (Non-Fungible Token) mechanism.
https://github.com/softstack/w3-now-soulbound-nft
hbi nft open-source solidity solidity-contracts soulbound w3now
Last synced: 10 days ago
JSON representation
Soulbound NFT for W3NOW Study" is a blockchain project aimed at recognizing and verifying participation in the W3NOW study through a unique, non-transferable NFT (Non-Fungible Token) mechanism.
- Host: GitHub
- URL: https://github.com/softstack/w3-now-soulbound-nft
- Owner: softstack
- Created: 2023-11-07T18:00:21.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-09T14:15:55.000Z (10 months ago)
- Last Synced: 2024-12-21T04:12:31.582Z (16 days ago)
- Topics: hbi, nft, open-source, solidity, solidity-contracts, soulbound, w3now
- Language: TypeScript
- Homepage: https://www.w3now.de/
- Size: 146 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# W3NOW Soulbound NFT
Für die Studie [W3NOW](https://www.w3now.de/) wurde ein "Soulbound NFT" entwickelt, der an alle Teilnehmer der Studie ausgeschüttet werden soll. Der Smart Contract erlaubt es dem Besitzer NFTs zu schürfen und an beliebige Adressen zu senden (minting). Jede Adresse darf maximal einen NFT besitzen und hat die Möglichkeit diesen eigenständig wieder zu zerstören (burnen). Damit ist das Recht auf Löschung nach Artikel 17 DSGVO abgedeckt. Die geschürften NFTs haben alle die selben Metadaten und dienen als Nachweis, an der Studie teilgenommen zu haben. Es gibt keine Möglichkeit die NFTs nach der Erstellung (initiales Senden zum Empfänger) an Dritte weiter zu transferieren. Die Token sind für ihren Lebenzyklus fest an eine Adresse gebunden.
English:
For the W3NOW study, a "Soulbound NFT" was developed to be distributed to all participants of the study. The smart contract allows the owner to mine NFTs and send them to any address (minting). Each address may own a maximum of one NFT and has the option to destroy it independently (burning). This covers the right to erasure under Article 17 GDPR. The mined NFTs all have the same metadata and serve as proof of participation in the study. There is no possibility to transfer the NFTs to third parties after their creation (initial sending to the recipient). The tokens are permanently bound to an address for their lifecycle.
## Scripts
To interact with this repository your can take advantage of predefined scripts for setting up, testing, linting, formating or compiling. Feel free to add your own scripts (for example for contract deployment or verification).
### Installing dependencies
To install all required project dependencies run:
```shell
npm install
```
### Compile smart contracts
To compile solidity smart contracts of this repository run:
```shell
npm run compile
```
### Run test cases for smart contract
To execute all test cases located in the _test_ folder run:
```shell
npm run test
```
### Testing code coverage
To get the current code coverage of all test for all solidity files run:
```shell
npm run coverage
```
### Deploy smart contracts
To deploy the Soulbound NFT contract follow these steps:
1. Create a .env file with the following variables ([.env.example](.env.example)) and set the values for the target network:
```
ETHERSCAN_API_KEY=ABC123ABC123ABC123ABC123ABC123ABC1
POLYGON_URL=
MUMBAI_URL=
PRIVATE_KEY=0xabc123abc123abc123abc123abc123abc123abc123abc123abc123abc123abc1
```
2. Adjust the deployment arguments in [deploymentArgs](scripts/deploymentArgs.ts) to set the token parameters as desired:
```
const DeploymentArgs = [
"W3NOW-NFT 2023", // collection name
"W3NOW23", // collection symbol
"https://ipfs.io/ipfs/QmPLosNSsFw81UZQisFzGm8mQ7HzmKSReQe6Ds2XF8c1cV", // token URI (metadata)
"0x2Cf143175b21564bc7520FF2d893884104dB8d07", // owner address
]
```
3. Run the script to deploy the NFT contract on the desired network by selecting the proper network name.
```shell
npm run deploy
```
## Verifying deployed smart contracts
If you successfully deployed the NFT contract copy the contract address and run the following command to verify the contract.
Run the following command and replace `DEPLOYED_CONTRACT_ADDRESS` with the copied address of the deployed contract:
```shell
npx hardhat verify DEPLOYED_CONTRACT_ADDRESS
```