From 7e50c49c9dd7b9c5e3c1f670eeed435bafa3a95e Mon Sep 17 00:00:00 2001 From: c8e4 Date: Thu, 23 May 2024 21:41:00 +0200 Subject: [PATCH] fix docs --- docs/01-Summary.md | 2 +- docs/05-KYA.md | 2 +- docs/README.md | 5 ++--- 3 files changed, 4 insertions(+), 5 deletions(-) diff --git a/docs/01-Summary.md b/docs/01-Summary.md index 60625fd..bd8be18 100644 --- a/docs/01-Summary.md +++ b/docs/01-Summary.md @@ -32,5 +32,5 @@ All transactions are settled on L1 and incur a transaction fee. CrystalPool main **Smart Contracts:** The project includes smart contracts for Deposit, Swap, Buy, and Sell operations. These contracts require more testing and audits. -**Potential Loss of Unsubmitted Transaction:** +**Potential Loss of Unsubmitted Transactions:** In an environment characterized by a constantly busy mempool and rising transaction fees, it is conceivable to imagine a scenario where an unsubmitted transaction tree with a low-fee root cannot be submitted before the unlock height. diff --git a/docs/05-KYA.md b/docs/05-KYA.md index 731d793..c0a56ea 100644 --- a/docs/05-KYA.md +++ b/docs/05-KYA.md @@ -6,5 +6,5 @@ All transactions are settled on L1 and incur a transaction fee. CrystalPool main **Smart Contracts:** The project includes smart contracts for Deposit, Swap, Buy, and Sell operations. These contracts reuire more testing and audits. -**Potential Loss of Unsubmitted Transaction:** +**Potential Loss of Unsubmitted Transactions:** In an environment characterized by a constantly busy mempool and rising transaction fees, it is conceivable to imagine a scenario where an unsubmitted transaction tree with a low-fee root cannot be submitted before the unlock height. \ No newline at end of file diff --git a/docs/README.md b/docs/README.md index 3a073a0..a8fb567 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,10 +4,9 @@ Welcome to the CrystalPool project documentation. This book provides an in-depth ## Table of Contents -- [Abstract](01-Abstract.md) +- [Summary](01-Summary.md) - [Project Goals](02-Project-Goals.md) - [Key Components](03-Key-Components.md) - [Built-in Wallet](04-Built-in-Wallet.md) -- [Know Your Asset (KYA)](05-KYA.md) +- [Know Your Assumtions (KYA)](05-KYA.md) - [Smart Contracts](06-Smart-Contracts.md) -- [Risk Vectors and Mitigations](07-Risk-Vectors-and-Mitigations.md)