Update README with architecture diagram and comprehensive docs#35
Merged
Update README with architecture diagram and comprehensive docs#35
Conversation
|
🚀 Preview deployed! Worker: |
Contributor
Author
|
@Asem-Abdelhady pls |
Asem-Abdelhady
approved these changes
Apr 11, 2026
Asem-Abdelhady
left a comment
Asem-Abdelhady
left a comment
There was a problem hiding this comment.
The comments are just suggestions
| direction TB | ||
| Page["+page.svelte"] | ||
| S0["Connect Wallet"] | ||
| S1["Manage Deposit"] |
There was a problem hiding this comment.
I would call it "Intent Configuration" since we choose here the chain and the input type as well.
| The app exposes six sequential screens, each representing one step in the OIF flow. | ||
|
|
||
| - **Connect Wallet** connects via Web3-Onboard (injected wallets, Coinbase, WalletConnect, Zeal) | ||
| - **Manage Deposit** lets you choose between escrow and compact locking, then deposit or withdraw tokens from The Compact |
| ``` | ||
| src/ | ||
| lib/ | ||
| abi/ # contract ABIs (Compact, Escrow, CoinFiller, Polymer Oracle, etc.) |
There was a problem hiding this comment.
Suggested change
| abi/ # contract ABIs (Compact, Escrow, CoinFiller, Polymer Oracle, etc.) | |
| abi/ # contract ABIs (Compact, Escrow, CoinFiller Output Settler, Polymer Oracle, etc.) |
| src/ | ||
| lib/ | ||
| abi/ # contract ABIs (Compact, Escrow, CoinFiller, Polymer Oracle, etc.) | ||
| libraries/ # core logic (Intent, IntentFactory, OrderServer, Solver, CompactLib) |
There was a problem hiding this comment.
Suggested change
| libraries/ # core logic (Intent, IntentFactory, OrderServer, Solver, CompactLib) | |
| libraries/ # core logic (Intent, IntentFactory, OrderServer, Solver, CompactLib, etc.) |
to be consistent
| abi/ # contract ABIs (Compact, Escrow, CoinFiller, Polymer Oracle, etc.) | ||
| libraries/ # core logic (Intent, IntentFactory, OrderServer, Solver, CompactLib) | ||
| screens/ # SvelteKit components for each step in the flow | ||
| utils/ # helpers (EIP-712 typed data, order validation, address encoding) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Test plan