[api] eth_getTransactionRecipt return TransactionLogs in events way (#4687)

Author: envestcc

action/Makefile

@@ -2,28 +2,52 @@
 
 # Variables
 SOLC := solc
-SOL_FILE := native_staking_contract_interface.sol
-ABI_FILE := native_staking_contract_abi.json
+NATIVE_SOL_FILE := native_staking_contract_interface.sol
+NATIVE_ABI_FILE := native_staking_contract_abi.json
+ACCOUNT_SOL_FILE := account_contract_interface.sol
+ACCOUNT_ABI_FILE := account_contract_abi.json
 TEMP_DIR := .temp
 
 # Default target
 .PHONY: all
 all: abi
 
-# Generate ABI from Solidity interface
+# Generate all ABI files
 .PHONY: abi
-abi: $(ABI_FILE)
+abi: native-abi account-abi
 
-$(ABI_FILE): $(SOL_FILE)
-	@echo "Generating ABI from $(SOL_FILE)..."
+# Generate ABI from native staking contract interface
+.PHONY: native-abi
+native-abi: $(NATIVE_ABI_FILE)
+
+$(NATIVE_ABI_FILE): $(NATIVE_SOL_FILE)
+	@echo "Generating ABI from $(NATIVE_SOL_FILE)..."
 	@mkdir -p $(TEMP_DIR)
-	@$(SOLC) --abi $(SOL_FILE) -o $(TEMP_DIR) --overwrite
+	@$(SOLC) --abi $(NATIVE_SOL_FILE) -o $(TEMP_DIR) --overwrite
 	@# Extract the ABI from the generated file and format it
 	@if [ -f "$(TEMP_DIR)/INativeStakingContract.abi" ]; then \
-		cat "$(TEMP_DIR)/INativeStakingContract.abi" | jq '.' > $(ABI_FILE); \
-		echo "ABI generated successfully: $(ABI_FILE)"; \
+		cat "$(TEMP_DIR)/INativeStakingContract.abi" | jq '.' > $(NATIVE_ABI_FILE); \
+		echo "ABI generated successfully: $(NATIVE_ABI_FILE)"; \
+	else \
+		echo "Error: Native staking ABI file not generated"; \
+		exit 1; \
+	fi
+	@rm -rf $(TEMP_DIR)
+
+# Generate ABI from account contract interface
+.PHONY: account-abi
+account-abi: $(ACCOUNT_ABI_FILE)
+
+$(ACCOUNT_ABI_FILE): $(ACCOUNT_SOL_FILE)
+	@echo "Generating ABI from $(ACCOUNT_SOL_FILE)..."
+	@mkdir -p $(TEMP_DIR)
+	@$(SOLC) --abi $(ACCOUNT_SOL_FILE) -o $(TEMP_DIR) --overwrite
+	@# Extract the ABI from the generated file and format it
+	@if [ -f "$(TEMP_DIR)/IAccountProtocolContract.abi" ]; then \
+		cat "$(TEMP_DIR)/IAccountProtocolContract.abi" | jq '.' > $(ACCOUNT_ABI_FILE); \
+		echo "ABI generated successfully: $(ACCOUNT_ABI_FILE)"; \
 	else \
-		echo "Error: ABI file not generated"; \
+		echo "Error: Account contract ABI file not generated"; \
 		exit 1; \
 	fi
 	@rm -rf $(TEMP_DIR)
@@ -32,7 +56,7 @@ $(ABI_FILE): $(SOL_FILE)
 .PHONY: clean
 clean:
 	@echo "Cleaning generated files..."
-	@rm -f $(ABI_FILE)
+	@rm -f $(NATIVE_ABI_FILE) $(ACCOUNT_ABI_FILE)
 	@rm -rf $(TEMP_DIR)
 
 # Install dependencies (solc and jq)
@@ -82,39 +106,51 @@ check-deps:
 # Watch for changes and regenerate ABI
 .PHONY: watch
 watch: check-deps
-	@echo "Watching $(SOL_FILE) for changes..."
+	@echo "Watching $(NATIVE_SOL_FILE) and $(ACCOUNT_SOL_FILE) for changes..."
 	@while true; do \
-		inotifywait -e modify $(SOL_FILE) 2>/dev/null || \
+		inotifywait -e modify $(NATIVE_SOL_FILE) $(ACCOUNT_SOL_FILE) 2>/dev/null || \
 		(echo "inotifywait not available, using sleep instead"; sleep 5); \
 		make abi; \
 		echo "Waiting for changes..."; \
 	done
 
-# Validate generated ABI
+# Validate generated ABI files
 .PHONY: validate
-validate: $(ABI_FILE)
-	@echo "Validating ABI file..."
-	@if jq empty $(ABI_FILE) 2>/dev/null; then \
-		echo "✅ ABI file is valid JSON"; \
-		echo "Functions found: $$(jq '[.[] | select(.type=="function")] | length' $(ABI_FILE))"; \
-		echo "Events found: $$(jq '[.[] | select(.type=="event")] | length' $(ABI_FILE))"; \
+validate: $(NATIVE_ABI_FILE) $(ACCOUNT_ABI_FILE)
+	@echo "Validating ABI files..."
+	@echo "Validating $(NATIVE_ABI_FILE)..."
+	@if jq empty $(NATIVE_ABI_FILE) 2>/dev/null; then \
+		echo "✅ Native staking ABI file is valid JSON"; \
+		echo "Functions found: $$(jq '[.[] | select(.type=="function")] | length' $(NATIVE_ABI_FILE))"; \
+		echo "Events found: $$(jq '[.[] | select(.type=="event")] | length' $(NATIVE_ABI_FILE))"; \
+	else \
+		echo "❌ Native staking ABI file is not valid JSON"; \
+		exit 1; \
+	fi
+	@echo "Validating $(ACCOUNT_ABI_FILE)..."
+	@if jq empty $(ACCOUNT_ABI_FILE) 2>/dev/null; then \
+		echo "✅ Account contract ABI file is valid JSON"; \
+		echo "Functions found: $$(jq '[.[] | select(.type=="function")] | length' $(ACCOUNT_ABI_FILE))"; \
+		echo "Events found: $$(jq '[.[] | select(.type=="event")] | length' $(ACCOUNT_ABI_FILE))"; \
 	else \
-		echo "❌ ABI file is not valid JSON"; \
+		echo "❌ Account contract ABI file is not valid JSON"; \
 		exit 1; \
 	fi
 
 # Show help
 .PHONY: help
 help:
 	@echo "Available targets:"
-	@echo "  abi           - Generate ABI from Solidity interface (default)"
+	@echo "  abi           - Generate all ABI files from Solidity interfaces (default)"
+	@echo "  native-abi    - Generate ABI from native staking contract interface"
+	@echo "  account-abi   - Generate ABI from account contract interface"
 	@echo "  clean         - Remove generated files"
 	@echo "  install-deps  - Install solc and jq dependencies"
 	@echo "  check-deps    - Check if dependencies are installed"
 	@echo "  watch         - Watch for changes and regenerate ABI"
-	@echo "  validate      - Validate generated ABI file"
+	@echo "  validate      - Validate generated ABI files"
 	@echo "  help          - Show this help message"
 	@echo ""
 	@echo "Files:"
-	@echo "  Input:  $(SOL_FILE)"
-	@echo "  Output: $(ABI_FILE)"
+	@echo "  Input:  $(NATIVE_SOL_FILE) -> Output: $(NATIVE_ABI_FILE)"
+	@echo "  Input:  $(ACCOUNT_SOL_FILE) -> Output: $(ACCOUNT_ABI_FILE)"

action/account_contract_abi.go

@@ -0,0 +1,61 @@
+package action
+
+import (
+	_ "embed"
+	"math/big"
+	"strings"
+	"sync"
+
+	"github.com/ethereum/go-ethereum/accounts/abi"
+	"github.com/ethereum/go-ethereum/common"
+	"github.com/iotexproject/go-pkgs/hash"
+	"github.com/iotexproject/iotex-address/address"
+)
+
+var (
+	//go:embed account_contract_abi.json
+	AccountContractABIJSON string
+
+	accountContractABI           abi.ABI
+	accountContractTransferEvent abi.Event
+
+	onceAcc sync.Once
+)
+
+func initAccountContractABI() {
+	onceAcc.Do(func() {
+		var err error
+		accountContractABI, err = abi.JSON(strings.NewReader(AccountContractABIJSON))
+		if err != nil {
+			panic("failed to load account contract ABI: " + err.Error())
+		}
+		var ok bool
+		accountContractTransferEvent, ok = accountContractABI.Events["Transfer"]
+		if !ok {
+			panic("failed to load Transfer event from account contract ABI")
+		}
+	})
+}
+
+// AccountContractABI returns the ABI of the account contract
+func AccountContractABI() *abi.ABI {
+	initAccountContractABI()
+	return &accountContractABI
+}
+
+// PackAccountTransferEvent packs the parameters for the account transfer event
+func PackAccountTransferEvent(
+	from, to address.Address, amount *big.Int, typ uint8,
+) (Topics, []byte, error) {
+	initAccountContractABI()
+	data, err := accountContractTransferEvent.Inputs.NonIndexed().Pack(amount)
+	if err != nil {
+		return nil, nil, err
+	}
+	topics := make(Topics, 4)
+	topics[0] = hash.Hash256(accountContractTransferEvent.ID)
+	topics[1] = hash.Hash256(common.BytesToHash(from.Bytes()))
+	topics[2] = hash.Hash256(common.BytesToHash(to.Bytes()))
+	topics[3] = hash.Hash256(common.BytesToHash([]byte{typ}))
+	return topics, data, nil
+}

action/account_contract_abi.json

@@ -0,0 +1,33 @@
+[
+  {
+    "anonymous": false,
+    "inputs": [
+      {
+        "indexed": true,
+        "internalType": "address",
+        "name": "from",
+        "type": "address"
+      },
+      {
+        "indexed": true,
+        "internalType": "address",
+        "name": "to",
+        "type": "address"
+      },
+      {
+        "indexed": true,
+        "internalType": "enum IAccountProtocolContract.TransactionLogType",
+        "name": "logType",
+        "type": "uint8"
+      },
+      {
+        "indexed": false,
+        "internalType": "uint256",
+        "name": "amount",
+        "type": "uint256"
+      }
+    ],
+    "name": "Transfer",
+    "type": "event"
+  }
+]

action/account_contract_interface.sol

@@ -0,0 +1,29 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.24;
+
+// Interface for the Account Protocol contract
+interface IAccountProtocolContract {
+    // enum representing different types of transfer events
+    enum TransactionLogType {
+        IN_CONTRACT_TRANSFER,
+        WITHDRAW_BUCKET,
+        CREATE_BUCKET,
+        DEPOSIT_TO_BUCKET,
+        CANDIDATE_SELF_STAKE,
+        CANDIDATE_REGISTRATION_FEE,
+        GAS_FEE,
+        NATIVE_TRANSFER,
+        DEPOSIT_TO_REWARDING_FUND,
+        CLAIM_FROM_REWARDING_FUND,
+        BLOB_FEE,
+        PRIORITY_FEE
+    }
+
+    // Event emitted when a transfer occurs
+    event Transfer(
+        address indexed from,
+        address indexed to,
+        TransactionLogType indexed logType,
+        uint256 amount
+    );
+}

action/receipt.go

@@ -12,7 +12,9 @@ import (
 	"google.golang.org/protobuf/proto"
 
 	"github.com/iotexproject/go-pkgs/hash"
+	"github.com/iotexproject/iotex-address/address"
 	"github.com/iotexproject/iotex-proto/golang/iotextypes"
+	"github.com/pkg/errors"
 
 	"github.com/iotexproject/iotex-core/v2/pkg/log"
 )
@@ -195,6 +197,25 @@ func (receipt *Receipt) UpdateIndex(txIndex, logIndex uint32) uint32 {
 	return logIndex
 }
 
+// TransferLogs converts transaction logs to logs with given account contract address and starting log index
+func (receipt *Receipt) TransferLogs(accountContractAddr string, logIndex uint32) ([]*Log, error) {
+	logs := make([]*Log, 0, len(receipt.transactionLogs))
+	for _, tlog := range receipt.transactionLogs {
+		log, err := tlog.convertToLog()
+		if err != nil {
+			return nil, errors.Wrapf(err, "failed to convert transaction log to log: %s", tlog.Type)
+		}
+		log.Address = accountContractAddr
+		log.BlockHeight = receipt.BlockHeight
+		log.ActionHash = receipt.ActionHash
+		log.Index = logIndex
+		log.TxIndex = receipt.TxIndex
+		logs = append(logs, log)
+		logIndex++
+	}
+	return logs, nil
+}
+
 // ConvertToLogPb converts a Log to protobuf's Log
 func (log *Log) ConvertToLogPb() *iotextypes.Log {
 	l := &iotextypes.Log{}
@@ -246,3 +267,36 @@ func (log *Log) Deserialize(buf []byte) error {
 	log.ConvertFromLogPb(pbLog)
 	return nil
 }
+
+func convertSpecialAddress(addr string) string {
+	switch addr {
+	case address.StakingBucketPoolAddr:
+		return address.StakingProtocolAddr
+	case address.RewardingPoolAddr:
+		return address.RewardingProtocol
+	case "":
+		return address.ZeroAddress
+	}
+	return addr
+}
+
+func (tlog *TransactionLog) convertToLog() (*Log, error) {
+	sender := convertSpecialAddress(tlog.Sender)
+	recipient := convertSpecialAddress(tlog.Recipient)
+	from, err := address.FromString(sender)
+	if err != nil {
+		return nil, errors.Wrapf(err, "failed to convert sender address from string: %s", sender)
+	}
+	to, err := address.FromString(recipient)
+	if err != nil {
+		return nil, errors.Wrapf(err, "failed to convert recipient address from string: %s", recipient)
+	}
+	topics, data, err := PackAccountTransferEvent(from, to, tlog.Amount, uint8(tlog.Type))
+	if err != nil {
+		return nil, errors.Wrapf(err, "failed to pack account transfer event: %s", tlog.Type)
+	}
+	return &Log{
+		Topics: topics,
+		Data:   data,
+	}, nil
+}

api/coreservice.go

@@ -359,7 +359,8 @@ func (core *coreService) BalanceAt(ctx context.Context, addr address.Address, he
 	if err != nil {
 		return "", status.Error(codes.Internal, err.Error())
 	}
-	if addrStr == address.RewardingPoolAddr || addrStr == address.StakingBucketPoolAddr {
+	if addrStr == address.RewardingPoolAddr || addrStr == address.StakingBucketPoolAddr ||
+		addrStr == address.RewardingProtocol || addrStr == address.StakingProtocolAddr {
 		acc, _, err := core.getProtocolAccount(ctx, addrStr)
 		if err != nil {
 			return "", err
@@ -1883,7 +1884,7 @@ func (core *coreService) getProtocolAccount(ctx context.Context, addr string) (*
 		err     error
 	)
 	switch addr {
-	case address.RewardingPoolAddr:
+	case address.RewardingPoolAddr, address.RewardingProtocol:
 		if out, err = core.ReadState("rewarding", "", []byte("TotalBalance"), nil); err != nil {
 			return nil, nil, err
 		}
@@ -1892,7 +1893,7 @@ func (core *coreService) getProtocolAccount(ctx context.Context, addr string) (*
 			return nil, nil, errors.New("balance convert error")
 		}
 		balance = val.String()
-	case address.StakingBucketPoolAddr:
+	case address.StakingBucketPoolAddr, address.StakingProtocolAddr:
 		methodName, err := proto.Marshal(&iotexapi.ReadStakingDataMethod{
 			Method: iotexapi.ReadStakingDataMethod_TOTAL_STAKING_AMOUNT,
 		})