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

Adds Local Ledger Readme #1035

Merged

Conversation

AlgoStephenAkiki
Copy link
Contributor

Resolves #4109

Starts Readme docs for local ledger

Resolves #4109

Starts Readme docs
@codecov
Copy link

codecov bot commented Jun 15, 2022

Codecov Report

❗ No coverage uploaded for pull request base (localledger/integration@eff4e6f). Click here to learn what that means.
The diff coverage is n/a.

@@                    Coverage Diff                     @@
##             localledger/integration    #1035   +/-   ##
==========================================================
  Coverage                           ?   59.24%           
==========================================================
  Files                              ?       47           
  Lines                              ?     8722           
  Branches                           ?        0           
==========================================================
  Hits                               ?     5167           
  Misses                             ?     3070           
  Partials                           ?      485           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update eff4e6f...fcd1274. Read the comment docs.

docs/LocalLedger.md Outdated Show resolved Hide resolved
docs/LocalLedger.md Outdated Show resolved Hide resolved

By default, the Indexer will choose option 2 unless otherwise specified.

## Troubleshooting
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if this section is needed. If the files aren't in the data directory, wouldn't they be created automatically?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is included because of this check,

if dbRound != 0 && !ledgerExists(datadir, prefix) {
. I think we can remove this check.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let me know if this is removed and I will update this accordingly.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@shiqizng does the user need to manually create the ledger file?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, user doesn't need to manually create the files. I removed that check from the PR. @AlgoStephenAkiki

docs/LocalLedger.md Outdated Show resolved Hide resolved
AlgoStephenAkiki and others added 3 commits June 16, 2022 10:46
Co-authored-by: Will Winder <wwinder.unh@gmail.com>
Co-authored-by: Will Winder <wwinder.unh@gmail.com>
Co-authored-by: Will Winder <wwinder.unh@gmail.com>
@AlgoStephenAkiki AlgoStephenAkiki merged commit a6c85a4 into localledger/integration Jun 21, 2022
@AlgoStephenAkiki AlgoStephenAkiki deleted the 4109-local-ledger-documentation branch June 21, 2022 15:26
Eric-Warehime added a commit that referenced this pull request Jul 21, 2022
* Local Ledger (#1011)

* integrate block processor

* Local Ledger Deployment (#1013)

* add simple local ledger migration

* add deleted opts

* fast catchup (#1023)

* add fast catchup

* Localledger merge (#1036)

* return empty lists from fetchApplications and fetchAppLocalStates (#1010)

* Update model to converge with algod (#1005)

* New Feature: Adds Data Directory Support (#1012)

- Updates the go-algorand submodule hash to point to rel/beta
- Moves the cpu profiling file, pid file and indexer configuration file
  to be options of only the daemon sub-command
- Changes os.Exit() to be a panic with a special handler.  This is so
  that defer's are handled instead of being ignored.
- Detects auto-loading configuration files in the data directory and
  issues errors if equivalent command line arguments are supplied.
- Updates the README with instructions on how to use the auto-loading
  configuration files and the data directory.

* Update mockery version

Co-authored-by: erer1243 <1377477+erer1243@users.noreply.github.com>
Co-authored-by: AlgoStephenAkiki <85183435+AlgoStephenAkiki@users.noreply.github.com>

* recovery scenario (#1024)

* handle ledger recovery scenario

* refactor create genesis block (#1026)

* refactor create genesis block

* Adds Local Ledger Readme (#1035)

* Adds Local Ledger Readme

Resolves #4109

Starts Readme docs

* Update docs/LocalLedger.md

Co-authored-by: Will Winder <wwinder.unh@gmail.com>

* Update docs/LocalLedger.md

Co-authored-by: Will Winder <wwinder.unh@gmail.com>

* Update docs/LocalLedger.md

Co-authored-by: Will Winder <wwinder.unh@gmail.com>

* Removed troubleshooting section

Co-authored-by: Will Winder <wwinder.unh@gmail.com>

* update ledger file path and migration (#1042)

* LocalLedger Refactoring + Catchpoint Service (#1049)

Part 1

    cleanup genesis file access.
    put node catchup into a function that can be swapped out with the catchup service.
    pass the indexer logger into the block processor.
    move open ledger into a util function, and move the initial state util function into a new ledger util file.
    add initial catchupservice implementation.
    move ledger init from daemon.go to constructor.
    Merge multiple read genesis functions.

Part 2

    Merge local_ledger migration package into blockprocessor.
    Rename Migration to Initialize
    Use logger in catchup service catchup

Part 3

    Update submodule and use NewWrappedLogger.
    Make util.CreateInitState private

* build: merge develop into localledger/integration (#1062)

* Ledger init status (#1058)

* Generate an error if the catchpoint is not valid for initialization. (#1075)

* Use main logger in handler and fetcher. (#1077)

* Switch from fullNode catchup to catchpoint catchup service. (#1076)

* Refactor daemon, add more tests (#1039)

Refactors daemon cmd into separate, testable pieces.

* Merge develop into localledger/integration (#1083)

* Misc Local Ledger cleanup (#1086)

* Update processor/blockprocessor/initialize.go

Co-authored-by: Zeph Grunschlag <tzaffi@users.noreply.github.com>

* commit

* fix function call args

* RFC-0001: Rfc 0001 impl (#1069)

Adds an Exporter interface and a noop exporter implementation with factory methods for construction

* Fix test errors

* Add/fix tests

* Add postgresql_exporter tests

* Update config loading

* Change BlockExportData to pointers

* Move and rename ExportData

* Add Empty func to BlockData

* Add comment

Co-authored-by: shiqizng <80276844+shiqizng@users.noreply.github.com>
Co-authored-by: shiqi.zheng@algorand.com <shiqi.zheng@algorand.com>
Co-authored-by: erer1243 <1377477+erer1243@users.noreply.github.com>
Co-authored-by: AlgoStephenAkiki <85183435+AlgoStephenAkiki@users.noreply.github.com>
Co-authored-by: Will Winder <wwinder.unh@gmail.com>
Co-authored-by: Zeph Grunschlag <tzaffi@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Local Ledger Documentation
4 participants