Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update ARCHITECTURE.md #197

Merged
merged 32 commits into from
Jun 11, 2024
Merged

docs: update ARCHITECTURE.md #197

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
673d977
docs: add wip, update ARCHITECTURE.md
DefiCake May 30, 2024
b2b0338
docs: add wip, block committing and incoming messages
DefiCake May 31, 2024
ea201b2
docs: add wip, architecture update, withdrawal of eth
DefiCake May 31, 2024
4e459f0
docs: add wip, update ARCHITECTURE.md withdrawal and fix some typos
DefiCake Jun 3, 2024
7feb576
docs: add wip, update ARCHITECTURE.md, decimal adjustments
DefiCake Jun 3, 2024
5141a17
docs: add wip, update ARCHITECTURE.md with SPoFs and risks
DefiCake Jun 3, 2024
da81ff4
chore: add changeset
DefiCake Jun 3, 2024
2e08fa6
docs: update getting started
DefiCake Jun 3, 2024
486deb1
Merge branch 'main' into deficake/167-update-docs
DefiCake Jun 3, 2024
2da6b01
docs: update ARCHITECTURE.md
DefiCake Jun 3, 2024
bc3bf81
docs: fix sections in ARCHITECTURE.md
DefiCake Jun 3, 2024
ce0bdbf
docs: add a general architecture diagram (hand written), and remove c…
DefiCake Jun 4, 2024
7932cde
Merge branch 'deficake/167-update-docs' of github.com:FuelLabs/fuel-b…
DefiCake Jun 4, 2024
c25e586
docs: apply prettier
DefiCake Jun 4, 2024
56ad03c
docs: add more context to some parts
DefiCake Jun 5, 2024
caf335d
docs: apply prettier
DefiCake Jun 5, 2024
3d93b4f
Update docs/ARCHITECTURE.md
DefiCake Jun 5, 2024
047bd41
Update docs/ARCHITECTURE.md
DefiCake Jun 5, 2024
857601c
Update docs/ARCHITECTURE.md
DefiCake Jun 5, 2024
973ac71
Update docs/ARCHITECTURE.md
DefiCake Jun 5, 2024
8dbcca2
Update docs/ARCHITECTURE.md
DefiCake Jun 5, 2024
f6777cd
Update docs/ARCHITECTURE.md
DefiCake Jun 5, 2024
fbdead3
Update docs/ARCHITECTURE.md
DefiCake Jun 5, 2024
dbfaf26
Update docs/ARCHITECTURE.md
DefiCake Jun 5, 2024
e76e6c7
Update docs/ARCHITECTURE.md
DefiCake Jun 5, 2024
b9061a3
Update docs/ARCHITECTURE.md
DefiCake Jun 5, 2024
3f43384
docs: apply prettier:format
DefiCake Jun 6, 2024
225fd60
Merge branch 'main' into deficake/167-update-docs
DefiCake Jun 6, 2024
73239ee
docs: small fix
DefiCake Jun 6, 2024
b8d57e9
Merge branch 'deficake/167-update-docs' of github.com:FuelLabs/fuel-b…
DefiCake Jun 6, 2024
351943f
docs: remove background color in diagram groupings
DefiCake Jun 6, 2024
49ea73f
Merge branch 'main' into deficake/167-update-docs
DefiCake Jun 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .changeset/few-pugs-cheat.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
'@fuel-bridge/fungible-token': patch
'@fuel-bridge/message-predicates': patch
'@fuel-bridge/solidity-contracts': patch
'@fuel-bridge/test-utils': patch
---

Update documentation
397 changes: 352 additions & 45 deletions docs/ARCHITECTURE.md
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/GETTING_STARTED.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This project includes both frontend and contracts. To begin, install dependencie
- [Docker v20.0.21 or latest stable](https://docs.docker.com/get-docker/)
- [Docker Compose v2.15.1 or latest stable](https://docs.docker.com/get-docker/)
- [Rust v1.74.1 or latest `stable`](https://www.rust-lang.org/tools/install)
- [Forc v0.54.0 with latest toolchain](https://install.fuel.network/latest)
- [Forc v0.60.0 with latest toolchain](https://install.fuel.network/latest)

## Running Project Locally

Expand Down
Binary file added docs/architecture.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/block_committing.png
View file
Open in desktop
Binary file not shown.
Binary file removed docs/l1_deposit.png
View file
Open in desktop
Binary file not shown.
Binary file removed docs/l2_withdrawal.png
View file
Open in desktop
Binary file not shown.
Loading