Differential D14607
[chronik-client] Support connection to in-node chronik Authored by bytesofman on Oct 6 2023, 00:10.
Details
chronik has slightly different features in node vs the original nng. This diff handles these distinctions:
npm test
Diff Detail
Event TimelineComment Actions still need to review for completeness, approach. Uses this as a work in progress in some local testing and not really sure what's even here until I review it. Comment Actions Build Bitcoin ABC Diffs / Diff Testing (chronik-client-tests) failed.
Tail of the build log: /blockchain-info
✔ gives us the blockchain info (534ms)
/block/:hash
✔ gives us the Genesis block by hash (329ms)
✔ gives us the Genesis block by height (426ms)
/blocks/:start/:end
✔ gives us the first few blocks (439ms)
/tx/:txid
✔ results in Not Found
✔ results in the right tx (412ms)
/token/:tokenId is not supported in the node, results in error
✔ existing tokenId gives error
/validate-utxos is not supported in the node, results in error
✔ Correct input throws error as method is not supported in in-node chronik
/script/:type/:payload/history
✔ gives us the first page (321ms)
✔ gives us an empty page for ?page=1 (306ms)
✔ gives us just one tx for ?page_size=1 (320ms)
✔ gives us the Genesis tx for ?page=1&page_size=1 (324ms)
/script/:type/:payload/utxos
✔ gives us the UTXOs (324ms)
/ws
- gives us a confirmation
✔ connects to the ws (319ms)
17 passing (4s)
1 pending
------------|---------|----------|---------|---------|----------------------------------------------
File | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s
------------|---------|----------|---------|---------|----------------------------------------------
All files | 35.15 | 11.63 | 30.83 | 35.13 |
chronik.ts | 29.58 | 8.73 | 20 | 29.77 | ...6-3969,3981,3986-3993,3998-4004,4039-4044
hex.ts | 94.73 | 50 | 100 | 93.93 | 47,55
index.ts | 64.59 | 46.2 | 80 | 64.87 | ...3,636,654-663,674-683,731-734,754-758,775
------------|---------|----------|---------|---------|----------------------------------------------
##teamcity[blockOpened name='Code Coverage Summary']
##teamcity[buildStatisticValue key='CodeCoverageAbsBCovered' value='618']
##teamcity[buildStatisticValue key='CodeCoverageAbsBTotal' value='1758']
##teamcity[buildStatisticValue key='CodeCoverageAbsRCovered' value='225']
##teamcity[buildStatisticValue key='CodeCoverageAbsRTotal' value='1934']
##teamcity[buildStatisticValue key='CodeCoverageAbsMCovered' value='103']
##teamcity[buildStatisticValue key='CodeCoverageAbsMTotal' value='334']
##teamcity[buildStatisticValue key='CodeCoverageAbsLCovered' value='610']
##teamcity[buildStatisticValue key='CodeCoverageAbsLTotal' value='1736']
##teamcity[blockClosed name='Code Coverage Summary']
/work/modules/chronik-client/coverage/lcov-report /work/modules/chronik-client /work/abc-ci-builds/chronik-client-tests
/work/modules/chronik-client /work/abc-ci-builds/chronik-client-tests
mv: cannot stat 'test_results/chronik-client-junit.xml': No such file or directory
Build chronik-client-tests failed with exit code 1Comment Actions Build Bitcoin ABC Diffs / Diff Testing (chronik-client-tests) failed.
Tail of the build log: /blockchain-info
✔ gives us the blockchain info (423ms)
/block/:hash
✔ gives us the Genesis block by hash (317ms)
✔ gives us the Genesis block by height (307ms)
/blocks/:start/:end
✔ gives us the first few blocks (321ms)
/tx/:txid
✔ results in Not Found
✔ results in the right tx (318ms)
/token/:tokenId is not supported in the node, results in error
✔ existing tokenId gives error
/validate-utxos is not supported in the node, results in error
✔ Correct input throws error as method is not supported in in-node chronik
/script/:type/:payload/history
✔ gives us the first page (314ms)
✔ gives us an empty page for ?page=1 (309ms)
✔ gives us just one tx for ?page_size=1 (310ms)
✔ gives us the Genesis tx for ?page=1&page_size=1 (306ms)
/script/:type/:payload/utxos
✔ gives us the UTXOs (303ms)
/ws
- gives us a confirmation
✔ connects to the ws (295ms)
17 passing (4s)
1 pending
------------|---------|----------|---------|---------|----------------------------------------------
File | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s
------------|---------|----------|---------|---------|----------------------------------------------
All files | 35.15 | 11.63 | 30.83 | 35.13 |
chronik.ts | 29.58 | 8.73 | 20 | 29.77 | ...6-3969,3981,3986-3993,3998-4004,4039-4044
hex.ts | 94.73 | 50 | 100 | 93.93 | 47,55
index.ts | 64.59 | 46.2 | 80 | 64.87 | ...3,636,654-663,674-683,731-734,754-758,775
------------|---------|----------|---------|---------|----------------------------------------------
##teamcity[blockOpened name='Code Coverage Summary']
##teamcity[buildStatisticValue key='CodeCoverageAbsBCovered' value='618']
##teamcity[buildStatisticValue key='CodeCoverageAbsBTotal' value='1758']
##teamcity[buildStatisticValue key='CodeCoverageAbsRCovered' value='225']
##teamcity[buildStatisticValue key='CodeCoverageAbsRTotal' value='1934']
##teamcity[buildStatisticValue key='CodeCoverageAbsMCovered' value='103']
##teamcity[buildStatisticValue key='CodeCoverageAbsMTotal' value='334']
##teamcity[buildStatisticValue key='CodeCoverageAbsLCovered' value='610']
##teamcity[buildStatisticValue key='CodeCoverageAbsLTotal' value='1736']
##teamcity[blockClosed name='Code Coverage Summary']
/work/modules/chronik-client/coverage/lcov-report /work/modules/chronik-client /work/abc-ci-builds/chronik-client-tests
/work/modules/chronik-client /work/abc-ci-builds/chronik-client-tests
mv: cannot stat 'test_results/chronik-client-junit.xml': No such file or directory
Build chronik-client-tests failed with exit code 1Comment Actions Build Bitcoin ABC Diffs / Diff Testing (chronik-client-tests) failed.
Tail of the build log: ✔ throws a decode error
/blockchain-info
✔ gives us the blockchain info (516ms)
/block/:hash
✔ gives us the Genesis block by hash (427ms)
✔ gives us the Genesis block by height (453ms)
/blocks/:start/:end
✔ gives us the first few blocks (420ms)
/tx/:txid
✔ results in Not Found
✔ results in the right tx (355ms)
/token/:tokenId is not supported in the node, results in error
✔ existing tokenId gives error
/validate-utxos is not supported in the node, results in error
✔ Correct input throws error as method is not supported in in-node chronik
/script/:type/:payload/history
✔ gives us the first page (326ms)
✔ gives us an empty page for ?page=1 (450ms)
✔ gives us just one tx for ?page_size=1 (329ms)
✔ gives us the Genesis tx for ?page=1&page_size=1 (316ms)
/script/:type/:payload/utxos
✔ gives us the UTXOs (324ms)
/ws
✔ connects to the ws (311ms)
17 passing (4s)
------------|---------|----------|---------|---------|----------------------------------------------
File | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s
------------|---------|----------|---------|---------|----------------------------------------------
All files | 35.15 | 11.63 | 30.83 | 35.13 |
chronik.ts | 29.58 | 8.73 | 20 | 29.77 | ...6-3969,3981,3986-3993,3998-4004,4039-4044
hex.ts | 94.73 | 50 | 100 | 93.93 | 47,55
index.ts | 64.59 | 46.2 | 80 | 64.87 | ...3,636,654-663,674-683,731-734,754-758,775
------------|---------|----------|---------|---------|----------------------------------------------
##teamcity[blockOpened name='Code Coverage Summary']
##teamcity[buildStatisticValue key='CodeCoverageAbsBCovered' value='618']
##teamcity[buildStatisticValue key='CodeCoverageAbsBTotal' value='1758']
##teamcity[buildStatisticValue key='CodeCoverageAbsRCovered' value='225']
##teamcity[buildStatisticValue key='CodeCoverageAbsRTotal' value='1934']
##teamcity[buildStatisticValue key='CodeCoverageAbsMCovered' value='103']
##teamcity[buildStatisticValue key='CodeCoverageAbsMTotal' value='334']
##teamcity[buildStatisticValue key='CodeCoverageAbsLCovered' value='610']
##teamcity[buildStatisticValue key='CodeCoverageAbsLTotal' value='1736']
##teamcity[blockClosed name='Code Coverage Summary']
/work/modules/chronik-client/coverage/lcov-report /work/modules/chronik-client /work/abc-ci-builds/chronik-client-tests
/work/modules/chronik-client /work/abc-ci-builds/chronik-client-tests
mv: cannot stat 'test_results/chronik-client-junit.xml': No such file or directory
Build chronik-client-tests failed with exit code 1Comment Actions improve comments, keep unit tests in one file, move fixtures to generated fixtures file Comment Actions Unit tests pass now. This version would "work" with in-node chronik however still some improvements needed before this should be published.
Comment Actions
this is resolved. was an issue bc in-node chronik does not return network (sensibly...since XEC is uh, strongly implied). Patched so that no network key is returned for in-node chronik. I did not modify the Token interface as this is currently only returned by nng. Still gotta do the websocket. Comment Actions Digging into this --- implementing websocket subscriptions is a big change. Will probably require the introduction of a new ChronikClientNode class, or at least a new websocket class, since the existing methods do not support in-node types and the in-node types are distinct enough that shimming them in is impractical ("shimming them in" i.e. how this diff supports the Utxo and Tx type for nng and in-node, since the distinction is only a matter of including a network key or an isFinal key in a response object). NNG
in-node
Each type is composed of distinct subtypes, which are sometimes composed of their own unique subtypes, e.g. https://github.com/Bitcoin-ABC/bitcoin-abc/blob/master/chronik/chronik-proto/proto/chronik.proto#L227j All of these types need their own class and encode/decode methods in chronik.ts. So -- this diff should be reviewed here. chronik-client should not be published until the websocket implementation is good, but websocket implementation should be its own diff. Comment Actions I think the general approach is not right. You are trying to make the client work with both variants by determining at runtime for each call whether it fits one or the other. You client should determine once for all at creation time if it is expecting nng or in-node, and stick to it. So that if the client is working against a nng version, it doesn't just drop some part of the data if something goes wrong on the backend only because it is the expected behavior for the in-node version.
Comment Actions Need to determine nng or in-node on startup and route to correct methods from there. With the more substantial changes that are required to get this to work with the websocket, consider refactoring the codebase so that nng and in-node methods / types are in their own files. Comment Actions Also worth considering whether to use D14269 as a baseline since that refactors ~60% of chronik-client | ||||||||||||||||||||