Skip to content

Commit 448b532

Browse files
committed
Folder structure and openzeppelin installation
1 parent 4fc6a1f commit 448b532

File tree

5 files changed

+61
-1
lines changed

5 files changed

+61
-1
lines changed

.gitmodules

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
11
[submodule "lib/forge-std"]
22
path = lib/forge-std
33
url = https://github.com/foundry-rs/forge-std
4+
[submodule "lib/openzeppelin-contracts"]
5+
path = lib/openzeppelin-contracts
6+
url = https://github.com/openzeppelin/openzeppelin-contracts

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,8 @@
1-
Our stable
1+
1. Relative Stability: Anchored or Pegged -> $1.00
2+
1. Chainlink Price feed.
3+
2. Set a function to exchange ETH & BTC -> $$$
4+
2. Stability Mechanism (Minting): Algorithmic (Decentralized)
5+
1. People can only mint the stable coin with enough collateral (coded)
6+
3. Collateral: Exagenous (Crypto)
7+
1. wETH
8+
2. wBTC

foundry.lock

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,11 @@
44
"name": "v1.12.0",
55
"rev": "7117c90c8cf6c68e5acce4f09a6b24715cea4de6"
66
}
7+
},
8+
"lib/openzeppelin-contracts": {
9+
"tag": {
10+
"name": "v5.5.0",
11+
"rev": "fcbae5394ae8ad52d8e580a3477db99814b9d565"
12+
}
713
}
814
}

lib/openzeppelin-contracts

Submodule openzeppelin-contracts added at fcbae53

src/DecentralizedStableCoin.sol

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
// SPDX-License-Identifier: MIT
2+
3+
// This is considered an Exogenous, Decentralized, Anchored (pegged), Crypto Collateralized low volitility coin
4+
5+
// Layout of Contract:
6+
// version
7+
// imports
8+
// interfaces, libraries, contracts
9+
// errors
10+
// Type declarations
11+
// State variables
12+
// Events
13+
// Modifiers
14+
// Functions
15+
16+
// Layout of Functions:
17+
// constructor
18+
// receive function (if exists)
19+
// fallback function (if exists)
20+
// external
21+
// public
22+
// internal
23+
// private
24+
// view & pure functions
25+
26+
pragma solidity ^0.8.18;
27+
28+
import
29+
30+
/**
31+
* @title DecentralizedStableCoin
32+
* @author Kalyan
33+
* Collateral: Exogenous (ETH & BTC)
34+
* Minting: Algorithmic
35+
* Relative Stability: Pegged to USD
36+
*
37+
* This is the contract meant to be governed by DSCEngine. This contract is just the ERC20 implementaion of our stablecoin system.
38+
*
39+
*/
40+
41+
contract DecentralizedStableCoin {
42+
constructor() {}
43+
}

0 commit comments

Comments
 (0)