Page MenuHomePhabricator
Differential D13612

[Chronik] Add general-purpose python `ChronikClient`
ClosedPublic
Actions

Authored by tobias_ruck on Apr 7 2023, 11:41.

Details

Reviewers
Fabien
Group Reviewers
Restricted Project
Commits
rABC3696c93da65f: [Chronik] Add general-purpose python `ChronikClient`
Summary

A simple client for querying the different Chronik endpoints in a nice flowing interface.

While it's currently placed in test_framework, in the future it is intended to be published on pip so people who want to access Chronik can use this client. For this reason we place it in its own directory.

We also update all the chronik tests to use this new client now.

Test Plan

ninja check-functional

Diff Detail

Repository
rABC Bitcoin ABC
Branch
chronik-python-client
Lint
Lint Passed
Unit
No Test Coverage
Build Status
Buildable 23069
Build 45758: Build Diffbuild-without-wallet · build-clang · build-diff · build-clang-tidy · build-debug
Build 45757: arc lint + arc unit

Event Timeline

tobias_ruck created this revision.Apr 7 2023, 11:41
Herald added a reviewer: Restricted Project. · View Herald TranscriptApr 7 2023, 11:41
tobias_ruck requested review of this revision.Apr 7 2023, 11:41
Harbormaster completed remote builds in B23069: Diff 39389.Apr 7 2023, 11:56
tobias_ruck updated this revision to Diff 39390.Apr 7 2023, 12:07

remove pagination from unconfirmed_txs

Harbormaster completed remote builds in B23070: Diff 39390.Apr 7 2023, 12:22
tobias_ruck added a child revision: D13613: [Chronik] Refactor tests: add genesis coinbase consts.Apr 7 2023, 12:40
tobias_ruck added a child revision: D13535: [Chronik] Add `/script/:type/:payload/history`.Apr 7 2023, 12:51
Fabien requested changes to this revision.Apr 7 2023, 16:47

no need for a subdir, just call the file chronik.py

I very much like the solution of the attributes describing the endpoint, it's worth investigating

test/functional/test_framework/chronik/client.py
72 ↗(On Diff #39390)

It will always be a client, could be simply called Chronik

This revision now requires changes to proceed.Apr 7 2023, 16:47
tobias_ruck requested review of this revision.Apr 8 2023, 10:40
tobias_ruck edited the summary of this revision. (Show Details)
aimal added a subscriber: aimal.Apr 9 2023, 06:11
Fabien requested changes to this revision.Apr 9 2023, 06:21
Fabien added inline comments.
test/functional/test_framework/chronik/client.py
75 ↗(On Diff #39390)

It is better to have some sensible default timeout value (even if it's a bit longer than what you actually have in the tests, like 30s) instead of no timeout by default. For the tests having a longer timeout is no problem, and for a library it avoids running forever with no output nor error message.

This revision now requires changes to proceed.Apr 9 2023, 06:21
tobias_ruck updated this revision to Diff 39601.Apr 12 2023, 14:22

Add 30s timeout to chronik/client.py

tobias_ruck updated this revision to Diff 39626.Apr 12 2023, 14:59

Remove timeout=4 from usages of ChronikClient

Fabien accepted this revision.Apr 12 2023, 15:02
This revision is now accepted and ready to land.Apr 12 2023, 15:02
Harbormaster completed remote builds in B23233: Diff 39601.Apr 12 2023, 15:25
Harbormaster completed remote builds in B23240: Diff 39626.Apr 12 2023, 16:10
Closed by commit rABC3696c93da65f: [Chronik] Add general-purpose python `ChronikClient` (authored by tobias_ruck). · Explain WhyApr 12 2023, 16:12
This revision was automatically updated to reflect the committed changes.
tobias_ruck added a commit: rABC3696c93da65f: [Chronik] Add general-purpose python `ChronikClient`.

Revision Contents
Changeset List

PathSize
test/
functional/
62 lines
42 lines
84 lines
53 lines
17 lines
56 lines
test_framework/
chronik/
113 lines

Diff 39389

View Options

test/functional/chronik_block.py

Loading...
View Options

test/functional/chronik_resync.py

Loading...
View Options

test/functional/chronik_script_confirmed_txs.py

Loading...
View Options

test/functional/chronik_script_unconfirmed_txs.py

Loading...
View Options

test/functional/chronik_serve.py

Loading...
View Options

test/functional/chronik_tx.py

Loading...
View Options

test/functional/test_framework/chronik/__init__.py

Loading...
View Options

test/functional/test_framework/chronik/client.py

Loading...