docs: update ARCHITECTURE.md #197

DefiCake · 2024-05-30T19:56:15Z

Closes #167

github-actions · 2024-05-30T20:00:00Z

This PR is published in NPM with version 0.6.0-pr-197-49

…onfusions around incoming / outgoing messages

…ridge into deficake/167-update-docs

BarneyChambers

+1 from me, the diagrams makes sense and are clear.

Some amendments to consider for future iterations:

Some terms could use further explanation to help users with less context on the use-case of the bridge. For example, "sequencers" and "epochs" could be briefly defined.
The think this sentence could be elaborated on for more context: The system features sending messages in both directions (L1 to L2, and L2 to L1), though the mechanisms involved for each direction are different and almost independent.
It would be nice to add some bullet points in the Message Passing from L1 to L2 portion, to be able to understand the flow a little better, eg:

-- An entity on L1 calls sendMessage on the Message Portal.
-- The sendMessage function emits a MessageSent event.
-- Fuel's sequencers detect the event and include the message in the next L2 block as a UTXO.
-- The L2 block header's inbox reflects the message.

DefiCake · 2024-06-05T15:16:37Z

Added additional context around the raised points

+1 from me, the diagrams makes sense and are clear.

Some amendments to consider for future iterations:

Some terms could use further explanation to help users with less context on the use-case of the bridge. For example, "sequencers" and "epochs" could be briefly defined.

The think this sentence could be elaborated on for more context: The system features sending messages in both directions (L1 to L2, and L2 to L1), though the mechanisms involved for each direction are different and almost independent.

It would be nice to add some bullet points in the Message Passing from L1 to L2 portion, to be able to understand the flow a little better, eg:

-- An entity on L1 calls sendMessage on the Message Portal. -- The sendMessage function emits a MessageSent event. -- Fuel's sequencers detect the event and include the message in the next L2 block as a UTXO. -- The L2 block header's inbox reflects the message.

K1-R1

LGTM, just some docs nits

docs/ARCHITECTURE.md

Co-authored-by: K1-R1 <77465250+K1-R1@users.noreply.github.com>

DefiCake · 2024-06-05T17:39:01Z

LGTM, just some docs nits

I will refrain from using apostrophes on written text from here on. I think I have done enough harm already.

docs/ARCHITECTURE.md

BarneyChambers · 2024-06-06T13:08:02Z

docs/ARCHITECTURE.md

+    participant portal as FuelMessagePortal.sol
+    end
+
+    box darkgreen FUEL


changing this to lightgreen makes it much easier to read

docs/ARCHITECTURE.md

…ridge into deficake/167-update-docs

@SwayStar123

