-
Notifications
You must be signed in to change notification settings - Fork 32
/
send.go
261 lines (232 loc) · 9.4 KB
/
send.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
// Copyright 2018, 2021 Kaleido
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package eth
import (
"context"
"encoding/hex"
"math/big"
"regexp"
"strings"
"time"
"github.com/hyperledger/firefly-ethconnect/internal/errors"
ethbinding "github.com/kaleido-io/ethbinding/pkg"
"github.com/hyperledger/firefly-ethconnect/internal/ethbind"
log "github.com/sirupsen/logrus"
)
type EthCommonConf struct {
GasEstimationFactor float64 `json:"gasEstimationFactor"`
}
const (
defaultGasEstimationFactor = 1.2
errorFunctionSelector = "0x08c379a0" // per https://solidity.readthedocs.io/en/v0.4.24/control-structures.html the signature of Error(string)
)
// calculateGas uses eth_estimateGas to estimate the gas required, providing a buffer
// of 20% for variation as the chain changes between estimation and submission.
func (tx *Txn) calculateGas(ctx context.Context, rpc RPCClient, txArgs *SendTXArgs, gas *ethbinding.HexUint64, estimationFactor float64) (reverted bool, err error) {
ctx, cancel := context.WithTimeout(ctx, 30*time.Second)
defer cancel()
if estimationFactor <= 0 {
estimationFactor = defaultGasEstimationFactor
}
beforeEstimate := time.Now()
if err := rpc.CallContext(ctx, &gas, "eth_estimateGas", txArgs); err != nil {
// Now we attempt a call of the transaction, because that will return us a useful error in the case, of a revert.
estError := errors.Errorf(errors.TransactionSendGasEstimateFailed, err)
log.Errorf(estError.Error())
if _, reverted, err := tx.Call(ctx, rpc, "latest"); err != nil {
return reverted, err
}
// If the call succeeds, after estimate completed - we still need to fail with the estimate error
return false, estError
}
beforeFactor := *gas
*gas = ethbinding.HexUint64(float64(*gas) * estimationFactor)
log.Infof("Gas estimate tx=%s gas=%d estimate=%d factor=%.2f time=%dms", tx.EthTX.Hash(), beforeFactor, *gas, estimationFactor, time.Since(beforeEstimate).Milliseconds())
return false, nil
}
func (tx *Txn) buildCallArgs() *SendTXArgs {
data := ethbinding.HexBytes(tx.EthTX.Data())
txArgs := &SendTXArgs{
From: tx.From.Hex(),
GasPrice: ethbinding.HexBigInt(*tx.EthTX.GasPrice()),
Value: ethbinding.HexBigInt(*tx.EthTX.Value()),
Data: &data,
}
var to = tx.EthTX.To()
if to != nil {
txArgs.To = to.Hex()
}
return txArgs
}
func (tx *Txn) Estimate(ctx context.Context, rpc RPCClient, estimationFactor float64) (data ethbinding.HexBytes, gas ethbinding.HexUint64, reverted bool, err error) {
txArgs := tx.buildCallArgs()
reverted, err = tx.calculateGas(ctx, rpc, txArgs, &gas, estimationFactor)
return *txArgs.Data, gas, reverted, err
}
// Call synchronously calls the method, without mining a transaction, and returns the result as RLP encoded bytes or nil
func (tx *Txn) Call(ctx context.Context, rpc RPCClient, blocknumber string) (res []byte, reverted bool, err error) {
txArgs := tx.buildCallArgs()
ctx, cancel := context.WithTimeout(ctx, 30*time.Second)
defer cancel()
var hexString string
if err = rpc.CallContext(ctx, &hexString, "eth_call", txArgs, blocknumber); err != nil {
return nil, false, errors.Errorf(errors.TransactionSendCallFailedNoRevert, err)
}
if len(hexString) == 0 || hexString == "0x" {
return nil, false, nil
}
retStrLen := uint64(len(hexString))
if strings.HasPrefix(hexString, errorFunctionSelector) && retStrLen > 138 {
// The call reverted. Process the error response
dataOffsetHex := new(big.Int)
dataOffsetHex.SetString(hexString[10:74], 16)
errorStringLen := new(big.Int)
errorStringLen.SetString(hexString[74:138], 16)
hexStringEnd := errorStringLen.Uint64()*2 + 138
if hexStringEnd > retStrLen {
hexStringEnd = retStrLen
}
errorStringHex := hexString[138:hexStringEnd]
errorStringBytes, err := hex.DecodeString(errorStringHex)
log.Warnf("EVM Reverted. Message='%s' Offset='%s'", errorStringBytes, dataOffsetHex.Text(10))
if err != nil {
return nil, true, errors.Errorf(errors.TransactionSendCallFailedRevertNoMessage)
}
return nil, true, errors.Errorf(errors.TransactionSendCallFailedRevertMessage, errorStringBytes)
}
log.Debugf("eth_call response: %s", hexString)
res = ethbind.API.FromHex(hexString)
return
}
func (tx *Txn) CallAndProcessReply(ctx context.Context, rpc RPCClient, blocknumber string) (map[string]interface{}, error) {
callOption := "latest"
// only allowed values are "earliest/latest/pending", "", a number string "12345" or a hex number "0xab23"
// "latest" and "" (no fly-blocknumber given) are equivalent
if blocknumber != "" && blocknumber != "latest" {
isHex, _ := regexp.MatchString(`^0x[0-9a-fA-F]+$`, blocknumber)
if isHex || blocknumber == "earliest" || blocknumber == "pending" {
callOption = blocknumber
} else {
n := new(big.Int)
n, ok := n.SetString(blocknumber, 10)
if !ok {
return nil, errors.Errorf(errors.TransactionCallInvalidBlockNumber)
}
callOption = ethbind.API.EncodeBig(n)
}
}
retBytes, _, err := tx.Call(ctx, rpc, callOption)
if err != nil || retBytes == nil {
return nil, err
}
return ProcessRLPBytes(tx.Method.Outputs, retBytes), nil
}
// Send sends an individual transaction, choosing external or internal signing
func (tx *Txn) Send(ctx context.Context, rpc RPCClient, estimationFactor float64) (err error) {
start := time.Now().UTC()
gas := ethbinding.HexUint64(tx.EthTX.Gas())
data := ethbinding.HexBytes(tx.EthTX.Data())
txArgs := &SendTXArgs{
From: tx.From.Hex(),
GasPrice: ethbinding.HexBigInt(*tx.EthTX.GasPrice()),
Value: ethbinding.HexBigInt(*tx.EthTX.Value()),
Data: &data,
}
var to = tx.EthTX.To()
if to != nil {
txArgs.To = to.Hex()
}
if uint64(gas) == uint64(0) {
if _, err = tx.calculateGas(ctx, rpc, txArgs, &gas, estimationFactor); err != nil {
return err
}
// Re-encode the EthTX (for external HD Wallet signing)
if to != nil {
tx.EthTX = ethbind.API.NewTransaction(tx.EthTX.Nonce(), *tx.EthTX.To(), tx.EthTX.Value(), uint64(gas), tx.EthTX.GasPrice(), tx.EthTX.Data())
} else {
tx.EthTX = ethbind.API.NewContractCreation(tx.EthTX.Nonce(), tx.EthTX.Value(), uint64(gas), tx.EthTX.GasPrice(), tx.EthTX.Data())
}
}
txArgs.Gas = &gas
ctx, cancel := context.WithTimeout(ctx, 30*time.Second)
defer cancel()
tx.Hash, err = tx.submitTXtoNode(ctx, rpc, txArgs)
callTime := time.Now().UTC().Sub(start)
if err != nil {
log.Warnf("TX:%s Failed to send: %s [%.2fs]", tx.Hash, err, callTime.Seconds())
} else {
log.Infof("TX:%s Sent OK [%.2fs]", tx.Hash, callTime.Seconds())
}
return err
}
// SendTXArgs is the JSON arguments that can be passed to an eth_sendTransaction call,
// and also the interface passed to the signer in the case of pre-signing
type SendTXArgs struct {
Nonce *ethbinding.HexUint64 `json:"nonce,omitempty"`
From string `json:"from"`
To string `json:"to,omitempty"`
Gas *ethbinding.HexUint64 `json:"gas,omitempty"`
GasPrice ethbinding.HexBigInt `json:"gasPrice,omitempty"`
Value ethbinding.HexBigInt `json:"value,omitempty"`
Data *ethbinding.HexBytes `json:"data"`
// EEA spec extensions
PrivateFrom string `json:"privateFrom,omitempty"`
PrivateFor []string `json:"privateFor,omitempty"`
PrivacyGroupID string `json:"privacyGroupId,omitempty"`
Restriction string `json:"restriction,omitempty"`
}
// submitTXtoNode sends a transaction
// - If no signer interface: For internal signing by the node
// - If a signer interface is present: Pre-signed by this process
func (tx *Txn) submitTXtoNode(ctx context.Context, rpc RPCClient, txArgs *SendTXArgs) (string, error) {
var nonce *ethbinding.HexUint64
if !tx.NodeAssignNonce {
hexNonce := ethbinding.HexUint64(tx.EthTX.Nonce())
nonce = &hexNonce
}
txArgs.Nonce = nonce
isPrivate := false
jsonRPCMethod := "eth_sendTransaction"
if tx.PrivacyGroupID != "" {
// This means we have an Orion style private TX.
// Earlier logic for Orion resolved the privateFor array down to a privacyGroupId
jsonRPCMethod = "eea_sendTransaction"
txArgs.PrivateFrom = tx.PrivateFrom
txArgs.PrivacyGroupID = tx.PrivacyGroupID
txArgs.Restriction = "restricted"
// PrivateFrom is requires for Orion transactions
if txArgs.PrivateFrom == "" {
return "", errors.Errorf(errors.TransactionSendMissingPrivateFromOrion)
}
isPrivate = true
} else if len(tx.PrivateFor) > 0 {
// Note that PrivateFrom is optional for Quorum/Tessera transactions
txArgs.PrivateFrom = tx.PrivateFrom
txArgs.PrivateFor = tx.PrivateFor
isPrivate = true
}
var callParam0 interface{} = txArgs
if tx.Signer != nil {
if isPrivate {
return "", errors.Errorf(errors.TransactionSendPrivateTXWithExternalSigner, tx.Signer.Type())
}
// Sign the transaction and get the bytes, which we pass to eth_sendRawTransaction
jsonRPCMethod = "eth_sendRawTransaction"
signed, err := tx.Signer.Sign(tx.EthTX)
if err != nil {
return "", err
}
callParam0 = ethbind.API.HexEncode(signed)
}
var txHash string
err := rpc.CallContext(ctx, &txHash, jsonRPCMethod, callParam0)
return txHash, err
}