_ Git - ldk-java/blob - src/main/java/org/ldk/structs/CounterpartyCommitmentSecrets.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 import java.lang.ref.Reference;
   8 import javax.annotation.Nullable;
   9
  10
  11 /**
  12  * Implements the per-commitment secret storage scheme from
  13  * [BOLT 3](https://github.com/lightningnetwork/lightning-rfc/blob/dcbf8583976df087c79c3ce0b535311212e6812d/03-transactions.md#efficient-per-commitment-secret-storage).
  14  *
  15  * Allows us to keep track of all of the revocation secrets of our counterparty in just 50*32 bytes
  16  * or so.
  17  */
  18 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
  19 public class CounterpartyCommitmentSecrets extends CommonBase {
  20         CounterpartyCommitmentSecrets(Object _dummy, long ptr) { super(ptr); }
  21         @Override @SuppressWarnings("deprecation")
  22         protected void finalize() throws Throwable {
  23                 super.finalize();
  24                 if (ptr != 0) { bindings.CounterpartyCommitmentSecrets_free(ptr); }
  25         }
  26
  27         long clone_ptr() {
  28                 long ret = bindings.CounterpartyCommitmentSecrets_clone_ptr(this.ptr);
  29                 Reference.reachabilityFence(this);
  30                 return ret;
  31         }
  32
  33         /**
  34          * Creates a copy of the CounterpartyCommitmentSecrets
  35          */
  36         public CounterpartyCommitmentSecrets clone() {
  37                 long ret = bindings.CounterpartyCommitmentSecrets_clone(this.ptr);
  38                 Reference.reachabilityFence(this);
  39                 if (ret >= 0 && ret <= 4096) { return null; }
  40                 CounterpartyCommitmentSecrets ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new CounterpartyCommitmentSecrets(null, ret); }
  41                 ret_hu_conv.ptrs_to.add(this);
  42                 return ret_hu_conv;
  43         }
  44
  45         /**
  46          * Creates a new empty `CounterpartyCommitmentSecrets` structure.
  47          */
  48         public static CounterpartyCommitmentSecrets of() {
  49                 long ret = bindings.CounterpartyCommitmentSecrets_new();
  50                 if (ret >= 0 && ret <= 4096) { return null; }
  51                 CounterpartyCommitmentSecrets ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new CounterpartyCommitmentSecrets(null, ret); }
  52                 ret_hu_conv.ptrs_to.add(ret_hu_conv);
  53                 return ret_hu_conv;
  54         }
  55
  56         /**
  57          * Returns the minimum index of all stored secrets. Note that indexes start
  58          * at 1 << 48 and get decremented by one for each new secret.
  59          */
  60         public long get_min_seen_secret() {
  61                 long ret = bindings.CounterpartyCommitmentSecrets_get_min_seen_secret(this.ptr);
  62                 Reference.reachabilityFence(this);
  63                 return ret;
  64         }
  65
  66         /**
  67          * Inserts the `secret` at `idx`. Returns `Ok(())` if the secret
  68          * was generated in accordance with BOLT 3 and is consistent with previous secrets.
  69          */
  70         public Result_NoneNoneZ provide_secret(long idx, byte[] secret) {
  71                 long ret = bindings.CounterpartyCommitmentSecrets_provide_secret(this.ptr, idx, InternalUtils.check_arr_len(secret, 32));
  72                 Reference.reachabilityFence(this);
  73                 Reference.reachabilityFence(idx);
  74                 Reference.reachabilityFence(secret);
  75                 if (ret >= 0 && ret <= 4096) { return null; }
  76                 Result_NoneNoneZ ret_hu_conv = Result_NoneNoneZ.constr_from_ptr(ret);
  77                 return ret_hu_conv;
  78         }
  79
  80         /**
  81          * Returns the secret at `idx`.
  82          * Returns `None` if `idx` is < [`CounterpartyCommitmentSecrets::get_min_seen_secret`].
  83          *
  84          * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
  85          */
  86         @Nullable
  87         public byte[] get_secret(long idx) {
  88                 byte[] ret = bindings.CounterpartyCommitmentSecrets_get_secret(this.ptr, idx);
  89                 Reference.reachabilityFence(this);
  90                 Reference.reachabilityFence(idx);
  91                 return ret;
  92         }
  93
  94         /**
  95          * Serialize the CounterpartyCommitmentSecrets object into a byte array which can be read by CounterpartyCommitmentSecrets_read
  96          */
  97         public byte[] write() {
  98                 byte[] ret = bindings.CounterpartyCommitmentSecrets_write(this.ptr);
  99                 Reference.reachabilityFence(this);
 100                 return ret;
 101         }
 102
 103         /**
 104          * Read a CounterpartyCommitmentSecrets from a byte array, created by CounterpartyCommitmentSecrets_write
 105          */
 106         public static Result_CounterpartyCommitmentSecretsDecodeErrorZ read(byte[] ser) {
 107                 long ret = bindings.CounterpartyCommitmentSecrets_read(ser);
 108                 Reference.reachabilityFence(ser);
 109                 if (ret >= 0 && ret <= 4096) { return null; }
 110                 Result_CounterpartyCommitmentSecretsDecodeErrorZ ret_hu_conv = Result_CounterpartyCommitmentSecretsDecodeErrorZ.constr_from_ptr(ret);
 111                 return ret_hu_conv;
 112         }
 113
 114 }