mirror of
https://gitlab.com/pulsechaincom/go-pulse.git
synced 2024-12-25 04:47:17 +00:00
cd79bc61a9
Add methods that allow for the unpacking of event logs into maps (allows for agnostic unpacking of logs)
374 lines
14 KiB
Go
374 lines
14 KiB
Go
// Copyright 2019 The go-ethereum Authors
|
|
// This file is part of the go-ethereum library.
|
|
//
|
|
// The go-ethereum library is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU Lesser General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// The go-ethereum library is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU Lesser General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU Lesser General Public License
|
|
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
package bind_test
|
|
|
|
import (
|
|
"bytes"
|
|
"context"
|
|
"math/big"
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/ethereum/go-ethereum"
|
|
"github.com/ethereum/go-ethereum/accounts/abi"
|
|
"github.com/ethereum/go-ethereum/accounts/abi/bind"
|
|
"github.com/ethereum/go-ethereum/common"
|
|
"github.com/ethereum/go-ethereum/common/hexutil"
|
|
"github.com/ethereum/go-ethereum/core/types"
|
|
"github.com/ethereum/go-ethereum/crypto"
|
|
"github.com/ethereum/go-ethereum/rlp"
|
|
)
|
|
|
|
type mockCaller struct {
|
|
codeAtBlockNumber *big.Int
|
|
callContractBlockNumber *big.Int
|
|
}
|
|
|
|
func (mc *mockCaller) CodeAt(ctx context.Context, contract common.Address, blockNumber *big.Int) ([]byte, error) {
|
|
mc.codeAtBlockNumber = blockNumber
|
|
return []byte{1, 2, 3}, nil
|
|
}
|
|
|
|
func (mc *mockCaller) CallContract(ctx context.Context, call ethereum.CallMsg, blockNumber *big.Int) ([]byte, error) {
|
|
mc.callContractBlockNumber = blockNumber
|
|
return nil, nil
|
|
}
|
|
func TestPassingBlockNumber(t *testing.T) {
|
|
|
|
mc := &mockCaller{}
|
|
|
|
bc := bind.NewBoundContract(common.HexToAddress("0x0"), abi.ABI{
|
|
Methods: map[string]abi.Method{
|
|
"something": {
|
|
Name: "something",
|
|
Outputs: abi.Arguments{},
|
|
},
|
|
},
|
|
}, mc, nil, nil)
|
|
var ret string
|
|
|
|
blockNumber := big.NewInt(42)
|
|
|
|
bc.Call(&bind.CallOpts{BlockNumber: blockNumber}, &ret, "something")
|
|
|
|
if mc.callContractBlockNumber != blockNumber {
|
|
t.Fatalf("CallContract() was not passed the block number")
|
|
}
|
|
|
|
if mc.codeAtBlockNumber != blockNumber {
|
|
t.Fatalf("CodeAt() was not passed the block number")
|
|
}
|
|
|
|
bc.Call(&bind.CallOpts{}, &ret, "something")
|
|
|
|
if mc.callContractBlockNumber != nil {
|
|
t.Fatalf("CallContract() was passed a block number when it should not have been")
|
|
}
|
|
|
|
if mc.codeAtBlockNumber != nil {
|
|
t.Fatalf("CodeAt() was passed a block number when it should not have been")
|
|
}
|
|
}
|
|
|
|
const hexData = "0x000000000000000000000000376c47978271565f56deb45495afa69e59c16ab200000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000060000000000000000000000000000000000000000000000000000000000000000158"
|
|
|
|
func TestUnpackIndexedStringTyLogIntoMap(t *testing.T) {
|
|
hash := crypto.Keccak256Hash([]byte("testName"))
|
|
mockLog := types.Log{
|
|
Address: common.HexToAddress("0x0"),
|
|
Topics: []common.Hash{
|
|
common.HexToHash("0x0"),
|
|
hash,
|
|
},
|
|
Data: hexutil.MustDecode(hexData),
|
|
BlockNumber: uint64(26),
|
|
TxHash: common.HexToHash("0x0"),
|
|
TxIndex: 111,
|
|
BlockHash: common.BytesToHash([]byte{1, 2, 3, 4, 5}),
|
|
Index: 7,
|
|
Removed: false,
|
|
}
|
|
|
|
abiString := `[{"anonymous":false,"inputs":[{"indexed":true,"name":"name","type":"string"},{"indexed":false,"name":"sender","type":"address"},{"indexed":false,"name":"amount","type":"uint256"},{"indexed":false,"name":"memo","type":"bytes"}],"name":"received","type":"event"}]`
|
|
parsedAbi, _ := abi.JSON(strings.NewReader(abiString))
|
|
bc := bind.NewBoundContract(common.HexToAddress("0x0"), parsedAbi, nil, nil, nil)
|
|
|
|
receivedMap := make(map[string]interface{})
|
|
expectedReceivedMap := map[string]interface{}{
|
|
"name": hash,
|
|
"sender": common.HexToAddress("0x376c47978271565f56DEB45495afa69E59c16Ab2"),
|
|
"amount": big.NewInt(1),
|
|
"memo": []byte{88},
|
|
}
|
|
if err := bc.UnpackLogIntoMap(receivedMap, "received", mockLog); err != nil {
|
|
t.Error(err)
|
|
}
|
|
|
|
if len(receivedMap) != 4 {
|
|
t.Fatal("unpacked map expected to have length 4")
|
|
}
|
|
if receivedMap["name"] != expectedReceivedMap["name"] {
|
|
t.Error("unpacked map does not match expected map")
|
|
}
|
|
if receivedMap["sender"] != expectedReceivedMap["sender"] {
|
|
t.Error("unpacked map does not match expected map")
|
|
}
|
|
if receivedMap["amount"].(*big.Int).Cmp(expectedReceivedMap["amount"].(*big.Int)) != 0 {
|
|
t.Error("unpacked map does not match expected map")
|
|
}
|
|
if !bytes.Equal(receivedMap["memo"].([]byte), expectedReceivedMap["memo"].([]byte)) {
|
|
t.Error("unpacked map does not match expected map")
|
|
}
|
|
}
|
|
|
|
func TestUnpackIndexedSliceTyLogIntoMap(t *testing.T) {
|
|
sliceBytes, err := rlp.EncodeToBytes([]string{"name1", "name2", "name3", "name4"})
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
hash := crypto.Keccak256Hash(sliceBytes)
|
|
mockLog := types.Log{
|
|
Address: common.HexToAddress("0x0"),
|
|
Topics: []common.Hash{
|
|
common.HexToHash("0x0"),
|
|
hash,
|
|
},
|
|
Data: hexutil.MustDecode(hexData),
|
|
BlockNumber: uint64(26),
|
|
TxHash: common.HexToHash("0x0"),
|
|
TxIndex: 111,
|
|
BlockHash: common.BytesToHash([]byte{1, 2, 3, 4, 5}),
|
|
Index: 7,
|
|
Removed: false,
|
|
}
|
|
|
|
abiString := `[{"anonymous":false,"inputs":[{"indexed":true,"name":"names","type":"string[]"},{"indexed":false,"name":"sender","type":"address"},{"indexed":false,"name":"amount","type":"uint256"},{"indexed":false,"name":"memo","type":"bytes"}],"name":"received","type":"event"}]`
|
|
parsedAbi, _ := abi.JSON(strings.NewReader(abiString))
|
|
bc := bind.NewBoundContract(common.HexToAddress("0x0"), parsedAbi, nil, nil, nil)
|
|
|
|
receivedMap := make(map[string]interface{})
|
|
expectedReceivedMap := map[string]interface{}{
|
|
"names": hash,
|
|
"sender": common.HexToAddress("0x376c47978271565f56DEB45495afa69E59c16Ab2"),
|
|
"amount": big.NewInt(1),
|
|
"memo": []byte{88},
|
|
}
|
|
if err := bc.UnpackLogIntoMap(receivedMap, "received", mockLog); err != nil {
|
|
t.Error(err)
|
|
}
|
|
|
|
if len(receivedMap) != 4 {
|
|
t.Fatal("unpacked map expected to have length 4")
|
|
}
|
|
if receivedMap["names"] != expectedReceivedMap["names"] {
|
|
t.Error("unpacked map does not match expected map")
|
|
}
|
|
if receivedMap["sender"] != expectedReceivedMap["sender"] {
|
|
t.Error("unpacked map does not match expected map")
|
|
}
|
|
if receivedMap["amount"].(*big.Int).Cmp(expectedReceivedMap["amount"].(*big.Int)) != 0 {
|
|
t.Error("unpacked map does not match expected map")
|
|
}
|
|
if !bytes.Equal(receivedMap["memo"].([]byte), expectedReceivedMap["memo"].([]byte)) {
|
|
t.Error("unpacked map does not match expected map")
|
|
}
|
|
}
|
|
|
|
func TestUnpackIndexedArrayTyLogIntoMap(t *testing.T) {
|
|
arrBytes, err := rlp.EncodeToBytes([2]common.Address{common.HexToAddress("0x0"), common.HexToAddress("0x376c47978271565f56DEB45495afa69E59c16Ab2")})
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
hash := crypto.Keccak256Hash(arrBytes)
|
|
mockLog := types.Log{
|
|
Address: common.HexToAddress("0x0"),
|
|
Topics: []common.Hash{
|
|
common.HexToHash("0x0"),
|
|
hash,
|
|
},
|
|
Data: hexutil.MustDecode(hexData),
|
|
BlockNumber: uint64(26),
|
|
TxHash: common.HexToHash("0x0"),
|
|
TxIndex: 111,
|
|
BlockHash: common.BytesToHash([]byte{1, 2, 3, 4, 5}),
|
|
Index: 7,
|
|
Removed: false,
|
|
}
|
|
|
|
abiString := `[{"anonymous":false,"inputs":[{"indexed":true,"name":"addresses","type":"address[2]"},{"indexed":false,"name":"sender","type":"address"},{"indexed":false,"name":"amount","type":"uint256"},{"indexed":false,"name":"memo","type":"bytes"}],"name":"received","type":"event"}]`
|
|
parsedAbi, _ := abi.JSON(strings.NewReader(abiString))
|
|
bc := bind.NewBoundContract(common.HexToAddress("0x0"), parsedAbi, nil, nil, nil)
|
|
|
|
receivedMap := make(map[string]interface{})
|
|
expectedReceivedMap := map[string]interface{}{
|
|
"addresses": hash,
|
|
"sender": common.HexToAddress("0x376c47978271565f56DEB45495afa69E59c16Ab2"),
|
|
"amount": big.NewInt(1),
|
|
"memo": []byte{88},
|
|
}
|
|
if err := bc.UnpackLogIntoMap(receivedMap, "received", mockLog); err != nil {
|
|
t.Error(err)
|
|
}
|
|
|
|
if len(receivedMap) != 4 {
|
|
t.Fatal("unpacked map expected to have length 4")
|
|
}
|
|
if receivedMap["addresses"] != expectedReceivedMap["addresses"] {
|
|
t.Error("unpacked map does not match expected map")
|
|
}
|
|
if receivedMap["sender"] != expectedReceivedMap["sender"] {
|
|
t.Error("unpacked map does not match expected map")
|
|
}
|
|
if receivedMap["amount"].(*big.Int).Cmp(expectedReceivedMap["amount"].(*big.Int)) != 0 {
|
|
t.Error("unpacked map does not match expected map")
|
|
}
|
|
if !bytes.Equal(receivedMap["memo"].([]byte), expectedReceivedMap["memo"].([]byte)) {
|
|
t.Error("unpacked map does not match expected map")
|
|
}
|
|
}
|
|
|
|
func TestUnpackIndexedFuncTyLogIntoMap(t *testing.T) {
|
|
mockAddress := common.HexToAddress("0x376c47978271565f56DEB45495afa69E59c16Ab2")
|
|
addrBytes := mockAddress.Bytes()
|
|
hash := crypto.Keccak256Hash([]byte("mockFunction(address,uint)"))
|
|
functionSelector := hash[:4]
|
|
functionTyBytes := append(addrBytes, functionSelector...)
|
|
var functionTy [24]byte
|
|
copy(functionTy[:], functionTyBytes[0:24])
|
|
mockLog := types.Log{
|
|
Address: common.HexToAddress("0x0"),
|
|
Topics: []common.Hash{
|
|
common.HexToHash("0x99b5620489b6ef926d4518936cfec15d305452712b88bd59da2d9c10fb0953e8"),
|
|
common.BytesToHash(functionTyBytes),
|
|
},
|
|
Data: hexutil.MustDecode(hexData),
|
|
BlockNumber: uint64(26),
|
|
TxHash: common.HexToHash("0x5c698f13940a2153440c6d19660878bc90219d9298fdcf37365aa8d88d40fc42"),
|
|
TxIndex: 111,
|
|
BlockHash: common.BytesToHash([]byte{1, 2, 3, 4, 5}),
|
|
Index: 7,
|
|
Removed: false,
|
|
}
|
|
|
|
abiString := `[{"anonymous":false,"inputs":[{"indexed":true,"name":"function","type":"function"},{"indexed":false,"name":"sender","type":"address"},{"indexed":false,"name":"amount","type":"uint256"},{"indexed":false,"name":"memo","type":"bytes"}],"name":"received","type":"event"}]`
|
|
parsedAbi, _ := abi.JSON(strings.NewReader(abiString))
|
|
bc := bind.NewBoundContract(common.HexToAddress("0x0"), parsedAbi, nil, nil, nil)
|
|
|
|
receivedMap := make(map[string]interface{})
|
|
expectedReceivedMap := map[string]interface{}{
|
|
"function": functionTy,
|
|
"sender": common.HexToAddress("0x376c47978271565f56DEB45495afa69E59c16Ab2"),
|
|
"amount": big.NewInt(1),
|
|
"memo": []byte{88},
|
|
}
|
|
if err := bc.UnpackLogIntoMap(receivedMap, "received", mockLog); err != nil {
|
|
t.Error(err)
|
|
}
|
|
|
|
if len(receivedMap) != 4 {
|
|
t.Fatal("unpacked map expected to have length 4")
|
|
}
|
|
if receivedMap["function"] != expectedReceivedMap["function"] {
|
|
t.Error("unpacked map does not match expected map")
|
|
}
|
|
if receivedMap["sender"] != expectedReceivedMap["sender"] {
|
|
t.Error("unpacked map does not match expected map")
|
|
}
|
|
if receivedMap["amount"].(*big.Int).Cmp(expectedReceivedMap["amount"].(*big.Int)) != 0 {
|
|
t.Error("unpacked map does not match expected map")
|
|
}
|
|
if !bytes.Equal(receivedMap["memo"].([]byte), expectedReceivedMap["memo"].([]byte)) {
|
|
t.Error("unpacked map does not match expected map")
|
|
}
|
|
}
|
|
|
|
func TestUnpackIndexedBytesTyLogIntoMap(t *testing.T) {
|
|
byts := []byte{1, 2, 3, 4, 5}
|
|
hash := crypto.Keccak256Hash(byts)
|
|
mockLog := types.Log{
|
|
Address: common.HexToAddress("0x0"),
|
|
Topics: []common.Hash{
|
|
common.HexToHash("0x99b5620489b6ef926d4518936cfec15d305452712b88bd59da2d9c10fb0953e8"),
|
|
hash,
|
|
},
|
|
Data: hexutil.MustDecode(hexData),
|
|
BlockNumber: uint64(26),
|
|
TxHash: common.HexToHash("0x5c698f13940a2153440c6d19660878bc90219d9298fdcf37365aa8d88d40fc42"),
|
|
TxIndex: 111,
|
|
BlockHash: common.BytesToHash([]byte{1, 2, 3, 4, 5}),
|
|
Index: 7,
|
|
Removed: false,
|
|
}
|
|
|
|
abiString := `[{"anonymous":false,"inputs":[{"indexed":true,"name":"content","type":"bytes"},{"indexed":false,"name":"sender","type":"address"},{"indexed":false,"name":"amount","type":"uint256"},{"indexed":false,"name":"memo","type":"bytes"}],"name":"received","type":"event"}]`
|
|
parsedAbi, _ := abi.JSON(strings.NewReader(abiString))
|
|
bc := bind.NewBoundContract(common.HexToAddress("0x0"), parsedAbi, nil, nil, nil)
|
|
|
|
receivedMap := make(map[string]interface{})
|
|
expectedReceivedMap := map[string]interface{}{
|
|
"content": hash,
|
|
"sender": common.HexToAddress("0x376c47978271565f56DEB45495afa69E59c16Ab2"),
|
|
"amount": big.NewInt(1),
|
|
"memo": []byte{88},
|
|
}
|
|
if err := bc.UnpackLogIntoMap(receivedMap, "received", mockLog); err != nil {
|
|
t.Error(err)
|
|
}
|
|
|
|
if len(receivedMap) != 4 {
|
|
t.Fatal("unpacked map expected to have length 4")
|
|
}
|
|
if receivedMap["content"] != expectedReceivedMap["content"] {
|
|
t.Error("unpacked map does not match expected map")
|
|
}
|
|
if receivedMap["sender"] != expectedReceivedMap["sender"] {
|
|
t.Error("unpacked map does not match expected map")
|
|
}
|
|
if receivedMap["amount"].(*big.Int).Cmp(expectedReceivedMap["amount"].(*big.Int)) != 0 {
|
|
t.Error("unpacked map does not match expected map")
|
|
}
|
|
if !bytes.Equal(receivedMap["memo"].([]byte), expectedReceivedMap["memo"].([]byte)) {
|
|
t.Error("unpacked map does not match expected map")
|
|
}
|
|
}
|
|
|
|
func TestUnpackIntoMapNamingConflict(t *testing.T) {
|
|
hash := crypto.Keccak256Hash([]byte("testName"))
|
|
mockLog := types.Log{
|
|
Address: common.HexToAddress("0x0"),
|
|
Topics: []common.Hash{
|
|
common.HexToHash("0x0"),
|
|
hash,
|
|
},
|
|
Data: hexutil.MustDecode(hexData),
|
|
BlockNumber: uint64(26),
|
|
TxHash: common.HexToHash("0x0"),
|
|
TxIndex: 111,
|
|
BlockHash: common.BytesToHash([]byte{1, 2, 3, 4, 5}),
|
|
Index: 7,
|
|
Removed: false,
|
|
}
|
|
|
|
abiString := `[{"anonymous":false,"inputs":[{"indexed":true,"name":"name","type":"string"},{"indexed":false,"name":"sender","type":"address"},{"indexed":false,"name":"amount","type":"uint256"},{"indexed":false,"name":"memo","type":"bytes"}],"name":"received","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"name":"sender","type":"address"}],"name":"received","type":"event"}]`
|
|
parsedAbi, _ := abi.JSON(strings.NewReader(abiString))
|
|
bc := bind.NewBoundContract(common.HexToAddress("0x0"), parsedAbi, nil, nil, nil)
|
|
receivedMap := make(map[string]interface{})
|
|
if err := bc.UnpackLogIntoMap(receivedMap, "received", mockLog); err == nil {
|
|
t.Error("naming conflict between two events; error expected")
|
|
}
|
|
}
|