Merge pull request #535 from daniel-cao-byte/feature/tvm_dynamic_energy

feat(DynamicEnergy): add dynamic energy apis for wallet

Author: yanghang8612

src/main/java/org/tron/walletcli/Client.java

@@ -93,6 +93,7 @@ public class Client {
       "DelegateResource",
       "DeleteProposal",
       "DeployContract contractName ABI byteCode constructor params isHex fee_limit consume_user_resource_percent origin_energy_limit value token_value token_id <library:address,library:address,...> <lib_compiler_version(e.g:v5)>",
+      "EstimateEnergy",
       "ExchangeCreate",
       "ExchangeInject",
       "ExchangeTransaction",
@@ -234,6 +235,7 @@ public class Client {
       "DelegateResource",
       "DeleteProposal",
       "DeployContract",
+      "EstimateEnergy",
       "ExchangeCreate",
       "ExchangeInject",
       "ExchangeTransaction",
@@ -2734,6 +2736,65 @@ private void triggerConstantContract(String[] parameters)
         ownerAddress, contractAddress, callValue, input, 0, tokenValue, tokenId, true);
   }
 
+  private void estimateEnergy(String[] parameters)
+      throws IOException, CipherException, CancelException  {
+
+    if (parameters == null || (parameters.length != 5 && parameters.length != 8)) {
+      System.out.println("EstimateEnergy needs 5 or 8 parameters like: ");
+      System.out.println("EstimateEnergy ownerAddress(use # if you own)"
+          + " contractAddress method args isHex "
+          + "[value token_value token_id(e.g: TRXTOKEN, use # if don't provided)]");
+      return;
+    }
+
+    int idx = 0;
+
+    String ownerAddressStr = parameters[idx++];
+    byte[] ownerAddress = null;
+    if (!"#".equals(ownerAddressStr)) {
+      ownerAddress = WalletApi.decodeFromBase58Check(ownerAddressStr);
+      if (ownerAddress == null) {
+        System.out.println("Invalid Owner Address.");
+        return;
+      }
+    }
+
+    String contractAddressStr = parameters[idx++];
+    byte[] contractAddress = WalletApi.decodeFromBase58Check(contractAddressStr);
+    if (contractAddress == null) {
+      System.out.println("Invalid Contract Address.");
+      return;
+    }
+
+    String methodStr = parameters[idx++];
+    String argsStr = parameters[idx++];
+    boolean isHex = Boolean.parseBoolean(parameters[idx++]);
+    long callValue = 0;
+    long tokenValue = 0;
+    String tokenId = "";
+    if (parameters.length == 8) {
+      callValue = Long.parseLong(parameters[idx++]);
+      tokenValue = Long.parseLong(parameters[idx++]);
+      tokenId = parameters[idx];
+    }
+
+    if (argsStr.equalsIgnoreCase("#")) {
+      argsStr = "";
+    }
+
+    if (tokenId.equalsIgnoreCase("#")) {
+      tokenId = "";
+    }
+
+    byte[] input = new byte[0];
+    if (!methodStr.equalsIgnoreCase("#")) {
+      input = Hex.decode(AbiUtil.parseMethod(methodStr, argsStr, isHex));
+    }
+
+    walletApiWrapper.estimateEnergy(
+        ownerAddress, contractAddress, callValue, input, tokenValue, tokenId);
+  }
+
   private void getContract(String[] parameters) {
     if (parameters == null ||
         parameters.length != 1) {
@@ -4658,6 +4719,10 @@ private void run() {
               triggerConstantContract(parameters);
               break;
             }
+            case "estimateenergy": {
+              estimateEnergy(parameters);
+              break;
+            }
             case "getcontract": {
               getContract(parameters);
               break;

src/main/java/org/tron/walletcli/WalletApiWrapper.java

@@ -779,6 +779,18 @@ public boolean callContract(byte[] ownerAddress, byte[] contractAddress, long ca
             isConstant);
   }
 
+  public boolean estimateEnergy(byte[] ownerAddress, byte[] contractAddress, long callValue,
+      byte[] data, long tokenValue, String tokenId)
+      throws CipherException, IOException, CancelException {
+    if (wallet == null || !wallet.isLoginState()) {
+      System.out.println("Warning: estimateEnergy failed, Please login first !!");
+      return false;
+    }
+
+    return wallet
+        .estimateEnergy(ownerAddress, contractAddress, callValue, data, tokenValue, tokenId);
+  }
+
   public boolean accountPermissionUpdate(byte[] ownerAddress, String permission)
       throws IOException, CipherException, CancelException {
     if (wallet == null || !wallet.isLoginState()) {

src/main/java/org/tron/walletserver/GrpcClient.java

@@ -937,6 +937,10 @@ public TransactionExtention triggerConstantContract(TriggerSmartContract request
     return blockingStubFull.triggerConstantContract(request);
   }
 
+  public EstimateEnergyMessage estimateEnergy(TriggerSmartContract request) {
+    return blockingStubFull.estimateEnergy(request);
+  }
+
   public SmartContract getContract(byte[] address) {
     ByteString byteString = ByteString.copyFrom(address);
     BytesMessage bytesMessage = BytesMessage.newBuilder().setValue(byteString).build();

src/main/java/org/tron/walletserver/WalletApi.java

@@ -44,6 +44,7 @@
 import org.tron.api.GrpcAPI.DiversifierMessage;
 import org.tron.api.GrpcAPI.EasyTransferResponse;
 import org.tron.api.GrpcAPI.EmptyMessage;
+import org.tron.api.GrpcAPI.EstimateEnergyMessage;
 import org.tron.api.GrpcAPI.ExchangeList;
 import org.tron.api.GrpcAPI.ExpandedSpendingKeyMessage;
 import org.tron.api.GrpcAPI.IncomingViewingKeyDiversifierMessage;
@@ -2376,6 +2377,39 @@ public boolean triggerContract(
     return processTransactionExtention(transactionExtention);
   }
 
+  public boolean estimateEnergy(
+      byte[] owner,
+      byte[] contractAddress,
+      long callValue,
+      byte[] data,
+      long tokenValue,
+      String tokenId)
+      throws IOException, CipherException, CancelException {
+    if (owner == null) {
+      owner = getAddress();
+    }
+
+    TriggerSmartContract triggerContract = triggerCallContract(owner, contractAddress, callValue,
+        data, tokenValue, tokenId);
+
+    EstimateEnergyMessage estimateEnergyMessage = rpcCli.estimateEnergy(triggerContract);
+
+    if (estimateEnergyMessage == null) {
+      System.out.println("RPC create call trx failed!");
+      return false;
+    }
+
+    if (!estimateEnergyMessage.getResult().getResult()) {
+      System.out.println("RPC estimate energy failed!");
+      System.out.println("Code = " + estimateEnergyMessage.getResult().getCode());
+      System.out
+          .println("Message = " + estimateEnergyMessage.getResult().getMessage().toStringUtf8());
+      return false;
+    }
+    System.out.println("Estimate energy result = " + Utils.formatMessageString(estimateEnergyMessage));
+    return true;
+  }
+
   public static SmartContract getContract(byte[] address) {
     return rpcCli.getContract(address);
   }

src/main/protos/api/api.proto

@@ -460,6 +460,9 @@ service Wallet {
   rpc TriggerConstantContract (TriggerSmartContract) returns (TransactionExtention) {
   }
 
+  rpc EstimateEnergy (TriggerSmartContract) returns (EstimateEnergyMessage) {
+  }
+
   rpc ClearContractABI (ClearABIContract) returns (TransactionExtention) {
   }
 
@@ -1281,6 +1284,12 @@ message TransactionExtention {
   int64 energy_used = 5;
   repeated TransactionInfo.Log logs = 6;
   repeated InternalTransaction internal_transactions = 7;
+  int64 energy_penalty = 8;
+}
+
+message EstimateEnergyMessage {
+  Return result = 1;
+  int64 energy_required = 2;
 }
 
 message BlockExtention {

src/main/protos/core/Tron.proto

@@ -259,6 +259,7 @@ message ResourceReceipt {
   int64 net_usage = 5;
   int64 net_fee = 6;
   Transaction.Result.contractResult result = 7;
+  int64 energy_penalty_total = 8;
 }
 
 message MarketOrderDetail {

src/main/protos/core/contract/smart_contract.proto

@@ -58,6 +58,12 @@ message SmartContract {
     int32 version = 11;
 }
 
+message ContractState {
+    int64 energy_usage = 1;
+    int64 energy_factor = 2;
+    int64 update_cycle = 3;
+}
+
 message CreateSmartContract {
     bytes owner_address = 1;
     SmartContract new_contract = 2;
@@ -94,4 +100,5 @@ message UpdateEnergyLimitContract {
 message SmartContractDataWrapper {
     SmartContract smart_contract = 1;
     bytes runtimecode = 2;
+    ContractState contract_state = 3;
 }