/
action.go
501 lines (454 loc) · 15.4 KB
/
action.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
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
// Copyright (c) 2022 IoTeX Foundation
// This source code is provided 'as is' and no warranties are given as to title or non-infringement, merchantability
// or fitness for purpose and, to the extent permitted by law, all liability for your use of the code is disclaimed.
// This source code is governed by Apache License 2.0 that can be found in the LICENSE file.
package action
import (
"context"
"encoding/hex"
"math/big"
"strings"
"github.com/grpc-ecosystem/go-grpc-middleware/util/metautils"
"github.com/iotexproject/go-pkgs/hash"
"github.com/iotexproject/iotex-address/address"
"github.com/iotexproject/iotex-proto/golang/iotexapi"
"github.com/iotexproject/iotex-proto/golang/iotextypes"
"github.com/pkg/errors"
"github.com/spf13/cobra"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/status"
"google.golang.org/protobuf/proto"
"github.com/iotexproject/iotex-core/action"
"github.com/iotexproject/iotex-core/ioctl"
"github.com/iotexproject/iotex-core/ioctl/config"
"github.com/iotexproject/iotex-core/ioctl/flag"
"github.com/iotexproject/iotex-core/ioctl/newcmd/account"
"github.com/iotexproject/iotex-core/ioctl/newcmd/bc"
"github.com/iotexproject/iotex-core/ioctl/util"
"github.com/iotexproject/iotex-core/pkg/util/byteutil"
)
// Multi-language support
var (
_actionCmdShorts = map[config.Language]string{
config.English: "Manage actions of IoTeX blockchain",
config.Chinese: "管理IoTex区块链的行为", // this translation
}
_infoWarn = map[config.Language]string{
config.English: "** This is an irreversible action!\n" +
"Once an account is deleted, all the assets under this account may be lost!\n" +
"Type 'YES' to continue, quit for anything else.",
config.Chinese: "** 这是一个不可逆转的操作!\n" +
"一旦一个账户被删除, 该账户下的所有资源都可能会丢失!\n" +
"输入 'YES' 以继续, 否则退出",
}
_infoQuit = map[config.Language]string{
config.English: "quit",
config.Chinese: "退出",
}
_flagGasLimitUsages = map[config.Language]string{
config.English: "set gas limit",
config.Chinese: "设置燃气上限",
}
_flagGasPriceUsages = map[config.Language]string{
config.English: `set gas price (unit: 10^(-6)IOTX), use suggested gas price if input is "0"`,
config.Chinese: `设置燃气费(单位:10^(-6)IOTX),如果输入为「0」,则使用默认燃气费`,
}
_flagNonceUsages = map[config.Language]string{
config.English: "set nonce (default using pending nonce)",
config.Chinese: "设置 nonce (默认使用 pending nonce)",
}
_flagSignerUsages = map[config.Language]string{
config.English: "choose a signing account",
config.Chinese: "选择要签名的帐户",
}
_flagBytecodeUsages = map[config.Language]string{
config.English: "set the byte code",
config.Chinese: "设置字节码",
}
_flagAssumeYesUsages = map[config.Language]string{
config.English: "answer yes for all confirmations",
config.Chinese: "为所有确认设置 yes",
}
_flagPasswordUsages = map[config.Language]string{
config.English: "input password for account",
config.Chinese: "设置密码",
}
)
// Flag label, short label and defaults
const (
gasLimitFlagLabel = "gas-limit"
gasLimitFlagShortLabel = "l"
GasLimitFlagDefault = uint64(20000000)
gasPriceFlagLabel = "gas-price"
gasPriceFlagShortLabel = "p"
gasPriceFlagDefault = "1"
nonceFlagLabel = "nonce"
nonceFlagShortLabel = "n"
nonceFlagDefault = uint64(0)
signerFlagLabel = "signer"
signerFlagShortLabel = "s"
SignerFlagDefault = ""
bytecodeFlagLabel = "bytecode"
bytecodeFlagShortLabel = "b"
bytecodeFlagDefault = ""
assumeYesFlagLabel = "assume-yes"
assumeYesFlagShortLabel = "y"
assumeYesFlagDefault = false
passwordFlagLabel = "password"
passwordFlagShortLabel = "P"
passwordFlagDefault = ""
)
func registerGasLimitFlag(client ioctl.Client, cmd *cobra.Command) {
flag.NewUint64VarP(gasLimitFlagLabel, gasLimitFlagShortLabel, GasLimitFlagDefault, selectTranslation(client, _flagGasLimitUsages)).RegisterCommand(cmd)
}
func registerGasPriceFlag(client ioctl.Client, cmd *cobra.Command) {
flag.NewStringVarP(gasPriceFlagLabel, gasPriceFlagShortLabel, gasPriceFlagDefault, selectTranslation(client, _flagGasPriceUsages)).RegisterCommand(cmd)
}
func registerNonceFlag(client ioctl.Client, cmd *cobra.Command) {
flag.NewUint64VarP(nonceFlagLabel, nonceFlagShortLabel, nonceFlagDefault, selectTranslation(client, _flagNonceUsages)).RegisterCommand(cmd)
}
func registerSignerFlag(client ioctl.Client, cmd *cobra.Command) {
flag.NewStringVarP(signerFlagLabel, signerFlagShortLabel, SignerFlagDefault, selectTranslation(client, _flagSignerUsages)).RegisterCommand(cmd)
}
func registerBytecodeFlag(client ioctl.Client, cmd *cobra.Command) {
flag.NewStringVarP(bytecodeFlagLabel, bytecodeFlagShortLabel, bytecodeFlagDefault, selectTranslation(client, _flagBytecodeUsages)).RegisterCommand(cmd)
}
func registerAssumeYesFlag(client ioctl.Client, cmd *cobra.Command) {
flag.BoolVarP(assumeYesFlagLabel, assumeYesFlagShortLabel, assumeYesFlagDefault, selectTranslation(client, _flagAssumeYesUsages)).RegisterCommand(cmd)
}
func registerPasswordFlag(client ioctl.Client, cmd *cobra.Command) {
flag.NewStringVarP(passwordFlagLabel, passwordFlagShortLabel, passwordFlagDefault, selectTranslation(client, _flagPasswordUsages)).RegisterCommand(cmd)
}
func selectTranslation(client ioctl.Client, trls map[config.Language]string) string {
txt, _ := client.SelectTranslation(trls)
return txt
}
// NewActionCmd represents the action command
func NewActionCmd(client ioctl.Client) *cobra.Command {
cmd := &cobra.Command{
Use: "action",
Short: selectTranslation(client, _actionCmdShorts),
}
// TODO add sub commands
// cmd.AddCommand(NewActionHash(client))
// cmd.AddCommand(NewActionTransfer(client))
// cmd.AddCommand(NewActionDeploy(client))
// cmd.AddCommand(NewActionInvoke(client))
// cmd.AddCommand(NewActionRead(client))
// cmd.AddCommand(NewActionClaim(client))
// cmd.AddCommand(NewActionDeposit(client))
// cmd.AddCommand(NewActionSendRaw(client))
client.SetEndpointWithFlag(cmd.PersistentFlags().StringVar)
client.SetInsecureWithFlag(cmd.PersistentFlags().BoolVar)
return cmd
}
// RegisterWriteCommand registers action flags for command
func RegisterWriteCommand(client ioctl.Client, cmd *cobra.Command) {
registerGasLimitFlag(client, cmd)
registerGasPriceFlag(client, cmd)
registerSignerFlag(client, cmd)
registerNonceFlag(client, cmd)
registerAssumeYesFlag(client, cmd)
registerPasswordFlag(client, cmd)
}
// GetWriteCommandFlag returns action flags for command
func GetWriteCommandFlag(cmd *cobra.Command) (gasPrice, signer, password string, nonce, gasLimit uint64, assumeYes bool, err error) {
gasPrice, err = cmd.Flags().GetString(gasPriceFlagLabel)
if err != nil {
err = errors.Wrap(err, "failed to get flag gas-price")
return
}
signer, err = cmd.Flags().GetString(signerFlagLabel)
if err != nil {
err = errors.Wrap(err, "failed to get flag signer")
return
}
password, err = cmd.Flags().GetString(passwordFlagLabel)
if err != nil {
err = errors.Wrap(err, "failed to get flag password")
return
}
nonce, err = cmd.Flags().GetUint64(nonceFlagLabel)
if err != nil {
err = errors.Wrap(err, "failed to get flag nonce")
return
}
gasLimit, err = cmd.Flags().GetUint64(gasLimitFlagLabel)
if err != nil {
err = errors.Wrap(err, "failed to get flag gas-limit")
return
}
assumeYes, err = cmd.Flags().GetBool(assumeYesFlagLabel)
if err != nil {
err = errors.Wrap(err, "failed to get flag assume-yes")
return
}
return
}
func handleClientRequestError(err error, apiName string) error {
if sta, ok := status.FromError(err); ok {
if sta.Code() == codes.Unavailable {
return ioctl.ErrInvalidEndpointOrInsecure
}
return errors.New(sta.Message())
}
return errors.Wrapf(err, "failed to invoke %s api", apiName)
}
// Signer returns signer's address
func Signer(client ioctl.Client, signer string) (string, error) {
if util.AliasIsHdwalletKey(signer) {
return signer, nil
}
return client.AddressWithDefaultIfNotExist(signer)
}
func checkNonce(client ioctl.Client, nonce uint64, executor string) (uint64, error) {
if util.AliasIsHdwalletKey(executor) {
// for hdwallet key, get the nonce in SendAction()
return 0, nil
}
if nonce != 0 {
return nonce, nil
}
accountMeta, err := account.Meta(client, executor)
if err != nil {
return 0, errors.Wrap(err, "failed to get account meta")
}
return accountMeta.PendingNonce, nil
}
// gasPriceInRau returns the suggest gas price
func gasPriceInRau(client ioctl.Client, gasPrice string) (*big.Int, error) {
if client.IsCryptoSm2() {
return big.NewInt(0), nil
}
if len(gasPrice) != 0 {
return util.StringToRau(gasPrice, util.GasPriceDecimalNum)
}
cli, err := client.APIServiceClient()
if err != nil {
return nil, errors.Wrap(err, "failed to connect to endpoint")
}
ctx := context.Background()
if jwtMD, err := util.JwtAuth(); err == nil {
ctx = metautils.NiceMD(jwtMD).ToOutgoing(ctx)
}
rsp, err := cli.SuggestGasPrice(ctx, &iotexapi.SuggestGasPriceRequest{})
if err != nil {
return nil, handleClientRequestError(err, "SuggestGasPrice")
}
return new(big.Int).SetUint64(rsp.GasPrice), nil
}
func fixGasLimit(client ioctl.Client, caller string, execution *action.Execution) (*action.Execution, error) {
cli, err := client.APIServiceClient()
if err != nil {
return nil, errors.Wrap(err, "failed to connect to endpoint")
}
ctx := context.Background()
if jwtMD, err := util.JwtAuth(); err == nil {
ctx = metautils.NiceMD(jwtMD).ToOutgoing(ctx)
}
res, err := cli.EstimateActionGasConsumption(ctx,
&iotexapi.EstimateActionGasConsumptionRequest{
Action: &iotexapi.EstimateActionGasConsumptionRequest_Execution{
Execution: execution.Proto(),
},
CallerAddress: caller,
})
if err != nil {
return nil, handleClientRequestError(err, "EstimateActionGasConsumption")
}
return action.NewExecution(execution.Contract(), execution.Nonce(), execution.Amount(), res.Gas, execution.GasPrice(), execution.Data())
}
// SendRaw sends raw action to blockchain
func SendRaw(client ioctl.Client, cmd *cobra.Command, selp *iotextypes.Action) error {
cli, err := client.APIServiceClient()
if err != nil {
return errors.Wrap(err, "failed to connect to endpoint")
}
ctx := context.Background()
if jwtMD, err := util.JwtAuth(); err == nil {
ctx = metautils.NiceMD(jwtMD).ToOutgoing(ctx)
}
_, err = cli.SendAction(ctx, &iotexapi.SendActionRequest{Action: selp})
if err != nil {
return handleClientRequestError(err, "SendAction")
}
shash := hash.Hash256b(byteutil.Must(proto.Marshal(selp)))
txhash := hex.EncodeToString(shash[:])
URL := "https://"
endpoint := client.Config().Endpoint
explorer := client.Config().Explorer
switch explorer {
case "iotexscan":
if strings.Contains(endpoint, "testnet") {
URL += "testnet."
}
URL += "iotexscan.io/action/" + txhash
case "iotxplorer":
URL = "iotxplorer.io/actions/" + txhash
default:
URL = explorer + txhash
}
cmd.Printf("Action has been sent to blockchain.\nWait for several seconds and query this action by hash: %s\n", URL)
return nil
}
// SendAction sends signed action to blockchain
func SendAction(client ioctl.Client,
cmd *cobra.Command,
elp action.Envelope,
signer, password string,
nonce uint64,
assumeYes bool,
) error {
sk, err := account.PrivateKeyFromSigner(client, cmd, signer, password)
if err != nil {
return errors.Wrap(err, "failed to get privateKey")
}
chainMeta, err := bc.GetChainMeta(client)
if err != nil {
return errors.Wrap(err, "failed to get chain meta")
}
elp.SetChainID(chainMeta.GetChainID())
if util.AliasIsHdwalletKey(signer) {
addr := sk.PublicKey().Address()
signer = addr.String()
nonce, err = checkNonce(client, nonce, signer)
if err != nil {
return errors.Wrap(err, "failed to get nonce")
}
elp.SetNonce(nonce)
}
sealed, err := action.Sign(elp, sk)
if err != nil {
return errors.Wrap(err, "failed to sign action")
}
if err := isBalanceEnough(client, signer, sealed); err != nil {
return errors.Wrap(err, "failed to pass balance check")
}
selp := sealed.Proto()
sk.Zero()
actionInfo, err := printActionProto(client, selp)
if err != nil {
return errors.Wrap(err, "failed to print action proto message")
}
cmd.Println(actionInfo)
if !assumeYes {
infoWarn := selectTranslation(client, _infoWarn)
infoQuit := selectTranslation(client, _infoQuit)
confirmed, err := client.AskToConfirm(infoWarn)
if err != nil {
return errors.Wrap(err, "failed to ask confirm")
}
if !confirmed {
cmd.Println(infoQuit)
return nil
}
}
return SendRaw(client, cmd, selp)
}
// Execute sends signed execution's transaction to blockchain
func Execute(client ioctl.Client,
cmd *cobra.Command,
contract string,
amount *big.Int,
bytecode []byte,
gasPrice, signer, password string,
nonce, gasLimit uint64,
assumeYes bool,
) error {
if len(contract) == 0 && len(bytecode) == 0 {
return errors.New("failed to deploy contract with empty bytecode")
}
gasPriceRau, err := gasPriceInRau(client, gasPrice)
if err != nil {
return errors.Wrap(err, "failed to get gas price")
}
sender, err := Signer(client, signer)
if err != nil {
return errors.Wrap(err, "failed to get signer address")
}
nonce, err = checkNonce(client, nonce, sender)
if err != nil {
return errors.Wrap(err, "failed to get nonce")
}
tx, err := action.NewExecution(contract, nonce, amount, gasLimit, gasPriceRau, bytecode)
if err != nil || tx == nil {
return errors.Wrap(err, "failed to make a Execution instance")
}
if gasLimit == 0 {
tx, err = fixGasLimit(client, sender, tx)
if err != nil || tx == nil {
return errors.Wrap(err, "failed to fix Execution gas limit")
}
gasLimit = tx.GasLimit()
}
return SendAction(
client,
cmd,
(&action.EnvelopeBuilder{}).
SetNonce(nonce).
SetGasPrice(gasPriceRau).
SetGasLimit(gasLimit).
SetAction(tx).Build(),
sender,
password,
nonce,
assumeYes,
)
}
// Read reads smart contract on IoTeX blockchain
func Read(client ioctl.Client,
contract address.Address,
amount string,
bytecode []byte,
signer string,
gasLimit uint64,
) (string, error) {
cli, err := client.APIServiceClient()
if err != nil {
return "", errors.Wrap(err, "failed to connect to endpoint")
}
ctx := context.Background()
if jwtMD, err := util.JwtAuth(); err == nil {
ctx = metautils.NiceMD(jwtMD).ToOutgoing(ctx)
}
callerAddr, err := Signer(client, signer)
if err != nil {
return "", errors.Wrap(err, "failed to get signer address")
}
if callerAddr == "" {
callerAddr = address.ZeroAddress
}
res, err := cli.ReadContract(ctx,
&iotexapi.ReadContractRequest{
Execution: &iotextypes.Execution{
Amount: amount,
Contract: contract.String(),
Data: bytecode,
},
CallerAddress: callerAddr,
GasLimit: gasLimit,
},
)
if err != nil {
return "", handleClientRequestError(err, "ReadContract")
}
return res.Data, nil
}
func isBalanceEnough(client ioctl.Client, address string, act *action.SealedEnvelope) error {
accountMeta, err := account.Meta(client, address)
if err != nil {
return errors.Wrap(err, "failed to get account meta")
}
balance, ok := new(big.Int).SetString(accountMeta.Balance, 10)
if !ok {
return errors.New("failed to convert balance into big int")
}
cost, err := act.Cost()
if err != nil {
return errors.Wrap(err, "failed to check cost of an action")
}
if balance.Cmp(cost) < 0 {
return errors.New("balance is not enough")
}
return nil
}