Skip to content

Stratum v2 connman #50

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 13 commits into
base: sv2-transport
Choose a base branch
from
Open

Stratum v2 connman #50

wants to merge 13 commits into from

Conversation

Sjors
Copy link
Owner

@Sjors Sjors commented Jul 19, 2024 •
edited
Loading

Based on:

Followed by #49. Parent PR #68

This PR introduces Sv2Connman, a subclass of SockMan (bitcoin#30988). It uses the Sv2Transport introduced in bitcoin#30315 to enable incoming connections from other Stratum v2 roles.

It's main target user is the Template Provider role introduced in #49.

There may be other Stratum v2 roles we want to support in the future.

Earlier version(s): bitcoin#30332

Note to self, to keep this rebased until bitcoin#30988 lands (1 merge commits and 3 normal commits):

git rebase --rebase-merges HEAD~4 --onto sv2-transport

This won't include changes in the original branches. To achieve that:

git reset --hard sv2-transport
# git fetch vasild
# git merge vasild/sockman
git fetch pinheadmz
git merge pinheadmz/sockman-lite
git cherry-pick sjors/2024/06/sv2_connection~2^..sjors/2024/06/sv2_connection

Note that this code will most likely not be upstreamed to Bitcoin Core, but instead used to create a standalone c++ application that connects to a running node via an IPC interface. See bitcoin#31098.

This was referenced Jul 19, 2024
Open
Closed
@Sjors
Copy link
Owner Author

Sjors commented Jul 19, 2024

@pinheadmz wrote in the original PR:

I am working on a libevent-replacing HTTP server using netbase primitives and yeah, I have some functions that look a lot like the sv2connamn in this branch.

I think it would be cool if possible to abstract the mechanisms in ThreadSocketHandler to work on "abstract clients" and I'd be happy to review and collaborate on that.

I plan to take a look at this.

This was referenced Jul 19, 2024
Closed
Open
Closed
@Sjors Sjors force-pushed the 2024/06/sv2_connection branch from 3cf779b to b549fd6 Compare August 8, 2024 16:13
@Sjors Sjors force-pushed the 2024/06/sv2_transport branch 2 times, most recently from bdc8542 to 199234a Compare August 13, 2024 17:11
@Sjors Sjors force-pushed the 2024/06/sv2_connection branch from b549fd6 to 22d033c Compare August 13, 2024 17:14
@Sjors Sjors mentioned this pull request Aug 26, 2024
Open
@Sjors Sjors force-pushed the 2024/06/sv2_transport branch from 199234a to 922fd8a Compare August 29, 2024 11:11
@Sjors Sjors force-pushed the 2024/06/sv2_connection branch from 22d033c to 6b5ee20 Compare August 29, 2024 11:31
@Sjors
Copy link
Owner Author

Sjors commented Aug 29, 2024

CMake rebase.

@Sjors Sjors force-pushed the 2024/06/sv2_connection branch from 6b5ee20 to 4f957ee Compare August 29, 2024 11:37
@Sjors Sjors force-pushed the 2024/06/sv2_transport branch from 922fd8a to 50b6eb8 Compare August 29, 2024 11:47
@Sjors Sjors force-pushed the 2024/06/sv2_connection branch from 4f957ee to b69544c Compare August 29, 2024 11:49
@Sjors Sjors force-pushed the 2024/06/sv2_transport branch from 50b6eb8 to 6a02367 Compare September 5, 2024 12:48
@Sjors Sjors force-pushed the 2024/06/sv2_connection branch from b69544c to 1ca68d2 Compare September 5, 2024 12:57
@Sjors Sjors mentioned this pull request Sep 5, 2024
Merged
@Sjors Sjors force-pushed the 2024/06/sv2_transport branch from 6a02367 to ce4269c Compare September 10, 2024 14:50
@Sjors Sjors force-pushed the 2024/06/sv2_connection branch from 1ca68d2 to b578e0a Compare September 10, 2024 14:54
@Sjors Sjors mentioned this pull request Sep 11, 2024
Closed
@Sjors Sjors force-pushed the 2024/06/sv2_transport branch 3 times, most recently from 8220337 to 5fca2c5 Compare September 19, 2024 14:40
@Sjors Sjors force-pushed the 2024/06/sv2_connection branch from b578e0a to 489c9fb Compare September 19, 2024 15:02
@Sjors Sjors force-pushed the 2024/06/sv2_transport branch from 5fca2c5 to dfb9a6d Compare September 20, 2024 09:13
@Sjors Sjors force-pushed the 2024/06/sv2_connection branch from 489c9fb to a55fa83 Compare September 20, 2024 09:17
@Sjors
Copy link
Owner Author

Sjors commented Sep 20, 2024

Rebased to move everything into a bitcoin_sv2 library (use -DWITH_SV2=ON to compile).

@Sjors
Copy link
Owner Author

Sjors commented Feb 10, 2025

Rebased after bitcoin#30205 landed.

@Sjors Sjors force-pushed the 2024/06/sv2_connection branch from 360aedd to 49ea07a Compare February 21, 2025 15:07
@Sjors Sjors force-pushed the 2024/06/sv2_connection branch from 49ea07a to ac05646 Compare March 6, 2025 12:04
@Sjors Sjors force-pushed the 2024/06/sv2_connection branch from ac05646 to 185eb09 Compare March 20, 2025 16:29
@Sjors Sjors force-pushed the 2024/06/sv2_connection branch from 185eb09 to 1a0f0f3 Compare April 8, 2025 17:49
@Sjors Sjors force-pushed the 2024/06/sv2_connection branch 2 times, most recently from 5692ffa to 7d5d5ad Compare April 15, 2025 13:21
@Sjors
Copy link
Owner Author

Sjors commented Apr 15, 2025

Rebased and squashed dc0f901 from #49 into this PR.

pinheadmz and others added 13 commits June 13, 2025 14:20
@pinheadmz @vasild
SockMan: introduce class and implement binding to listening socket
9299d5d 
Introduce a new low-level socket managing class `SockMan`.
Unit-test it with a new class `SocketTestingSetup` which mocks
`CreateSock()` and will enable mock client I/O in future commits.

`SockMan` and `SocketTestingSetup` are designed to be generic and
reusbale for higher-level network protocol implementation and testing.

Co-authored-by: Vasil Dimov <[email protected]>
@pinheadmz @vasild
style: modernize the style of SockMan::BindListenPort()
de63369 
It was copied verbatim from `CConnman::BindListenPort()` in the previous
commit. Modernize its variables and style and log the error messages
from the caller. Also categorize the informative messages to the "net"
category because they are quite specific to the networking layer.

Co-authored-by: Vasil Dimov <[email protected]>
@pinheadmz @vasild
SockMan: implement and test AcceptConnection()
f6af0c8 
Co-authored-by: Vasil Dimov <[email protected]>
@vasild @pinheadmz
style: modernize the style of SockMan::AcceptConnection()
cca484c
@pinheadmz @vasild
SockMan: generate sequential Ids for each newly accepted connection
1deaa08 
Co-authored-by: Vasil Dimov <[email protected]>
@pinheadmz @vasild
SockMan: start an I/O loop in a new thread and accept connections
2e6cdb4 
Socket handling methods are copied from CConnMan:

`CConnman::GenerateWaitSockets()` goes to
`SockMan::GenerateWaitSockets()`.

`CConnman::ThreadSocketHandler()` and
`CConnman::SocketHandler()` are combined into
`SockMan::ThreadSocketHandler()`.

`CConnman::SocketHandlerListening()` goes to
`SockMan::SocketHandlerListening()`.

Co-authored-by: Vasil Dimov <[email protected]>
@pinheadmz @vasild
SockMan: handle connected sockets: read data from socket
674a5ff 
`CConnman::SocketHandlerConnected()` copied to
`SockMan::SocketHandlerConnected()`.

Testing this requires adding a new feature to the SocketTestingSetup,
inserting a "request" payload into the mock client that conencts
to us.

Co-authored-by: Vasil Dimov <[email protected]>
@pinheadmz @vasild
SockMan: handle connected sockets: write data to socket
3f796b6 
Sockets-touching bits from `CConnman::SocketSendData()` copied to
`SockMan::SendBytes()`.

Testing this requires adding a new feature to the SocketTestingSetup,
returning the DynSock I/O pipes from the mock socket so the recevied
data can be checked.

Co-authored-by: Vasil Dimov <[email protected]>
@pinheadmz @vasild
SockMan: dispatch cyclical events from I/O loop
5f79411 
Copy from some parts of `CConnman::SocketHandlerConnected()` and
`CConnman::ThreadSocketHandler()` to:
`EventIOLoopCompletedForOne(id)` and `EventIOLoopCompletedForAll()`.

Co-authored-by: Vasil Dimov <[email protected]>
@Sjors
Merge remote-tracking branch 'pinheadmz/sockman-lite' into 2024/06/sv…
cf812f6 
…2_connection
@Sjors @ccdle12
Add sv2 SETUP_CONNECTION messages
5f6250e 
Co-Authored-By: Christopher Coverdale <[email protected]>
@Sjors
Add strings for Sv2MsgType
e702957
@Sjors @vasild
Add Sv2Connman
de05710 
Co-Authored-By: Vasil Dimov <[email protected]>
@Sjors Sjors force-pushed the 2024/06/sv2_connection branch from 7d5d5ad to de05710 Compare June 16, 2025 08:20
@Sjors Sjors mentioned this pull request Jun 16, 2025
Open
@Sjors
Copy link
Owner Author

Sjors commented Jun 16, 2025

I switched to @pinheadmz's lite version of SockMan for now: bitcoin#32747

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vasild vasild vasild left review comments

@pinheadmz pinheadmz pinheadmz left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Sjors @vasild @pinheadmz