This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated. # Releases ## @fuel-bridge/fungible-token@0.6.0 ### Minor Changes - Upgrade all dependencies to fuel-core 0.27, by [@SwayStar123](https://github.com/SwayStar123) (See [#201](#201)) - Bump ts-sdk to 0.94.4, by [@DefiCake](https://github.com/DefiCake) (See [#277](#277)) - remove unused mapping, by [@viraj124](https://github.com/viraj124) (See [#258](#258)) - Architecture revamp featuring single asset issuer on L2, by [@DefiCake](https://github.com/DefiCake) (See [#150](#150)) - Bump all packages to adhere to fuel-core 0.26, forc 0.56, fuel-rs 0.60, fuel-ts 0.85, by [@DefiCake](https://github.com/DefiCake) (See [#180](#180)) - Update forc to 0.63.3, by [@DefiCake](https://github.com/DefiCake) (See [#265](#265)) - Upgraded fuel dependencies to fuel-core 0.33, by [@DefiCake](https://github.com/DefiCake) (See [#237](#237)) - Implement SRC-7 and SRC-20, by [@DefiCake](https://github.com/DefiCake) (See [#240](#240)) - Added upgradability to bridge contracts, by [@DefiCake](https://github.com/DefiCake) (See [#164](#164)) - Add typegen for fuel ts sdk and a deploy script for the bridge. Bump fuel-core to v0.31.0, by [@DefiCake](https://github.com/DefiCake) (See [#222](#222)) - Upgraded ts-sdk to 0.94.3, by [@DefiCake](https://github.com/DefiCake) (See [#271](#271)) - Use custom error for relay unknown error reverts, by [@DefiCake](https://github.com/DefiCake) (See [#178](#178)) - Update fuel-core to v0.26.0 and all sdk dependencies needed to track it, by [@DefiCake](https://github.com/DefiCake) (See [#161](#161)) ### Patch Changes - Update documentation, by [@DefiCake](https://github.com/DefiCake) (See [#197](#197)) - Use L1 token decimals to determine L2 token decimals, by [@DefiCake](https://github.com/DefiCake) (See [#166](#166)) - Add reentrancy unit test for l2 proxy-bridge, by [@DefiCake](https://github.com/DefiCake) (See [#221](#221)) - Add comments to Hexens audit. Fix some other in-code commentary, by [@DefiCake](https://github.com/DefiCake) (See [#177](#177)) - Remove unused code in L2 bridge, by [@DefiCake](https://github.com/DefiCake) (See [#259](#259)) - Removed unused and vulnerable npm dependencies, by [@DefiCake](https://github.com/DefiCake) (See [#212](#212)) - Bump forc and ts version, by [@DefiCake](https://github.com/DefiCake) (See [#162](#162)) ## @fuel-bridge/message-predicates@0.6.0 ### Minor Changes - Upgrade all dependencies to fuel-core 0.27, by [@SwayStar123](https://github.com/SwayStar123) (See [#201](#201)) - Bump all packages to adhere to fuel-core 0.26, forc 0.56, fuel-rs 0.60, fuel-ts 0.85, by [@DefiCake](https://github.com/DefiCake) (See [#180](#180)) - Upgraded fuel dependencies to fuel-core 0.33, by [@DefiCake](https://github.com/DefiCake) (See [#237](#237)) - Implement SRC-7 and SRC-20, by [@DefiCake](https://github.com/DefiCake) (See [#240](#240)) - Added upgradability to bridge contracts, by [@DefiCake](https://github.com/DefiCake) (See [#164](#164)) - Update fuel-core to v0.26.0 and all sdk dependencies needed to track it, by [@DefiCake](https://github.com/DefiCake) (See [#161](#161)) ### Patch Changes - Update documentation, by [@DefiCake](https://github.com/DefiCake) (See [#197](#197)) - Removed unused and vulnerable npm dependencies, by [@DefiCake](https://github.com/DefiCake) (See [#212](#212)) - Bump forc and ts version, by [@DefiCake](https://github.com/DefiCake) (See [#162](#162)) ## @fuel-bridge/solidity-contracts@0.6.0 ### Minor Changes - add eth rate limiter, by [@viraj124](https://github.com/viraj124) (See [#228](#228)) - Adds FuelMessagePortalV3 with increased granularity on withdrawals control, by [@DefiCake](https://github.com/DefiCake) (See [#148](#148)) - Adapted deployments for a full e2e environment, and minor util adaptions to anvil quirks, by [@DefiCake](https://github.com/DefiCake) (See [#229](#229)) - 🐞 fix pnpm audit findings, by [@PraneshASP](https://github.com/PraneshASP) (See [#247](#247)) - reset rate limit script, by [@viraj124](https://github.com/viraj124) (See [#254](#254)) - Added FuelChainState setter to FuelMessagePortalV3, by [@DefiCake](https://github.com/DefiCake) (See [#234](#234)) - Deploy devnet and testnet contracts, by [@DefiCake](https://github.com/DefiCake) (See [#175](#175)) - 🐞 Fix depositToken naming, by [@DefiCake](https://github.com/DefiCake) (See [#273](#273)) - 🐞 Fix ECDSA test flakiness, by [@DefiCake](https://github.com/DefiCake) (See [#144](#144)) - Add recommit protection in FuelChainState, by [@DefiCake](https://github.com/DefiCake) (See [#174](#174)) - remove unused mapping, by [@viraj124](https://github.com/viraj124) (See [#258](#258)) - Architecture revamp featuring single asset issuer on L2, by [@DefiCake](https://github.com/DefiCake) (See [#150](#150)) - Ported @fuel-contracts/merkle-sol utils, by [@DefiCake](https://github.com/DefiCake) (See [#196](#196)) - FuelChainState is now configurable in deployment scripts, by [@DefiCake](https://github.com/DefiCake) (See [#204](#204)) - erc20 rate limit, by [@viraj124](https://github.com/viraj124) (See [#239](#239)) - Bump all packages to adhere to fuel-core 0.26, forc 0.56, fuel-rs 0.60, fuel-ts 0.85, by [@DefiCake](https://github.com/DefiCake) (See [#180](#180)) - add `_disableInitializers()` to FuelMessagePortal V2 and V3, by [@PraneshASP](https://github.com/PraneshASP) (See [#248](#248)) - Add relay deposit script, by [@DefiCake](https://github.com/DefiCake) (See [#266](#266)) - add disable initializer in erc20 v4 gateway, by [@viraj124](https://github.com/viraj124) (See [#261](#261)) - Added upgradability to bridge contracts, by [@DefiCake](https://github.com/DefiCake) (See [#164](#164)) - Extract CommonPredicates lib into its own file, by [@DefiCake](https://github.com/DefiCake) (See [#142](#142)) - Use custom error for relay unknown error reverts, by [@DefiCake](https://github.com/DefiCake) (See [#178](#178)) - Update fuel-core to v0.26.0 and all sdk dependencies needed to track it, by [@DefiCake](https://github.com/DefiCake) (See [#161](#161)) - Added hardhat scripts, by [@DefiCake](https://github.com/DefiCake) (See [#190](#190)) - add zero address check for asset issuer id, by [@viraj124](https://github.com/viraj124) (See [#250](#250)) ### Patch Changes - Deployment of new devnet, by [@DefiCake](https://github.com/DefiCake) (See [#157](#157)) - Add deprecation notices and use better folder grouping, by [@DefiCake](https://github.com/DefiCake) (See [#171](#171)) - Update documentation, by [@DefiCake](https://github.com/DefiCake) (See [#197](#197)) - Add nonce to FTI interface, by [@DefiCake](https://github.com/DefiCake) (See [#155](#155)) - Deploy new token bridge to devnet, by [@DefiCake](https://github.com/DefiCake) (See [#233](#233)) - 🐞 Fix encoding issue on FuelERC20GatewayV4.sendMetadata(), by [@DefiCake](https://github.com/DefiCake) (See [#169](#169)) - Add migration files of FuelChainState testnet upgrade - withdrawal period extension, by [@DefiCake](https://github.com/DefiCake) (See [#207](#207)) - Use L1 token decimals to determine L2 token decimals, by [@DefiCake](https://github.com/DefiCake) (See [#166](#166)) - 🐞 Fix CI on pnpm audit, by [@DefiCake](https://github.com/DefiCake) (See [#217](#217)) - Add FTI interface, by [@DefiCake](https://github.com/DefiCake) (See [#151](#151)) - Improve granularity of blacklisting permissions for messages in FuelMessagePortal, by [@DefiCake](https://github.com/DefiCake) (See [#168](#168)) - Add comments to Hexens audit. Fix some other in-code commentary, by [@DefiCake](https://github.com/DefiCake) (See [#177](#177)) - Added FuelChainState devnet and testnet redeploy artifacts, by [@DefiCake](https://github.com/DefiCake) (See [#235](#235)) - Reconfigured testnet and devnet contracts, by [@DefiCake](https://github.com/DefiCake) (See [#236](#236)) - Update testnet and devnet contracts, by [@DefiCake](https://github.com/DefiCake) (See [#185](#185)) - Removed unused and vulnerable npm dependencies, by [@DefiCake](https://github.com/DefiCake) (See [#212](#212)) ## @fuel-bridge/test-utils@0.6.0 ### Minor Changes - Improve message relay utils, by [@DefiCake](https://github.com/DefiCake) (See [#275](#275)) - Adapted deployments for a full e2e environment, and minor util adaptions to anvil quirks, by [@DefiCake](https://github.com/DefiCake) (See [#229](#229)) - Upgrade all dependencies to fuel-core 0.27, by [@SwayStar123](https://github.com/SwayStar123) (See [#201](#201)) - Bump ts-sdk to 0.94.4, by [@DefiCake](https://github.com/DefiCake) (See [#277](#277)) - 🐞 Fix depositToken naming, by [@DefiCake](https://github.com/DefiCake) (See [#273](#273)) - Architecture revamp featuring single asset issuer on L2, by [@DefiCake](https://github.com/DefiCake) (See [#150](#150)) - Bump all packages to adhere to fuel-core 0.26, forc 0.56, fuel-rs 0.60, fuel-ts 0.85, by [@DefiCake](https://github.com/DefiCake) (See [#180](#180)) - Add relay deposit script, by [@DefiCake](https://github.com/DefiCake) (See [#266](#266)) - add disable initializer in erc20 v4 gateway, by [@viraj124](https://github.com/viraj124) (See [#261](#261)) - Upgraded fuel dependencies to fuel-core 0.33, by [@DefiCake](https://github.com/DefiCake) (See [#237](#237)) - Implement SRC-7 and SRC-20, by [@DefiCake](https://github.com/DefiCake) (See [#240](#240)) - Added upgradability to bridge contracts, by [@DefiCake](https://github.com/DefiCake) (See [#164](#164)) - Add typegen for fuel ts sdk and a deploy script for the bridge. Bump fuel-core to v0.31.0, by [@DefiCake](https://github.com/DefiCake) (See [#222](#222)) - Upgraded ts-sdk to 0.94.3, by [@DefiCake](https://github.com/DefiCake) (See [#271](#271)) - Update fuel-core to v0.26.0 and all sdk dependencies needed to track it, by [@DefiCake](https://github.com/DefiCake) (See [#161](#161)) ### Patch Changes - Increase test coverage, by [@DefiCake](https://github.com/DefiCake) (See [#226](#226)) - Update documentation, by [@DefiCake](https://github.com/DefiCake) (See [#197](#197)) - Use ZeroBytes32 for witnesses at relayCommonMessage.ts, by [@DefiCake](https://github.com/DefiCake) (See [#193](#193)) - 🐞 Fix CI on pnpm audit, by [@DefiCake](https://github.com/DefiCake) (See [#217](#217)) - Removed unused and vulnerable npm dependencies, by [@DefiCake](https://github.com/DefiCake) (See [#212](#212)) - Bump forc and ts version, by [@DefiCake](https://github.com/DefiCake) (See [#162](#162)) Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

