Building on top of decred/atomic swaps code - Next Steps

decred / atomicswap

On-chain atomic swaps for Decred and other cryptocurrencies.

https://blog.decred.org/2017/09/20/On-Chain-Atomic-Swaps/

ISC License

509 stars 231 forks source link

Building on top of decred/atomic swaps code - Next Steps #94

Closed devwarrior777 closed 5 years ago

devwarrior777 commented 5 years ago

Thoughts about building on top of decred/atomic swaps code:

The tools are great as a PoC but difficult to use from other code

Standalone executables is fine for PoC
Trying to use them in new code means making unwieldy child processes from them .. awkward!
The current tools from individual coins need to be in non-main packages can wrap command line around that if wanted
It is then ok to import those packages into new code such as sequencer for an atomic swap
The new individual coin packages should ~be emitting json~ later have gRPC/protocol buffer support
They should not have the decision to broadcast txs, rather that should be for higher level code
@jrick Your idea for go 1.11 module use is a great idea to manage the individual coin packages Cheers 😉

devwarrior777 commented 5 years ago

Some context: https://github.com/xaur/decred-issues/issues/8

devwarrior777 commented 5 years ago

Here is an example of the above suggestion.

https://github.com/devwarrior777/atomicswap/tree/libs

Took one coin (Zcoin, XZC) and refactored decred/atomicswap/

Created a new libs folder for coin specific libraries
Added libs/xzc for Zcoin. Moved all HTLC/RPC code there from the cmd/xzcatomiswap/main.go tool
Refactored and simplified the command tool xzcatomiswap .. it also acts as a testcase for the libs/xzc code

The core of the new libs/xzc code is commands.go which is a Public interface/api into the HTLC and RPC functionality.

This could be taken further by including all coin-specific code in it's respective libs/ directory instead of having that dispersed on the various contributor's github repos. Or not; as seen fit.

Cheers

devwarrior777 commented 5 years ago

Added protocol buffers bindings for example refactor above

https://github.com/devwarrior777/atomicswap/blob/libs/libs/protobind/atomicswap.proto

... for future gRPC / non-golang language support

jrick commented 5 years ago

This is interesting work and would definitely be useful to some applications, but I feel that it is currently out of scope for this project and may require extra work for maintainers who have already ported their tools. Perhaps if/when the DEX development begins, this can be reconsidered.