1 package org.ldk.structs;
3 import org.ldk.impl.bindings;
4 import org.ldk.enums.*;
6 import java.util.Arrays;
7 import java.lang.ref.Reference;
8 import javax.annotation.Nullable;
12 * Implements the per-commitment secret storage scheme from
13 * [BOLT 3](https://github.com/lightning/bolts/blob/dcbf8583976df087c79c3ce0b535311212e6812d/03-transactions.md#efficient-per-commitment-secret-storage).
15 * Allows us to keep track of all of the revocation secrets of our counterparty in just 50*32 bytes
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 {
24 if (ptr != 0) { bindings.CounterpartyCommitmentSecrets_free(ptr); }
28 long ret = bindings.CounterpartyCommitmentSecrets_clone_ptr(this.ptr);
29 Reference.reachabilityFence(this);
34 * Creates a copy of the CounterpartyCommitmentSecrets
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 org.ldk.structs.CounterpartyCommitmentSecrets ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.CounterpartyCommitmentSecrets(null, ret); }
41 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
46 * Creates a new empty `CounterpartyCommitmentSecrets` structure.
48 public static CounterpartyCommitmentSecrets of() {
49 long ret = bindings.CounterpartyCommitmentSecrets_new();
50 if (ret >= 0 && ret <= 4096) { return null; }
51 org.ldk.structs.CounterpartyCommitmentSecrets ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.CounterpartyCommitmentSecrets(null, ret); }
52 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(ret_hu_conv); };
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.
60 public long get_min_seen_secret() {
61 long ret = bindings.CounterpartyCommitmentSecrets_get_min_seen_secret(this.ptr);
62 Reference.reachabilityFence(this);
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.
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);
81 * Returns the secret at `idx`.
82 * Returns `None` if `idx` is < [`CounterpartyCommitmentSecrets::get_min_seen_secret`].
84 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
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);
95 * Serialize the CounterpartyCommitmentSecrets object into a byte array which can be read by CounterpartyCommitmentSecrets_read
97 public byte[] write() {
98 byte[] ret = bindings.CounterpartyCommitmentSecrets_write(this.ptr);
99 Reference.reachabilityFence(this);
104 * Read a CounterpartyCommitmentSecrets from a byte array, created by CounterpartyCommitmentSecrets_write
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);