docs: add wip, update ARCHITECTURE.md

673d977

DefiCake self-assigned this May 30, 2024

DefiCake and others added 12 commits May 31, 2024 19:39

docs: add wip, block committing and incoming messages

b2b0338

docs: add wip, architecture update, withdrawal of eth

ea201b2

docs: add wip, update ARCHITECTURE.md withdrawal and fix some typos

4e459f0

docs: add wip, update ARCHITECTURE.md, decimal adjustments

7feb576

docs: add wip, update ARCHITECTURE.md with SPoFs and risks

5141a17

chore: add changeset

da81ff4

docs: update getting started

2e08fa6

Merge branch 'main' into deficake/167-update-docs

486deb1

docs: update ARCHITECTURE.md

2da6b01

docs: fix sections in ARCHITECTURE.md

bc3bf81

docs: add a general architecture diagram (hand written), and remove c…

ce0bdbf

…onfusions around incoming / outgoing messages

Merge branch 'deficake/167-update-docs' of github.com:FuelLabs/fuel-b…

7932cde

…ridge into deficake/167-update-docs

DefiCake requested review from luizstacio and a team June 4, 2024 10:07

docs: apply prettier

c25e586

DefiCake requested a review from BarneyChambers June 4, 2024 15:56

BarneyChambers previously approved these changes Jun 5, 2024

