Skip to content

Commit af0e59f

Browse files
raymondliu0711raymondliu0711
authored
feat(tvm): implement TIP-6780 (#6383)
* feat(tvm): tip-6780: selfdestruct in same transaction * test(tvm): add test for tip-6780 * test(tvm): fix import style * test(tvm): fix suicide energy cost test and suicideAction test. fix checkstyle warning
1 parent 9e456c3 commit af0e59f

File tree

19 files changed

+407
-1
lines changed

19 files changed

+407
-1
lines changed

‎actuator/src/main/java/org/tron/core/utils/ProposalUtil.java‎

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -841,6 +841,21 @@ public static void validator(DynamicPropertiesStore dynamicPropertiesStore,
841841
}
842842
break;
843843
}
844+
case ALLOW_TVM_SELFDESTRUCT_RESTRICTION: {
845+
if (!forkController.pass(ForkBlockVersionEnum.VERSION_4_8_1)) {
846+
throw new ContractValidateException(
847+
"Bad chain parameter id [ALLOW_TVM_SELFDESTRUCT_RESTRICTION]");
848+
}
849+
if (dynamicPropertiesStore.allowTvmSelfdestructRestriction()) {
850+
throw new ContractValidateException(
851+
"[ALLOW_TVM_SELFDESTRUCT_RESTRICTION] has been valid, no need to propose again");
852+
}
853+
if (value != 1) {
854+
throw new ContractValidateException(
855+
"This value[ALLOW_TVM_SELFDESTRUCT_RESTRICTION] is only allowed to be 1");
856+
}
857+
break;
858+
}
844859
case PROPOSAL_EXPIRE_TIME: {
845860
if (!forkController.pass(ForkBlockVersionEnum.VERSION_4_8_1)) {
846861
throw new ContractValidateException(
@@ -938,7 +953,8 @@ public enum ProposalType { // current value, value range
938953
ALLOW_STRICT_MATH(87), // 0, 1
939954
CONSENSUS_LOGIC_OPTIMIZATION(88), // 0, 1
940955
ALLOW_TVM_BLOB(89), // 0, 1
941-
PROPOSAL_EXPIRE_TIME(92); // (0, 31536003000)
956+
PROPOSAL_EXPIRE_TIME(92), // (0, 31536003000)
957+
ALLOW_TVM_SELFDESTRUCT_RESTRICTION(94); // 0, 1
942958

943959
private long code;
944960

‎actuator/src/main/java/org/tron/core/vm/EnergyCost.java‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ public class EnergyCost {
5555
private static final long EXT_CODE_SIZE = 20;
5656
private static final long EXT_CODE_HASH = 400;
5757
private static final long SUICIDE = 0;
58+
private static final long SUICIDE_V2 = 5000;
5859
private static final long STOP = 0;
5960
private static final long CREATE_DATA = 200;
6061
private static final long TLOAD = 100;
@@ -289,6 +290,14 @@ public static long getSuicideCost2(Program program) {
289290
return getSuicideCost(program);
290291
}
291292

293+
public static long getSuicideCost3(Program program) {
294+
DataWord inheritorAddress = program.getStack().peek();
295+
if (isDeadAccount(program, inheritorAddress)) {
296+
return SUICIDE_V2 + NEW_ACCT_CALL;
297+
}
298+
return SUICIDE_V2;
299+
}
300+
292301
public static long getBalanceCost(Program ignored) {
293302
return BALANCE;
294303
}

‎actuator/src/main/java/org/tron/core/vm/OperationActions.java‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1072,4 +1072,19 @@ public static void suicideAction(Program program) {
10721072
program.stop();
10731073
}
10741074

1075+
public static void suicideAction2(Program program) {
1076+
if (program.isStaticCall()) {
1077+
throw new Program.StaticCallModificationException();
1078+
}
1079+
1080+
if (!program.canSuicide2()) {
1081+
program.getResult().setRevert();
1082+
} else {
1083+
DataWord address = program.stackPop();
1084+
program.suicide2(address);
1085+
}
1086+
1087+
program.stop();
1088+
}
1089+
10751090
}

‎actuator/src/main/java/org/tron/core/vm/OperationRegistry.java‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,10 @@ public static JumpTable getTable() {
7979
adjustForFairEnergy(table);
8080
}
8181

82+
if (VMConfig.allowTvmSelfdestructRestriction()) {
83+
adjustSelfdestruct(table);
84+
}
85+
8286
return table;
8387
}
8488

@@ -695,4 +699,11 @@ public static void appendCancunOperations(JumpTable table) {
695699
OperationActions::blobBaseFeeAction,
696700
tvmBlobProposal));
697701
}
702+
703+
public static void adjustSelfdestruct(JumpTable table) {
704+
table.set(new Operation(
705+
Op.SUICIDE, 1, 0,
706+
EnergyCost::getSuicideCost3,
707+
OperationActions::suicideAction2));
708+
}
698709
}

