Skip to content

Commit

Permalink
fix typo, improve landing page
Browse files Browse the repository at this point in the history
  • Loading branch information
c8e4 committed Jun 2, 2024
1 parent 885e23f commit 2298b73
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 14 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ CrystalPool provides real-time balance and state updates. Each trading action ge
To enhance the user experience, a built-in wallet is integrated into the trading client. The trading UI manages user balances based on the latest DEPOSIT, SWAP, BUY, and SELL activities. This built-in wallet ensures a seamless experience by signing transactions in the background. To maintain a trustless process, each transaction presents a simple summary **integrated in the UI** to the user, who can then choose to confirm or discard it.


**Know Your Assumtions (KYA)**
**Know Your Assumptions (KYA)**

**Protocol:**
All transactions are settled on L1 and incur a transaction fee. CrystalPool maintains a public set of unsubmitted transactions, with real-time balance calculations based on the latest known state. Security is ensured as CrystalPool cannot move user balances without the userPK. In case of service shutdown, users can withdraw their deposits/orders after the unlockHeight period.
Expand Down
2 changes: 1 addition & 1 deletion docs/01-Summary.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ CrystalPool provides real-time balance and state updates. Each trading action ge
To enhance the user experience, a built-in wallet is integrated into the trading client. The trading UI manages user balances based on the latest DEPOSIT, SWAP, BUY, and SELL activities. This built-in wallet ensures a seamless experience by signing transactions in the background. To maintain a trustless process, each transaction presents a simple summary **integrated in the UI** to the user, who can then choose to confirm or discard it.


**Know Your Assumtions (KYA)**
**Know Your Assumptions (KYA)**

**Protocol:**
All transactions are settled on L1 and incur a transaction fee. CrystalPool maintains a public set of unsubmitted transactions. User funds are protected by userPK at the level of smart-contracts. In case of service shutdown, users can withdraw their deposits/orders after the unlockHeight period.
Expand Down
2 changes: 1 addition & 1 deletion docs/06-KYA.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
**Know Your Assumtions (KYA)**
**Know Your Assumptions (KYA)**

**Protocol:**
All transactions are settled on L1 and incur a transaction fee. CrystalPool maintains a public set of unsubmitted transactions. User funds are protected by userPK at the level of smart-contracts. In case of service shutdown, users can withdraw their deposits/orders after the unlockHeight period.
Expand Down
14 changes: 4 additions & 10 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,14 @@
# CrystalPool: Instant trades on L1
# CrystalPool: Instant Trades on L1

Welcome to the CrystalPool documentation. This book provides an in-depth look into the development of a **self-custodial** limit order exchange on Ergo L1 with **instant** order execution and clear KYA.

## Screenshot
![CrystalPool UI](./ui.png?raw=true "CrystalPool UI")

![CrystalPool UI](./ui.png?raw=true "Crystal Pool UI")
Welcome to the CrystalPool documentation. This book provides an in-depth look into the development of a **self-custodial** limit order exchange on Ergo L1 with **instant** order execution and clear KYA.

## Table of Contents

- [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 Assumtions (KYA)](05-KYA.md)
- [Know Your Assumptions (KYA)](05-KYA.md)
- [Smart Contracts](06-Smart-Contracts.md)

## Screenshot

![CrystalPool UI](./ui.png?raw=true "Crystal Pool UI")
2 changes: 1 addition & 1 deletion docs/_sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@
- [Built-in Wallet](03-Built-in-Wallet.md)
- [Token Swap Example](04-Token-Swap-Example.md)
- [Smart Contracts](05-Smart-Contracts.md)
- [Know Your Assumtions (KYA)](06-KYA.md)
- [Know Your Assumptions (KYA)](06-KYA.md)

0 comments on commit 2298b73

Please sign in to comment.