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

Jump to bottom

chore(protocol): improve contracts and docs for auditing #14565

Merged
merged 191 commits into from
Aug 31, 2023
Merged

chore(protocol): improve contracts and docs for auditing #14565

merged 191 commits into from
Aug 31, 2023

Conversation

adaki2004
Copy link
Contributor

@adaki2004 adaki2004 commented Aug 23, 2023 •
edited
Loading

(Still draft)

Described here, we need to address few items to properly comply with a comprehensive description of https://secure-contracts.com/.

Arithmetic

  • is unchecked / rounding safe ?
  • arithmetic formulas (more complex ones) documented and match the code ?

Monitoring documentation

  • incident response plan, possible failures identified

Authentication/ access control

  • There is clear documentation about the actors and their respective privileges in the system. (-> actors_privileges_deployments.md)

  • Actors with privileges are not EOAs. (Documented in the markdown above. For now, some yes, but TimeLockController will be further down the road.)

Migration/update documentation

  • Is it documented 'howto' ? -> actors_privileges_deployments.md

  • ERC20 comformity check

dantaik and others added 30 commits June 28, 2023 15:30
@dantaik @adaki2004
@dionysuzx @cyberhorsey @jscriptcoder @davidtaikocha @2manslkh @mfinestone @whohideonbug @Megumiiiiii @Venoox @github-actions @dong77 @Brechtpd
feat(protocol): alpha-4 with staking-based tokenomics (#13981)
d96e4bd 
Co-authored-by: D <51912515+adaki2004@users.noreply.github.com>
Co-authored-by: dantaik <dantaik@users.noreply.github.com>
Co-authored-by: dave | d1onys1us <13951458+d1onys1us@users.noreply.github.com>
Co-authored-by: adaki2004 <adaki2004@users.noreply.github.com>
Co-authored-by: jeff <113397187+cyberhorsey@users.noreply.github.com>
Co-authored-by: Francisco Ramos <jscriptcoder@gmail.com>
Co-authored-by: David <david@taiko.xyz>
Co-authored-by: Kenk <kenghin_lim@hotmail.com>
Co-authored-by: mfinestone <36642873+mfinestone@users.noreply.github.com>
Co-authored-by: hideonbug <92258181+whohideonbug@users.noreply.github.com>
Co-authored-by: megumii <98658943+Megumiiiiii@users.noreply.github.com>
Co-authored-by: Tomaž <venooxpersonal@gmail.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Daniel Wang <dong77@gmail.com>
Co-authored-by: adaki2004 <keszeydani@gmail.com>
Co-authored-by: Jeffery Walsh <cyberhorsey@gmail.com>
Co-authored-by: cyberhorsey <cyberhorsey@users.noreply.github.com>
Co-authored-by: Brecht Devos <Brechtp.Devos@gmail.com>
@dantaik
refactor(protocol): add very minor update (#14066)
c7fee73
@dantaik @cyberhorsey
refactor(protocol): optimize ProverPool (#14069)
4cb7367 
Co-authored-by: dantaik <dantaik@users.noreply.github.com>
Co-authored-by: Jeffery Walsh <cyberhorsey@gmail.com>
Co-authored-by: cyberhorsey <cyberhorsey@users.noreply.github.com>
@dantaik
Merge branch 'main' into alpha-4
dc2e975
@cyberhorsey
fix(protocol): Fix alpha-4 ability to build protocol and run tests (#…
46c0e66 
…14075)
@cyberhorsey
feat(eventindexer): Alpha 4 event indexing (#14078)
dee55c9
@cyberhorsey
feat(relayer): Alpha 4 event sub (#14081)
5c40c12
@davidtaikocha
Merge branch 'main' into alpha-4
81176e3
@dantaik
chore(protocol): delete ProverPool2 and deprecated documents (#14082)
8e398f4
@cyberhorsey
feat(protocol): allow premint of TKO to multiple addresses/amounts in…
478ba5e 
… deployonl1 script (#14084)
@dantaik
chore(protocol): use block.prevrandao to avoid warning (#14088)
8ba71a6
@dantaik
Merge branch 'main' into alpha-4
6805a11
@dong77
Update TokenVault.sol
e8ffbb8
@dantaik
fix typo
2fa83d2
@dantaik
feat(protocol): restrict prover staking changes to once per hour (#14093
a539646 
)
@dantaik
feat(protocol): disable oracle proofs to be over written by regular p…
5bf313e 
…roofs (#14097)
@dantaik @dong77
feat(protocol): unify taiko tokens acros L1, L2s, and L3s (#14083)
38d537b 
Co-authored-by: dantaik <dantaik@users.noreply.github.com>
Co-authored-by: Daniel Wang <dong77@gmail.com>
@cyberhorsey
Merge branch 'main' into alpha-4
4e8e78a
@cyberhorsey
feat(protocol): A4 bindings (#14101)
7f41353
@cyberhorsey
fix(eventindexer): add address to Slashed event in db, + add logs (#1…
4ef8d0c 
…4103)
@dantaik @dong77 @cyberhorsey
fix(protocol): limit reward per gas in weight calculation (#14098)
05da0e7 
Co-authored-by: Daniel Wang <dong77@gmail.com>
Co-authored-by: jeff <113397187+cyberhorsey@users.noreply.github.com>
@cyberhorsey
add provers route
c341f0a
@cyberhorsey
Merge branch 'main' into alpha-4
44d119e
@cyberhorsey
abigen
a24f9a6
@cyberhorsey
Merge branch 'alpha-4' of github.com:taikoxyz/taiko-mono into alpha-4
76d9375
@dantaik
chore(protocol) use uint32 for gas limit, gas used, gas price (#14112)
5cd6c82
@dantaik @dong77
feat(protocol): add prover into block events (#14123)
fd07f3f 
Co-authored-by: Daniel Wang <dong77@gmail.com>
@dantaik @dong77
feat(protocol): also add rewardPerGas into BlockProposedEvent (#14124)
c4c671e 
Co-authored-by: Daniel Wang <dong77@gmail.com>
@cyberhorsey
Resolve merge from main with eventindexer changes
053e198
@cyberhorsey
Merge branch 'alpha-4' of github.com:taikoxyz/taiko-mono into alpha-4
c4ab00d
dantaik
dantaik previously approved these changes Aug 31, 2023
View reviewed changes
@dantaik dantaik enabled auto-merge August 31, 2023 06:29
@dantaik dantaik mentioned this pull request Aug 31, 2023
Merged
@dantaik dantaik requested a review from Brechtpd August 31, 2023 06:52
Brechtpd
Brechtpd previously approved these changes Aug 31, 2023
View reviewed changes
@adaki2004 @Brechtpd
Update packages/protocol/contracts/L1/libs/LibProving.sol
77e9639 
Co-authored-by: Brecht Devos <Brechtp.Devos@gmail.com>
@adaki2004 adaki2004 dismissed stale reviews from Brechtpd and dantaik via 77e9639 August 31, 2023 12:44
@dantaik dantaik requested a review from Brechtpd August 31, 2023 14:40
@dantaik dantaik added this pull request to the merge queue Aug 31, 2023
Merged via the queue into main with commit 839326c Aug 31, 2023
@dantaik dantaik deleted the audit_preparation branch August 31, 2023 15:26
2manslkh added a commit that referenced this pull request Sep 14, 2023
@adaki2004 @dantaik
@dionysuzx @cyberhorsey @jscriptcoder @davidtaikocha @2manslkh @mfinestone @whohideonbug @Megumiiiiii @Venoox @github-actions @dong77 @Brechtpd @RogerLamTd @KorbinianK
chore(protocol): improve contracts and docs for auditing (#14565)
94e4201 
Co-authored-by: Daniel Wang <99078276+dantaik@users.noreply.github.com>
Co-authored-by: dantaik <dantaik@users.noreply.github.com>
Co-authored-by: dave | d1onys1us <13951458+d1onys1us@users.noreply.github.com>
Co-authored-by: adaki2004 <adaki2004@users.noreply.github.com>
Co-authored-by: jeff <113397187+cyberhorsey@users.noreply.github.com>
Co-authored-by: Francisco Ramos <jscriptcoder@gmail.com>
Co-authored-by: David <david@taiko.xyz>
Co-authored-by: Kenk <kenghin_lim@hotmail.com>
Co-authored-by: mfinestone <36642873+mfinestone@users.noreply.github.com>
Co-authored-by: hideonbug <92258181+whohideonbug@users.noreply.github.com>
Co-authored-by: megumii <98658943+Megumiiiiii@users.noreply.github.com>
Co-authored-by: Tomaž <venooxpersonal@gmail.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Daniel Wang <dong77@gmail.com>
Co-authored-by: Jeffery Walsh <cyberhorsey@gmail.com>
Co-authored-by: cyberhorsey <cyberhorsey@users.noreply.github.com>
Co-authored-by: Brecht Devos <Brechtp.Devos@gmail.com>
Co-authored-by: d1onys1us <d1onys1us@users.noreply.github.com>
Co-authored-by: Roger <50648015+RogerLamTd@users.noreply.github.com>
Co-authored-by: Korbinian <KorbinianK@users.noreply.github.com>
Co-authored-by: Daniel Wang <dan@taiko.xyz>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dantaik dantaik dantaik approved these changes

@Brechtpd Brechtpd Brechtpd approved these changes

@dionysuzx dionysuzx Awaiting requested review from dionysuzx

@davidtaikocha davidtaikocha Awaiting requested review from davidtaikocha

Assignees

@adaki2004 adaki2004

Labels
area.docs meta.audits
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Audit preparation items
9 participants
@adaki2004 @dantaik @Brechtpd @cyberhorsey @davidtaikocha @dong77 @dionysuzx @jscriptcoder @KorbinianK