first commit
This commit is contained in:
19
tokenizerRendu/.gitignore
vendored
Normal file
19
tokenizerRendu/.gitignore
vendored
Normal file
@@ -0,0 +1,19 @@
|
||||
# Secrets — jamais dans Git
|
||||
.env
|
||||
.env.*
|
||||
!.env.example
|
||||
|
||||
# Node / Hardhat
|
||||
node_modules/
|
||||
cache/
|
||||
artifacts/
|
||||
typechain-types/
|
||||
coverage/
|
||||
dist/
|
||||
|
||||
# OS / IDE
|
||||
.DS_Store
|
||||
.idea/
|
||||
.vscode/
|
||||
|
||||
*.log
|
||||
82
tokenizerRendu/README.md
Normal file
82
tokenizerRendu/README.md
Normal file
@@ -0,0 +1,82 @@
|
||||
# Tokenizer — Build your own token
|
||||
|
||||
Projet 42 — création et déploiement d’un **token** sur blockchain publique (**testnet**).
|
||||
|
||||
> **Dépôt de rendu école** : ce dossier est la **racine** du dépôt Git Vogosphere. Pas de `docs/` ni de sujet traduit ici.
|
||||
|
||||
## État du projet
|
||||
|
||||
| Élément | Statut |
|
||||
|---------|--------|
|
||||
| Smart contract (`code/`) | À compléter |
|
||||
| Déploiement (`deployment/`) | À compléter |
|
||||
| Documentation utilisateur (`documentation/`) | À compléter |
|
||||
|
||||
## Token (à compléter après déploiement)
|
||||
|
||||
| Champ | Valeur |
|
||||
|-------|--------|
|
||||
| **Nom** | *(contient `42` — ex. `FortyTwoToken`)* |
|
||||
| **Symbole** | *(ex. `FT42`)* |
|
||||
| **Standard** | BEP-20 (BNB Smart Chain) |
|
||||
| **Réseau** | *(ex. BNB Smart Chain **Testnet**, chainId `97`)* |
|
||||
| **Adresse du contrat** | `0x...` |
|
||||
| **Explorer** | *(ex. https://testnet.bscscan.com/address/0x...)* |
|
||||
|
||||
## Choix techniques (à rédiger pour la soutenance)
|
||||
|
||||
Explique **pourquoi** tu as fait ces choix (le sujet l’exige) :
|
||||
|
||||
1. **Chaîne** : …
|
||||
2. **Langage / outils** (Solidity, Hardhat, Remix, etc.) : …
|
||||
3. **Bibliothèques** (ex. OpenZeppelin) : …
|
||||
4. **Modèle économique** (supply, mint, decimals) : …
|
||||
5. **Sécurité** (ownership, privilèges, ce qui est interdit) : …
|
||||
|
||||
## Structure du dépôt
|
||||
|
||||
```
|
||||
README.md ← ce fichier
|
||||
code/ ← sources du smart contract
|
||||
deployment/ ← scripts et infos de déploiement
|
||||
documentation/ ← comment utiliser le token
|
||||
```
|
||||
|
||||
## Lancer / tester (à adapter selon ta stack)
|
||||
|
||||
Exemple avec Hardhat dans `code/` :
|
||||
|
||||
```bash
|
||||
cd code
|
||||
npm install
|
||||
npx hardhat compile
|
||||
npx hardhat test
|
||||
```
|
||||
|
||||
Déploiement (exemple) :
|
||||
|
||||
```bash
|
||||
# depuis deployment/ ou via script documenté dans deployment/README.md
|
||||
```
|
||||
|
||||
**Ne jamais committer** de clé privée. Utiliser un fichier `.env` local (voir `.env.example` si présent).
|
||||
|
||||
## Démo en évaluation (actions minimales)
|
||||
|
||||
1. Montrer le contrat sur l’**explorer** (adresse + token).
|
||||
2. **Transfer** entre deux comptes de test.
|
||||
3. Expliquer **owner** et les fonctions restreintes (ex. `mint` `onlyOwner`).
|
||||
4. Montrer que la **documentation/** permet d’utiliser le token sans ton aide.
|
||||
|
||||
## Bonus
|
||||
|
||||
*(Si implémenté : multisig — décrire ici où se trouve le code et comment le tester.)*
|
||||
|
||||
## Vidéo démo (optionnel)
|
||||
|
||||
*(Lien uniquement — la vidéo n’est pas requise et n’améliore pas la note.)*
|
||||
|
||||
## Ressources
|
||||
|
||||
- [BNB Chain Testnet Faucet](https://www.bnbchain.org/en/testnet-faucet)
|
||||
- [BscScan Testnet](https://testnet.bscscan.com/)
|
||||
14
tokenizerRendu/code/README.md
Normal file
14
tokenizerRendu/code/README.md
Normal file
@@ -0,0 +1,14 @@
|
||||
# Code — smart contract(s)
|
||||
|
||||
Place ici les sources du token (ex. `contracts/`, `hardhat.config.js`, tests).
|
||||
|
||||
**Exigences sujet :** code commenté, noms de variables et fonctions explicites, standard **BEP-20** (ou équivalent documenté).
|
||||
|
||||
## Commandes (à compléter)
|
||||
|
||||
```bash
|
||||
# Exemple Hardhat — adapter
|
||||
npm install
|
||||
npx hardhat compile
|
||||
npx hardhat test
|
||||
```
|
||||
11
tokenizerRendu/deployment/README.md
Normal file
11
tokenizerRendu/deployment/README.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# Déploiement
|
||||
|
||||
Scripts, configuration réseau et **adresses déployées** (ex. `addresses.json`).
|
||||
|
||||
Après déploiement sur **testnet public** :
|
||||
|
||||
1. Noter l’adresse du contrat.
|
||||
2. Vérifier le contrat sur l’explorer (BscScan testnet ou équivalent).
|
||||
3. Reporter réseau + adresse dans le [README racine](../README.md).
|
||||
|
||||
**Ne pas versionner** de clé privée — utiliser `.env` local.
|
||||
13
tokenizerRendu/documentation/README.md
Normal file
13
tokenizerRendu/documentation/README.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# Documentation du token
|
||||
|
||||
Ce dossier est évalué en soutenance : il doit permettre de **comprendre** le token et de **l’utiliser** (wallet, transferts, rôle du token).
|
||||
|
||||
## Contenu à rédiger
|
||||
|
||||
1. **Présentation** — à quoi sert ce token (même dans un cadre pédagogique).
|
||||
2. **Réseau et adresse** — lien vers l’explorer.
|
||||
3. **Guide d’utilisation** — ajouter le token dans un wallet, effectuer un transfert.
|
||||
4. **Sécurité et gouvernance** — owner, mint, limites connues.
|
||||
5. **(Optionnel)** `WHITEPAPER.md` — vision et fonctionnalités sur 1–2 pages.
|
||||
|
||||
Ce fichier est distinct de la documentation **dev** du dépôt perso (`docs/` à la racine du dépôt de travail).
|
||||
Reference in New Issue
Block a user