_ Git - ldk-java/blob - src/main/java/org/ldk/structs/Sign.java

   1 package org.ldk.structs;
   2
   3 import org.ldk.impl.bindings;
   4 import org.ldk.enums.*;
   5 import org.ldk.util.*;
   6 import java.util.Arrays;
   7
   8 /**
   9  * A trait to sign lightning channel transactions as described in BOLT 3.
  10  *
  11  * Signing services could be implemented on a hardware wallet. In this case,
  12  * the current Sign would be a front-end on top of a communication
  13  * channel connected to your secure device and lightning key material wouldn't
  14  * reside on a hot server. Nevertheless, a this deployment would still need
  15  * to trust the ChannelManager to avoid loss of funds as this latest component
  16  * could ask to sign commitment transaction with HTLCs paying to attacker pubkeys.
  17  *
  18  * A more secure iteration would be to use hashlock (or payment points) to pair
  19  * invoice/incoming HTLCs with outgoing HTLCs to implement a no-trust-ChannelManager
  20  * at the price of more state and computation on the hardware wallet side. In the future,
  21  * we are looking forward to design such interface.
  22  *
  23  * In any case, ChannelMonitor or fallback watchtowers are always going to be trusted
  24  * to act, as liveness and breach reply correctness are always going to be hard requirements
  25  * of LN security model, orthogonal of key management issues.
  26  */
  27 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
  28 public class Sign extends CommonBase {
  29         final bindings.LDKSign bindings_instance;
  30         Sign(Object _dummy, long ptr) { super(ptr); bindings_instance = null; }
  31         private Sign(bindings.LDKSign arg, ChannelPublicKeys pubkeys) {
  32                 super(bindings.LDKSign_new(arg, pubkeys == null ? 0 : pubkeys.ptr & ~1));
  33                 this.ptrs_to.add(arg);
  34                 this.ptrs_to.add(pubkeys);
  35                 this.bindings_instance = arg;
  36         }
  37         @Override @SuppressWarnings("deprecation")
  38         protected void finalize() throws Throwable {
  39                 if (ptr != 0) { bindings.Sign_free(ptr); } super.finalize();
  40         }
  41
  42         public static interface SignInterface {
  43                 /**
  44                  * Gets the per-commitment point for a specific commitment number
  45                  *
  46                  * Note that the commitment number starts at (1 << 48) - 1 and counts backwards.
  47                  */
  48                 byte[] get_per_commitment_point(long idx);
  49                 /**
  50                  * Gets the commitment secret for a specific commitment number as part of the revocation process
  51                  *
  52                  * An external signer implementation should error here if the commitment was already signed
  53                  * and should refuse to sign it in the future.
  54                  *
  55                  * May be called more than once for the same index.
  56                  *
  57                  * Note that the commitment number starts at (1 << 48) - 1 and counts backwards.
  58                  */
  59                 byte[] release_commitment_secret(long idx);
  60                 /**
  61                  * Gets an arbitrary identifier describing the set of keys which are provided back to you in
  62                  * some SpendableOutputDescriptor types. This should be sufficient to identify this
  63                  * Sign object uniquely and lookup or re-derive its keys.
  64                  */
  65                 byte[] channel_keys_id();
  66                 /**
  67                  * Create a signature for a counterparty's commitment transaction and associated HTLC transactions.
  68                  *
  69                  * Note that if signing fails or is rejected, the channel will be force-closed.
  70                  */
  71                 Result_C2Tuple_SignatureCVec_SignatureZZNoneZ sign_counterparty_commitment(CommitmentTransaction commitment_tx);
  72                 /**
  73                  * Create a signatures for a holder's commitment transaction and its claiming HTLC transactions.
  74                  * This will only ever be called with a non-revoked commitment_tx.  This will be called with the
  75                  * latest commitment_tx when we initiate a force-close.
  76                  * This will be called with the previous latest, just to get claiming HTLC signatures, if we are
  77                  * reacting to a ChannelMonitor replica that decided to broadcast before it had been updated to
  78                  * the latest.
  79                  * This may be called multiple times for the same transaction.
  80                  *
  81                  * An external signer implementation should check that the commitment has not been revoked.
  82                  *
  83                  * May return Err if key derivation fails.  Callers, such as ChannelMonitor, will panic in such a case.
  84                  */
  85                 Result_C2Tuple_SignatureCVec_SignatureZZNoneZ sign_holder_commitment_and_htlcs(HolderCommitmentTransaction commitment_tx);
  86                 /**
  87                  * Create a signature for the given input in a transaction spending an HTLC or commitment
  88                  * transaction output when our counterparty broadcasts an old state.
  89                  *
  90                  * A justice transaction may claim multiples outputs at the same time if timelocks are
  91                  * similar, but only a signature for the input at index `input` should be signed for here.
  92                  * It may be called multiples time for same output(s) if a fee-bump is needed with regards
  93                  * to an upcoming timelock expiration.
  94                  *
  95                  * Amount is value of the output spent by this input, committed to in the BIP 143 signature.
  96                  *
  97                  * per_commitment_key is revocation secret which was provided by our counterparty when they
  98                  * revoked the state which they eventually broadcast. It's not a _holder_ secret key and does
  99                  * not allow the spending of any funds by itself (you need our holder revocation_secret to do
 100                  * so).
 101                  *
 102                  * htlc holds HTLC elements (hash, timelock) if the output being spent is a HTLC output, thus
 103                  * changing the format of the witness script (which is committed to in the BIP 143
 104                  * signatures).
 105                  */
 106                 Result_SignatureNoneZ sign_justice_transaction(byte[] justice_tx, long input, long amount, byte[] per_commitment_key, HTLCOutputInCommitment htlc);
 107                 /**
 108                  * Create a signature for a claiming transaction for a HTLC output on a counterparty's commitment
 109                  * transaction, either offered or received.
 110                  *
 111                  * Such a transaction may claim multiples offered outputs at same time if we know the
 112                  * preimage for each when we create it, but only the input at index `input` should be
 113                  * signed for here. It may be called multiple times for same output(s) if a fee-bump is
 114                  * needed with regards to an upcoming timelock expiration.
 115                  *
 116                  * Witness_script is either a offered or received script as defined in BOLT3 for HTLC
 117                  * outputs.
 118                  *
 119                  * Amount is value of the output spent by this input, committed to in the BIP 143 signature.
 120                  *
 121                  * Per_commitment_point is the dynamic point corresponding to the channel state
 122                  * detected onchain. It has been generated by our counterparty and is used to derive
 123                  * channel state keys, which are then included in the witness script and committed to in the
 124                  * BIP 143 signature.
 125                  */
 126                 Result_SignatureNoneZ sign_counterparty_htlc_transaction(byte[] htlc_tx, long input, long amount, byte[] per_commitment_point, HTLCOutputInCommitment htlc);
 127                 /**
 128                  * Create a signature for a (proposed) closing transaction.
 129                  *
 130                  * Note that, due to rounding, there may be one \"missing\" satoshi, and either party may have
 131                  * chosen to forgo their output as dust.
 132                  */
 133                 Result_SignatureNoneZ sign_closing_transaction(byte[] closing_tx);
 134                 /**
 135                  * Signs a channel announcement message with our funding key, proving it comes from one
 136                  * of the channel participants.
 137                  *
 138                  * Note that if this fails or is rejected, the channel will not be publicly announced and
 139                  * our counterparty may (though likely will not) close the channel on us for violating the
 140                  * protocol.
 141                  */
 142                 Result_SignatureNoneZ sign_channel_announcement(UnsignedChannelAnnouncement msg);
 143                 /**
 144                  * Set the counterparty static channel data, including basepoints,
 145                  * counterparty_selected/holder_selected_contest_delay and funding outpoint.
 146                  * This is done as soon as the funding outpoint is known.  Since these are static channel data,
 147                  * they MUST NOT be allowed to change to different values once set.
 148                  *
 149                  * channel_parameters.is_populated() MUST be true.
 150                  *
 151                  * We bind holder_selected_contest_delay late here for API convenience.
 152                  *
 153                  * Will be called before any signatures are applied.
 154                  */
 155                 void ready_channel(ChannelTransactionParameters channel_parameters);
 156                 /**
 157                  * Serialize the object into a byte array
 158                  */
 159                 byte[] write();
 160         }
 161         private static class LDKSignHolder { Sign held; }
 162         public static Sign new_impl(SignInterface arg, ChannelPublicKeys pubkeys) {
 163                 final LDKSignHolder impl_holder = new LDKSignHolder();
 164                 impl_holder.held = new Sign(new bindings.LDKSign() {
 165                         @Override public byte[] get_per_commitment_point(long idx) {
 166                                 byte[] ret = arg.get_per_commitment_point(idx);
 167                                 return ret;
 168                         }
 169                         @Override public byte[] release_commitment_secret(long idx) {
 170                                 byte[] ret = arg.release_commitment_secret(idx);
 171                                 return ret;
 172                         }
 173                         @Override public byte[] channel_keys_id() {
 174                                 byte[] ret = arg.channel_keys_id();
 175                                 return ret;
 176                         }
 177                         @Override public long sign_counterparty_commitment(long commitment_tx) {
 178                                 CommitmentTransaction commitment_tx_hu_conv = new CommitmentTransaction(null, commitment_tx);
 179                                 Result_C2Tuple_SignatureCVec_SignatureZZNoneZ ret = arg.sign_counterparty_commitment(commitment_tx_hu_conv);
 180                                 long result = ret != null ? ret.ptr : 0;
 181                                 return result;
 182                         }
 183                         @Override public long sign_holder_commitment_and_htlcs(long commitment_tx) {
 184                                 HolderCommitmentTransaction commitment_tx_hu_conv = new HolderCommitmentTransaction(null, commitment_tx);
 185                                 Result_C2Tuple_SignatureCVec_SignatureZZNoneZ ret = arg.sign_holder_commitment_and_htlcs(commitment_tx_hu_conv);
 186                                 long result = ret != null ? ret.ptr : 0;
 187                                 return result;
 188                         }
 189                         @Override public long sign_justice_transaction(byte[] justice_tx, long input, long amount, byte[] per_commitment_key, long htlc) {
 190                                 HTLCOutputInCommitment htlc_hu_conv = new HTLCOutputInCommitment(null, htlc);
 191                                 Result_SignatureNoneZ ret = arg.sign_justice_transaction(justice_tx, input, amount, per_commitment_key, htlc_hu_conv);
 192                                 long result = ret != null ? ret.ptr : 0;
 193                                 return result;
 194                         }
 195                         @Override public long sign_counterparty_htlc_transaction(byte[] htlc_tx, long input, long amount, byte[] per_commitment_point, long htlc) {
 196                                 HTLCOutputInCommitment htlc_hu_conv = new HTLCOutputInCommitment(null, htlc);
 197                                 Result_SignatureNoneZ ret = arg.sign_counterparty_htlc_transaction(htlc_tx, input, amount, per_commitment_point, htlc_hu_conv);
 198                                 long result = ret != null ? ret.ptr : 0;
 199                                 return result;
 200                         }
 201                         @Override public long sign_closing_transaction(byte[] closing_tx) {
 202                                 Result_SignatureNoneZ ret = arg.sign_closing_transaction(closing_tx);
 203                                 long result = ret != null ? ret.ptr : 0;
 204                                 return result;
 205                         }
 206                         @Override public long sign_channel_announcement(long msg) {
 207                                 UnsignedChannelAnnouncement msg_hu_conv = new UnsignedChannelAnnouncement(null, msg);
 208                                 Result_SignatureNoneZ ret = arg.sign_channel_announcement(msg_hu_conv);
 209                                 long result = ret != null ? ret.ptr : 0;
 210                                 return result;
 211                         }
 212                         @Override public void ready_channel(long channel_parameters) {
 213                                 ChannelTransactionParameters channel_parameters_hu_conv = new ChannelTransactionParameters(null, channel_parameters);
 214                                 arg.ready_channel(channel_parameters_hu_conv);
 215                         }
 216                         @Override public byte[] write() {
 217                                 byte[] ret = arg.write();
 218                                 return ret;
 219                         }
 220                 }, pubkeys);
 221                 return impl_holder.held;
 222         }
 223         /**
 224          * Gets the per-commitment point for a specific commitment number
 225          *
 226          * Note that the commitment number starts at (1 << 48) - 1 and counts backwards.
 227          */
 228         public byte[] get_per_commitment_point(long idx) {
 229                 byte[] ret = bindings.Sign_get_per_commitment_point(this.ptr, idx);
 230                 return ret;
 231         }
 232
 233         /**
 234          * Gets the commitment secret for a specific commitment number as part of the revocation process
 235          *
 236          * An external signer implementation should error here if the commitment was already signed
 237          * and should refuse to sign it in the future.
 238          *
 239          * May be called more than once for the same index.
 240          *
 241          * Note that the commitment number starts at (1 << 48) - 1 and counts backwards.
 242          */
 243         public byte[] release_commitment_secret(long idx) {
 244                 byte[] ret = bindings.Sign_release_commitment_secret(this.ptr, idx);
 245                 return ret;
 246         }
 247
 248         /**
 249          * Gets an arbitrary identifier describing the set of keys which are provided back to you in
 250          * some SpendableOutputDescriptor types. This should be sufficient to identify this
 251          * Sign object uniquely and lookup or re-derive its keys.
 252          */
 253         public byte[] channel_keys_id() {
 254                 byte[] ret = bindings.Sign_channel_keys_id(this.ptr);
 255                 return ret;
 256         }
 257
 258         /**
 259          * Create a signature for a counterparty's commitment transaction and associated HTLC transactions.
 260          *
 261          * Note that if signing fails or is rejected, the channel will be force-closed.
 262          */
 263         public Result_C2Tuple_SignatureCVec_SignatureZZNoneZ sign_counterparty_commitment(CommitmentTransaction commitment_tx) {
 264                 long ret = bindings.Sign_sign_counterparty_commitment(this.ptr, commitment_tx == null ? 0 : commitment_tx.ptr & ~1);
 265                 Result_C2Tuple_SignatureCVec_SignatureZZNoneZ ret_hu_conv = Result_C2Tuple_SignatureCVec_SignatureZZNoneZ.constr_from_ptr(ret);
 266                 this.ptrs_to.add(commitment_tx);
 267                 return ret_hu_conv;
 268         }
 269
 270         /**
 271          * Create a signatures for a holder's commitment transaction and its claiming HTLC transactions.
 272          * This will only ever be called with a non-revoked commitment_tx.  This will be called with the
 273          * latest commitment_tx when we initiate a force-close.
 274          * This will be called with the previous latest, just to get claiming HTLC signatures, if we are
 275          * reacting to a ChannelMonitor replica that decided to broadcast before it had been updated to
 276          * the latest.
 277          * This may be called multiple times for the same transaction.
 278          *
 279          * An external signer implementation should check that the commitment has not been revoked.
 280          *
 281          * May return Err if key derivation fails.  Callers, such as ChannelMonitor, will panic in such a case.
 282          */
 283         public Result_C2Tuple_SignatureCVec_SignatureZZNoneZ sign_holder_commitment_and_htlcs(HolderCommitmentTransaction commitment_tx) {
 284                 long ret = bindings.Sign_sign_holder_commitment_and_htlcs(this.ptr, commitment_tx == null ? 0 : commitment_tx.ptr & ~1);
 285                 Result_C2Tuple_SignatureCVec_SignatureZZNoneZ ret_hu_conv = Result_C2Tuple_SignatureCVec_SignatureZZNoneZ.constr_from_ptr(ret);
 286                 this.ptrs_to.add(commitment_tx);
 287                 return ret_hu_conv;
 288         }
 289
 290         /**
 291          * Create a signature for the given input in a transaction spending an HTLC or commitment
 292          * transaction output when our counterparty broadcasts an old state.
 293          *
 294          * A justice transaction may claim multiples outputs at the same time if timelocks are
 295          * similar, but only a signature for the input at index `input` should be signed for here.
 296          * It may be called multiples time for same output(s) if a fee-bump is needed with regards
 297          * to an upcoming timelock expiration.
 298          *
 299          * Amount is value of the output spent by this input, committed to in the BIP 143 signature.
 300          *
 301          * per_commitment_key is revocation secret which was provided by our counterparty when they
 302          * revoked the state which they eventually broadcast. It's not a _holder_ secret key and does
 303          * not allow the spending of any funds by itself (you need our holder revocation_secret to do
 304          * so).
 305          *
 306          * htlc holds HTLC elements (hash, timelock) if the output being spent is a HTLC output, thus
 307          * changing the format of the witness script (which is committed to in the BIP 143
 308          * signatures).
 309          */
 310         public Result_SignatureNoneZ sign_justice_transaction(byte[] justice_tx, long input, long amount, byte[] per_commitment_key, HTLCOutputInCommitment htlc) {
 311                 long ret = bindings.Sign_sign_justice_transaction(this.ptr, justice_tx, input, amount, per_commitment_key, htlc == null ? 0 : htlc.ptr & ~1);
 312                 Result_SignatureNoneZ ret_hu_conv = Result_SignatureNoneZ.constr_from_ptr(ret);
 313                 this.ptrs_to.add(htlc);
 314                 return ret_hu_conv;
 315         }
 316
 317         /**
 318          * Create a signature for a claiming transaction for a HTLC output on a counterparty's commitment
 319          * transaction, either offered or received.
 320          *
 321          * Such a transaction may claim multiples offered outputs at same time if we know the
 322          * preimage for each when we create it, but only the input at index `input` should be
 323          * signed for here. It may be called multiple times for same output(s) if a fee-bump is
 324          * needed with regards to an upcoming timelock expiration.
 325          *
 326          * Witness_script is either a offered or received script as defined in BOLT3 for HTLC
 327          * outputs.
 328          *
 329          * Amount is value of the output spent by this input, committed to in the BIP 143 signature.
 330          *
 331          * Per_commitment_point is the dynamic point corresponding to the channel state
 332          * detected onchain. It has been generated by our counterparty and is used to derive
 333          * channel state keys, which are then included in the witness script and committed to in the
 334          * BIP 143 signature.
 335          */
 336         public Result_SignatureNoneZ sign_counterparty_htlc_transaction(byte[] htlc_tx, long input, long amount, byte[] per_commitment_point, HTLCOutputInCommitment htlc) {
 337                 long ret = bindings.Sign_sign_counterparty_htlc_transaction(this.ptr, htlc_tx, input, amount, per_commitment_point, htlc == null ? 0 : htlc.ptr & ~1);
 338                 Result_SignatureNoneZ ret_hu_conv = Result_SignatureNoneZ.constr_from_ptr(ret);
 339                 this.ptrs_to.add(htlc);
 340                 return ret_hu_conv;
 341         }
 342
 343         /**
 344          * Create a signature for a (proposed) closing transaction.
 345          *
 346          * Note that, due to rounding, there may be one \"missing\" satoshi, and either party may have
 347          * chosen to forgo their output as dust.
 348          */
 349         public Result_SignatureNoneZ sign_closing_transaction(byte[] closing_tx) {
 350                 long ret = bindings.Sign_sign_closing_transaction(this.ptr, closing_tx);
 351                 Result_SignatureNoneZ ret_hu_conv = Result_SignatureNoneZ.constr_from_ptr(ret);
 352                 return ret_hu_conv;
 353         }
 354
 355         /**
 356          * Signs a channel announcement message with our funding key, proving it comes from one
 357          * of the channel participants.
 358          *
 359          * Note that if this fails or is rejected, the channel will not be publicly announced and
 360          * our counterparty may (though likely will not) close the channel on us for violating the
 361          * protocol.
 362          */
 363         public Result_SignatureNoneZ sign_channel_announcement(UnsignedChannelAnnouncement msg) {
 364                 long ret = bindings.Sign_sign_channel_announcement(this.ptr, msg == null ? 0 : msg.ptr & ~1);
 365                 Result_SignatureNoneZ ret_hu_conv = Result_SignatureNoneZ.constr_from_ptr(ret);
 366                 this.ptrs_to.add(msg);
 367                 return ret_hu_conv;
 368         }
 369
 370         /**
 371          * Set the counterparty static channel data, including basepoints,
 372          * counterparty_selected/holder_selected_contest_delay and funding outpoint.
 373          * This is done as soon as the funding outpoint is known.  Since these are static channel data,
 374          * they MUST NOT be allowed to change to different values once set.
 375          *
 376          * channel_parameters.is_populated() MUST be true.
 377          *
 378          * We bind holder_selected_contest_delay late here for API convenience.
 379          *
 380          * Will be called before any signatures are applied.
 381          */
 382         public void ready_channel(ChannelTransactionParameters channel_parameters) {
 383                 bindings.Sign_ready_channel(this.ptr, channel_parameters == null ? 0 : channel_parameters.ptr & ~1);
 384                 this.ptrs_to.add(channel_parameters);
 385         }
 386
 387         /**
 388          * Serialize the object into a byte array
 389          */
 390         public byte[] write() {
 391                 byte[] ret = bindings.Sign_write(this.ptr);
 392                 return ret;
 393         }
 394
 395         /**
 396          * Frees any resources associated with this object given its this_arg pointer.
 397          * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
 398          */
 399         public ChannelPublicKeys get_pubkeys() {
 400                 long ret = bindings.Sign_get_pubkeys(this.ptr);
 401                 ChannelPublicKeys ret_hu_conv = new ChannelPublicKeys(null, ret);
 402                 ret_hu_conv.ptrs_to.add(this);
 403                 return ret_hu_conv;
 404         }
 405
 406         /**
 407          * Creates a copy of a Sign
 408          */
 409         public Sign clone() {
 410                 long ret = bindings.Sign_clone(this.ptr);
 411                 Sign ret_hu_conv = new Sign(null, ret);
 412                 ret_hu_conv.ptrs_to.add(this);
 413                 return ret_hu_conv;
 414         }
 415
 416 }