_ Git - ldk-java/blob - src/main/java/org/ldk/structs/OutPoint.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 /**
  10  * A reference to a transaction output.
  11  *
  12  * Differs from bitcoin::blockdata::transaction::OutPoint as the index is a u16 instead of u32
  13  * due to LN's restrictions on index values. Should reduce (possibly) unsafe conversions this way.
  14  */
  15 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
  16 public class OutPoint extends CommonBase {
  17         OutPoint(Object _dummy, long ptr) { super(ptr); }
  18         @Override @SuppressWarnings("deprecation")
  19         protected void finalize() throws Throwable {
  20                 super.finalize();
  21                 if (ptr != 0) { bindings.OutPoint_free(ptr); }
  22         }
  23
  24         /**
  25          * The referenced transaction's txid.
  26          */
  27         public byte[] get_txid() {
  28                 byte[] ret = bindings.OutPoint_get_txid(this.ptr);
  29                 return ret;
  30         }
  31
  32         /**
  33          * The referenced transaction's txid.
  34          */
  35         public void set_txid(byte[] val) {
  36                 bindings.OutPoint_set_txid(this.ptr, val);
  37         }
  38
  39         /**
  40          * The index of the referenced output in its transaction's vout.
  41          */
  42         public short get_index() {
  43                 short ret = bindings.OutPoint_get_index(this.ptr);
  44                 return ret;
  45         }
  46
  47         /**
  48          * The index of the referenced output in its transaction's vout.
  49          */
  50         public void set_index(short val) {
  51                 bindings.OutPoint_set_index(this.ptr, val);
  52         }
  53
  54         /**
  55          * Constructs a new OutPoint given each field
  56          */
  57         public static OutPoint of(byte[] txid_arg, short index_arg) {
  58                 long ret = bindings.OutPoint_new(txid_arg, index_arg);
  59                 OutPoint ret_hu_conv = new OutPoint(null, ret);
  60                 ret_hu_conv.ptrs_to.add(ret_hu_conv);
  61                 return ret_hu_conv;
  62         }
  63
  64         /**
  65          * Creates a copy of the OutPoint
  66          */
  67         public OutPoint clone() {
  68                 long ret = bindings.OutPoint_clone(this.ptr);
  69                 OutPoint ret_hu_conv = new OutPoint(null, ret);
  70                 ret_hu_conv.ptrs_to.add(this);
  71                 return ret_hu_conv;
  72         }
  73
  74         /**
  75          * Checks if two OutPoints contain equal inner contents.
  76          * This ignores pointers and is_owned flags and looks at the values in fields.
  77          * Two objects with NULL inner values will be considered "equal" here.
  78          */
  79         public boolean eq(OutPoint b) {
  80                 boolean ret = bindings.OutPoint_eq(this.ptr, b == null ? 0 : b.ptr & ~1);
  81                 this.ptrs_to.add(b);
  82                 return ret;
  83         }
  84
  85         /**
  86          * Checks if two OutPoints contain equal inner contents.
  87          */
  88         public long hash() {
  89                 long ret = bindings.OutPoint_hash(this.ptr);
  90                 return ret;
  91         }
  92
  93         /**
  94          * Convert an `OutPoint` to a lightning channel id.
  95          */
  96         public byte[] to_channel_id() {
  97                 byte[] ret = bindings.OutPoint_to_channel_id(this.ptr);
  98                 return ret;
  99         }
 100
 101         /**
 102          * Serialize the OutPoint object into a byte array which can be read by OutPoint_read
 103          */
 104         public byte[] write() {
 105                 byte[] ret = bindings.OutPoint_write(this.ptr);
 106                 return ret;
 107         }
 108
 109         /**
 110          * Read a OutPoint from a byte array, created by OutPoint_write
 111          */
 112         public static Result_OutPointDecodeErrorZ read(byte[] ser) {
 113                 long ret = bindings.OutPoint_read(ser);
 114                 Result_OutPointDecodeErrorZ ret_hu_conv = Result_OutPointDecodeErrorZ.constr_from_ptr(ret);
 115                 return ret_hu_conv;
 116         }
 117
 118 }