search

skip-mev / connect

A general purpose oracle leveraging ABCI++
Other
79 stars 44 forks source link

docs: fix integration guide code #714

Closed technicallyty closed 2 weeks ago

technicallyty commented 3 weeks ago

found some issues with the code in the docs while messing around with rollkit<>connect

codecov[bot] commented 3 weeks ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 56.01%. Comparing base (9bfe18c) to head (96ea728). Report is 1 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #714 +/- ## ========================================== + Coverage 55.99% 56.01% +0.01% ========================================== Files 206 206 Lines 11481 11481 ========================================== + Hits 6429 6431 +2 + Misses 4453 4451 -2 Partials 599 599 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

github-actions[bot] commented 3 weeks ago

@check-spelling-bot Report

:red_circle: Please review

See the :open_file_folder: files view, the :scroll:action log, or :memo: job summary for details.

Unrecognized words (1)

initalize

These words are not needed and should be removed alr anypb anys arounds badprice beginblocker bitsets cdb cmthash commitheight Concluson coretypes cvp ddd Devation dfa endblocker goautoneg GOM goodprice IDbz incentivize initgenesis Macbook msc munnerz oraclevetypes outpkg pbk pkany pkb pkv Prce pubkeys pvks sdktypes statelessly submitters tmhash UIDs underperform unescrow unmashalling VEbz vih voteaggregator wrt

