WIP: Tools: event tests

formats-gossip_queries_ex-and-static_remotekey.csv

@@ -0,0 +1,254 @@
+msgtype,init,16
+msgdata,init,gflen,u16,
+msgdata,init,globalfeatures,byte,gflen
+msgdata,init,lflen,u16,
+msgdata,init,localfeatures,byte,lflen
+msgtype,error,17
+msgdata,error,channel_id,channel_id,
+msgdata,error,len,u16,
+msgdata,error,data,byte,len
+msgtype,ping,18
+msgdata,ping,num_pong_bytes,u16,
+msgdata,ping,byteslen,u16,
+msgdata,ping,ignored,byte,byteslen
+msgtype,pong,19
+msgdata,pong,byteslen,u16,
+msgdata,pong,ignored,byte,byteslen
+tlvtype,n1,tlv1,1
+tlvdata,n1,tlv1,amount_msat,tu64,
+tlvtype,n1,tlv2,2
+tlvdata,n1,tlv2,scid,short_channel_id,
+tlvtype,n1,tlv3,3
+tlvdata,n1,tlv3,node_id,point,
+tlvdata,n1,tlv3,amount_msat_1,u64,
+tlvdata,n1,tlv3,amount_msat_2,u64,
+tlvtype,n1,tlv4,254
+tlvdata,n1,tlv4,cltv_delta,u16,
+tlvtype,n2,tlv1,0
+tlvdata,n2,tlv1,amount_msat,tu64,
+tlvtype,n2,tlv2,11
+tlvdata,n2,tlv2,cltv_expiry,tu32,
+msgtype,open_channel,32
+msgdata,open_channel,chain_hash,chain_hash,
+msgdata,open_channel,temporary_channel_id,byte,32
+msgdata,open_channel,funding_satoshis,u64,
+msgdata,open_channel,push_msat,u64,
+msgdata,open_channel,dust_limit_satoshis,u64,
+msgdata,open_channel,max_htlc_value_in_flight_msat,u64,
+msgdata,open_channel,channel_reserve_satoshis,u64,
+msgdata,open_channel,htlc_minimum_msat,u64,
+msgdata,open_channel,feerate_per_kw,u32,
+msgdata,open_channel,to_self_delay,u16,
+msgdata,open_channel,max_accepted_htlcs,u16,
+msgdata,open_channel,funding_pubkey,point,
+msgdata,open_channel,revocation_basepoint,point,
+msgdata,open_channel,payment_basepoint,point,
+msgdata,open_channel,delayed_payment_basepoint,point,
+msgdata,open_channel,htlc_basepoint,point,
+msgdata,open_channel,first_per_commitment_point,point,
+msgdata,open_channel,channel_flags,byte,
+msgdata,open_channel,shutdown_len,u16,,option_upfront_shutdown_script
+msgdata,open_channel,shutdown_scriptpubkey,byte,shutdown_len,option_upfront_shutdown_script
+msgtype,accept_channel,33
+msgdata,accept_channel,temporary_channel_id,byte,32
+msgdata,accept_channel,dust_limit_satoshis,u64,
+msgdata,accept_channel,max_htlc_value_in_flight_msat,u64,
+msgdata,accept_channel,channel_reserve_satoshis,u64,
+msgdata,accept_channel,htlc_minimum_msat,u64,
+msgdata,accept_channel,minimum_depth,u32,
+msgdata,accept_channel,to_self_delay,u16,
+msgdata,accept_channel,max_accepted_htlcs,u16,
+msgdata,accept_channel,funding_pubkey,point,
+msgdata,accept_channel,revocation_basepoint,point,
+msgdata,accept_channel,payment_basepoint,point,
+msgdata,accept_channel,delayed_payment_basepoint,point,
+msgdata,accept_channel,htlc_basepoint,point,
+msgdata,accept_channel,first_per_commitment_point,point,
+msgdata,accept_channel,shutdown_len,u16,,option_upfront_shutdown_script
+msgdata,accept_channel,shutdown_scriptpubkey,byte,shutdown_len,option_upfront_shutdown_script
+msgtype,funding_created,34
+msgdata,funding_created,temporary_channel_id,byte,32
+msgdata,funding_created,funding_txid,sha256,
+msgdata,funding_created,funding_output_index,u16,
+msgdata,funding_created,signature,signature,
+msgtype,funding_signed,35
+msgdata,funding_signed,channel_id,channel_id,
+msgdata,funding_signed,signature,signature,
+msgtype,funding_locked,36
+msgdata,funding_locked,channel_id,channel_id,
+msgdata,funding_locked,next_per_commitment_point,point,
+msgtype,shutdown,38
+msgdata,shutdown,channel_id,channel_id,
+msgdata,shutdown,len,u16,
+msgdata,shutdown,scriptpubkey,byte,len
+msgtype,closing_signed,39
+msgdata,closing_signed,channel_id,channel_id,
+msgdata,closing_signed,fee_satoshis,u64,
+msgdata,closing_signed,signature,signature,
+msgtype,update_add_htlc,128
+msgdata,update_add_htlc,channel_id,channel_id,
+msgdata,update_add_htlc,id,u64,
+msgdata,update_add_htlc,amount_msat,u64,
+msgdata,update_add_htlc,payment_hash,sha256,
+msgdata,update_add_htlc,cltv_expiry,u32,
+msgdata,update_add_htlc,onion_routing_packet,byte,1366
+msgtype,update_fulfill_htlc,130
+msgdata,update_fulfill_htlc,channel_id,channel_id,
+msgdata,update_fulfill_htlc,id,u64,
+msgdata,update_fulfill_htlc,payment_preimage,byte,32
+msgtype,update_fail_htlc,131
+msgdata,update_fail_htlc,channel_id,channel_id,
+msgdata,update_fail_htlc,id,u64,
+msgdata,update_fail_htlc,len,u16,
+msgdata,update_fail_htlc,reason,byte,len
+msgtype,update_fail_malformed_htlc,135
+msgdata,update_fail_malformed_htlc,channel_id,channel_id,
+msgdata,update_fail_malformed_htlc,id,u64,
+msgdata,update_fail_malformed_htlc,sha256_of_onion,sha256,
+msgdata,update_fail_malformed_htlc,failure_code,u16,
+msgtype,commitment_signed,132
+msgdata,commitment_signed,channel_id,channel_id,
+msgdata,commitment_signed,signature,signature,
+msgdata,commitment_signed,num_htlcs,u16,
+msgdata,commitment_signed,htlc_signature,signature,num_htlcs
+msgtype,revoke_and_ack,133
+msgdata,revoke_and_ack,channel_id,channel_id,
+msgdata,revoke_and_ack,per_commitment_secret,byte,32
+msgdata,revoke_and_ack,next_per_commitment_point,point,
+msgtype,update_fee,134
+msgdata,update_fee,channel_id,channel_id,
+msgdata,update_fee,feerate_per_kw,u32,
+msgtype,channel_reestablish,136
+msgdata,channel_reestablish,channel_id,channel_id,
+msgdata,channel_reestablish,next_commitment_number,u64,
+msgdata,channel_reestablish,next_revocation_number,u64,
+msgdata,channel_reestablish,your_last_per_commitment_secret,byte,32,option_data_loss_protect,option_static_remotekey
+msgdata,channel_reestablish,my_current_per_commitment_point,point,,option_data_loss_protect
+tlvtype,tlv_payload,amt_to_forward,2
+tlvdata,tlv_payload,amt_to_forward,amt_to_forward,tu64,
+tlvtype,tlv_payload,outgoing_cltv_value,4
+tlvdata,tlv_payload,outgoing_cltv_value,outgoing_cltv_value,tu32,
+tlvtype,tlv_payload,short_channel_id,6
+tlvdata,tlv_payload,short_channel_id,short_channel_id,short_channel_id,
+msgtype,invalid_realm,PERM|1
+msgtype,temporary_node_failure,NODE|2
+msgtype,permanent_node_failure,PERM|NODE|2
+msgtype,required_node_feature_missing,PERM|NODE|3
+msgtype,invalid_onion_version,BADONION|PERM|4
+msgdata,invalid_onion_version,sha256_of_onion,sha256,
+msgtype,invalid_onion_hmac,BADONION|PERM|5
+msgdata,invalid_onion_hmac,sha256_of_onion,sha256,
+msgtype,invalid_onion_key,BADONION|PERM|6
+msgdata,invalid_onion_key,sha256_of_onion,sha256,
+msgtype,temporary_channel_failure,UPDATE|7
+msgdata,temporary_channel_failure,len,u16,
+msgdata,temporary_channel_failure,channel_update,byte,len
+msgtype,permanent_channel_failure,PERM|8
+msgtype,required_channel_feature_missing,PERM|9
+msgtype,unknown_next_peer,PERM|10
+msgtype,amount_below_minimum,UPDATE|11
+msgdata,amount_below_minimum,htlc_msat,u64,
+msgdata,amount_below_minimum,len,u16,
+msgdata,amount_below_minimum,channel_update,byte,len
+msgtype,fee_insufficient,UPDATE|12
+msgdata,fee_insufficient,htlc_msat,u64,
+msgdata,fee_insufficient,len,u16,
+msgdata,fee_insufficient,channel_update,byte,len
+msgtype,incorrect_cltv_expiry,UPDATE|13
+msgdata,incorrect_cltv_expiry,cltv_expiry,u32,
+msgdata,incorrect_cltv_expiry,len,u16,
+msgdata,incorrect_cltv_expiry,channel_update,byte,len
+msgtype,expiry_too_soon,UPDATE|14
+msgdata,expiry_too_soon,len,u16,
+msgdata,expiry_too_soon,channel_update,byte,len
+msgtype,incorrect_or_unknown_payment_details,PERM|15
+msgdata,incorrect_or_unknown_payment_details,htlc_msat,u64,
+msgtype,final_expiry_too_soon,17
+msgtype,final_incorrect_cltv_expiry,18
+msgdata,final_incorrect_cltv_expiry,cltv_expiry,u32,
+msgtype,final_incorrect_htlc_amount,19
+msgdata,final_incorrect_htlc_amount,incoming_htlc_amt,u64,
+msgtype,channel_disabled,UPDATE|20
+msgtype,expiry_too_far,21
+msgtype,announcement_signatures,259
+msgdata,announcement_signatures,channel_id,channel_id,
+msgdata,announcement_signatures,short_channel_id,short_channel_id,
+msgdata,announcement_signatures,node_signature,signature,
+msgdata,announcement_signatures,bitcoin_signature,signature,
+msgtype,channel_announcement,256
+msgdata,channel_announcement,node_signature_1,signature,
+msgdata,channel_announcement,node_signature_2,signature,
+msgdata,channel_announcement,bitcoin_signature_1,signature,
+msgdata,channel_announcement,bitcoin_signature_2,signature,
+msgdata,channel_announcement,len,u16,
+msgdata,channel_announcement,features,byte,len
+msgdata,channel_announcement,chain_hash,chain_hash,
+msgdata,channel_announcement,short_channel_id,short_channel_id,
+msgdata,channel_announcement,node_id_1,point,
+msgdata,channel_announcement,node_id_2,point,
+msgdata,channel_announcement,bitcoin_key_1,point,
+msgdata,channel_announcement,bitcoin_key_2,point,
+msgtype,node_announcement,257
+msgdata,node_announcement,signature,signature,
+msgdata,node_announcement,flen,u16,
+msgdata,node_announcement,features,byte,flen
+msgdata,node_announcement,timestamp,u32,
+msgdata,node_announcement,node_id,point,
+msgdata,node_announcement,rgb_color,byte,3
+msgdata,node_announcement,alias,byte,32
+msgdata,node_announcement,addrlen,u16,
+msgdata,node_announcement,addresses,byte,addrlen
+msgtype,channel_update,258
+msgdata,channel_update,signature,signature,
+msgdata,channel_update,chain_hash,chain_hash,
+msgdata,channel_update,short_channel_id,short_channel_id,
+msgdata,channel_update,timestamp,u32,
+msgdata,channel_update,message_flags,byte,
+msgdata,channel_update,channel_flags,byte,
+msgdata,channel_update,cltv_expiry_delta,u16,
+msgdata,channel_update,htlc_minimum_msat,u64,
+msgdata,channel_update,fee_base_msat,u32,
+msgdata,channel_update,fee_proportional_millionths,u32,
+msgdata,channel_update,htlc_maximum_msat,u64,,option_channel_htlc_max
+msgtype,query_short_channel_ids,261,gossip_queries
+msgdata,query_short_channel_ids,chain_hash,chain_hash,
+msgdata,query_short_channel_ids,len,u16,
+msgdata,query_short_channel_ids,encoded_short_ids,byte,len
+msgdata,query_short_channel_ids,tlvs,query_short_channel_ids_tlvs,
+tlvtype,query_short_channel_ids_tlvs,query_flags,1
+tlvdata,query_short_channel_ids_tlvs,query_flags,encoding_type,byte,
+tlvdata,query_short_channel_ids_tlvs,query_flags,encoded_query_flags,byte,...
+msgtype,reply_short_channel_ids_end,262,gossip_queries
+msgdata,reply_short_channel_ids_end,chain_hash,chain_hash,
+msgdata,reply_short_channel_ids_end,complete,byte,
+msgtype,query_channel_range,263,gossip_queries
+msgdata,query_channel_range,chain_hash,chain_hash,
+msgdata,query_channel_range,first_blocknum,u32,
+msgdata,query_channel_range,number_of_blocks,u32,
+msgdata,query_channel_range,tlvs,query_channel_range_tlvs,
+tlvtype,query_channel_range_tlvs,query_option,1
+tlvdata,query_channel_range_tlvs,query_option,query_option_flags,varint,
+msgtype,reply_channel_range,264,gossip_queries
+msgdata,reply_channel_range,chain_hash,chain_hash,
+msgdata,reply_channel_range,first_blocknum,u32,
+msgdata,reply_channel_range,number_of_blocks,u32,
+msgdata,reply_channel_range,complete,byte,
+msgdata,reply_channel_range,len,u16,
+msgdata,reply_channel_range,encoded_short_ids,byte,len
+msgdata,reply_channel_range,tlvs,reply_channel_range_tlvs,
+tlvtype,reply_channel_range_tlvs,timestamps_tlv,1
+tlvdata,reply_channel_range_tlvs,timestamps_tlv,encoding_type,byte,
+tlvdata,reply_channel_range_tlvs,timestamps_tlv,encoded_timestamps,byte,...
+tlvtype,reply_channel_range_tlvs,checksums_tlv,3
+tlvdata,reply_channel_range_tlvs,checksums_tlv,encoding_type,byte,
+tlvdata,reply_channel_range_tlvs,checksums_tlv,encoded_checksums,byte,...
+subtype,channel_update_timestamps
+subtypedata,channel_update_timestamps,timestamp_node_id_1,u32,
+subtypedata,channel_update_timestamps,timestamp_node_id_2,u32,
+subtype,channel_update_checksums
+subtypedata,channel_update_checksums,checksum_node_id_1,u32,
+subtypedata,channel_update_checksums,checksum_node_id_2,u32,
+msgtype,gossip_timestamp_filter,265,gossip_queries
+msgdata,gossip_timestamp_filter,chain_hash,chain_hash,
+msgdata,gossip_timestamp_filter,first_timestamp,u32,
+msgdata,gossip_timestamp_filter,timestamp_range,u32,