View reviewed changes

docs: add more context to some parts

56ad03c

DefiCake dismissed BarneyChambers’s stale review via 56ad03c June 5, 2024 15:15

DefiCake requested a review from BarneyChambers June 5, 2024 15:16

docs: apply prettier

caf335d

K1-R1 requested a review from a team June 5, 2024 15:38

K1-R1 previously approved these changes Jun 5, 2024

View reviewed changes

Update docs/ARCHITECTURE.md

3d93b4f

Co-authored-by: K1-R1 <77465250+K1-R1@users.noreply.github.com>

DefiCake dismissed K1-R1’s stale review via 3d93b4f June 5, 2024 17:35

Update docs/ARCHITECTURE.md

047bd41

Co-authored-by: K1-R1 <77465250+K1-R1@users.noreply.github.com>

DefiCake and others added 5 commits June 5, 2024 19:36

Update docs/ARCHITECTURE.md

f6777cd

Co-authored-by: K1-R1 <77465250+K1-R1@users.noreply.github.com>

Update docs/ARCHITECTURE.md

fbdead3

Co-authored-by: K1-R1 <77465250+K1-R1@users.noreply.github.com>

Update docs/ARCHITECTURE.md

dbfaf26

Co-authored-by: K1-R1 <77465250+K1-R1@users.noreply.github.com>

Update docs/ARCHITECTURE.md

e76e6c7

Co-authored-by: K1-R1 <77465250+K1-R1@users.noreply.github.com>

Update docs/ARCHITECTURE.md

b9061a3

Co-authored-by: K1-R1 <77465250+K1-R1@users.noreply.github.com>

BarneyChambers previously approved these changes Jun 6, 2024

View reviewed changes

docs: apply prettier:format

3f43384

DefiCake dismissed BarneyChambers’s stale review via 3f43384 June 6, 2024 12:37

Merge branch 'main' into deficake/167-update-docs

225fd60

DefiCake requested review from BarneyChambers and K1-R1 June 6, 2024 13:00

BarneyChambers reviewed Jun 6, 2024

View reviewed changes