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.

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

Feature/#2200 generate json-schema + docs for node config file and network_custom #2252

Conversation

joanestebanr
Copy link
Contributor

@joanestebanr joanestebanr commented Jul 4, 2023

Closes #2200

What does this PR do?

  • Inject default values to json-schema to be part of the generated documentation
  • Generate Markdown and HTML documentation for node config file and genesis
  • Added more comments to config structs to be shown in documentation
  • Added a github action to check that the documentation are syncronized with code

You could find the documentation outcome files in the folder docs/config-file/:

  • node-config-doc.html: HTML documentation for Node config file

  • node-config-doc.md: Markdown documentation for Node config file

  • node-config-schema.json: Json schema documentation for Node config file

  • custom_network-config-doc.html: HTML documentation for Custom Network config file

  • custom_network-config-doc.md: Markdown documentation for Custom Network config file

  • custom_network-config-schema.json: Json schema documentation for Custom Network config file

Also there are new target in Makefile:

  • config-doc-gen: Generate all documentation
  • config-doc-node: Generate only node config file documentation
  • config-doc-custom_network: Generate only custom network config file documentation

Reviewers

Main reviewers:

@cla-bot cla-bot bot added the cla-signed label Jul 4, 2023
@joanestebanr joanestebanr changed the title generate json-schema + docs for node config file and network_custom Feature/#2200 generate json-schema + docs for node config file and network_custom Jul 4, 2023
@joanestebanr joanestebanr self-assigned this Jul 4, 2023
@joanestebanr joanestebanr added this to the v0.2.0 milestone Jul 4, 2023
joanestebanr and others added 11 commits July 5, 2023 10:02
* fix concurrent web socket writes

* fix eth_syncing

* fix custom trace internal tx call error handling and update prover

* add test to custom tracer depth issue; fix internal call error and gas used

* fix custom tracer for internal tx with error and no more steps after it

* remove debug code

* Make max grpc message size configurable  (#2179)

* make max grpc message size configurable

* fix state tests

* fix tests

* fix tests

* get SequencerNodeURI from SC if empty and not IsTrustedSequencer

* Optimize trace (#2183)

* optimize trace

* fix memory reading

* update docker image

* update prover image

* fix converter

* fix memory

* fix step memory

* fix structlogs

* fix structlogs

* fix structlogs

* fix structlogs

* fix structlogs

* fix structlogs

* fix structlogs

* fix structlogs

* update prover image

* fix struclogs

* fix memory size

* fix memory size

* fix memory size

* refactor memory resize

* refactor memory resize

* move log for the best fitting tx (#2192)

* fix load zkCounters from pool

* remove unnecessary log.info

* add custom tracer support to CREATES opcode without depth increase (#2213)

* logs

* fix getting stateroot from previous batch (GetWIPBatch)

* logs

* Fix GetWipBatch when previous last batch is a forced batch

* fix forcedBatch trusted state

* Revert "fix getting stateroot from previous batch (GetWIPBatch)"

This reverts commit 860f0e7.

* force GHA

* add pool limits (#2189)

* Hotfix/batch l2 data (#2223)

* Fix BatchL2Data

* Force GHA

* remove failed txs from the pool limit check (#2233)

* debug trace by batch number via external rpc requests (#2235)

* fix trace batch remote requests in parallel limitation (#2244)

* Added RPC.TraceBatchUseHTTPS config parameter

* fix executor version

---------

Co-authored-by: tclemos <[email protected]>
Co-authored-by: tclemos <[email protected]>
Co-authored-by: Toni Ramírez <[email protected]>
Co-authored-by: agnusmor <[email protected]>
Co-authored-by: agnusmor <[email protected]>
Co-authored-by: Thiago Coimbra Lemos <[email protected]>
Bumps [golang.org/x/crypto](https://github.com/golang/crypto) from 0.10.0 to 0.11.0.
- [Commits](golang/crypto@v0.10.0...v0.11.0)

---
updated-dependencies:
- dependency-name: golang.org/x/crypto
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
…ssword from etherman.Config that are not in use
Bumps [golang.org/x/net](https://github.com/golang/net) from 0.11.0 to 0.12.0.
- [Commits](golang/net@v0.11.0...v0.12.0)

---
updated-dependencies:
- dependency-name: golang.org/x/net
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Alonso Rodriguez <[email protected]>
@joanestebanr joanestebanr marked this pull request as ready for review July 7, 2023 08:51
@agnusmor agnusmor changed the base branch from develop to release/v0.2.0 July 10, 2023 11:50
@joanestebanr joanestebanr requested a review from dpunish3r July 10, 2023 14:42
@joanestebanr joanestebanr merged commit 17a95f5 into release/v0.2.0 Jul 11, 2023
@joanestebanr joanestebanr deleted the feature/#2200-add-documentation-for-node-config-file-2 branch July 11, 2023 07:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add documentation for node config file (.toml)
3 participants