Skip to content

Commit 271e3d0

Browse files
lxcmyflxcmyf
committed
feat(*): remove redundant ret for transaction
1 parent 76df76c commit 271e3d0

File tree

10 files changed

+159
-12
lines changed

10 files changed

+159
-12
lines changed

‎chainbase/src/main/java/org/tron/core/capsule/TransactionCapsule.java‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717

1818
import static org.tron.common.utils.StringUtil.encode58Check;
1919
import static org.tron.common.utils.WalletUtil.checkPermissionOperations;
20+
import static org.tron.core.Constant.MAX_CONTRACT_RESULT_SIZE;
2021
import static org.tron.core.exception.P2pException.TypeEnum.PROTOBUF_ERROR;
2122

2223
import com.google.common.primitives.Bytes;
@@ -730,6 +731,15 @@ public long getResultSerializedSize() {
730731
return size;
731732
}
732733

734+
public long getResultSizeWithMaxContractRet() {
735+
long size = 0;
736+
for (Result result : this.transaction.getRetList()) {
737+
size += result.toBuilder().clearContractRet().build().getSerializedSize()
738+
+ MAX_CONTRACT_RESULT_SIZE;
739+
}
740+
return size;
741+
}
742+
733743
@Override
734744
public Transaction getInstance() {
735745
return this.transaction;
@@ -842,4 +852,18 @@ public BalanceContract.TransferContract getTransferContract() {
842852
return null;
843853
}
844854
}
855+
856+
public void removeRedundantRet() {
857+
Transaction tx = this.getInstance();
858+
List<Result> tmpList = new ArrayList<>(tx.getRetList());
859+
int contractCount = tx.getRawData().getContractCount();
860+
if (tx.getRetCount() > contractCount && contractCount > 0) {
861+
Transaction.Builder transactionBuilder = tx.toBuilder().clearRet();
862+
for (int i = 0; i < contractCount; i++) {
863+
Result result = tmpList.get(i);
864+
transactionBuilder.addRet(result);
865+
}
866+
this.transaction = transactionBuilder.build();
867+
}
868+
}
845869
}

