multi: create challenger, secret, and interceptor packages

orbitalturtle commented 1 year ago

This PR is just moving things around and exporting things. It attempts to make a few organizational changes:

Moves the challenger, secret, and client_interceptor code to new packages so that 1) they can be imported elsewhere. 2) to get rid of importing cycles when importing this code (particularly for the watchtower case described below)
Exports some of the testing mock tools, since they are potentially useful in the watchtower tests, and seems to make sense to keep things as DRY as possible!

Stepping back, the higher level goal here is to be able to use some of the minter and challenger code in the lnd watchtower for minting and verifying lsats. I had talked with @roasbeef a while back about adding a method of paying a watchtower for storing state updates for other users, and we discussed using lsats for this purpose. This lays the groundwork for that. (Initial PR for the watchtower code incoming soon(tm))

If there are reasons to organize these changes in a different way, I'm more than happy to make adjustments, thanks!

ellemouton commented 1 year ago

Thanks for the PR @orbitalturtle 🔥

@guggero - I dont have the perms to request myself as reviewer here it seems. Can you request review from me pls?

bucko13 commented 1 year ago

Just wanted to chime in a plus one on the motivation for this. Being able to use this more as a library when applicable will be huge for lsat adoption imo.

ellemouton commented 1 year ago

@orbitalturtle , planning to continue with this? I think it is pretty much good to go once the nits have been addressed :)

orbitalturtle commented 1 year ago

@ellemouton Yikes, yes, sorry for being so slow :sloth: to get to this. I don't know how time moves so fast. I'll review and address your feedback this weekend. :pray:

orbitalturtle commented 1 year ago

@ellemouton Finally got around to this. Sorry for the long wait. Promise if you have any more feedback I'll respond much faster! One comment/question above but otherwise was able to address the rest of the comments.

Roasbeef commented 1 year ago

Approved the CI run.

orbitalturtle commented 1 year ago

Thanks @Roasbeef - fixed that linter issue.

orbitalturtle commented 1 year ago

@ellemouton Yeah definitely a fair point about the mocks. Here's what I'm envisioning. I'll definitely be making some changes to the mocks to test the aforementioned lnd watchtower payments changes. But I figured it would be a bit odd to copy the mocks and make updates to it in the lnd repo, since someone who might also be interested in these mock updates is unlikely to be looking in lnd/watchtower for them. If someone might want to use or copy these mocks, they're much more likely to look here in the aperture package for inspiration.

As you said, it's awkward that the auth package supplies the Mint mock and the or that the challenger supplies the mock for the InvoiceClient. I'd personally lean towards keeping these mocks exported, but moving them to a more appropriate package -- either a separate "mock" package or just to more appropriate existing packages. Then users can choose to either import or just copy the mocks for whatever projects their working on -- depending on what makes sense for their particular project.