com.hedera.hashgraph.sdk.TopicMessageSubmitTransaction Maven / Gradle / Ivy
Show all versions of sdk-full Show documentation
/*-
*
* Hedera Java SDK
*
* Copyright (C) 2020 - 2024 Hedera Hashgraph, LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
package com.hedera.hashgraph.sdk;
import com.google.protobuf.ByteString;
import com.google.protobuf.InvalidProtocolBufferException;
import com.hedera.hashgraph.sdk.proto.ConsensusMessageChunkInfo;
import com.hedera.hashgraph.sdk.proto.ConsensusServiceGrpc;
import com.hedera.hashgraph.sdk.proto.ConsensusSubmitMessageTransactionBody;
import com.hedera.hashgraph.sdk.proto.SchedulableTransactionBody;
import com.hedera.hashgraph.sdk.proto.TransactionBody;
import com.hedera.hashgraph.sdk.proto.TransactionID;
import com.hedera.hashgraph.sdk.proto.TransactionResponse;
import io.grpc.MethodDescriptor;
import javax.annotation.Nullable;
import java.util.LinkedHashMap;
import java.util.Objects;
/**
* Submit a message for consensus.
*
* Valid and authorized messages on valid topics will be ordered by the consensus service, gossipped to the
* mirror net, and published (in order) to all subscribers (from the mirror net) on this topic.
*
* The submitKey (if any) must sign this transaction.
*
* On success, the resulting TransactionReceipt contains the topic's updated topicSequenceNumber and
* topicRunningHash.
*/
public final class TopicMessageSubmitTransaction extends ChunkedTransaction {
@Nullable
private TopicId topicId = null;
/**
* Constructor.
*/
public TopicMessageSubmitTransaction() {
}
/**
* Constructor.
*
* @param txs Compound list of transaction id's list of (AccountId, Transaction)
* records
* @throws InvalidProtocolBufferException when there is an issue with the protobuf
*/
TopicMessageSubmitTransaction(LinkedHashMap> txs) throws InvalidProtocolBufferException {
super(txs);
initFromTransactionBody();
}
/**
* Constructor.
*
* @param txBody protobuf TransactionBody
*/
TopicMessageSubmitTransaction(com.hedera.hashgraph.sdk.proto.TransactionBody txBody) {
super(txBody);
initFromTransactionBody();
}
/**
* Extract the topic id.
*
* @return the topic id
*/
@Nullable
public TopicId getTopicId() {
return topicId;
}
/**
* Assign the topic id.
*
* @param topicId the topic id
* @return {@code this}
*/
public TopicMessageSubmitTransaction setTopicId(TopicId topicId) {
Objects.requireNonNull(topicId);
requireNotFrozen();
this.topicId = topicId;
return this;
}
/**
* Extract the message.
*
* @return the message
*/
public ByteString getMessage() {
return getData();
}
/**
* Assign the message from a byte string.
*
* @param message the byte string
* @return the message
*/
public TopicMessageSubmitTransaction setMessage(ByteString message) {
return setData(message);
}
/**
* Assign the message from a byte array.
*
* @param message the byte array
* @return the message
*/
public TopicMessageSubmitTransaction setMessage(byte[] message) {
return setData(message);
}
/**
* Assign the message from a string.
*
* @param message the string
* @return the message
*/
public TopicMessageSubmitTransaction setMessage(String message) {
return setData(message);
}
/**
* Initialize from the transaction body.
*/
void initFromTransactionBody() {
var body = sourceTransactionBody.getConsensusSubmitMessage();
if (body.hasTopicID()) {
topicId = TopicId.fromProtobuf(body.getTopicID());
}
if (!innerSignedTransactions.isEmpty()) {
try {
for (var i = 0; i < innerSignedTransactions.size();
i += nodeAccountIds.isEmpty() ? 1 : nodeAccountIds.size()) {
data = data.concat(
TransactionBody.parseFrom(innerSignedTransactions.get(i).getBodyBytes())
.getConsensusSubmitMessage().getMessage()
);
}
} catch (InvalidProtocolBufferException exc) {
throw new IllegalArgumentException(exc.getMessage());
}
} else {
data = body.getMessage();
}
}
/**
* Build the transaction body.
*
* @return {@link
* com.hedera.hashgraph.sdk.proto.ConsensusSubmitMessageTransactionBody}
*/
ConsensusSubmitMessageTransactionBody.Builder build() {
var builder = ConsensusSubmitMessageTransactionBody.newBuilder();
if (topicId != null) {
builder.setTopicID(topicId.toProtobuf());
}
builder.setMessage(data);
return builder;
}
@Override
void validateChecksums(Client client) throws BadEntityIdException {
if (topicId != null) {
topicId.validateChecksum(client);
}
}
@Override
MethodDescriptor getMethodDescriptor() {
return ConsensusServiceGrpc.getSubmitMessageMethod();
}
@Override
void onFreeze(TransactionBody.Builder bodyBuilder) {
bodyBuilder.setConsensusSubmitMessage(build());
}
@Override
void onFreezeChunk(TransactionBody.Builder body, @Nullable TransactionID initialTransactionId, int startIndex, int endIndex, int chunk, int total) {
if (total == 1) {
body.setConsensusSubmitMessage(build().setMessage(data.substring(startIndex, endIndex)));
} else {
body.setConsensusSubmitMessage(build().setMessage(data.substring(startIndex, endIndex))
.setChunkInfo(ConsensusMessageChunkInfo.newBuilder()
.setInitialTransactionID(Objects.requireNonNull(initialTransactionId))
.setNumber(chunk + 1)
.setTotal(total)
)
);
}
}
@Override
void onScheduled(SchedulableTransactionBody.Builder scheduled) {
scheduled.setConsensusSubmitMessage(build().setMessage(data));
}
}