forked from cosmos/interchain-security
-
Notifications
You must be signed in to change notification settings - Fork 0
/
actions.go
2331 lines (2012 loc) · 68.3 KB
/
actions.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
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package main
import (
"bufio"
"encoding/json"
"fmt"
"log"
"math"
"os"
"os/exec"
"regexp"
"sort"
"strconv"
"strings"
"sync"
"time"
clienttypes "github.com/cosmos/ibc-go/v7/modules/core/02-client/types"
"github.com/tidwall/gjson"
"golang.org/x/mod/semver"
"github.com/cosmos/interchain-security/v4/x/ccv/provider/client"
"github.com/cosmos/interchain-security/v4/x/ccv/provider/types"
ccvtypes "github.com/cosmos/interchain-security/v4/x/ccv/types"
)
type SendTokensAction struct {
Chain ChainID
From ValidatorID
To ValidatorID
Amount uint
}
const done = "done!!!!!!!!"
func (tr TestConfig) sendTokens(
action SendTokensAction,
target ExecutionTarget,
verbose bool,
) {
fromValCfg := tr.validatorConfigs[action.From]
toValCfg := tr.validatorConfigs[action.To]
fromAddress := fromValCfg.DelAddress
toAddress := toValCfg.DelAddress
if action.Chain != ChainID("provi") {
// use binary with Bech32Prefix set to ConsumerAccountPrefix
if fromValCfg.UseConsumerKey {
fromAddress = fromValCfg.ConsumerDelAddress
} else {
// use the same address as on the provider but with different prefix
fromAddress = fromValCfg.DelAddressOnConsumer
}
if toValCfg.UseConsumerKey {
toAddress = toValCfg.ConsumerDelAddress
} else {
// use the same address as on the provider but with different prefix
toAddress = toValCfg.DelAddressOnConsumer
}
}
binaryName := tr.chainConfigs[action.Chain].BinaryName
cmd := target.ExecCommand(binaryName,
"tx", "bank", "send",
fromAddress,
toAddress,
fmt.Sprint(action.Amount)+`stake`,
`--chain-id`, string(tr.chainConfigs[action.Chain].ChainId),
`--home`, tr.getValidatorHome(action.Chain, action.From),
`--node`, tr.getValidatorNode(action.Chain, action.From),
`--keyring-backend`, `test`,
`-y`,
)
if verbose {
fmt.Println("sendTokens cmd:", cmd.String())
}
bz, err := cmd.CombinedOutput()
if err != nil {
log.Fatal(err, "\n", string(bz))
}
// wait for inclusion in a block -> '--broadcast-mode block' is deprecated
tr.waitBlocks(action.Chain, 2, 30*time.Second)
}
type StartChainAction struct {
Chain ChainID
Validators []StartChainValidator
// Genesis changes specific to this action, appended to genesis changes defined in chain config
GenesisChanges string
IsConsumer bool
}
type StartChainValidator struct {
Id ValidatorID
Allocation uint
Stake uint
}
func (tr *TestConfig) startChain(
action StartChainAction,
target ExecutionTarget,
verbose bool,
) {
chainConfig := tr.chainConfigs[action.Chain]
type jsonValAttrs struct {
Mnemonic string `json:"mnemonic"`
Allocation string `json:"allocation"`
Stake string `json:"stake"`
ValId string `json:"val_id"`
PrivValidatorKey string `json:"priv_validator_key"`
NodeKey string `json:"node_key"`
IpSuffix string `json:"ip_suffix"`
ConsumerMnemonic string `json:"consumer_mnemonic"`
ConsumerPrivValidatorKey string `json:"consumer_priv_validator_key"`
StartWithConsumerKey bool `json:"start_with_consumer_key"`
}
var validators []jsonValAttrs
for _, val := range action.Validators {
validators = append(validators, jsonValAttrs{
Mnemonic: tr.validatorConfigs[val.Id].Mnemonic,
NodeKey: tr.validatorConfigs[val.Id].NodeKey,
ValId: fmt.Sprint(val.Id),
PrivValidatorKey: tr.validatorConfigs[val.Id].PrivValidatorKey,
Allocation: fmt.Sprint(val.Allocation) + "stake",
Stake: fmt.Sprint(val.Stake) + "stake",
IpSuffix: tr.validatorConfigs[val.Id].IpSuffix,
ConsumerMnemonic: tr.validatorConfigs[val.Id].ConsumerMnemonic,
ConsumerPrivValidatorKey: tr.validatorConfigs[val.Id].ConsumerPrivValidatorKey,
// if true node will be started with consumer key for each consumer chain
StartWithConsumerKey: tr.validatorConfigs[val.Id].UseConsumerKey,
})
}
vals, err := json.Marshal(validators)
if err != nil {
log.Fatal(err)
}
// Concat genesis changes defined in chain config, with any custom genesis changes for this chain instantiation
var genesisChanges string
if action.GenesisChanges != "" {
genesisChanges = chainConfig.GenesisChanges + " | " + action.GenesisChanges
} else {
genesisChanges = chainConfig.GenesisChanges
}
var cometmockArg string
if tr.useCometmock {
cometmockArg = "true"
} else {
cometmockArg = "false"
}
startChainScript := target.GetTestScriptPath(action.IsConsumer, "start-chain.sh")
cmd := target.ExecCommand("/bin/bash",
startChainScript, chainConfig.BinaryName, string(vals),
string(chainConfig.ChainId), chainConfig.IpPrefix, genesisChanges,
fmt.Sprint(action.IsConsumer),
// override config/config.toml for each node on chain
// usually timeout_commit and peer_gossip_sleep_duration are changed to vary the test run duration
// lower timeout_commit means the blocks are produced faster making the test run shorter
// with short timeout_commit (eg. timeout_commit = 1s) some nodes may miss blocks causing the test run to fail
tr.tendermintConfigOverride,
cometmockArg,
)
cmdReader, err := cmd.StdoutPipe()
if err != nil {
log.Fatal(err)
}
cmd.Stderr = cmd.Stdout
if err := cmd.Start(); err != nil {
log.Fatal(err)
}
scanner := bufio.NewScanner(cmdReader)
for scanner.Scan() {
out := scanner.Text()
if verbose {
fmt.Println("startChain: " + out)
}
if out == done {
break
}
}
if err := scanner.Err(); err != nil {
log.Fatal(err)
}
tr.addChainToRelayer(AddChainToRelayerAction{
Chain: action.Chain,
Validator: action.Validators[0].Id,
IsConsumer: action.IsConsumer,
}, target, verbose)
// store the fact that we started the chain
tr.runningChains[action.Chain] = true
fmt.Println("Started chain", action.Chain)
if tr.timeOffset != 0 {
// advance time for this chain so that it is in sync with the rest of the network
tr.AdvanceTimeForChain(action.Chain, tr.timeOffset)
}
}
type SubmitTextProposalAction struct {
Chain ChainID
From ValidatorID
Deposit uint
Title string
Description string
}
func (tr TestConfig) submitTextProposal(
action SubmitTextProposalAction,
target ExecutionTarget,
verbose bool,
) {
// TEXT PROPOSAL
bz, err := target.ExecCommand(
tr.chainConfigs[action.Chain].BinaryName,
"tx", "gov", "submit-legacy-proposal",
`--title`, action.Title,
`--description`, action.Description,
`--deposit`, fmt.Sprint(action.Deposit)+`stake`,
`--from`, `validator`+fmt.Sprint(action.From),
`--chain-id`, string(tr.chainConfigs[action.Chain].ChainId),
`--home`, tr.getValidatorHome(action.Chain, action.From),
`--node`, tr.getValidatorNode(action.Chain, action.From),
`--keyring-backend`, `test`,
`-y`,
).CombinedOutput()
if err != nil {
log.Fatal(err, "\n", string(bz))
}
// wait for inclusion in a block -> '--broadcast-mode block' is deprecated
tr.waitBlocks(action.Chain, 1, 10*time.Second)
}
type SubmitConsumerAdditionProposalAction struct {
PreCCV bool
Chain ChainID
From ValidatorID
Deposit uint
ConsumerChain ChainID
SpawnTime uint
InitialHeight clienttypes.Height
DistributionChannel string
}
func (tr TestConfig) submitConsumerAdditionProposal(
action SubmitConsumerAdditionProposalAction,
target ExecutionTarget,
verbose bool,
) {
spawnTime := tr.containerConfig.Now.Add(time.Duration(action.SpawnTime) * time.Millisecond)
params := ccvtypes.DefaultParams()
prop := client.ConsumerAdditionProposalJSON{
Title: "Propose the addition of a new chain",
Summary: "Gonna be a great chain",
ChainId: string(tr.chainConfigs[action.ConsumerChain].ChainId),
InitialHeight: action.InitialHeight,
GenesisHash: []byte("gen_hash"),
BinaryHash: []byte("bin_hash"),
SpawnTime: spawnTime,
ConsumerRedistributionFraction: params.ConsumerRedistributionFraction,
BlocksPerDistributionTransmission: params.BlocksPerDistributionTransmission,
HistoricalEntries: params.HistoricalEntries,
CcvTimeoutPeriod: params.CcvTimeoutPeriod,
TransferTimeoutPeriod: params.TransferTimeoutPeriod,
UnbondingPeriod: params.UnbondingPeriod,
Deposit: fmt.Sprint(action.Deposit) + `stake`,
DistributionTransmissionChannel: action.DistributionChannel,
}
bz, err := json.Marshal(prop)
if err != nil {
log.Fatal(err)
}
jsonStr := string(bz)
if strings.Contains(jsonStr, "'") {
log.Fatal("prop json contains single quote")
}
//#nosec G204 -- bypass unsafe quoting warning (no production code)
bz, err = target.ExecCommand(
"/bin/bash", "-c", fmt.Sprintf(`echo '%s' > %s`, jsonStr, "/temp-proposal.json"),
).CombinedOutput()
if err != nil {
log.Fatal(err, "\n", string(bz))
}
// CONSUMER ADDITION PROPOSAL
bz, err = target.ExecCommand(
tr.chainConfigs[action.Chain].BinaryName,
"tx", "gov", "submit-legacy-proposal", "consumer-addition", "/temp-proposal.json",
`--from`, `validator`+fmt.Sprint(action.From),
`--chain-id`, string(tr.chainConfigs[action.Chain].ChainId),
`--home`, tr.getValidatorHome(action.Chain, action.From),
`--gas`, `900000`,
`--node`, tr.getValidatorNode(action.Chain, action.From),
`--keyring-backend`, `test`,
`-y`,
).CombinedOutput()
if err != nil {
log.Fatal(err, "\n", string(bz))
}
// wait for inclusion in a block -> '--broadcast-mode block' is deprecated
tr.waitBlocks(ChainID("provi"), 2, 10*time.Second)
}
type SubmitConsumerRemovalProposalAction struct {
Chain ChainID
From ValidatorID
Deposit uint
ConsumerChain ChainID
StopTimeOffset time.Duration // offset from time.Now()
}
func (tr TestConfig) submitConsumerRemovalProposal(
action SubmitConsumerRemovalProposalAction,
target ExecutionTarget,
verbose bool,
) {
stopTime := tr.containerConfig.Now.Add(action.StopTimeOffset)
prop := client.ConsumerRemovalProposalJSON{
Title: fmt.Sprintf("Stop the %v chain", action.ConsumerChain),
Summary: "It was a great chain",
ChainId: string(tr.chainConfigs[action.ConsumerChain].ChainId),
StopTime: stopTime,
Deposit: fmt.Sprint(action.Deposit) + `stake`,
}
bz, err := json.Marshal(prop)
if err != nil {
log.Fatal(err)
}
jsonStr := string(bz)
if strings.Contains(jsonStr, "'") {
log.Fatal("prop json contains single quote")
}
bz, err = target.ExecCommand(
"/bin/bash", "-c", fmt.Sprintf(`echo '%s' > %s`, jsonStr, "/temp-proposal.json")).CombinedOutput()
if err != nil {
log.Fatal(err, "\n", string(bz))
}
bz, err = target.ExecCommand(
tr.chainConfigs[action.Chain].BinaryName,
"tx", "gov", "submit-legacy-proposal", "consumer-removal",
"/temp-proposal.json",
`--from`, `validator`+fmt.Sprint(action.From),
`--chain-id`, string(tr.chainConfigs[action.Chain].ChainId),
`--home`, tr.getValidatorHome(action.Chain, action.From),
`--node`, tr.getValidatorNode(action.Chain, action.From),
`--gas`, "900000",
`--keyring-backend`, `test`,
`-y`,
).CombinedOutput()
if err != nil {
log.Fatal(err, "\n", string(bz))
}
// wait for inclusion in a block -> '--broadcast-mode block' is deprecated
tr.waitBlocks(ChainID("provi"), 2, 20*time.Second)
}
type SubmitParamChangeLegacyProposalAction struct {
Chain ChainID
From ValidatorID
Deposit uint
Subspace string
Key string
Value interface{}
}
type paramChangeProposalJSON struct {
Title string `json:"title"`
Summary string `json:"summary"`
Description string `json:"description"`
Changes []paramChangeJSON `json:"changes"`
Deposit string `json:"deposit"`
}
type paramChangeJSON struct {
Subspace string `json:"subspace"`
Key string `json:"key"`
Value interface{} `json:"value"`
}
func (tr TestConfig) submitParamChangeProposal(
action SubmitParamChangeLegacyProposalAction,
target ExecutionTarget,
verbose bool,
) {
prop := paramChangeProposalJSON{
Title: "Legacy Param change",
Summary: "Changing legacy module params",
Description: "Changing legacy module params",
Changes: []paramChangeJSON{{Subspace: action.Subspace, Key: action.Key, Value: action.Value}},
Deposit: fmt.Sprint(action.Deposit) + `stake`,
}
bz, err := json.Marshal(prop)
if err != nil {
log.Fatal(err)
}
jsonStr := string(bz)
if strings.Contains(jsonStr, "'") {
log.Fatal("prop json contains single quote")
}
//#nosec G204 -- bypass unsafe quoting warning (no production code)
bz, err = target.ExecCommand(
"/bin/bash", "-c", fmt.Sprintf(`echo '%s' > %s`, jsonStr, "/params-proposal.json"),
).CombinedOutput()
if err != nil {
log.Fatal(err, "\n", string(bz))
}
cmd := target.ExecCommand(
tr.chainConfigs[action.Chain].BinaryName,
"tx", "gov", "submit-legacy-proposal", "param-change", "/params-proposal.json",
`--from`, `validator`+fmt.Sprint(action.From),
`--chain-id`, string(tr.chainConfigs[action.Chain].ChainId),
`--home`, tr.getValidatorHome(action.Chain, action.From),
`--node`, tr.getValidatorNode(action.Chain, action.From),
`--gas`, "900000",
`--keyring-backend`, `test`,
`-y`,
)
bz, err = cmd.CombinedOutput()
if err != nil {
log.Fatal(err, "\n", string(bz))
}
// wait for inclusion in a block -> '--broadcast-mode block' is deprecated
tr.waitBlocks(action.Chain, 2, 60*time.Second)
}
type VoteGovProposalAction struct {
Chain ChainID
From []ValidatorID
Vote []string
PropNumber uint
}
func (tr *TestConfig) voteGovProposal(
action VoteGovProposalAction,
target ExecutionTarget,
verbose bool,
) {
var wg sync.WaitGroup
for i, val := range action.From {
wg.Add(1)
vote := action.Vote[i]
go func(val ValidatorID, vote string) {
defer wg.Done()
bz, err := target.ExecCommand(
tr.chainConfigs[action.Chain].BinaryName,
"tx", "gov", "vote",
fmt.Sprint(action.PropNumber), vote,
`--from`, `validator`+fmt.Sprint(val),
`--chain-id`, string(tr.chainConfigs[action.Chain].ChainId),
`--home`, tr.getValidatorHome(action.Chain, val),
`--node`, tr.getValidatorNode(action.Chain, val),
`--keyring-backend`, `test`,
`--gas`, "900000",
`-y`,
).CombinedOutput()
if err != nil {
log.Fatal(err, "\n", string(bz))
}
}(val, vote)
}
wg.Wait()
// wait for inclusion in a block -> '--broadcast-mode block' is deprecated
tr.waitBlocks(action.Chain, 1, 10*time.Second)
tr.WaitTime(time.Duration(tr.chainConfigs[action.Chain].VotingWaitTime) * time.Second)
}
type StartConsumerChainAction struct {
ConsumerChain ChainID
ProviderChain ChainID
Validators []StartChainValidator
GenesisChanges string
}
func (tr *TestConfig) startConsumerChain(
action StartConsumerChainAction,
target ExecutionTarget,
verbose bool,
) {
fmt.Println("Starting consumer chain ", action.ConsumerChain)
consumerGenesis := ".app_state.ccvconsumer = " + tr.getConsumerGenesis(action.ProviderChain, action.ConsumerChain, target)
consumerGenesisChanges := tr.chainConfigs[action.ConsumerChain].GenesisChanges
if consumerGenesisChanges != "" {
consumerGenesis = consumerGenesis + " | " + consumerGenesisChanges + " | " + action.GenesisChanges
}
tr.startChain(StartChainAction{
Chain: action.ConsumerChain,
Validators: action.Validators,
GenesisChanges: consumerGenesis,
IsConsumer: true,
}, target, verbose)
}
// Get consumer genesis from provider
func (tr *TestConfig) getConsumerGenesis(providerChain, consumerChain ChainID, target ExecutionTarget) string {
fmt.Println("Exporting consumer genesis from provider")
providerBinaryName := tr.chainConfigs[providerChain].BinaryName
cmd := target.ExecCommand(
providerBinaryName,
"query", "provider", "consumer-genesis",
string(tr.chainConfigs[consumerChain].ChainId),
`--node`, tr.getQueryNode(providerChain),
`-o`, `json`,
)
bz, err := cmd.CombinedOutput()
if err != nil {
log.Fatal(err, "\n", string(bz))
}
if tr.transformGenesis || needsGenesisTransform(target.GetTargetConfig()) {
return string(tr.transformConsumerGenesis(consumerChain, bz, target))
} else {
fmt.Println("No genesis transformation performed")
}
return string(bz)
}
// needsGenesisTransform tries to identify if a genesis transformation should be performed
func needsGenesisTransform(cfg TargetConfig) bool {
// no genesis transformation needed for same versions
if cfg.consumerVersion == cfg.providerVersion {
return false
}
// use v4.0.0 (after genesis transform breakages) for the checks if 'latest' is used
consumerVersion := cfg.consumerVersion
if cfg.consumerVersion == "latest" {
consumerVersion = "v4.0.0"
}
providerVersion := cfg.providerVersion
if cfg.providerVersion == "latest" {
providerVersion = "v4.0.0"
}
if !semver.IsValid(consumerVersion) || !semver.IsValid(providerVersion) {
fmt.Printf("unable to identify the need for genesis transformation: invalid sem-version: consumer='%s', provider='%s'",
consumerVersion, providerVersion)
return false
}
breakages := []string{"v3.0.0", "v3.3.0", "v4.0.0"}
for _, breakage := range breakages {
if (semver.Compare(consumerVersion, breakage) < 0 && semver.Compare(providerVersion, breakage) >= 0) ||
(semver.Compare(providerVersion, breakage) < 0 && semver.Compare(consumerVersion, breakage) >= 0) {
fmt.Println("genesis transformation needed for versions:", providerVersion, consumerVersion)
return true
}
}
fmt.Println("NO genesis transformation needed for versions:", providerVersion, consumerVersion)
return false
}
// getTransformParameter identifies the needed transformation parameter for current `transformGenesis` implementation
// based on consumer and provider versions.
func getTransformParameter(consumerVersion string) (string, error) {
switch consumerVersion {
case "":
// For "" (default: local workspace) use HEAD as reference point
consumerVersion = "HEAD"
case "latest":
// For 'latest' originated from latest-image use "origin/main" as ref point
consumerVersion = "origin/main"
}
// Hash of breakage due to preHashKey release in version 2.x
// ics23/go v.0.10.0 adding 'prehash_key_before_comparison' in ProofSpec
breakage_prehash := "d4dde74b062c2fded0d3b3dbef4b3b0229e317f3" // first released in v3.2.0-consumer
// breakage 2: split of genesis
breakage_splitgenesisMain := "946f6ec626d3de3fe2e00cbb386ccf9c2f05d94d"
breakage_splitgenesisV33x := "1d2641a3b2ba706ae0a307d9019b48c62d86133b"
// breakage 3: split of genesis + delay_period
breakage_retry_delay := "88499b7c650ea0fb2c448af2b182ad5fee94d795"
// mapping of the accepted parameter values of the `genesis transform` command
// to the related git refs introducing a breakage
transformParams := map[string][]string{
"v2.x": {breakage_prehash},
"v3.3.x": {breakage_splitgenesisMain, breakage_splitgenesisV33x},
"v4.x": {breakage_retry_delay},
}
// set default consumer target version to "v4.x"
// and iterate in order of breakage history [oldest first] to identify
// the "--to" target for consumer version used
targetVersion := "v4.x"
keys := make([]string, 0, len(transformParams))
for k := range transformParams {
keys = append(keys, k)
}
sort.Slice(keys, func(k, l int) bool { return keys[k] < keys[l] })
for _, version := range keys {
for _, breakageHash := range transformParams[version] {
// Check if the 'breakage' is an ancestor of the 'consumerVersion'
//#nosec G204 -- Bypass linter warning for spawning subprocess with cmd arguments
cmd := exec.Command("git", "merge-base", "--is-ancestor", breakageHash, consumerVersion)
fmt.Println("running ", cmd)
out, err := cmd.CombinedOutput()
if err == nil {
// breakage is already part of the consumer version -> goto next breakage
fmt.Println(" consumer >= breakage ", transformParams[version], " ... going to next one")
targetVersion = version
break
}
if rc, ok := err.(*exec.ExitError); ok {
if rc.ExitCode() != 1 {
return "", fmt.Errorf("error identifying transform parameter '%v': %s", err, string(out))
}
// not an ancestor -- ignore this breakage
fmt.Println("breakage :", transformParams[version], " is not an ancestor of version ", version)
continue
}
return "", fmt.Errorf("unexpected error when running '%v': %v", cmd, err) // unable to get return code
}
}
// consumer > latest known breakage (use default target version 'v4.x')
return fmt.Sprintf("--to=%s", targetVersion), nil
}
// Transform consumer genesis content from older version
func (tr *TestConfig) transformConsumerGenesis(consumerChain ChainID, genesis []byte, target ExecutionTarget) []byte {
fmt.Println("Transforming consumer genesis")
fileName := "consumer_genesis.json"
file, err := os.CreateTemp("", fileName)
if err != nil {
panic(fmt.Sprintf("failed writing ccv consumer file : %v", err))
}
defer file.Close()
err = os.WriteFile(file.Name(), genesis, 0600)
if err != nil {
log.Fatalf("Failed writing consumer genesis to file: %v", err)
}
containerInstance := tr.containerConfig.InstanceName
targetFile := fmt.Sprintf("/tmp/%s", fileName)
sourceFile := file.Name()
//#nosec G204 -- Bypass linter warning for spawning subprocess with cmd arguments.
cmd := exec.Command("docker", "cp", sourceFile,
fmt.Sprintf("%s:%s", containerInstance, targetFile))
genesis, err = cmd.CombinedOutput()
if err != nil {
log.Fatal(err, "\n", string(genesis))
}
// check if genesis transform supports --to target
bz, err := target.ExecCommand(
"interchain-security-transformer",
"genesis", "transform", "--to").CombinedOutput()
if err != nil && !strings.Contains(string(bz), "unknown flag: --to") {
cfg := target.GetTargetConfig()
targetVersion, err := getTransformParameter(cfg.consumerVersion)
if err != nil {
log.Fatal("Failed getting genesis transformation parameter: ", err)
}
cmd = target.ExecCommand(
"interchain-security-transformer",
"genesis", "transform", targetVersion, targetFile)
} else {
cmd = target.ExecCommand(
"interchain-security-transformer",
"genesis", "transform", targetFile)
}
result, err := cmd.CombinedOutput()
if err != nil {
log.Fatal(err, "CCV consumer genesis transformation failed: %s", string(result))
}
return result
}
type ChangeoverChainAction struct {
SovereignChain ChainID
ProviderChain ChainID
Validators []StartChainValidator
GenesisChanges string
}
func (tr TestConfig) changeoverChain(
action ChangeoverChainAction,
target ExecutionTarget,
verbose bool,
) {
// sleep until the consumer chain genesis is ready on consumer
time.Sleep(5 * time.Second)
cmd := target.ExecCommand(
tr.chainConfigs[action.ProviderChain].BinaryName,
"query", "provider", "consumer-genesis",
string(tr.chainConfigs[action.SovereignChain].ChainId),
`--node`, tr.getQueryNode(action.ProviderChain),
`-o`, `json`,
)
if verbose {
log.Println("changeoverChain cmd: ", cmd.String())
}
bz, err := cmd.CombinedOutput()
if err != nil {
log.Fatal(err, "\n", string(bz))
}
consumerGenesis := ".app_state.ccvconsumer = " + string(bz)
consumerGenesisChanges := tr.chainConfigs[action.SovereignChain].GenesisChanges
if consumerGenesisChanges != "" {
consumerGenesis = consumerGenesis + " | " + consumerGenesisChanges + " | " + action.GenesisChanges
}
tr.startChangeover(ChangeoverChainAction{
Validators: action.Validators,
GenesisChanges: consumerGenesis,
}, target, verbose)
}
func (tr TestConfig) startChangeover(
action ChangeoverChainAction,
target ExecutionTarget,
verbose bool,
) {
chainConfig := tr.chainConfigs[ChainID("sover")]
type jsonValAttrs struct {
Mnemonic string `json:"mnemonic"`
Allocation string `json:"allocation"`
Stake string `json:"stake"`
ValId string `json:"val_id"`
PrivValidatorKey string `json:"priv_validator_key"`
NodeKey string `json:"node_key"`
IpSuffix string `json:"ip_suffix"`
ConsumerMnemonic string `json:"consumer_mnemonic"`
ConsumerPrivValidatorKey string `json:"consumer_priv_validator_key"`
StartWithConsumerKey bool `json:"start_with_consumer_key"`
}
var validators []jsonValAttrs
for _, val := range action.Validators {
validators = append(validators, jsonValAttrs{
Mnemonic: tr.validatorConfigs[val.Id].Mnemonic,
NodeKey: tr.validatorConfigs[val.Id].NodeKey,
ValId: fmt.Sprint(val.Id),
PrivValidatorKey: tr.validatorConfigs[val.Id].PrivValidatorKey,
Allocation: fmt.Sprint(val.Allocation) + "stake",
Stake: fmt.Sprint(val.Stake) + "stake",
IpSuffix: tr.validatorConfigs[val.Id].IpSuffix,
ConsumerMnemonic: tr.validatorConfigs[val.Id].ConsumerMnemonic,
ConsumerPrivValidatorKey: tr.validatorConfigs[val.Id].ConsumerPrivValidatorKey,
// if true node will be started with consumer key for each consumer chain
StartWithConsumerKey: tr.validatorConfigs[val.Id].UseConsumerKey,
})
}
vals, err := json.Marshal(validators)
if err != nil {
log.Fatal(err)
}
// Concat genesis changes defined in chain config, with any custom genesis changes for this chain instantiation
var genesisChanges string
if action.GenesisChanges != "" {
genesisChanges = chainConfig.GenesisChanges + " | " + action.GenesisChanges
} else {
genesisChanges = chainConfig.GenesisChanges
}
isConsumer := true
changeoverScript := target.GetTestScriptPath(isConsumer, "start-changeover.sh")
cmd := target.ExecCommand(
"/bin/bash",
changeoverScript, chainConfig.UpgradeBinary, string(vals),
"sover", chainConfig.IpPrefix, genesisChanges,
tr.tendermintConfigOverride,
)
cmdReader, err := cmd.StdoutPipe()
if err != nil {
log.Fatal(err)
}
cmd.Stderr = cmd.Stdout
if err := cmd.Start(); err != nil {
log.Fatal(err)
}
scanner := bufio.NewScanner(cmdReader)
for scanner.Scan() {
out := scanner.Text()
if verbose {
fmt.Println("startChangeover: " + out)
}
if out == done {
break
}
}
if err := scanner.Err(); err != nil {
log.Fatal("startChangeover died", err)
}
}
type AddChainToRelayerAction struct {
Chain ChainID
Validator ValidatorID
IsConsumer bool
}
const hermesChainConfigTemplate = `
[[chains]]
account_prefix = "%s"
clock_drift = "5s"
gas_multiplier = 1.1
grpc_addr = "%s"
id = "%s"
key_name = "%s"
max_gas = 20000000
rpc_addr = "%s"
rpc_timeout = "10s"
store_prefix = "ibc"
trusting_period = "14days"
event_source = { mode = "push", url = "%s", batch_delay = "50ms" }
ccv_consumer_chain = %v
[chains.gas_price]
denom = "stake"
price = 0.000
[chains.trust_threshold]
denominator = "3"
numerator = "1"
`
// Set up the config for a new chain for gorelayer.
// This config is added to the container as a file.
// We then add the chain to the relayer, using this config as the chain config with `rly chains add --file`
// This is functionally similar to the config used by Hermes for chains, e.g. gas is free.
const gorelayerChainConfigTemplate = `
{
"type": "cosmos",
"value": {
"key": "default",
"chain-id": "%s",
"rpc-addr": "%s",
"account-prefix": "%s",
"keyring-backend": "test",
"gas-adjustment": 1.2,
"gas-prices": "0.00stake",
"debug": true,
"timeout": "20s",
"output-format": "json",
"sign-mode": "direct"
}
}`
func (tr TestConfig) addChainToRelayer(
action AddChainToRelayerAction,
target ExecutionTarget,
verbose bool,
) {
if !tr.useGorelayer {
tr.addChainToHermes(action, target, verbose)
} else {
tr.addChainToGorelayer(action, target, verbose)
}
}
func (tr TestConfig) addChainToGorelayer(
action AddChainToRelayerAction,
target ExecutionTarget,
verbose bool,
) {
queryNodeIP := tr.getQueryNodeIP(action.Chain)
ChainId := tr.chainConfigs[action.Chain].ChainId
rpcAddr := "http://" + queryNodeIP + ":26658"
chainConfig := fmt.Sprintf(gorelayerChainConfigTemplate,
ChainId,
rpcAddr,
tr.chainConfigs[action.Chain].AccountPrefix,
)
bz, err := target.ExecCommand(
"rly", "config", "init").CombinedOutput()
if err != nil && !strings.Contains(string(bz), "config already exists") {
log.Fatal(err, "\n", string(bz))
}
chainConfigFileName := fmt.Sprintf("/root/%s_config.json", ChainId)
bashCommand := fmt.Sprintf(`echo '%s' >> %s`, chainConfig, chainConfigFileName)
bz, err = target.ExecCommand("bash", "-c",
bashCommand).CombinedOutput()
if err != nil {
log.Fatal(err, "\n", string(bz))
}
addChainCommand := target.ExecCommand("rly", "chains", "add", "--file", chainConfigFileName, string(ChainId))
executeCommand(addChainCommand, "add chain")
keyRestoreCommand := target.ExecCommand("rly", "keys", "restore", string(ChainId), "default", tr.validatorConfigs[action.Validator].Mnemonic)
executeCommand(keyRestoreCommand, "restore keys")
}
func (tr TestConfig) addChainToHermes(
action AddChainToRelayerAction,
target ExecutionTarget,
verbose bool,
) {
bz, err := target.ExecCommand("bash", "-c", "hermes", "version").CombinedOutput()
if err != nil {
log.Fatal(err, "\n error getting hermes version", string(bz))
}
re, err := regexp.Compile(`hermes\s+(\d+.\d+.\d+)`)
if err != nil {
log.Fatal(err, "error identifying hermes version")
}
match := re.FindStringSubmatch(string(bz))
if match == nil {
log.Fatalln("error identifying hermes version from", string(bz))
}
hermesVersion := match[1]
queryNodeIP := tr.getQueryNodeIP(action.Chain)
hermesConfig := GetHermesConfig(hermesVersion, queryNodeIP, tr.chainConfigs[action.Chain], action.IsConsumer)
bashCommand := fmt.Sprintf(`echo '%s' >> %s`, hermesConfig, "/root/.hermes/config.toml")
bz, err = target.ExecCommand("bash", "-c", bashCommand).CombinedOutput()
if err != nil {
log.Fatal(err, "\n", string(bz))
}
// Save mnemonic to file within container
var mnemonic string
if tr.validatorConfigs[action.Validator].UseConsumerKey && action.IsConsumer {
mnemonic = tr.validatorConfigs[action.Validator].ConsumerMnemonic
} else {
mnemonic = tr.validatorConfigs[action.Validator].Mnemonic
}
saveMnemonicCommand := fmt.Sprintf(`echo '%s' > %s`, mnemonic, "/root/.hermes/mnemonic.txt")
fmt.Println("Add to hermes", action.Validator)
bz, err = target.ExecCommand("bash", "-c", saveMnemonicCommand).CombinedOutput()
if err != nil {
log.Fatal(err, "\n", string(bz))
}
bz, err = target.ExecCommand("hermes",
"keys", "add",
"--chain", string(tr.chainConfigs[action.Chain].ChainId),
"--mnemonic-file", "/root/.hermes/mnemonic.txt",