-
Notifications
You must be signed in to change notification settings - Fork 55
/
create.go
406 lines (369 loc) · 12.5 KB
/
create.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
// Copyright (C) 2022, Ava Labs, Inc. All rights reserved.
// See the file LICENSE for licensing terms.
package subnetcmd
import (
"encoding/json"
"errors"
"fmt"
"sort"
"strconv"
"strings"
"unicode"
"github.com/ava-labs/avalanche-cli/cmd/flags"
"github.com/ava-labs/avalanche-cli/pkg/cobrautils"
"github.com/ava-labs/avalanche-cli/pkg/constants"
"github.com/ava-labs/avalanche-cli/pkg/metrics"
"github.com/ava-labs/avalanche-cli/pkg/models"
"github.com/ava-labs/avalanche-cli/pkg/prompts"
"github.com/ava-labs/avalanche-cli/pkg/teleporter"
"github.com/ava-labs/avalanche-cli/pkg/utils"
"github.com/ava-labs/avalanche-cli/pkg/ux"
"github.com/ava-labs/avalanche-cli/pkg/vm"
"github.com/spf13/cobra"
"golang.org/x/mod/semver"
)
const (
forceFlag = "force"
latest = "latest"
preRelease = "pre-release"
)
var (
forceCreate bool
useSubnetEvm bool
genesisFile string
vmFile string
useCustom bool
evmVersion string
evmChainID uint64
evmToken string
evmDefaults bool
useLatestReleasedEvmVersion bool
useLatestPreReleasedEvmVersion bool
useRepo bool
teleporterReady bool
runRelayer bool
useWarp bool
errIllegalNameCharacter = errors.New(
"illegal name character: only letters, no special characters allowed")
errMutuallyExlusiveVersionOptions = errors.New("version flags --latest,--pre-release,vm-version are mutually exclusive")
errMutuallyVMConfigOptions = errors.New("specifying --genesis flag disables SubnetEVM config flags --evm-chain-id,--evm-token,--evm-defaults")
)
// avalanche subnet create
func newCreateCmd() *cobra.Command {
cmd := &cobra.Command{
Use: "create [subnetName]",
Short: "Create a new subnet configuration",
Long: `The subnet create command builds a new genesis file to configure your Subnet.
By default, the command runs an interactive wizard. It walks you through
all the steps you need to create your first Subnet.
The tool supports deploying Subnet-EVM, and custom VMs. You
can create a custom, user-generated genesis with a custom VM by providing
the path to your genesis and VM binaries with the --genesis and --vm flags.
By default, running the command with a subnetName that already exists
causes the command to fail. If you’d like to overwrite an existing
configuration, pass the -f flag.`,
Args: cobrautils.ExactArgs(1),
RunE: createSubnetConfig,
PersistentPostRun: handlePostRun,
}
cmd.Flags().StringVar(&genesisFile, "genesis", "", "file path of genesis to use")
cmd.Flags().BoolVar(&useSubnetEvm, "evm", false, "use the Subnet-EVM as the base template")
cmd.Flags().StringVar(&evmVersion, "vm-version", "", "version of Subnet-EVM template to use")
cmd.Flags().Uint64Var(&evmChainID, "evm-chain-id", 0, "chain ID to use with Subnet-EVM")
cmd.Flags().StringVar(&evmToken, "evm-token", "", "token name to use with Subnet-EVM")
cmd.Flags().BoolVar(&evmDefaults, "evm-defaults", false, "use default settings for fees/airdrop/precompiles/teleporter with Subnet-EVM")
cmd.Flags().BoolVar(&useCustom, "custom", false, "use a custom VM template")
cmd.Flags().BoolVar(&useLatestPreReleasedEvmVersion, preRelease, false, "use latest Subnet-EVM pre-released version, takes precedence over --vm-version")
cmd.Flags().BoolVar(&useLatestReleasedEvmVersion, latest, false, "use latest Subnet-EVM released version, takes precedence over --vm-version")
cmd.Flags().BoolVarP(&forceCreate, forceFlag, "f", false, "overwrite the existing configuration if one exists")
cmd.Flags().StringVar(&vmFile, "vm", "", "file path of custom vm to use. alias to custom-vm-path")
cmd.Flags().StringVar(&vmFile, "custom-vm-path", "", "file path of custom vm to use")
cmd.Flags().StringVar(&customVMRepoURL, "custom-vm-repo-url", "", "custom vm repository url")
cmd.Flags().StringVar(&customVMBranch, "custom-vm-branch", "", "custom vm branch or commit")
cmd.Flags().StringVar(&customVMBuildScript, "custom-vm-build-script", "", "custom vm build-script")
cmd.Flags().BoolVar(&useRepo, "from-github-repo", false, "generate custom VM binary from github repository")
cmd.Flags().BoolVar(&useWarp, "warp", true, "generate a vm with warp support (needed for teleporter)")
cmd.Flags().BoolVar(&teleporterReady, "teleporter", false, "generate a teleporter-ready vm")
cmd.Flags().BoolVar(&runRelayer, "relayer", false, "run AWM relayer when deploying the vm")
return cmd
}
func CallCreate(
cmd *cobra.Command,
subnetName string,
forceCreateParam bool,
genesisFileParam string,
useSubnetEvmParam bool,
useCustomParam bool,
evmVersionParam string,
evmChainIDParam uint64,
evmTokenParam string,
evmDefaultsParam bool,
useLatestReleasedEvmVersionParam bool,
useLatestPreReleasedEvmVersionParam bool,
customVMRepoURLParam string,
customVMBranchParam string,
customVMBuildScriptParam string,
) error {
forceCreate = forceCreateParam
genesisFile = genesisFileParam
useSubnetEvm = useSubnetEvmParam
evmVersion = evmVersionParam
evmChainID = evmChainIDParam
evmToken = evmTokenParam
evmDefaults = evmDefaultsParam
useLatestReleasedEvmVersion = useLatestReleasedEvmVersionParam
useLatestPreReleasedEvmVersion = useLatestPreReleasedEvmVersionParam
useCustom = useCustomParam
customVMRepoURL = customVMRepoURLParam
customVMBranch = customVMBranchParam
customVMBuildScript = customVMBuildScriptParam
return createSubnetConfig(cmd, []string{subnetName})
}
func detectVMTypeFromFlags() {
// assumes custom
if customVMRepoURL != "" || customVMBranch != "" || customVMBuildScript != "" {
useCustom = true
}
}
func moreThanOneVMSelected() bool {
vmVars := []bool{useSubnetEvm, useCustom}
firstSelect := false
for _, val := range vmVars {
if firstSelect && val {
return true
} else if val {
firstSelect = true
}
}
return false
}
func getVMFromFlag() models.VMType {
if useSubnetEvm {
return models.SubnetEvm
}
if useCustom {
return models.CustomVM
}
return ""
}
// override postrun function from root.go, so that we don't double send metrics for the same command
func handlePostRun(_ *cobra.Command, _ []string) {}
func createSubnetConfig(cmd *cobra.Command, args []string) error {
subnetName := args[0]
if app.GenesisExists(subnetName) && !forceCreate {
return errors.New("configuration already exists. Use --" + forceFlag + " parameter to overwrite")
}
if err := checkInvalidSubnetNames(subnetName); err != nil {
return fmt.Errorf("subnet name %q is invalid: %w", subnetName, err)
}
detectVMTypeFromFlags()
if moreThanOneVMSelected() {
return errors.New("too many VMs selected. Provide at most one VM selection flag")
}
if !flags.EnsureMutuallyExclusive([]bool{useLatestReleasedEvmVersion, useLatestPreReleasedEvmVersion, evmVersion != ""}) {
return errMutuallyExlusiveVersionOptions
}
if genesisFile != "" && (evmChainID != 0 || evmToken != "" || evmDefaults) {
return errMutuallyVMConfigOptions
}
subnetType := getVMFromFlag()
if subnetType == "" {
subnetTypeStr, err := app.Prompt.CaptureList(
"Choose your VM",
[]string{models.SubnetEvm, models.CustomVM},
)
if err != nil {
return err
}
subnetType = models.VMTypeFromString(subnetTypeStr)
}
var (
genesisBytes []byte
sc *models.Sidecar
err error
)
if useLatestReleasedEvmVersion {
evmVersion = latest
}
if useLatestPreReleasedEvmVersion {
evmVersion = preRelease
}
if evmVersion != latest && evmVersion != preRelease && evmVersion != "" && !semver.IsValid(evmVersion) {
return fmt.Errorf("invalid version string, should be semantic version (ex: v1.1.1): %s", evmVersion)
}
if subnetType == models.SubnetEvm {
evmVersion, err = vm.GetVMVersion(app, "Subnet-EVM", constants.SubnetEVMRepoName, evmVersion)
if err != nil {
return err
}
}
genesisFileIsEVM := false
if genesisFile != "" {
genesisFileIsEVM, err = utils.PathIsSubnetEVMGenesis(genesisFile)
if err != nil {
return err
}
}
if subnetType == models.SubnetEvm && genesisFile != "" && !genesisFileIsEVM {
return fmt.Errorf("provided genesis file has no proper Subnet-EVM format")
}
if subnetType == models.SubnetEvm || genesisFileIsEVM {
if evmDefaults {
teleporterReady = true
runRelayer = true
}
teleporterReady, err = prompts.CaptureBoolFlag(
app.Prompt,
cmd,
"teleporter",
teleporterReady,
"Would you like to enable Teleporter on your VM?",
)
if err != nil {
return err
}
if teleporterReady && !useWarp {
return fmt.Errorf("warp should be enabled for teleporter to work")
}
if teleporterReady {
runRelayer, err = prompts.CaptureBoolFlag(
app.Prompt,
cmd,
"relayer",
runRelayer,
"Would you like to run AMW Relayer when deploying your VM?",
)
if err != nil {
return err
}
}
}
var teleporterInfo *teleporter.Info
if teleporterReady {
teleporterInfo, err = teleporter.GetInfo(app)
if err != nil {
return err
}
}
switch subnetType {
case models.SubnetEvm:
genesisBytes, sc, err = vm.CreateEvmSubnetConfig(
app,
subnetName,
genesisFile,
evmVersion,
true,
evmChainID,
evmToken,
evmDefaults,
useWarp,
teleporterInfo,
)
if err != nil {
return err
}
case models.CustomVM:
genesisBytes, sc, err = vm.CreateCustomSubnetConfig(
app,
subnetName,
genesisFile,
useRepo,
customVMRepoURL,
customVMBranch,
customVMBuildScript,
vmFile,
)
if err != nil {
return err
}
default:
return errors.New("not implemented")
}
if teleporterReady {
sc.TeleporterReady = teleporterReady
sc.TeleporterKey = constants.TeleporterKeyName
sc.TeleporterVersion = teleporterInfo.Version
sc.RunRelayer = runRelayer
if genesisFile != "" && genesisFileIsEVM {
// evm genesis file was given. make appropriate checks and customizations for teleporter
genesisBytes, err = addSubnetEVMGenesisPrefundedAddress(genesisBytes, teleporterInfo.FundedAddress, teleporterInfo.FundedBalance.String())
if err != nil {
return err
}
}
}
if err = app.WriteGenesisFile(subnetName, genesisBytes); err != nil {
return err
}
sc.ImportedFromAPM = false
if err = app.CreateSidecar(sc); err != nil {
return err
}
if subnetType == models.SubnetEvm {
err = sendMetrics(cmd, subnetType.RepoName(), subnetName)
if err != nil {
return err
}
}
ux.Logger.GreenCheckmarkToUser("Successfully created subnet configuration")
return nil
}
func addSubnetEVMGenesisPrefundedAddress(genesisBytes []byte, address string, balance string) ([]byte, error) {
var genesisMap map[string]interface{}
if err := json.Unmarshal(genesisBytes, &genesisMap); err != nil {
return nil, err
}
allocI, ok := genesisMap["alloc"]
if !ok {
return nil, fmt.Errorf("alloc field not found on genesis")
}
alloc, ok := allocI.(map[string]interface{})
if !ok {
return nil, fmt.Errorf("expected genesis alloc field to be map[string]interface, found %T", allocI)
}
trimmedAddress := strings.TrimPrefix(address, "0x")
alloc[trimmedAddress] = map[string]interface{}{
"balance": balance,
}
genesisMap["alloc"] = alloc
return json.MarshalIndent(genesisMap, "", " ")
}
func sendMetrics(cmd *cobra.Command, repoName, subnetName string) error {
flags := make(map[string]string)
flags[constants.SubnetType] = repoName
genesis, err := app.LoadEvmGenesis(subnetName)
if err != nil {
return err
}
conf := genesis.Config.GenesisPrecompiles
precompiles := make([]string, 6)
for precompileName := range conf {
precompileTag := "precompile-" + precompileName
flags[precompileTag] = precompileName
precompiles = append(precompiles, precompileName)
}
numAirdropAddresses := len(genesis.Alloc)
for address := range genesis.Alloc {
if address.String() != vm.PrefundedEwoqAddress.String() {
precompileTag := "precompile-" + constants.CustomAirdrop
flags[precompileTag] = constants.CustomAirdrop
precompiles = append(precompiles, constants.CustomAirdrop)
break
}
}
sort.Strings(precompiles)
precompilesJoined := strings.Join(precompiles, ",")
flags[constants.PrecompileType] = precompilesJoined
flags[constants.NumberOfAirdrops] = strconv.Itoa(numAirdropAddresses)
metrics.HandleTracking(cmd, constants.MetricsSubnetCreateCommand, app, flags)
return nil
}
func checkInvalidSubnetNames(name string) error {
// this is currently exactly the same code as in avalanchego/vms/platformvm/create_chain_tx.go
for _, r := range name {
if r > unicode.MaxASCII || !(unicode.IsLetter(r) || unicode.IsNumber(r) || r == ' ') {
return errIllegalNameCharacter
}
}
return nil
}