Page MenuHomePhabricator

Update chronik documentation after NNG deprecation
AbandonedPublic

Authored by Fabien on Aug 31 2024, 13:34.

Details

Reviewers
emack
Group Reviewers
Restricted Project
Summary

The class names have changed a bit, so let's reflect this.

Test Plan
cat > modules/docs/chronik.e.cash/.abclatestversion << EOF
0.29.11
EOF

docker build -f modules/Dockerfile -t chronik-docs-website .

Diff Detail

Repository
rABC Bitcoin ABC
Branch
fix_chronik_doc
Lint
Lint Passed
Unit
No Test Coverage
Build Status
Buildable 30146
Build 59825: Build Diff
Build 59824: arc lint + arc unit

Event Timeline

Fabien requested review of this revision.Aug 31 2024, 13:34
emack requested changes to this revision.Aug 31 2024, 15:40
emack added a subscriber: emack.
  • I did a quick grep and there's no documentation on the chronik.lokadId() API, which is exclusively on in-node chronik?
  • Maybe outside the scope of this diff, but can do with a production considerations section that talks to the various production challenges e.g. retrieving an address' history since inception can be tricky, as it's typically larger than the max number of pages retrievable per API call (200 pages). In which case the doc should recommend retrieving the first page so you get the numPages property which can be used to then work out the appropriate history pagination or to loop through and build up an array of promises for concurrent execution.
modules/docs/chronik.e.cash/docs/1-chronik-js/01-connect.mdx
14 ↗(On Diff #49431)
This revision now requires changes to proceed.Aug 31 2024, 15:40
Fabien planned changes to this revision.Aug 31 2024, 15:48
modules/docs/chronik.e.cash/docs/1-chronik-js/05-addresses.mdx
53 ↗(On Diff #49431)

Looks like it's the wrong way around - it's (starting page, page size). In which case 300 should be 200 as the max page size permitted by chronik.

Fabien planned changes to this revision.Aug 31 2024, 19:46
Fabien planned changes to this revision.Sep 5 2024, 18:16

imo D16750 is closer to landing now -- are ok with the approach used in D16750? If so, abandon here and I'll land there.

imo D16750 is closer to landing now -- are ok with the approach used in D16750? If so, abandon here and I'll land there.

Yes, this solution still doesn't work anyway. I think the right approach forward is to create a workspace, so let's get the docs updated and later work on that instead.