feat(protocol, relayer): Improved Taiko Protocol and Relayer Documentations

[joaolago1113]

Overview

This Pull Request introduces updates to the Taiko Protocol and Relayer project documentation and configuration settings. These changes are based on my hands-on experience using and testing these protocols, the documentation aligns well with practical usage and all setup processes are streamlined for future developers.

Changes

1. Expand Relayer README with Detailed Build, Config, and Usage Instructions

   • Overhauled the Relayer's README.md to include comprehensive instructions on building the source, configuring MySQL and RabbitMQ, setting up environment variables, and usage guidelines.

2. Revamp README with Detailed Steps

   • Extensively updated the Taiko Protocol's README.md. This revamp includes detailed steps for setting up the environment, generating the L2 genesis JSON's alloc field, generating and running with the L2 genesis block, and deploying the L1 contracts.

3. Changed DATABASE_PASSWORD from root to passw00d

   • Modified the default database password in the .l1processor.example.env file of the Relayer package to match the default db password.

[vercel]

@joaolago1113 is attempting to deploy a commit to the taikoxyz Team on Vercel.

A member of the Team first needs to authorize it.

[spachib]

Nice

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (d33e130) 27.15% compared to head (85183ff) 26.88%.

❗ Current head 85183ff differs from pull request most recent head d326a4c. Consider uploading reports for the commit d326a4c to get more accurate results

Additional details and impacted files

@@             Coverage Diff             @@
##           alpha-6   #15440      +/-   ##
===========================================
- Coverage    27.15%   26.88%   -0.27%     
===========================================
  Files           94       96       +2     
  Lines         5700     5798      +98     
===========================================
+ Hits          1548     1559      +11     
- Misses        3988     4073      +85     
- Partials       164      166       +2     

Flag	Coverage Δ		*Carryforward flag
eventindexer	17.22% <ø> (-0.07%)	⬇️	Carriedforward from 5192485
guardian-prover-health-check	34.84% <ø> (ø)		Carriedforward from 5192485
relayer	39.34% <ø> (-1.27%)	⬇️

*This pull request uses carry forward flags. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated (UTC)
bridge-ui-v2-internal	✅ Ready (Inspect)	Visit Preview	Jan 10, 2024 4:58am