‎chainbase/src/main/java/org/tron/core/db/BandwidthProcessor.java‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,13 @@ public void consume(TransactionCapsule trx, TransactionTrace trace)
9797
throws ContractValidateException, AccountResourceInsufficientException,
9898
TooBigTransactionResultException {
9999
List<Contract> contracts = trx.getInstance().getRawData().getContractList();
100+
long resultSizeWithMaxContractRet = trx.getResultSizeWithMaxContractRet();
101+
if (!trx.isInBlock() && resultSizeWithMaxContractRet >
102+
Constant.MAX_RESULT_SIZE_IN_TX * contracts.size()) {
103+
throw new TooBigTransactionResultException(String.format(
104+
"Too big transaction result, TxId %s, the result size is %d bytes, maxResultSize %d",
105+
trx.getTransactionId(), resultSizeWithMaxContractRet, Constant.MAX_RESULT_SIZE_IN_TX));
106+
}
100107
if (trx.getResultSerializedSize() > Constant.MAX_RESULT_SIZE_IN_TX * contracts.size()) {
101108
throw new TooBigTransactionResultException();
102109
}

‎common/src/main/java/org/tron/core/Constant.java‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ public class Constant {
3131
public static final long SUN_PER_ENERGY = 100; // 1 us = 100 SUN = 100 * 10^-6 TRX
3232
public static final long ENERGY_LIMIT_IN_CONSTANT_TX = 3_000_000L; // ref: 1 us = 1 energy
3333
public static final long MAX_RESULT_SIZE_IN_TX = 64; // max 8 * 8 items in result
34+
public static final long MAX_CONTRACT_RESULT_SIZE = 2L;
3435
public static final long PB_DEFAULT_ENERGY_LIMIT = 0L;
3536
public static final long CREATOR_DEFAULT_ENERGY_LIMIT = 1000 * 10_000L;
3637

‎framework/src/main/java/org/tron/core/Wallet.java‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -497,8 +497,6 @@ public GrpcAPI.Return broadcastTransaction(Transaction signedTransaction) {
497497
trx.setTime(System.currentTimeMillis());
498498
Sha256Hash txID = trx.getTransactionId();
499499
try {
500-
TransactionMessage message = new TransactionMessage(signedTransaction.toByteArray());
501-
502500
if (tronNetDelegate.isBlockUnsolidified()) {
503501
logger.warn("Broadcast transaction {} has failed, block unsolidified.", txID);
504502
return builder.setResult(false).setCode(response_code.BLOCK_UNSOLIDIFIED)
@@ -550,6 +548,7 @@ public GrpcAPI.Return broadcastTransaction(Transaction signedTransaction) {
550548
if (trx.getInstance().getRawData().getContractCount() == 0) {
551549
throw new ContractValidateException(ActuatorConstant.CONTRACT_NOT_EXIST);
552550
}
551+
TransactionMessage message = new TransactionMessage(trx.getInstance().toByteArray());
553552
dbManager.pushTransaction(trx);
554553
int num = tronNetService.fastBroadcastTransaction(message);
555554
if (num == 0 && minEffectiveConnection != 0) {
@@ -592,8 +591,7 @@ public GrpcAPI.Return broadcastTransaction(Transaction signedTransaction) {
592591
} catch (TooBigTransactionException e) {
593592
logger.warn(BROADCAST_TRANS_FAILED, txID, e.getMessage());
594593
return builder.setResult(false).setCode(response_code.TOO_BIG_TRANSACTION_ERROR)
595-
.setMessage(ByteString.copyFromUtf8("Transaction size is too big."))
596-
.build();
594+
.setMessage(ByteString.copyFromUtf8(e.getMessage())).build();
597595
} catch (TransactionExpirationException e) {
598596
logger.warn(BROADCAST_TRANS_FAILED, txID, e.getMessage());
599597
return builder.setResult(false).setCode(response_code.TRANSACTION_EXPIRATION_ERROR)

‎framework/src/main/java/org/tron/core/db/Manager.java‎

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
package org.tron.core.db;
22

33
import static org.tron.common.utils.Commons.adjustBalance;
4+
import static org.tron.core.Constant.TRANSACTION_MAX_BYTE_SIZE;
45
import static org.tron.core.exception.BadBlockException.TypeEnum.CALC_MERKLE_ROOT_FAILED;
56
import static org.tron.protos.Protocol.Transaction.Contract.ContractType.TransferContract;
67
import static org.tron.protos.Protocol.Transaction.Result.contractResult.SUCCESS;
@@ -793,6 +794,17 @@ void validateTapos(TransactionCapsule transactionCapsule) throws TaposException
793794

794795
void validateCommon(TransactionCapsule transactionCapsule)
795796
throws TransactionExpirationException, TooBigTransactionException {
797+
if (!transactionCapsule.isInBlock()) {
798+
transactionCapsule.removeRedundantRet();
799+
long generalBytesSize =
800+
transactionCapsule.getInstance().toBuilder().clearRet().build().getSerializedSize()
801+
+ Constant.MAX_RESULT_SIZE_IN_TX + Constant.MAX_RESULT_SIZE_IN_TX;
802+
if (generalBytesSize > TRANSACTION_MAX_BYTE_SIZE) {
803+
throw new TooBigTransactionException(String.format(
804+
"Too big transaction with result, TxId %s, the size is %d bytes, maxTxSize %d",
805+
transactionCapsule.getTransactionId(), generalBytesSize, TRANSACTION_MAX_BYTE_SIZE));
806+
}
807+
}
796808
if (transactionCapsule.getData().length > Constant.TRANSACTION_MAX_BYTE_SIZE) {
797809
throw new TooBigTransactionException(String.format(
798810
"Too big transaction, the size is %d bytes", transactionCapsule.getData().length));
@@ -1411,8 +1423,14 @@ public TransactionInfo processTransaction(final TransactionCapsule trxCap, Block
14111423
if (trxCap == null) {
14121424
return null;
14131425
}
1414-
Contract contract = trxCap.getInstance().getRawData().getContract(0);
14151426
Sha256Hash txId = trxCap.getTransactionId();
1427+
if (trxCap.getInstance().getRawData().getContractList().size() != 1) {
1428+
throw new ContractSizeNotEqualToOneException(
1429+
String.format(
1430+
"tx %s contract size should be exactly 1, this is extend feature ,actual :%d",
1431+
txId, trxCap.getInstance().getRawData().getContractList().size()));
1432+
}
1433+
Contract contract = trxCap.getInstance().getRawData().getContract(0);
14161434
final Histogram.Timer requestTimer = Metrics.histogramStartTimer(
14171435
MetricKeys.Histogram.PROCESS_TRANSACTION_LATENCY,
14181436
Objects.nonNull(blockCap) ? MetricLabels.BLOCK : MetricLabels.TRX,
@@ -1427,13 +1445,6 @@ public TransactionInfo processTransaction(final TransactionCapsule trxCap, Block
14271445
validateTapos(trxCap);
14281446
validateCommon(trxCap);
14291447

1430-
if (trxCap.getInstance().getRawData().getContractList().size() != 1) {
1431-
throw new ContractSizeNotEqualToOneException(
1432-
String.format(
1433-
"tx %s contract size should be exactly 1, this is extend feature ,actual :%d",
1434-
txId, trxCap.getInstance().getRawData().getContractList().size()));
1435-
}
1436-
14371448
validateDup(trxCap);
14381449

14391450
if (!trxCap.validateSignature(chainBaseManager.getAccountStore(),

‎framework/src/test/java/org/tron/common/runtime/vm/BandWidthRuntimeTest.java‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,8 @@
4343
import org.tron.protos.Protocol.Transaction;
4444
import org.tron.protos.Protocol.Transaction.Contract;
4545
import org.tron.protos.Protocol.Transaction.Contract.ContractType;
46+
import org.tron.protos.Protocol.Transaction.Result;
47+
import org.tron.protos.Protocol.Transaction.Result.contractResult;
4648
import org.tron.protos.Protocol.Transaction.raw;
4749
import org.tron.protos.contract.SmartContractOuterClass.CreateSmartContract;
4850
import org.tron.protos.contract.SmartContractOuterClass.TriggerSmartContract;
@@ -235,4 +237,17 @@ private byte[] createContract()
235237
Assert.assertNull(trace.getRuntimeError());
236238
return trace.getRuntimeResult().getContractAddress();
237239
}
240+
241+
@Test
242+
public void testMaxContractResultSize() {
243+
int maxSize = 0;
244+
for (contractResult cr : contractResult.values()) {
245+
if (cr.name().equals("UNRECOGNIZED")) {
246+
continue;
247+
}
248+
Result result = Result.newBuilder().setContractRet(cr).build();
249+
maxSize = Math.max(maxSize, result.getSerializedSize());
250+
}
251+
Assert.assertEquals(2, maxSize);
252+
}
238253
}

‎framework/src/test/java/org/tron/core/BandwidthProcessorTest.java‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
package org.tron.core;
22

3+
import static org.junit.Assert.assertThrows;
4+
35
import com.google.protobuf.Any;
46
import com.google.protobuf.ByteString;
7+
import java.nio.charset.StandardCharsets;
58
import lombok.extern.slf4j.Slf4j;
69
import org.joda.time.DateTime;
710
import org.junit.Assert;
@@ -23,6 +26,11 @@
2326
import org.tron.core.store.StoreFactory;
2427
import org.tron.protos.Protocol;
2528
import org.tron.protos.Protocol.AccountType;
29+
import org.tron.protos.Protocol.Transaction;
30+
import org.tron.protos.Protocol.Transaction.Contract;
31+
import org.tron.protos.Protocol.Transaction.Contract.ContractType;
32+
import org.tron.protos.Protocol.Transaction.Result;
33+
import org.tron.protos.Protocol.Transaction.raw;
2634
import org.tron.protos.contract.AssetIssueContractOuterClass.AssetIssueContract;
2735
import org.tron.protos.contract.AssetIssueContractOuterClass.TransferAssetContract;
2836
import org.tron.protos.contract.BalanceContract.TransferContract;
@@ -539,6 +547,32 @@ public void testUsingFee() throws Exception {
539547
dbManager.consumeBandwidth(trx, trace);
540548
}
541549

550+
@Test
551+
public void testConsumeBandwidthTooBigTransactionResultException() {
552+
TransferContract transferContract =
553+
TransferContract.newBuilder()
554+
.setAmount(10)
555+
.setOwnerAddress(ByteString.copyFromUtf8("aaa"))
556+
.setToAddress(ByteString.copyFromUtf8("bbb"))
557+
.build();
558+
StringBuilder sb = new StringBuilder();
559+
for (int i = 0; i < 6666; i++) {
560+
sb.append("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa");
561+
}
562+
Transaction transaction = Transaction.newBuilder().setRawData(raw.newBuilder()
563+
.setData(ByteString.copyFrom(sb.toString().getBytes(StandardCharsets.UTF_8)))
564+
.addContract(Contract.newBuilder().setParameter(Any.pack(transferContract))
565+
.setType(ContractType.TransferContract)))
566+
.addRet(Result.newBuilder().setAssetIssueID(sb.toString()).build()).build();
567+
TransactionCapsule trx = new TransactionCapsule(transaction);
568+
trx.setInBlock(false);
569+
TransactionTrace trace = new TransactionTrace(trx, StoreFactory
570+
.getInstance(), new RuntimeImpl());
571+
assertThrows(
572+
"Too big transaction result, TxId %s, the result size is %d bytes, maxResultSize %d",
573+
TooBigTransactionResultException.class, () -> dbManager.consumeBandwidth(trx, trace));
574+
}
575+
542576
/**
543577
* sameTokenName close, consume success assetIssueCapsule.getOwnerAddress() !=
544578
* fromAccount.getAddress()) contract.getType() = TransferAssetContract

‎framework/src/test/java/org/tron/core/capsule/TransactionCapsuleTest.java‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
package org.tron.core.capsule;
22

3+
import static org.tron.protos.Protocol.Transaction.Result.contractResult.BAD_JUMP_DESTINATION;
4+
import static org.tron.protos.Protocol.Transaction.Result.contractResult.PRECOMPILED_CONTRACT;
5+
import static org.tron.protos.Protocol.Transaction.Result.contractResult.SUCCESS;
6+
37
import com.google.protobuf.ByteString;
48
import lombok.extern.slf4j.Slf4j;
59
import org.junit.Assert;
@@ -13,8 +17,10 @@
1317
import org.tron.core.config.args.Args;
1418
import org.tron.protos.Protocol.AccountType;
1519
import org.tron.protos.Protocol.Transaction;
20+
import org.tron.protos.Protocol.Transaction.Contract.ContractType;
1621
import org.tron.protos.Protocol.Transaction.Result;
1722
import org.tron.protos.Protocol.Transaction.Result.contractResult;
23+
import org.tron.protos.Protocol.Transaction.raw;
1824

1925
@Slf4j
2026
public class TransactionCapsuleTest extends BaseTest {
@@ -1064,4 +1070,18 @@ public void trxCapsuleClearTest() {
10641070
Assert.assertEquals(trxCap.getInstance()
10651071
.getRet(0).getContractRet(), Result.contractResult.OUT_OF_TIME);
10661072
}
1073+
1074+
@Test
1075+
public void testRemoveRedundantRet() {
1076+
Transaction.Builder transaction = Transaction.newBuilder().setRawData(raw.newBuilder()
1077+
.addContract(Transaction.Contract.newBuilder().setType(ContractType.TriggerSmartContract))
1078+
.setFeeLimit(1000000000)).build().toBuilder();
1079+
transaction.addRet(Result.newBuilder().setContractRet(SUCCESS).build());
1080+
transaction.addRet(Result.newBuilder().setContractRet(PRECOMPILED_CONTRACT).build());
1081+
transaction.addRet(Result.newBuilder().setContractRet(BAD_JUMP_DESTINATION).build());
1082+
TransactionCapsule transactionCapsule = new TransactionCapsule(transaction.build());
1083+
transactionCapsule.removeRedundantRet();
1084+
Assert.assertEquals(1, transactionCapsule.getInstance().getRetCount());
1085+
Assert.assertEquals(SUCCESS, transactionCapsule.getInstance().getRet(0).getContractRet());
1086+
}
10671087
}

‎framework/src/test/java/org/tron/core/db/ManagerTest.java‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
package org.tron.core.db;
22

3+
import static org.junit.Assert.assertThrows;
34
import static org.tron.common.utils.Commons.adjustAssetBalanceV2;
45
import static org.tron.common.utils.Commons.adjustBalance;
56
import static org.tron.common.utils.Commons.adjustTotalShieldedPoolValue;
@@ -8,8 +9,10 @@
89

910
import com.google.common.collect.Maps;
1011
import com.google.common.collect.Sets;
12+
import com.google.protobuf.Any;
1113
import com.google.protobuf.ByteString;
1214
import java.io.IOException;
15+
import java.nio.charset.StandardCharsets;
1316
import java.util.ArrayList;
1417
import java.util.Arrays;
1518
import java.util.List;
@@ -1114,4 +1117,37 @@ public void testExpireTransaction() {
11141117
Assert.fail();
11151118
}
11161119
}
1120+
1121+
@Test
1122+
public void testTooBigTransaction() {
1123+
TransferContract transferContract =
1124+
TransferContract.newBuilder()
1125+
.setAmount(10)
1126+
.setOwnerAddress(ByteString.copyFromUtf8("aaa"))
1127+
.setToAddress(ByteString.copyFromUtf8("bbb"))
1128+
.build();
1129+
StringBuilder sb = new StringBuilder();
1130+
for (int i = 0; i < 6666; i++) {
1131+
sb.append("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa");
1132+
}
1133+
Transaction transaction = Transaction.newBuilder().setRawData(Transaction.raw.newBuilder()
1134+
.setData(ByteString.copyFrom(sb.toString().getBytes(StandardCharsets.UTF_8)))
1135+
.addContract(Transaction.Contract.newBuilder().setParameter(Any.pack(transferContract))
1136+
.setType(ContractType.TransferContract))).build();
1137+
TransactionCapsule trx = new TransactionCapsule(transaction);
1138+
trx.setInBlock(false);
1139+
assertThrows(
1140+
"Too big transaction with result, "
1141+
+ "TxId 1c05e9fca6a2d0c366ed4430456527eb40198e70c8b20f5ceca4739c68a79af8, "
1142+
+ "the size is 533483 bytes, maxTxSize 512000",
1143+
TooBigTransactionException.class, () -> dbManager.validateCommon(trx));
1144+
1145+
trx.setInBlock(true);
1146+
assertThrows(
1147+
"Too big transaction, "
1148+
+ "TxId 1c05e9fca6a2d0c366ed4430456527eb40198e70c8b20f5ceca4739c68a79af8, "
1149+
+ "the size is 1066643 bytes, maxTxSize 512000",
1150+
TooBigTransactionException.class, () -> dbManager.validateCommon(trx));
1151+
1152+
}
11171153
}

‎protocol/src/main/protos/core/Tron.proto‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -407,6 +407,7 @@ message Transaction {
407407
UNKNOWN = 13;
408408
TRANSFER_FAILED = 14;
409409
INVALID_CODE = 15;
410+
// please fill in the order according to the serial number
410411
}
411412
int64 fee = 1;
412413
code ret = 2;

0 commit comments

Comments
 (0)