To accept these unrecognized words as correct and remove the previously acknowledged and now absent words, you could run the following commands ... in a clone of the [git@github.com:skip-mev/connect.git](https://github.com/skip-mev/connect.git) repository on the `tyler/fix-integration-docs` branch ([:information_source: how do I use this?]( https://docs.check-spelling.dev/Accepting-Suggestions)): ``` sh curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/prerelease/apply.pl' | perl - 'https://github.com/skip-mev/connect/actions/runs/10605604216/attempts/1' ```
**OR** To have the bot accept them for you, comment in the PR quoting the following line: @check-spelling-bot apply [updates](https://github.com/skip-mev/connect/actions/runs/10605604216/attempts/1).
Available :books: dictionaries could cover words (expected and unrecognized) not in the :blue_book: dictionary This includes both **expected items** (800) from .github/actions/spelling/expect.txt and **unrecognized words** (1) Dictionary | Entries | Covers | Uniquely -|-|-|- [cspell:python/src/python/python-lib.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20230509/dictionaries/python/src/python/python-lib.txt)|2417|8|4| [cspell:fullstack/dict/fullstack.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20230509/dictionaries/fullstack/dict/fullstack.txt)|419|5|4| [cspell:java/src/java.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20230509/dictionaries/java/src/java.txt)|2464|5|3| [cspell:filetypes/filetypes.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20230509/dictionaries/filetypes/filetypes.txt)|264|4|3| [cspell:java/src/java-terms.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20230509/dictionaries/java/src/java-terms.txt)|920|4|1| Consider adding them (in `.github/workflows/spell.yml`) in `jobs:`/`build:` to `extra_dictionaries`: ``` yml cspell:python/src/python/python-lib.txt cspell:fullstack/dict/fullstack.txt cspell:java/src/java.txt cspell:filetypes/filetypes.txt cspell:java/src/java-terms.txt ``` To stop checking additional dictionaries, add (in `.github/workflows/spell.yml`): ``` yml check_extra_dictionaries: '' ```
Warnings (1) #### See the [:open_file_folder: files](https://github.com/skip-mev/connect/pull/714/files/) view, the [:scroll:action log](https://github.com/skip-mev/connect/actions/runs/10605604216/job/29394724502#step:4:1), or [:memo: job summary](https://github.com/skip-mev/connect/actions/runs/10605604216/attempts/1#summary-29394724502) for details. [:warning: Warnings](https://docs.check-spelling.dev/Event-descriptions) | Count -|- [:warning: no-newline-at-eof](https://docs.check-spelling.dev/Event-descriptions#no-newline-at-eof) | 3 See [:warning: Event descriptions](https://docs.check-spelling.dev/Event-descriptions) for more information.
If the flagged items are :exploding_head: false positives If items relate to a ... * binary file (or some other file you wouldn't want to check at all). Please add a file path to the `excludes.txt` file matching the containing file. File paths are Perl 5 Regular Expressions - you can [test]( https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your files. `^` refers to the file's path from the root of the repository, so `^README\.md$` would exclude [README.md]( ../../../README.md) (on whichever branch you're using). * well-formed pattern. If you can write a [pattern](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-patterns) that would match it, try adding it to the `patterns.txt` file. Patterns are Perl 5 Regular Expressions - you can [test]( https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your lines. Note that patterns can't match multiline strings.
:steam_locomotive: If you're seeing this message and your PR is from a branch that doesn't have check-spelling, please merge to your PR's base branch to get the version configured for your repository.
github-actions[bot] commented 3 weeks ago

@check-spelling-bot Report

:red_circle: Please review

See the :open_file_folder: files view, the :scroll:action log, or :memo: job summary for details.

Unrecognized words (1)

initalize

These words are not needed and should be removed alr anypb anys arounds badprice beginblocker bitsets cdb cmthash commitheight Concluson coretypes cvp ddd Devation dfa endblocker goautoneg GOM goodprice IDbz incentivize initgenesis Macbook msc munnerz oraclevetypes outpkg pbk pkany pkb pkv Prce pubkeys pvks sdktypes statelessly submitters tmhash UIDs underperform unescrow unmashalling VEbz vih voteaggregator wrt

To accept these unrecognized words as correct and remove the previously acknowledged and now absent words, you could run the following commands ... in a clone of the [git@github.com:skip-mev/connect.git](https://github.com/skip-mev/connect.git) repository on the `tyler/fix-integration-docs` branch ([:information_source: how do I use this?]( https://docs.check-spelling.dev/Accepting-Suggestions)): ``` sh curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/prerelease/apply.pl' | perl - 'https://github.com/skip-mev/connect/actions/runs/10605613674/attempts/1' ```
**OR** To have the bot accept them for you, comment in the PR quoting the following line: @check-spelling-bot apply [updates](https://github.com/skip-mev/connect/actions/runs/10605613674/attempts/1).
Available :books: dictionaries could cover words (expected and unrecognized) not in the :blue_book: dictionary This includes both **expected items** (800) from .github/actions/spelling/expect.txt and **unrecognized words** (1) Dictionary | Entries | Covers | Uniquely -|-|-|- [cspell:python/src/python/python-lib.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20230509/dictionaries/python/src/python/python-lib.txt)|2417|8|4| [cspell:fullstack/dict/fullstack.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20230509/dictionaries/fullstack/dict/fullstack.txt)|419|5|4| [cspell:java/src/java.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20230509/dictionaries/java/src/java.txt)|2464|5|3| [cspell:filetypes/filetypes.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20230509/dictionaries/filetypes/filetypes.txt)|264|4|3| [cspell:java/src/java-terms.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20230509/dictionaries/java/src/java-terms.txt)|920|4|1| Consider adding them (in `.github/workflows/spell.yml`) in `jobs:`/`build:` to `extra_dictionaries`: ``` yml cspell:python/src/python/python-lib.txt cspell:fullstack/dict/fullstack.txt cspell:java/src/java.txt cspell:filetypes/filetypes.txt cspell:java/src/java-terms.txt ``` To stop checking additional dictionaries, add (in `.github/workflows/spell.yml`): ``` yml check_extra_dictionaries: '' ```
Warnings (1) #### See the [:open_file_folder: files](https://github.com/skip-mev/connect/pull/714/files/) view, the [:scroll:action log](https://github.com/skip-mev/connect/actions/runs/10605613674/job/29394753339#step:4:1), or [:memo: job summary](https://github.com/skip-mev/connect/actions/runs/10605613674/attempts/1#summary-29394753339) for details. [:warning: Warnings](https://docs.check-spelling.dev/Event-descriptions) | Count -|- [:warning: no-newline-at-eof](https://docs.check-spelling.dev/Event-descriptions#no-newline-at-eof) | 3 See [:warning: Event descriptions](https://docs.check-spelling.dev/Event-descriptions) for more information.
If the flagged items are :exploding_head: false positives If items relate to a ... * binary file (or some other file you wouldn't want to check at all). Please add a file path to the `excludes.txt` file matching the containing file. File paths are Perl 5 Regular Expressions - you can [test]( https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your files. `^` refers to the file's path from the root of the repository, so `^README\.md$` would exclude [README.md]( ../../../README.md) (on whichever branch you're using). * well-formed pattern. If you can write a [pattern](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-patterns) that would match it, try adding it to the `patterns.txt` file. Patterns are Perl 5 Regular Expressions - you can [test]( https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your lines. Note that patterns can't match multiline strings.
:steam_locomotive: If you're seeing this message and your PR is from a branch that doesn't have check-spelling, please merge to your PR's base branch to get the version configured for your repository.
github-actions[bot] commented 3 weeks ago

@check-spelling-bot Report

:red_circle: Please review

See the :open_file_folder: files view, the :scroll:action log, or :memo: job summary for details.

Unrecognized words (1)

initalize

These words are not needed and should be removed alr anypb anys arounds badprice beginblocker bitsets cdb cmthash commitheight Concluson coretypes cvp ddd Devation dfa endblocker goautoneg GOM goodprice IDbz incentivize initgenesis Macbook msc munnerz oraclevetypes outpkg pbk pkany pkb pkv Prce pubkeys pvks sdktypes statelessly submitters tmhash UIDs underperform unescrow unmashalling VEbz vih voteaggregator wrt

To accept these unrecognized words as correct and remove the previously acknowledged and now absent words, you could run the following commands ... in a clone of the [git@github.com:skip-mev/connect.git](https://github.com/skip-mev/connect.git) repository on the `tyler/fix-integration-docs` branch ([:information_source: how do I use this?]( https://docs.check-spelling.dev/Accepting-Suggestions)): ``` sh curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/prerelease/apply.pl' | perl - 'https://github.com/skip-mev/connect/actions/runs/10605616031/attempts/1' ```
**OR** To have the bot accept them for you, comment in the PR quoting the following line: @check-spelling-bot apply [updates](https://github.com/skip-mev/connect/actions/runs/10605616031/attempts/1).
Available :books: dictionaries could cover words (expected and unrecognized) not in the :blue_book: dictionary This includes both **expected items** (800) from .github/actions/spelling/expect.txt and **unrecognized words** (1) Dictionary | Entries | Covers | Uniquely -|-|-|- [cspell:python/src/python/python-lib.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20230509/dictionaries/python/src/python/python-lib.txt)|2417|8|4| [cspell:fullstack/dict/fullstack.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20230509/dictionaries/fullstack/dict/fullstack.txt)|419|5|4| [cspell:java/src/java.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20230509/dictionaries/java/src/java.txt)|2464|5|3| [cspell:filetypes/filetypes.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20230509/dictionaries/filetypes/filetypes.txt)|264|4|3| [cspell:java/src/java-terms.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20230509/dictionaries/java/src/java-terms.txt)|920|4|1| Consider adding them (in `.github/workflows/spell.yml`) in `jobs:`/`build:` to `extra_dictionaries`: ``` yml cspell:python/src/python/python-lib.txt cspell:fullstack/dict/fullstack.txt cspell:java/src/java.txt cspell:filetypes/filetypes.txt cspell:java/src/java-terms.txt ``` To stop checking additional dictionaries, add (in `.github/workflows/spell.yml`): ``` yml check_extra_dictionaries: '' ```
Warnings (1) #### See the [:open_file_folder: files](https://github.com/skip-mev/connect/pull/714/files/) view, the [:scroll:action log](https://github.com/skip-mev/connect/actions/runs/10605616031/job/29394761827#step:4:1), or [:memo: job summary](https://github.com/skip-mev/connect/actions/runs/10605616031/attempts/1#summary-29394761827) for details. [:warning: Warnings](https://docs.check-spelling.dev/Event-descriptions) | Count -|- [:warning: no-newline-at-eof](https://docs.check-spelling.dev/Event-descriptions#no-newline-at-eof) | 3 See [:warning: Event descriptions](https://docs.check-spelling.dev/Event-descriptions) for more information.
If the flagged items are :exploding_head: false positives If items relate to a ... * binary file (or some other file you wouldn't want to check at all). Please add a file path to the `excludes.txt` file matching the containing file. File paths are Perl 5 Regular Expressions - you can [test]( https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your files. `^` refers to the file's path from the root of the repository, so `^README\.md$` would exclude [README.md]( ../../../README.md) (on whichever branch you're using). * well-formed pattern. If you can write a [pattern](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-patterns) that would match it, try adding it to the `patterns.txt` file. Patterns are Perl 5 Regular Expressions - you can [test]( https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your lines. Note that patterns can't match multiline strings.
:steam_locomotive: If you're seeing this message and your PR is from a branch that doesn't have check-spelling, please merge to your PR's base branch to get the version configured for your repository.
github-actions[bot] commented 3 weeks ago

@check-spelling-bot Report

:red_circle: Please review

See the :open_file_folder: files view, the :scroll:action log, or :memo: job summary for details.

Unrecognized words (1)

initalize

These words are not needed and should be removed alr anypb anys arounds badprice beginblocker bitsets cdb cmthash commitheight Concluson coretypes cvp ddd Devation dfa endblocker goautoneg GOM goodprice IDbz incentivize initgenesis Macbook msc munnerz oraclevetypes outpkg pbk pkany pkb pkv Prce pubkeys pvks sdktypes statelessly submitters tmhash UIDs underperform unescrow unmashalling VEbz vih voteaggregator wrt

To accept these unrecognized words as correct and remove the previously acknowledged and now absent words, you could run the following commands ... in a clone of the [git@github.com:skip-mev/connect.git](https://github.com/skip-mev/connect.git) repository on the `tyler/fix-integration-docs` branch ([:information_source: how do I use this?]( https://docs.check-spelling.dev/Accepting-Suggestions)): ``` sh curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/prerelease/apply.pl' | perl - 'https://github.com/skip-mev/connect/actions/runs/10605619596/attempts/1' ```
**OR** To have the bot accept them for you, comment in the PR quoting the following line: @check-spelling-bot apply [updates](https://github.com/skip-mev/connect/actions/runs/10605619596/attempts/1).
Available :books: dictionaries could cover words (expected and unrecognized) not in the :blue_book: dictionary This includes both **expected items** (800) from .github/actions/spelling/expect.txt and **unrecognized words** (1) Dictionary | Entries | Covers | Uniquely -|-|-|- [cspell:python/src/python/python-lib.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20230509/dictionaries/python/src/python/python-lib.txt)|2417|8|4| [cspell:fullstack/dict/fullstack.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20230509/dictionaries/fullstack/dict/fullstack.txt)|419|5|4| [cspell:java/src/java.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20230509/dictionaries/java/src/java.txt)|2464|5|3| [cspell:filetypes/filetypes.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20230509/dictionaries/filetypes/filetypes.txt)|264|4|3| [cspell:java/src/java-terms.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20230509/dictionaries/java/src/java-terms.txt)|920|4|1| Consider adding them (in `.github/workflows/spell.yml`) in `jobs:`/`build:` to `extra_dictionaries`: ``` yml cspell:python/src/python/python-lib.txt cspell:fullstack/dict/fullstack.txt cspell:java/src/java.txt cspell:filetypes/filetypes.txt cspell:java/src/java-terms.txt ``` To stop checking additional dictionaries, add (in `.github/workflows/spell.yml`): ``` yml check_extra_dictionaries: '' ```
Warnings (1) #### See the [:open_file_folder: files](https://github.com/skip-mev/connect/pull/714/files/) view, the [:scroll:action log](https://github.com/skip-mev/connect/actions/runs/10605619596/job/29394774189#step:4:1), or [:memo: job summary](https://github.com/skip-mev/connect/actions/runs/10605619596/attempts/1#summary-29394774189) for details. [:warning: Warnings](https://docs.check-spelling.dev/Event-descriptions) | Count -|- [:warning: no-newline-at-eof](https://docs.check-spelling.dev/Event-descriptions#no-newline-at-eof) | 3 See [:warning: Event descriptions](https://docs.check-spelling.dev/Event-descriptions) for more information.
If the flagged items are :exploding_head: false positives If items relate to a ... * binary file (or some other file you wouldn't want to check at all). Please add a file path to the `excludes.txt` file matching the containing file. File paths are Perl 5 Regular Expressions - you can [test]( https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your files. `^` refers to the file's path from the root of the repository, so `^README\.md$` would exclude [README.md]( ../../../README.md) (on whichever branch you're using). * well-formed pattern. If you can write a [pattern](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-patterns) that would match it, try adding it to the `patterns.txt` file. Patterns are Perl 5 Regular Expressions - you can [test]( https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your lines. Note that patterns can't match multiline strings.
:steam_locomotive: If you're seeing this message and your PR is from a branch that doesn't have check-spelling, please merge to your PR's base branch to get the version configured for your repository.