This specification could be improved by using byte encoding for Lightning messages instead of JSON encoded payloads. This would make the specification more precise, faster to parse and require less space to transmit and store messages. Current Lightning messages use byte encodings for this reason and all Lightning implementations implement codecs for handling byte encodings. Using an encoding format familiar to reviewers of current Lightning messages should also help increase feedback and facilitate eventual adoption.
This is a big change, but should help with the evolution and adoption of PeerSwap.
For example, the swap_in_request message as currently described looks like:
type: 42069
payload json encoded:
{
protocol_version: uint64,
swap_id: string,
asset: string,
network: string,
scid: string,
amount: uint64,
pubkey: string
}
An example of this message described with byte encoding based on the fundamental Lightning types might look something like the following:
-
type: 42069 (swap_in_request)
-
data:
- [
u16:protocol_version]
- [
u32:swap_id]
- [
chain_hash:network]
- [
short_channel_id:short_channel_id]
- [
u64:amount]
- [
point:pubkey]
- [
request_tlvs:tlvs]
-
tlv_stream: request_tlvs
-
types:
- type: 1 (
asset_id)
- data:
Note: network field indicates the chain_hash of the network used to create on-chain transactions, such as Bitcoin mainnet or signet, but could also indicate a network such as Liquid.
The optional asset_id contains any network specific data needed for on-chain transactions.
This specification could be improved by using byte encoding for Lightning messages instead of JSON encoded payloads. This would make the specification more precise, faster to parse and require less space to transmit and store messages. Current Lightning messages use byte encodings for this reason and all Lightning implementations implement codecs for handling byte encodings. Using an encoding format familiar to reviewers of current Lightning messages should also help increase feedback and facilitate eventual adoption.
This is a big change, but should help with the evolution and adoption of PeerSwap.
For example, the
swap_in_requestmessage as currently described looks like:type: 42069payloadjson encoded:An example of this message described with byte encoding based on the fundamental Lightning types might look something like the following:
type: 42069 (
swap_in_request)data:
u16:protocol_version]u32:swap_id]chain_hash:network]short_channel_id:short_channel_id]u64:amount]point:pubkey]request_tlvs:tlvs]tlv_stream:request_tlvstypes:
asset_id)...*byte:data]Note:
networkfield indicates thechain_hashof the network used to create on-chain transactions, such as Bitcoinmainnetorsignet, but could also indicate a network such as Liquid.The optional
asset_idcontains anynetworkspecific data needed for on-chain transactions.