Add support for BumpFootprintExpirationOperation and RestoreFootprint…

…Operation (#491)

src/main/java/org/stellar/sdk/BumpFootprintExpirationOperation.java

@@ -0,0 +1,71 @@
+package org.stellar.sdk;
+
+import lombok.EqualsAndHashCode;
+import lombok.NonNull;
+import lombok.Value;
+import lombok.experimental.SuperBuilder;
+import org.stellar.sdk.xdr.BumpFootprintExpirationOp;
+import org.stellar.sdk.xdr.ExtensionPoint;
+import org.stellar.sdk.xdr.OperationType;
+import org.stellar.sdk.xdr.Uint32;
+
+/**
+ * Represents <a
+ * href="https://github.com/stellar/go/blob/7ff6ffae29d278f979fcd6c6bed8cd0d4b4d2e08/txnbuild/bump_footprint_expiration.go#L8-L12"
+ * target="_blank">BumpFootprintExpiration</a> operation.
+ *
+ * <p>Bump the expiration of a footprint (read and written ledger keys).
+ *
+ * @see <a href="https://developers.stellar.org/docs/fundamentals-and-concepts/list-of-operations"
+ * target="_blank">List of Operations</a>
+ */
+@EqualsAndHashCode(callSuper = true)
+@SuperBuilder(toBuilder = true)
+@Value
+public class BumpFootprintExpirationOperation extends Operation {
+
+ /**
+ * the number of ledgers past the LCL (last closed ledger) by which to extend the validity of the
+ * ledger keys in this transaction
+ */
+ @NonNull Integer ledgersToExpire;
+
+ /**
+ * Constructs a new BumpFootprintExpirationOperation object from the XDR representation of the
+ * {@link BumpFootprintExpirationOperation}.
+ *
+ * @param op the XDR representation of the {@link BumpFootprintExpirationOperation}.
+ */
+ public static BumpFootprintExpirationOperation fromXdr(BumpFootprintExpirationOp op) {
+ return BumpFootprintExpirationOperation.builder()
+ .ledgersToExpire(op.getLedgersToExpire().getUint32())
+ .build();
+ }
+
+ @Override
+ org.stellar.sdk.xdr.Operation.OperationBody toOperationBody(AccountConverter accountConverter) {
+ BumpFootprintExpirationOp op = new BumpFootprintExpirationOp();
+ op.setExt(new ExtensionPoint.Builder().discriminant(0).build());
+ op.setLedgersToExpire(new Uint32(ledgersToExpire));
+
+ org.stellar.sdk.xdr.Operation.OperationBody body =
+ new org.stellar.sdk.xdr.Operation.OperationBody();
+ body.setDiscriminant(OperationType.BUMP_FOOTPRINT_EXPIRATION);
+ body.setBumpFootprintExpirationOp(op);
+ return body;
+ }
+
+ /** Customizing builder methods. Rest of the builder code will be auto generated by Lombok. */
+ public abstract static class BumpFootprintExpirationOperationBuilder<
+ C extends BumpFootprintExpirationOperation,
+ B extends BumpFootprintExpirationOperationBuilder<C, B>>
+ extends OperationBuilder<C, B> {
+ public B ledgersToExpire(Integer ledgersToExpire) {
+ if (ledgersToExpire <= 0) {
+ throw new IllegalArgumentException("ledgersToExpire isn't a ledger quantity (uint32)");
+ }
+ this.ledgersToExpire = ledgersToExpire;
+ return self();
+ }
+ }
+}

src/main/java/org/stellar/sdk/InvokeHostFunctionOperation.java

@@ -14,7 +14,7 @@
 
 /**
  * Represents <a
- * href="https://developers.stellar.org/docs/fundamentals-and-concepts/list-of-operations#invoke-host-function"
+ * href="https://github.com/stellar/go/blob/7ff6ffae29d278f979fcd6c6bed8cd0d4b4d2e08/txnbuild/invoke_host_function.go#L8-L13"
  * target="_blank">InvokeHostFunction</a> operation.
  *
  * @see <a href="https://developers.stellar.org/docs/fundamentals-and-concepts/list-of-operations"

src/main/java/org/stellar/sdk/Operation.java

@@ -209,6 +209,12 @@ public static Operation fromXdr(
  case INVOKE_HOST_FUNCTION:
  operation = InvokeHostFunctionOperation.fromXdr(body.getInvokeHostFunctionOp());
  break;
+ case BUMP_FOOTPRINT_EXPIRATION:
+ operation = BumpFootprintExpirationOperation.fromXdr(body.getBumpFootprintExpirationOp());
+ break;
+ case RESTORE_FOOTPRINT:
+ operation = RestoreFootprintOperation.fromXdr(body.getRestoreFootprintOp());
+ break;
  default:
  throw new RuntimeException("Unknown operation body " + body.getDiscriminant());
  }

src/main/java/org/stellar/sdk/RestoreFootprintOperation.java

@@ -0,0 +1,46 @@
+package org.stellar.sdk;
+
+import lombok.AccessLevel;
+import lombok.EqualsAndHashCode;
+import lombok.NoArgsConstructor;
+import lombok.Value;
+import lombok.experimental.SuperBuilder;
+import org.stellar.sdk.xdr.ExtensionPoint;
+import org.stellar.sdk.xdr.OperationType;
+import org.stellar.sdk.xdr.RestoreFootprintOp;
+
+/**
+ * Represents <a
+ * href="https://github.com/stellar/go/blob/7ff6ffae29d278f979fcd6c6bed8cd0d4b4d2e08/txnbuild/restore_footprint.go#L8-L11"
+ * target="_blank">RestoreFootprint</a> operation.
+ *
+ * @see <a href="https://developers.stellar.org/docs/fundamentals-and-concepts/list-of-operations"
+ * target="_blank">List of Operations</a>
+ */
+@EqualsAndHashCode(callSuper = true)
+@SuperBuilder(toBuilder = true)
+@Value
+@NoArgsConstructor(access = AccessLevel.PRIVATE)
+public class RestoreFootprintOperation extends Operation {
+ /**
+ * Constructs a new RestoreFootprintOperation object from the XDR representation of the {@link
+ * RestoreFootprintOperation}.
+ *
+ * @param op the XDR representation of the {@link RestoreFootprintOperation}.
+ */
+ public static RestoreFootprintOperation fromXdr(RestoreFootprintOp op) {
+ return new RestoreFootprintOperation();
+ }
+
+ @Override
+ org.stellar.sdk.xdr.Operation.OperationBody toOperationBody(AccountConverter accountConverter) {
+ RestoreFootprintOp op = new RestoreFootprintOp();
+ op.setExt(new ExtensionPoint.Builder().discriminant(0).build());
+
+ org.stellar.sdk.xdr.Operation.OperationBody body =
+ new org.stellar.sdk.xdr.Operation.OperationBody();
+ body.setDiscriminant(OperationType.RESTORE_FOOTPRINT);
+ body.setRestoreFootprintOp(op);
+ return body;
+ }
+}

src/main/java/org/stellar/sdk/responses/OperationDeserializer.java

@@ -89,6 +89,10 @@ public OperationResponse deserialize(
  return gson.fromJson(json, LiquidityPoolWithdrawOperationResponse.class);
  case INVOKE_HOST_FUNCTION:
  return gson.fromJson(json, InvokeHostFunctionOperationResponse.class);
+ case BUMP_FOOTPRINT_EXPIRATION:
+ return gson.fromJson(json, BumpFootprintExpirationOperationResponse.class);
+ case RESTORE_FOOTPRINT:
+ return gson.fromJson(json, RestoreFootprintOperationResponse.class);
  default:
  throw new RuntimeException("Invalid operation type");
  }

src/main/java/org/stellar/sdk/responses/operations/BumpFootprintExpirationOperationResponse.java

@@ -0,0 +1,27 @@
+package org.stellar.sdk.responses.operations;
+
+import com.google.gson.annotations.SerializedName;
+
+/**
+ * Represents BumpFootprintExpiration operation response.
+ *
+ * @see <a
+ * href="https://github.com/stellar/go/blob/7ff6ffae29d278f979fcd6c6bed8cd0d4b4d2e08/protocols/horizon/operations/main.go#L376-L381">Horizon
+ * Protocol</a>
+ * @see <a href="https://developers.stellar.org/api/horizon/resources/operations"
+ * target="_blank">Operation documentation</a>
+ * @see org.stellar.sdk.requests.OperationsRequestBuilder
+ * @see org.stellar.sdk.Server#operations()
+ */
+public class BumpFootprintExpirationOperationResponse extends OperationResponse {
+ @SerializedName("ledgers_to_expire")
+ private final Long ledgersToExpire;
+
+ public BumpFootprintExpirationOperationResponse(Long ledgersToExpire) {
+ this.ledgersToExpire = ledgersToExpire;
+ }
+
+ public Long getLedgersToExpire() {
+ return ledgersToExpire;
+ }
+}

src/main/java/org/stellar/sdk/responses/operations/InvokeHostFunctionOperationResponse.java

@@ -7,6 +7,9 @@
 /**
  * Represents InvokeHostFunction operation response.
  *
+ * @see <a
+ * href="https://github.com/stellar/go/blob/7ff6ffae29d278f979fcd6c6bed8cd0d4b4d2e08/protocols/horizon/operations/main.go#L350-L367">Horizon
+ * Protocol</a>
  * @see <a href="https://developers.stellar.org/api/horizon/resources/operations"
  * target="_blank">Operation documentation</a>
  * @see org.stellar.sdk.requests.OperationsRequestBuilder

src/main/java/org/stellar/sdk/responses/operations/RestoreFootprintOperationResponse.java

@@ -0,0 +1,14 @@
+package org.stellar.sdk.responses.operations;
+
+/**
+ * Represents RestoreFootprint operation response.
+ *
+ * @see <a
+ * href="https://github.com/stellar/go/blob/7ff6ffae29d278f979fcd6c6bed8cd0d4b4d2e08/protocols/horizon/operations/main.go#L383-L386">Horizon
+ * Protocol</a>
+ * @see <a href="https://developers.stellar.org/api/horizon/resources/operations"
+ * target="_blank">Operation documentation</a>
+ * @see org.stellar.sdk.requests.OperationsRequestBuilder
+ * @see org.stellar.sdk.Server#operations()
+ */
+public class RestoreFootprintOperationResponse extends OperationResponse {}

src/test/java/org/stellar/sdk/BumpFootprintExpirationOperationTest.java

@@ -0,0 +1,111 @@
+package org.stellar.sdk;
+
+import static junit.framework.TestCase.assertEquals;
+import static junit.framework.TestCase.assertNull;
+
+import org.junit.Assert;
+import org.junit.Test;
+
+public class BumpFootprintExpirationOperationTest {
+ @Test
+ public void testBuilderWithSource() {
+ String source = "GASOCNHNNLYFNMDJYQ3XFMI7BYHIOCFW3GJEOWRPEGK2TDPGTG2E5EDW";
+ BumpFootprintExpirationOperation op =
+ BumpFootprintExpirationOperation.builder()
+ .ledgersToExpire(123)
+ .sourceAccount(source)
+ .build();
+ assertEquals(Integer.valueOf(123), op.getLedgersToExpire());
+ assertEquals(source, op.getSourceAccount());
+ String expectXdr = "AAAAAQAAAAAk4TTtavBWsGnEN3KxHw4Ohwi22ZJHWi8hlamN5pm0TgAAABkAAAAAAAAAew==";
+ assertEquals(expectXdr, op.toXdrBase64());
+ }
+
+ @Test
+ public void testBuilderWithoutSource() {
+ BumpFootprintExpirationOperation op =
+ BumpFootprintExpirationOperation.builder().ledgersToExpire(123).build();
+ assertEquals(Integer.valueOf(123), op.getLedgersToExpire());
+ assertNull(op.getSourceAccount());
+ String expectXdr = "AAAAAAAAABkAAAAAAAAAew==";
+ assertEquals(expectXdr, op.toXdrBase64());
+ }
+
+ @Test
+ public void testFromXdr() {
+ String source = "GASOCNHNNLYFNMDJYQ3XFMI7BYHIOCFW3GJEOWRPEGK2TDPGTG2E5EDW";
+ BumpFootprintExpirationOperation originOp =
+ BumpFootprintExpirationOperation.builder()
+ .ledgersToExpire(123)
+ .sourceAccount(source)
+ .build();
+ org.stellar.sdk.xdr.Operation xdrObject = originOp.toXdr();
+ Operation restartOp = Operation.fromXdr(xdrObject);
+ Assert.assertEquals(restartOp, originOp);
+ }
+
+ @Test
+ public void testEquals() {
+ String source = "GASOCNHNNLYFNMDJYQ3XFMI7BYHIOCFW3GJEOWRPEGK2TDPGTG2E5EDW";
+ BumpFootprintExpirationOperation operation1 =
+ BumpFootprintExpirationOperation.builder()
+ .ledgersToExpire(123)
+ .sourceAccount(source)
+ .build();
+ BumpFootprintExpirationOperation operation2 =
+ BumpFootprintExpirationOperation.builder()
+ .ledgersToExpire(123)
+ .sourceAccount(source)
+ .build();
+ assertEquals(operation1, operation2);
+ }
+
+ @Test
+ public void testNotEquals() {
+ String source = "GASOCNHNNLYFNMDJYQ3XFMI7BYHIOCFW3GJEOWRPEGK2TDPGTG2E5EDW";
+ BumpFootprintExpirationOperation operation1 =
+ BumpFootprintExpirationOperation.builder()
+ .ledgersToExpire(123)
+ .sourceAccount(source)
+ .build();
+ BumpFootprintExpirationOperation operation2 =
+ BumpFootprintExpirationOperation.builder()
+ .ledgersToExpire(124)
+ .sourceAccount(source)
+ .build();
+ Assert.assertNotEquals(operation1, operation2);
+ }
+
+ @Test
+ public void testNotEqualsSource() {
+ String source = "GASOCNHNNLYFNMDJYQ3XFMI7BYHIOCFW3GJEOWRPEGK2TDPGTG2E5EDW";
+ BumpFootprintExpirationOperation operation1 =
+ BumpFootprintExpirationOperation.builder()
+ .ledgersToExpire(123)
+ .sourceAccount(source)
+ .build();
+ BumpFootprintExpirationOperation operation2 =
+ BumpFootprintExpirationOperation.builder().ledgersToExpire(123).build();
+ Assert.assertNotEquals(operation1, operation2);
+ }
+
+ @Test
+ public void testLedgersToExpireIsInvalidThrows() {
+ try {
+ BumpFootprintExpirationOperation.builder().ledgersToExpire(-1).build();
+ Assert.fail();
+ } catch (IllegalArgumentException e) {
+ Assert.assertEquals("ledgersToExpire isn't a ledger quantity (uint32)", e.getMessage());
+ }
+ }
+
+ @Test
+ public void testLedgersToExpireIsNullThrows() {
+ try {
+ BumpFootprintExpirationOperation.builder().build();
+ Assert.fail();
+ } catch (NullPointerException e) {
+ Assert.assertEquals("ledgersToExpire is marked non-null but is null", e.getMessage());
+ }
+ }
+}

src/test/java/org/stellar/sdk/RestoreFootprintOperationTest.java

@@ -0,0 +1,56 @@
+package org.stellar.sdk;
+
+import static junit.framework.TestCase.assertEquals;
+import static junit.framework.TestCase.assertNull;
+
+import org.junit.Assert;
+import org.junit.Test;
+
+public class RestoreFootprintOperationTest {
+ @Test
+ public void testBuilderWithSource() {
+ String source = "GASOCNHNNLYFNMDJYQ3XFMI7BYHIOCFW3GJEOWRPEGK2TDPGTG2E5EDW";
+ RestoreFootprintOperation op =
+ RestoreFootprintOperation.builder().sourceAccount(source).build();
+ assertEquals(source, op.getSourceAccount());
+ String expectXdr = "AAAAAQAAAAAk4TTtavBWsGnEN3KxHw4Ohwi22ZJHWi8hlamN5pm0TgAAABoAAAAA";
+ assertEquals(expectXdr, op.toXdrBase64());
+ }
+
+ @Test
+ public void testBuilderWithoutSource() {
+ RestoreFootprintOperation op = RestoreFootprintOperation.builder().build();
+ assertNull(op.getSourceAccount());
+ String expectXdr = "AAAAAAAAABoAAAAA";
+ assertEquals(expectXdr, op.toXdrBase64());
+ }
+
+ @Test
+ public void testFromXdr() {
+ String source = "GASOCNHNNLYFNMDJYQ3XFMI7BYHIOCFW3GJEOWRPEGK2TDPGTG2E5EDW";
+ RestoreFootprintOperation originOp =
+ RestoreFootprintOperation.builder().sourceAccount(source).build();
+ org.stellar.sdk.xdr.Operation xdrObject = originOp.toXdr();
+ Operation restartOp = Operation.fromXdr(xdrObject);
+ Assert.assertEquals(restartOp, originOp);
+ }
+
+ @Test
+ public void testEquals() {
+ String source = "GASOCNHNNLYFNMDJYQ3XFMI7BYHIOCFW3GJEOWRPEGK2TDPGTG2E5EDW";
+ RestoreFootprintOperation operation1 =
+ RestoreFootprintOperation.builder().sourceAccount(source).build();
+ RestoreFootprintOperation operation2 =
+ RestoreFootprintOperation.builder().sourceAccount(source).build();
+ assertEquals(operation1, operation2);
+ }
+
+ @Test
+ public void testNotEquals() {
+ String source = "GASOCNHNNLYFNMDJYQ3XFMI7BYHIOCFW3GJEOWRPEGK2TDPGTG2E5EDW";
+ RestoreFootprintOperation operation1 =
+ RestoreFootprintOperation.builder().sourceAccount(source).build();
+ RestoreFootprintOperation operation2 = RestoreFootprintOperation.builder().build();
+ Assert.assertNotEquals(operation1, operation2);
+ }
+}