Skip to content

Commit f8a0210

Browse files
Merge pull request #67 from chronicleprotocol/ScaffoldF2
Update example to Foundry
2 parents c17e7b5 + 3364e1b commit f8a0210

File tree

2 files changed

+19
-24
lines changed

2 files changed

+19
-24
lines changed

docs/Developers/tutorials/boilerplate.md

Lines changed: 19 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,26 @@
11
# Boilerplate
22

3-
## Scaffold Eth 2 + Chronicle
3+
## Scaffold-ETH2 + Chronicle
4+
5+
<div style={{textAlign: 'center'}}>
6+
<img
7+
src="/img/Developers/Boilerplate/OracleReader.png"
8+
alt="Oracle Reader"
9+
/>
10+
</div>
411

512
:::info
6-
Please be aware that, as the project currently stands, you should use **Hardhat** in terms of programming environments, and deploy your contracts to the **Sepolia** network.
13+
Please be aware that, as the project currently stands, you should use **Foundry** in terms of programming environments, and deploy your contracts to the **Sepolia** network.
714
:::
815

9-
Please refer to the following [GitHub repo](https://github.com/chronicleprotocol/scaffold-oracle-reader) to take advantage of the boilerplate we have created in conjuction with Scaffold-Eth 2.
16+
Please refer to the following [GitHub Repo](https://github.com/chronicleprotocol/scaffold-oracle-reader) to take advantage of the boilerplate we have created in conjunction with [Scaffold-ETH2](https://scaffoldeth.io/).
1017

1118

1219
To find our `OracleReader.sol` contract, follow the following path:
1320

1421
```
1522
- packages
16-
- hardhat
23+
- foundry
1724
- contracts
1825
- OracleReader.sol
1926
```
@@ -72,37 +79,25 @@ interface ISelfKisser {
7279
Add your environment variables in the `.env.example` file and rename it to `.env`:
7380
```
7481
- packages
75-
- hardhat
82+
- foundry
7683
- .env.example
7784
```
7885
7986
```js
8087
/*
81-
* Template for Hardhat environment variables.
88+
* Template for environment variables.
8289
* To use this template, copy this file, rename it .env, and fill in the values.
83-
* If not set, we provide default values (check `hardhat.config.ts`) so developers can start prototyping out of the box,
84-
* but we recommend getting your own API Keys for Production Apps.
85-
* The Chronicle ETH/USD oracle on Sepolia.
90+
* The Chronicle ETH/USD Oracle on Sepolia.
8691
*/
8792

88-
CHRONICLE_ORACLE=0xdd6D76262Fd7BdDe428dcfCd94386EbAe0151603
89-
90-
// The Chronicle SelfKisser contract on Sepolia.
91-
SELF_KISSER=0x0Dcc19657007713483A5cA76e6A7bbe5f56EA37d
92-
93-
// To access the values stored in this .env file you can use: process.env.VARIABLENAME
94-
ALCHEMY_API_KEY=
9593
DEPLOYER_PRIVATE_KEY=
9694
ETHERSCAN_API_KEY=
97-
```
98-
99-
The ETH/USD oracle and self-kisser addresses have been added to the .env.example file.
100-
101-
If you would run a Sepolia fork, you can deploy the contract using:
95+
ALCHEMY_API_KEY=
10296

103-
```bash
104-
yarn deploy --tags OracleReader
97+
# The Chronicle ETH/USD Oracle on Sepolia.
98+
CHRONICLE_ORACLE=0xdd6D76262Fd7BdDe428dcfCd94386EbAe0151603
99+
# The Chronicle SelfKisser contract on Sepolia.
100+
SELF_KISSER=0x0Dcc19657007713483A5cA76e6A7bbe5f56EA37d
105101
```
106102
107103
108-
253 KB
Loading

0 commit comments

Comments
 (0)