Skip to content

Commit 3d751a5

Browse files
AzimovSescottalexander
authored andcommitted
docs: fix typo and formatting
1 parent b8fc7a6 commit 3d751a5

File tree

1 file changed

+10
-17
lines changed

1 file changed

+10
-17
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 10 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -382,7 +382,7 @@ yarn simulate:whitelist
382382

383383
* ⛔️ Reverts if no valid prices are available
384384

385-
**### πŸ€” Key Insights:**
385+
### πŸ€” Key Insights:
386386

387387
- **Economic Incentives**: Nodes stake ETH and can be slashed for bad behavior, where in contrast, good behavior rewards the nodes with ORA token
388388
- **Decentralized**: Anyone can participate by staking, no central authority needed
@@ -402,7 +402,7 @@ yarn simulate:staking
402402

403403
πŸ€– This will start automated bots that simulate honest and malicious node behavior, frequent and stale reports, and demonstrate how slashing and median aggregation impact the reported price. You can update the price variance and skip probability from the front-end as well.
404404

405-
**### πŸ₯… Goals:**
405+
### πŸ₯… Goals:
406406

407407
- Understand how economic incentives drive honest behavior
408408
- See how slashing mechanisms enforce data freshness
@@ -471,7 +471,7 @@ sequenceDiagram
471471

472472
πŸ” Open the `packages/hardhat/contracts/02_Optimistic/OptimisticOracle.sol` file to implement the optimistic oracle functionality.
473473

474-
**### ✏️ Tasks:**
474+
### ✏️ Tasks:
475475

476476
1. **Implement `assertEvent(string memory description, uint256 startTime, uint256 endTime)`**
477477

@@ -502,7 +502,7 @@ Here are more granular instructions on setting up the EventAssertion struct:
502502
- reward should be `msg.value`
503503
- bond should be `FIXED_BOND`
504504
- startTime = `startTime`
505-
- endTime = `endTIme`
505+
- endTime = `endTime`
506506
- description = `description`
507507
- any remaining properties can be initialized with the default values (`false`, `address(0)`, etc.)
508508

@@ -815,7 +815,7 @@ This function enables the asserter to get a refund of their posted reward when n
815815

816816
This is the method that the decider will call to settle whether the proposer or disputer are correct.
817817

818-
It should be;
818+
It should be:
819819

820820
* πŸ§‘β€βš–οΈ Only callable by the `decider` contract
821821

@@ -973,7 +973,7 @@ yarn simulate:optimistic
973973

974974
πŸ€– This will start automated bots that create assertions, propose outcomes, dispute proposals, and settle via the decider, so you can observe rewards, bonds, fees, and timing windows in a realistic flow.
975975

976-
**### πŸ₯… Goals:**
976+
### πŸ₯… Goals:
977977

978978
- Users can assert events with descriptions and time windows
979979
- Users can propose outcomes for asserted events
@@ -987,23 +987,16 @@ yarn simulate:optimistic
987987

988988
🧠 Now let's analyze the strengths and weaknesses of each oracle design.
989989

990-
**### πŸ“Š Comparison Table:**
991-
990+
### πŸ“Š Comparison Table:
992991
| Aspect | Whitelist Oracle | Staking Oracle | Optimistic Oracle |
993-
994992
|--------|------------------|----------------|-------------------|
995-
996993
| **Speed** | Fast | Medium | Slow |
997-
998994
| **Security** | Low (trusted authority) | Medium (economic incentives) | High (dispute resolution) |
999-
1000995
| **Decentralization** | Low | High | Medium |
1001-
1002996
| **Cost** | Low | Medium | High |
1003-
1004997
| **Complexity** | Simple | Medium | Complex |
1005998

1006-
**### πŸ€” Key Trade-offs:**
999+
### πŸ€” Key Trade-offs:
10071000

10081001
1. **Whitelist Oracle:**
10091002

@@ -1037,7 +1030,7 @@ yarn simulate:optimistic
10371030

10381031
- ❌ More complex
10391032

1040-
**### 🎯 Understanding the "Why":**
1033+
### 🎯 Understanding the "Why":
10411034

10421035
Each oracle design solves different problems:
10431036

@@ -1083,7 +1076,7 @@ Each oracle design solves different problems:
10831076
10841077
> 🦊 Since we have deployed to a public testnet, you will now need to connect using a wallet you own or use a burner wallet. By default πŸ”₯ `burner wallets` are only available on `hardhat` . You can enable them on every chain by setting `onlyLocalBurnerWallet: false` in your frontend config (`scaffold.config.ts` in `packages/nextjs/`)
10851078
1086-
**#### Configuration of Third-Party Services for Production-Grade Apps.**
1079+
#### Configuration of Third-Party Services for Production-Grade Apps.
10871080

10881081
By default, πŸ— Scaffold-ETH 2 provides predefined API keys for popular services such as Alchemy and Etherscan. This allows you to begin developing and testing your applications more easily, avoiding the need to register for these services.
10891082

0 commit comments

Comments
Β (0)