‎actuator/src/main/java/org/tron/core/vm/config/ConfigLoader.java‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ public static void load(StoreFactory storeFactory) {
4444
VMConfig.initAllowTvmCancun(ds.getAllowTvmCancun());
4545
VMConfig.initDisableJavaLangMath(ds.getConsensusLogicOptimization());
4646
VMConfig.initAllowTvmBlob(ds.getAllowTvmBlob());
47+
VMConfig.initAllowTvmSelfdestructRestriction(ds.getAllowTvmSelfdestructRestriction());
4748
}
4849
}
4950
}

‎actuator/src/main/java/org/tron/core/vm/program/ContractState.java‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,16 @@ public void updateContractState(byte[] address, ContractStateCapsule contractSta
121121
repository.updateContractState(address, contractStateCapsule);
122122
}
123123

124+
@Override
125+
public void putNewContract(byte[] address) {
126+
repository.putNewContract(address);
127+
}
128+
129+
@Override
130+
public boolean isNewContract(byte[] address) {
131+
return repository.isNewContract(address);
132+
}
133+
124134
@Override
125135
public void updateAccount(byte[] address, AccountCapsule accountCapsule) {
126136
repository.updateAccount(address, accountCapsule);

‎actuator/src/main/java/org/tron/core/vm/program/Program.java‎

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -515,6 +515,72 @@ public void suicide(DataWord obtainerAddress) {
515515
getResult().addDeleteAccount(this.getContractAddress());
516516
}
517517

518+
public void suicide2(DataWord obtainerAddress) {
519+
520+
byte[] owner = getContextAddress();
521+
boolean isNewContract = getContractState().isNewContract(owner);
522+
if (isNewContract) {
523+
suicide(obtainerAddress);
524+
return;
525+
}
526+
527+
byte[] obtainer = obtainerAddress.toTronAddress();
528+
529+
long balance = getContractState().getBalance(owner);
530+
531+
if (logger.isDebugEnabled()) {
532+
logger.debug("Transfer to: [{}] heritage: [{}]",
533+
Hex.toHexString(obtainer),
534+
balance);
535+
}
536+
537+
increaseNonce();
538+
539+
InternalTransaction internalTx = addInternalTx(null, owner, obtainer, balance, null,
540+
"suicide", nonce, getContractState().getAccount(owner).getAssetMapV2());
541+
542+
if (FastByteComparisons.isEqual(owner, obtainer)) {
543+
return;
544+
}
545+
546+
if (VMConfig.allowTvmVote()) {
547+
withdrawRewardAndCancelVote(owner, getContractState());
548+
balance = getContractState().getBalance(owner);
549+
if (internalTx != null && balance != internalTx.getValue()) {
550+
internalTx.setValue(balance);
551+
}
552+
}
553+
554+
// transfer balance and trc10
555+
createAccountIfNotExist(getContractState(), obtainer);
556+
try {
557+
MUtil.transfer(getContractState(), owner, obtainer, balance);
558+
if (VMConfig.allowTvmTransferTrc10()) {
559+
MUtil.transferAllToken(getContractState(), owner, obtainer);
560+
}
561+
} catch (ContractValidateException e) {
562+
if (VMConfig.allowTvmConstantinople()) {
563+
throw new TransferException(
564+
"transfer all token or transfer all trx failed in suicide: %s", e.getMessage());
565+
}
566+
throw new BytecodeExecutionException("transfer failure");
567+
}
568+
569+
// transfer freeze
570+
if (VMConfig.allowTvmFreeze()) {
571+
transferDelegatedResourceToInheritor(owner, obtainer, getContractState());
572+
}
573+
574+
// transfer freezeV2
575+
if (VMConfig.allowTvmFreezeV2()) {
576+
long expireUnfrozenBalance =
577+
transferFrozenV2BalanceToInheritor(owner, obtainer, getContractState());
578+
if (expireUnfrozenBalance > 0 && internalTx != null) {
579+
internalTx.setValue(internalTx.getValue() + expireUnfrozenBalance);
580+
}
581+
}
582+
}
583+
518584
public Repository getContractState() {
519585
return this.contractState;
520586
}
@@ -544,6 +610,11 @@ private void transferDelegatedResourceToInheritor(byte[] ownerAddr, byte[] inher
544610

545611
// transfer all kinds of frozen balance to BlackHole
546612
repo.addBalance(inheritorAddr, frozenBalanceForBandwidthOfOwner + frozenBalanceForEnergyOfOwner);
613+
614+
if (VMConfig.allowTvmSelfdestructRestriction()) {
615+
clearOwnerFreeze(ownerCapsule);
616+
repo.updateAccount(ownerAddr, ownerCapsule);
617+
}
547618
}
548619

549620
private long transferFrozenV2BalanceToInheritor(byte[] ownerAddr, byte[] inheritorAddr, Repository repo) {
@@ -609,6 +680,11 @@ private long transferFrozenV2BalanceToInheritor(byte[] ownerAddr, byte[] inherit
609680
return expireUnfrozenBalance;
610681
}
611682

683+
private void clearOwnerFreeze(AccountCapsule ownerCapsule) {
684+
ownerCapsule.setFrozenForBandwidth(0, 0);
685+
ownerCapsule.setFrozenForEnergy(0, 0);
686+
}
687+
612688
private void clearOwnerFreezeV2(AccountCapsule ownerCapsule) {
613689
ownerCapsule.clearFrozenV2();
614690
ownerCapsule.setNetUsage(0);
@@ -666,6 +742,38 @@ public boolean canSuicide() {
666742
// return freezeCheck && voteCheck;
667743
}
668744

745+
public boolean canSuicide2() {
746+
byte[] owner = getContextAddress();
747+
AccountCapsule accountCapsule = getContractState().getAccount(owner);
748+
749+
return freezeV1Check(accountCapsule) && freezeV2Check(accountCapsule);
750+
}
751+
752+
private boolean freezeV1Check(AccountCapsule accountCapsule) {
753+
if (!VMConfig.allowTvmFreeze()) {
754+
return true;
755+
}
756+
757+
// check freeze
758+
long now = getContractState().getDynamicPropertiesStore().getLatestBlockHeaderTimestamp();
759+
// bandwidth
760+
if (accountCapsule.getFrozenCount() > 0
761+
&& accountCapsule.getFrozenList().stream()
762+
.anyMatch(frozen -> frozen.getExpireTime() > now)) {
763+
return false;
764+
}
765+
// energy
766+
Protocol.Account.Frozen frozenEnergy =
767+
accountCapsule.getAccountResource().getFrozenBalanceForEnergy();
768+
if (frozenEnergy.getFrozenBalance() > 0 && frozenEnergy.getExpireTime() > now) {
769+
return false;
770+
}
771+
772+
// check delegate
773+
return accountCapsule.getDelegatedFrozenBalanceForBandwidth() == 0
774+
&& accountCapsule.getDelegatedFrozenBalanceForEnergy() == 0;
775+
}
776+
669777
private boolean freezeV2Check(AccountCapsule accountCapsule) {
670778
if (!VMConfig.allowTvmFreezeV2()) {
671779
return true;

‎actuator/src/main/java/org/tron/core/vm/repository/Repository.java‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,10 @@ public interface Repository {
5555

5656
void updateContractState(byte[] address, ContractStateCapsule contractStateCapsule);
5757

58+
void putNewContract(byte[] address);
59+
60+
boolean isNewContract(byte[] address);
61+
5862
void updateAccount(byte[] address, AccountCapsule accountCapsule);
5963

6064
void updateDynamicProperty(byte[] word, BytesCapsule bytesCapsule);

‎actuator/src/main/java/org/tron/core/vm/repository/RepositoryImpl.java‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
import com.google.common.collect.HashBasedTable;
1010
import com.google.protobuf.ByteString;
1111
import java.util.HashMap;
12+
import java.util.HashSet;
1213
import java.util.Optional;
1314
import lombok.Getter;
1415
import lombok.extern.slf4j.Slf4j;
@@ -135,6 +136,7 @@ public class RepositoryImpl implements Repository {
135136
private final HashMap<Key, Value<byte[]>> delegationCache = new HashMap<>();
136137
private final HashMap<Key, Value<DelegatedResourceAccountIndex>> delegatedResourceAccountIndexCache = new HashMap<>();
137138
private final HashBasedTable<Key, Key, Value<byte[]>> transientStorage = HashBasedTable.create();
139+
private final HashSet<Key> newContractCache = new HashSet<>();
138140

139141
public static void removeLruCache(byte[] address) {
140142
}
@@ -479,6 +481,7 @@ public void deleteContract(byte[] address) {
479481
public void createContract(byte[] address, ContractCapsule contractCapsule) {
480482
contractCache.put(Key.create(address),
481483
Value.create(contractCapsule, Type.CREATE));
484+
putNewContract(address);
482485
}
483486

484487
@Override
@@ -533,6 +536,29 @@ public void updateContractState(byte[] address, ContractStateCapsule contractSta
533536
Value.create(contractStateCapsule, Type.DIRTY));
534537
}
535538

539+
@Override
540+
public void putNewContract(byte[] address) {
541+
newContractCache.add(Key.create(address));
542+
}
543+
544+
@Override
545+
public boolean isNewContract(byte[] address) {
546+
Key key = Key.create(address);
547+
if (newContractCache.contains(key)) {
548+
return true;
549+
}
550+
551+
if (parent != null) {
552+
boolean isNew = parent.isNewContract(address);
553+
if (isNew) {
554+
newContractCache.add(key);
555+
}
556+
return isNew;
557+
} else {
558+
return false;
559+
}
560+
}
561+
536562
@Override
537563
public void updateAccount(byte[] address, AccountCapsule accountCapsule) {
538564
accountCache.put(Key.create(address),
@@ -740,6 +766,7 @@ public void commit() {
740766
commitDelegationCache(repository);
741767
commitDelegatedResourceAccountIndexCache(repository);
742768
commitTransientStorage(repository);
769+
commitNewContractCache(repository);
743770
}
744771

745772
@Override
@@ -1060,6 +1087,12 @@ public void commitTransientStorage(Repository deposit) {
10601087
}
10611088
}
10621089

1090+
public void commitNewContractCache(Repository deposit) {
1091+
if (deposit != null) {
1092+
newContractCache.forEach(key -> deposit.putNewContract(key.getData()));
1093+
}
1094+
}
1095+
10631096
/**
10641097
* Get the block id from the number.
10651098
*/

‎chainbase/src/main/java/org/tron/core/store/DynamicPropertiesStore.java‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -235,6 +235,9 @@ public class DynamicPropertiesStore extends TronStoreWithRevoking<BytesCapsule>
235235
private static final byte[] ALLOW_TVM_BLOB = "ALLOW_TVM_BLOB".getBytes();
236236
private static final byte[] PROPOSAL_EXPIRE_TIME = "PROPOSAL_EXPIRE_TIME".getBytes();
237237

238+
private static final byte[] ALLOW_TVM_SELFDESTRUCT_RESTRICTION =
239+
"ALLOW_TVM_SELFDESTRUCT_RESTRICTION".getBytes();
240+
238241
@Autowired
239242
private DynamicPropertiesStore(@Value("properties") String dbName) {
240243
super(dbName);
@@ -2949,6 +2952,22 @@ public long getAllowTvmBlob() {
29492952
.orElse(CommonParameter.getInstance().getAllowTvmBlob());
29502953
}
29512954

2955+
2956+
public long getAllowTvmSelfdestructRestriction() {
2957+
return Optional.ofNullable(getUnchecked(ALLOW_TVM_SELFDESTRUCT_RESTRICTION))
2958+
.map(BytesCapsule::getData)
2959+
.map(ByteArray::toLong)
2960+
.orElse(CommonParameter.getInstance().getAllowTvmSelfdestructRestriction());
2961+
}
2962+
2963+
public void saveAllowTvmSelfdestructRestriction(long value) {
2964+
this.put(ALLOW_TVM_SELFDESTRUCT_RESTRICTION, new BytesCapsule(ByteArray.fromLong(value)));
2965+
}
2966+
2967+
public boolean allowTvmSelfdestructRestriction() {
2968+
return getAllowTvmSelfdestructRestriction() == 1L;
2969+
}
2970+
29522971
public void saveProposalExpireTime(long proposalExpireTime) {
29532972
this.put(PROPOSAL_EXPIRE_TIME, new BytesCapsule(ByteArray.fromLong(proposalExpireTime)));
29542973
}

0 commit comments

Comments
 (0)