VarInt: Introduce intValue() and longValue() accessors and use them, …

…deprecating access to the field.
bisq-network · Aug 23, 2021 · 8b2b1b8 · 8b2b1b8
1 parent d8a7ad7
commit 8b2b1b8
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 12 deletions.
diff --git a/core/src/main/java/org/bitcoinj/core/Message.java b/core/src/main/java/org/bitcoinj/core/Message.java
@@ -299,7 +299,7 @@ protected long readVarInt(int offset) throws ProtocolException {
         try {
             VarInt varint = new VarInt(payload, cursor + offset);
             cursor += offset + varint.getOriginalSizeInBytes();
-            return varint.value;
+            return varint.longValue();
         } catch (ArrayIndexOutOfBoundsException e) {
             throw new ProtocolException(e);
         }

diff --git a/core/src/main/java/org/bitcoinj/core/Transaction.java b/core/src/main/java/org/bitcoinj/core/Transaction.java
@@ -608,27 +608,27 @@ protected static int calcLength(byte[] buf, int offset) {
         long scriptLen;
 
         varint = new VarInt(buf, cursor);
-        long txInCount = varint.value;
+        long txInCount = varint.longValue();
         cursor += varint.getOriginalSizeInBytes();
 
         for (i = 0; i < txInCount; i++) {
             // 36 = length of previous_outpoint
             cursor += 36;
             varint = new VarInt(buf, cursor);
-            scriptLen = varint.value;
+            scriptLen = varint.longValue();
             // 4 = length of sequence field (unint32)
             cursor += scriptLen + 4 + varint.getOriginalSizeInBytes();
         }
 
         varint = new VarInt(buf, cursor);
-        long txOutCount = varint.value;
+        long txOutCount = varint.longValue();
         cursor += varint.getOriginalSizeInBytes();
 
         for (i = 0; i < txOutCount; i++) {
             // 8 = length of tx value field (uint64)
             cursor += 8;
             varint = new VarInt(buf, cursor);
-            scriptLen = varint.value;
+            scriptLen = varint.longValue();
             cursor += scriptLen + varint.getOriginalSizeInBytes();
         }
         // 4 = length of lock_time field (uint32)

diff --git a/core/src/main/java/org/bitcoinj/core/VarInt.java b/core/src/main/java/org/bitcoinj/core/VarInt.java
@@ -1,5 +1,6 @@
 /*
  * Copyright 2011 Google Inc.
+ * Copyright 2021 Andreas Schildbach
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -16,10 +17,14 @@
 
 package org.bitcoinj.core;
 
+import com.google.common.primitives.Ints;
+
 /**
  * A variable-length encoded unsigned integer using Satoshi's encoding (a.k.a. "CompactSize").
  */
 public class VarInt {
+    /** @deprecated use {{@link #intValue()} or {{@link #longValue()}}} */
+    @Deprecated
     public final long value;
     private final int originallyEncodedSize;
 
@@ -56,6 +61,14 @@ public VarInt(byte[] buf, int offset) {
         }
     }
 
+    public long longValue() {
+        return value;
+    }
+
+    public int intValue() {
+        return Ints.checkedCast(value);
+    }
+
     /**
      * Returns the original number of bytes used to encode the value if it was
      * deserialized from a byte array, or the minimum encoded size if it was not.

diff --git a/core/src/test/java/org/bitcoinj/core/FullBlockTestGenerator.java b/core/src/test/java/org/bitcoinj/core/FullBlockTestGenerator.java
@@ -1230,7 +1230,7 @@ public boolean add(Rule element) {
             Utils.uint32ToByteArrayLE((long)b64Original.block.getTransactions().size(), varIntBytes, 1);
             Utils.uint32ToByteArrayLE(((long)b64Original.block.getTransactions().size()) >>> 32, varIntBytes, 5);
             stream.write(varIntBytes);
-            checkState(new VarInt(varIntBytes, 0).value == b64Original.block.getTransactions().size());
+            checkState(new VarInt(varIntBytes, 0).intValue() == b64Original.block.getTransactions().size());
 
             for (Transaction transaction : b64Original.block.getTransactions())
                 transaction.bitcoinSerialize(stream);

diff --git a/core/src/test/java/org/bitcoinj/core/VarIntTest.java b/core/src/test/java/org/bitcoinj/core/VarIntTest.java
@@ -28,23 +28,23 @@ public void testBytes() throws Exception {
         VarInt a = new VarInt(10); // with widening conversion
         assertEquals(1, a.getSizeInBytes());
         assertEquals(1, a.encode().length);
-        assertEquals(10, new VarInt(a.encode(), 0).value);
+        assertEquals(10, new VarInt(a.encode(), 0).intValue());
     }
 
     @Test
     public void testShorts() throws Exception {
         VarInt a = new VarInt(64000); // with widening conversion
         assertEquals(3, a.getSizeInBytes());
         assertEquals(3, a.encode().length);
-        assertEquals(64000, new VarInt(a.encode(), 0).value);
+        assertEquals(64000, new VarInt(a.encode(), 0).intValue());
     }
 
     @Test
     public void testShortFFFF() throws Exception {
         VarInt a = new VarInt(0xFFFFL);
         assertEquals(3, a.getSizeInBytes());
         assertEquals(3, a.encode().length);
-        assertEquals(0xFFFFL, new VarInt(a.encode(), 0).value);
+        assertEquals(0xFFFFL, new VarInt(a.encode(), 0).intValue());
     }
 
     @Test
@@ -53,7 +53,7 @@ public void testInts() throws Exception {
         assertEquals(5, a.getSizeInBytes());
         assertEquals(5, a.encode().length);
         byte[] bytes = a.encode();
-        assertEquals(0xAABBCCDDL, 0xFFFFFFFFL & new VarInt(bytes, 0).value);
+        assertEquals(0xAABBCCDDL, new VarInt(bytes, 0).longValue());
     }
 
     @Test
@@ -62,7 +62,7 @@ public void testIntFFFFFFFF() throws Exception {
         assertEquals(5, a.getSizeInBytes());
         assertEquals(5, a.encode().length);
         byte[] bytes = a.encode();
-        assertEquals(0xFFFFFFFFL, 0xFFFFFFFFL & new VarInt(bytes, 0).value);
+        assertEquals(0xFFFFFFFFL, new VarInt(bytes, 0).longValue());
     }
 
     @Test
@@ -71,7 +71,7 @@ public void testLong() throws Exception {
         assertEquals(9, a.getSizeInBytes());
         assertEquals(9, a.encode().length);
         byte[] bytes = a.encode();
-        assertEquals(0xCAFEBABEDEADBEEFL, new VarInt(bytes, 0).value);
+        assertEquals(0xCAFEBABEDEADBEEFL, new VarInt(bytes, 0).longValue());
     }
 
     @Test