Ack messages for all trade, offer- and dispute messages

src/main/java/bisq/network/crypto/EncryptionService.java

@@ -57,8 +57,8 @@ public EncryptionService(KeyRing keyRing, NetworkProtoResolver networkProtoResol
         this.networkProtoResolver = networkProtoResolver;
     }
 
-    public SealedAndSigned encryptAndSign(PubKeyRing pubKeyRing, NetworkEnvelope networkEnvelop) throws CryptoException {
-        return encryptHybridWithSignature(networkEnvelop, keyRing.getSignatureKeyPair(), pubKeyRing.getEncryptionPubKey());
+    public SealedAndSigned encryptAndSign(PubKeyRing pubKeyRing, NetworkEnvelope networkEnvelope) throws CryptoException {
+        return encryptHybridWithSignature(networkEnvelope, keyRing.getSignatureKeyPair(), pubKeyRing.getEncryptionPubKey());
     }
 
     /**
@@ -94,8 +94,8 @@ public DecryptedMessageWithPubKey decryptAndVerify(SealedAndSigned sealedAndSign
                 decryptedDataTuple.getSigPublicKey());
     }
 
-    private static byte[] encryptPayloadWithHmac(NetworkEnvelope networkEnvelop, SecretKey secretKey) throws CryptoException {
-        return Encryption.encryptPayloadWithHmac(networkEnvelop.toProtoNetworkEnvelope().toByteArray(), secretKey);
+    private static byte[] encryptPayloadWithHmac(NetworkEnvelope networkEnvelope, SecretKey secretKey) throws CryptoException {
+        return Encryption.encryptPayloadWithHmac(networkEnvelope.toProtoNetworkEnvelope().toByteArray(), secretKey);
     }
 
     /**

src/main/java/bisq/network/p2p/AckMessage.java

@@ -0,0 +1,180 @@
+/*
+ * This file is part of Bisq.
+ *
+ * Bisq is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or (at
+ * your option) any later version.
+ *
+ * Bisq is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public
+ * License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with Bisq. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+package bisq.network.p2p;
+
+import bisq.network.p2p.storage.payload.CapabilityRequiringPayload;
+import bisq.network.p2p.storage.payload.ExpirablePayload;
+
+import bisq.common.app.Capabilities;
+import bisq.common.app.Version;
+import bisq.common.proto.ProtoUtil;
+import bisq.common.proto.network.NetworkEnvelope;
+import bisq.common.proto.persistable.PersistablePayload;
+
+import io.bisq.generated.protobuffer.PB;
+
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+import java.util.Optional;
+import java.util.UUID;
+import java.util.concurrent.TimeUnit;
+
+import lombok.EqualsAndHashCode;
+import lombok.Value;
+import lombok.extern.slf4j.Slf4j;
+
+import javax.annotation.Nullable;
+
+// We exclude uid from hashcode and equals to detect duplicate entries of the same AckMessage
+@EqualsAndHashCode(callSuper = true, exclude = {"uid"})
+@Value
+@Slf4j
+public final class AckMessage extends NetworkEnvelope implements MailboxMessage, PersistablePayload,
+        ExpirablePayload, CapabilityRequiringPayload {
+
+    private final String uid;
+    private final NodeAddress senderNodeAddress;
+    private final AckMessageSourceType sourceType;
+    private final String sourceMsgClassName;
+    @Nullable
+    private final String sourceUid;
+    private final String sourceId;
+    private final boolean success;
+    @Nullable
+    private final String errorMessage;
+
+    /**
+     *
+     * @param senderNodeAddress       Address of sender
+     * @param sourceType            Type of source e.g. TradeMessage, DisputeMessage,...
+     * @param sourceMsgClassName    Class name of source msg
+     * @param sourceUid             Optional Uid of source (TradeMessage). Can be null if we receive trades/offers from old clients
+     * @param sourceId              Id of source (tradeId, disputeId)
+     * @param success               True if source message was processed successfully
+     * @param errorMessage          Optional error message if source message processing failed
+     */
+    public AckMessage(NodeAddress senderNodeAddress,
+                      AckMessageSourceType sourceType,
+                      String sourceMsgClassName,
+                      String sourceUid,
+                      String sourceId,
+                      boolean success,
+                      String errorMessage) {
+        this(UUID.randomUUID().toString(),
+                senderNodeAddress,
+                sourceType,
+                sourceMsgClassName,
+                sourceUid,
+                sourceId,
+                success,
+                errorMessage,
+                Version.getP2PMessageVersion());
+    }
+
+
+    ///////////////////////////////////////////////////////////////////////////////////////////
+    // PROTO BUFFER
+    ///////////////////////////////////////////////////////////////////////////////////////////
+
+    private AckMessage(String uid,
+                       NodeAddress senderNodeAddress,
+                       AckMessageSourceType sourceType,
+                       String sourceMsgClassName,
+                       @Nullable String sourceUid,
+                       String sourceId,
+                       boolean success,
+                       @Nullable String errorMessage,
+                       int messageVersion) {
+        super(messageVersion);
+        this.uid = uid;
+        this.senderNodeAddress = senderNodeAddress;
+        this.sourceType = sourceType;
+        this.sourceMsgClassName = sourceMsgClassName;
+        this.sourceUid = sourceUid;
+        this.sourceId = sourceId;
+        this.success = success;
+        this.errorMessage = errorMessage;
+    }
+
+    public PB.AckMessage toProtoMessage() {
+        return getBuilder().build();
+    }
+
+    @Override
+    public PB.NetworkEnvelope toProtoNetworkEnvelope() {
+        return getNetworkEnvelopeBuilder().setAckMessage(getBuilder()).build();
+    }
+
+    public PB.AckMessage.Builder getBuilder() {
+        PB.AckMessage.Builder builder = PB.AckMessage.newBuilder()
+                .setUid(uid)
+                .setSenderNodeAddress(senderNodeAddress.toProtoMessage())
+                .setSourceType(sourceType.name())
+                .setSourceMsgClassName(sourceMsgClassName)
+                .setSourceId(sourceId)
+                .setSuccess(success);
+        Optional.ofNullable(sourceUid).ifPresent(builder::setSourceUid);
+        Optional.ofNullable(errorMessage).ifPresent(builder::setErrorMessage);
+        return builder;
+    }
+
+    public static AckMessage fromProto(PB.AckMessage proto, int messageVersion) {
+        AckMessageSourceType sourceType = ProtoUtil.enumFromProto(AckMessageSourceType.class, proto.getSourceType());
+        return new AckMessage(proto.getUid(),
+                NodeAddress.fromProto(proto.getSenderNodeAddress()),
+                sourceType,
+                proto.getSourceMsgClassName(),
+                proto.getSourceUid().isEmpty() ? null : proto.getSourceUid(),
+                proto.getSourceId(),
+                proto.getSuccess(),
+                proto.getErrorMessage().isEmpty() ? null : proto.getErrorMessage(),
+                messageVersion);
+    }
+
+
+    ///////////////////////////////////////////////////////////////////////////////////////////
+    // API
+    ///////////////////////////////////////////////////////////////////////////////////////////
+
+    @Override
+    public List<Integer> getRequiredCapabilities() {
+        return new ArrayList<>(Collections.singletonList(
+                Capabilities.Capability.ACK_MSG.ordinal()
+        ));
+    }
+
+    @Override
+    public long getTTL() {
+        return TimeUnit.DAYS.toMillis(10);
+    }
+
+    @Override
+    public String toString() {
+        return "AckMessage{" +
+                "\n     uid='" + uid + '\'' +
+                ",\n     senderNodeAddress=" + senderNodeAddress +
+                ",\n     sourceType=" + sourceType +
+                ",\n     sourceMsgClassName='" + sourceMsgClassName + '\'' +
+                ",\n     sourceUid='" + sourceUid + '\'' +
+                ",\n     sourceId='" + sourceId + '\'' +
+                ",\n     success=" + success +
+                ",\n     errorMessage='" + errorMessage + '\'' +
+                "\n} " + super.toString();
+    }
+}

src/main/java/bisq/network/p2p/AckMessageSourceType.java

@@ -0,0 +1,25 @@
+/*
+ * This file is part of Bisq.
+ *
+ * Bisq is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or (at
+ * your option) any later version.
+ *
+ * Bisq is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public
+ * License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with Bisq. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+package bisq.network.p2p;
+
+public enum AckMessageSourceType {
+    UNDEFINED,
+    OFFER_MESSAGE,
+    TRADE_MESSAGE,
+    DISPUTE_MESSAGE
+}

src/main/java/bisq/network/p2p/MailboxMessage.java

@@ -18,8 +18,6 @@
 package bisq.network.p2p;
 
 
-public interface MailboxMessage extends DirectMessage {
+public interface MailboxMessage extends DirectMessage, UidMessage {
     NodeAddress getSenderNodeAddress();
-
-    String getUid();
 }