tests/events/README.md

@@ -0,0 +1,23 @@
+# Implementation Tests for Lightning Specifications
+
+This directory contains conversation-style tests for Lightning
+implementations.  The format is documented in
+[tests/events/test-spec.md](events/test-spec.md), and the base driver for an
+implementation is in the [tools/test-events.py](../tools/test-events.py).
+
+To run the tests, you need to write a driver for your particular
+implementation, like the one for
+[c-lightning](../tools/test-events-clightning.py).  Then extract the
+format of all messages into a file, like so:
+
+	$ python3 tools/extract-formats.py 0*.md > format.csv
+
+Finally, you can run a test like so:
+
+	$ tools/test-events-clightning.py formats.csv tests/events/*.events
+
+The `-v` option will give more verbose output, which is particularly
+useful when debugging your test script.
+
+Good luck!
+Rusty.

tests/events/bolt1-01-init.events

@@ -0,0 +1,75 @@
+# Variations on init exchange.
+# Spec: MUST respond to known feature bits as specified in [BOLT #9](09-features.md).
+
+1. connect: privkey=0000000000000000000000000000000000000000000000000000000000000003
+2. expect-send: type=init
+3. recv: type=init globalfeatures= localfeatures=
+
+    1. nothing
+    1. disconnect:
+
+4. connect: privkey=0000000000000000000000000000000000000000000000000000000000000002
+    # Even if we don't send anything, it should send init.
+    1. expect-send: type=init
+
+    # Minimal possible init message.
+    # Spec: MUST send `init` as the first Lightning message for any connection.
+    1. expect-send: type=init
+    2. recv: type=init globalfeatures= localfeatures=
+
+    # Sanity check that bits 14 and 15 are not used!
+    1. expect-send: type=init globalfeatures=0000/C000
+    # init msg with unknown odd global bit (15): no error
+    2. recv: type=init globalfeatures=8000 localfeatures=
+
+    1. expect-send: type=init localfeatures=0000/C000
+    # init msg with unknown odd local bit (15): no error
+    2. recv: type=init globalfeatures= localfeatures=8000
+
+    # init msg with unknown even global bit (14): you will error
+    1. expect-send: type=init
+    2. recv: type=init globalfeatures=4000 localfeatures=
+    3. expect-error:
+
+    # init msg with unknown even local bit (14): you will error
+    1. expect-send: type=init
+    2. recv: type=init globalfeatures= localfeatures=4000
+    3. expect-error:
+
+    # If you don't support `option_data_loss_protect`, you will be ok if
+    # we ask for it.
+    1. expect-send: type=init localfeatures=00/03 !option_data_loss_protect
+    2. recv: type=init globalfeatures= localfeatures=02 !option_data_loss_protect
+
+    # If you don't support `option_data_loss_protect`, you will error if
+    # we require it.
+    1. expect-send: type=init localfeatures=00/03 !option_data_loss_protect
+    2. recv: type=init globalfeatures= localfeatures=01 !option_data_loss_protect
+    3. expect-error: !option_data_loss_protect
+
+    # If you support `option_data_loss_protect`, you will advertize it odd.
+    1. expect-send: type=init localfeatures=02/03 option_data_loss_protect/odd
+
+    # If you require `option_data_loss_protect`, you will advertize it even.
+    1. expect-send: type=init localfeatures=01/03 option_data_loss_protect/even
+
+    # If you don't support `option_static_remotekey`, you will be ok if
+    # we ask for it.
+    1. expect-send: type=init localfeatures=0000000000/C000000000 !option_static_remotekey
+    2. recv: type=init globalfeatures= localfeatures=02000000000000 !option_static_remotekey
+
+    # If you don't support `option_static_remotekey`, you will error if
+    # we require it.
+    1. expect-send: type=init localfeatures=0000000000/C000000000 !option_static_remotekey
+    2. recv: type=init globalfeatures= localfeatures=01000000000000 !option_static_remotekey
+    3. expect-error: !option_static_remotekey
+
+    # If you support `option_static_remotekey`, you will advertize it odd.
+    1. expect-send: type=init localfeatures=02000000000000/03000000000000 option_static_remotekey/odd
+
+    # If you require `option_static_remotekey`, you will advertize it even.
+    1. expect-send: type=init localfeatures=01000000000000/03000000000000 option_static_remotekey/even
+
+    # Note: it's undefined what you'll do if implementation requires
+    # an option and isn't offered it.  The recipient of the required feature
+    # bit should notice the requirement and error.

tests/events/bolt1-02-unknown-messages.events

@@ -0,0 +1,22 @@
+# Init exchange, with unknown messages
+#
+# BOLT #1:
+# The receiving node:
+#...
+#   - upon receiving unknown _odd_ feature bits that are non-zero:
+#     - MUST ignore the bit.
+#   - upon receiving unknown _even_ feature bits that are non-zero:
+#     - MUST fail the connection.
+
+1. connect: privkey=0000000000000000000000000000000000000000000000000000000000000003
+2. expect-send: type=init
+3. recv: type=init globalfeatures= localfeatures=
+
+    1. nothing
+
+    # Unknown odd is OK.
+    1. recv: type=9999
+
+    # Unknown even causes error.
+    1. recv: type=10000
+    2. expect-error: