Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update avalanche-cli headers #1908

Merged
merged 5 commits into from
Oct 10, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 27 additions & 28 deletions content/docs/tooling/avalanche-cli.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -44,14 +44,14 @@ avalanche primary addValidator [flags]
--delegation-fee uint set the delegation fee (20 000 is equivalent to 2%)
```

Avalanche L1[​](#avalanche-l1 "Direct link to heading")
Avalanche Blockchain[​](#avalanche-blockchain "Direct link to heading")
-------------------------------------------

The `blockchain` command suite provides a collection of tools for developing and deploying Avalanche L1s.

To get started, use the `blockchain create` command wizard to walk through the configuration of your very first Avalanche L1. Then, go ahead and deploy it with the `blockchain deploy` command. You can use the rest of the commands to manage your Avalanche L1 configurations and live deployments.

### Avalanche L1 AddValidator
### Blockchain Add Validator
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So either:

Suggested change
### Blockchain Add Validator
### Avalanche Blockchain AddValidator


The `blockchain addValidator` command whitelists a primary network validator to validate the provided deployed Avalanche L1.

Expand Down Expand Up @@ -88,7 +88,7 @@ avalanche blockchain addValidator [blockchainName] [flags]
--weight uint set the staking weight of the validator to add
```

### Remove Validator in an Avalanche L1
### Blockchain Remove Validator

This command removes a node as a validator in an Avalanche L1.

Expand All @@ -113,7 +113,7 @@ avalanche blockchain removeValidator [blockchainName] [flags]
--testnet remove validator in existing testnet deployment (alias for `fuji`)
```

### Avalanche L1 Change Owner
### Blockchain Change Owner

The `blockchain changeOwner` changes the owner of the deployed Avalanche L1.

Expand Down Expand Up @@ -146,7 +146,7 @@ avalanche blockchain changeOwner [blockchainName] [flags]
--threshold uint32 required number of control key signatures to make subnet changes
```

### Avalanche L1 Configure
### Blockchain Configure

AvalancheGo nodes support several different configuration files. Avalanche L1s have their own Avalanche L1 config which applies to all chains/VMs in the Avalanche L1. Each chain within the Avalanche L1 can have its own chain config. This command allows you to set both config files.

Expand All @@ -165,8 +165,7 @@ avalanche blockchain configure [blockchainName] [flags]
--subnet-config string path to the subnet configuration
```

### Avalanche L1 Create

### Blockchain Create
The `blockchain create` command builds a new genesis file to configure your Avalanche L1. By default, the command runs an interactive wizard. It walks you through all the steps you need to create your first Avalanche L1.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or:

Suggested change
### Blockchain Create
The `blockchain create` command builds a new genesis file to configure your Avalanche L1. By default, the command runs an interactive wizard. It walks you through all the steps you need to create your first Avalanche L1.
### Blockchain Create
The `avalanche blockchain create` command builds a new genesis file to configure your Avalanche L1. By default, the command runs an interactive wizard. It walks you through all the steps you need to create your first Avalanche L1.

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.
Expand Down Expand Up @@ -204,7 +203,7 @@ avalanche blockchain create [blockchainName] [flags]
--warp generate a vm with warp support (needed for teleporter)
```

### Avalanche L1 Delete
### Blockchain Delete

The `blockchain delete` command deletes an existing Avalanche L1 configuration.

Expand All @@ -220,7 +219,7 @@ avalanche blockchain delete [flags]
-h, --help help for delete
```

### Avalanche L1 Deploy
### Blockchain Deploy

The `blockchain deploy` command deploys your Avalanche L1 configuration locally, to Fuji Testnet, or to Mainnet.

Expand Down Expand Up @@ -259,7 +258,7 @@ avalanche blockchain deploy [blockchainName] [flags]
--threshold uint32 required number of control key signatures to make subnet changes
```

### Avalanche L1 Describe
### Blockchain Describe

The `blockchain describe` command prints the details of an Avalanche L1 configuration to the console. By default, the command prints a summary of the configuration. By providing the `--genesis` flag, the command instead prints out the raw genesis file.

Expand All @@ -276,7 +275,7 @@ avalanche blockchain describe [blockchainName] [flags]
-h, --help help for describe
```

### Avalanche L1 Export
### Blockchain Export

The `blockchain export` command write the details of an existing Avalanche L1 deploy to a file.

Expand All @@ -295,7 +294,7 @@ avalanche blockchain export [blockchainName] [flags]
-o, --output string write the export data to the provided file path
```

### Avalanche L1 Import
### Blockchain Import

The `blockchain import` command imports configurations into Avalanche-CLI.

Expand Down Expand Up @@ -349,7 +348,7 @@ avalanche blockchain import public [blockchainPath] [flags]

```

### Avalanche L1 Join
### Blockchain Join

The `blockchain join` command configures your validator node to begin validating a new Avalanche L1.

Expand Down Expand Up @@ -382,7 +381,7 @@ avalanche blockchain join [blockchainName] [flags]
--testnet testnet join on testnet (alias for `fuji`)
```

### Avalanche L1 List
### Blockchain List

The `blockchain list` command prints the names of all created Avalanche L1 configurations. Without any flags, it prints some general, static information about the Avalanche L1. With the `--deployed` flag, the command shows additional information including the VMID, BlockchainID and SubnetID.

Expand All @@ -399,7 +398,7 @@ avalanche blockchain list [flags]
-h, --help help for list
```

### Avalanche L1 Publish
### Blockchain Publish

The `blockchain publish` command publishes the Avalanche L1's VM to a repository.

Expand All @@ -421,7 +420,7 @@ avalanche blockchain publish [blockchainName] [flags]
--vm-file-path string Path to the VM description file. If not given, a prompting sequence will be initiated.
```

### Avalanche L1 Stats
### Blockchain Stats

The `blockchain stats` command prints validator statistics for the given Avalanche L1.

Expand All @@ -440,7 +439,7 @@ avalanche blockchain stats [blockchainName] [flags]
--testnet testnet print stats on testnet (alias for `fuji`)
```

### Avalanche L1 VMID
### Blockchain VMID

The `blockchain vmid` command prints the virtual machine ID (VMID) for the given Avalanche L1.

Expand All @@ -450,10 +449,10 @@ The `blockchain vmid` command prints the virtual machine ID (VMID) for the given
avalanche blockchain vmid [blockchainName]
```

Elastic Avalanche L1[​](#elastic-avalanche-l1 "Direct link to heading")
Elastic L1s[​](#elastic-avalanche-l1 "Direct link to heading")
-----------------------------------------------------------

### Transforms permissioned Avalanche L1 into Elastic Avalanche L1
### Transforms permissioned L1 into Elastic L1

This command transforms your permissioned Avalanche L1 into an Elastic Avalanche L1 (NOTE: this action is irreversible).

Expand Down Expand Up @@ -486,7 +485,7 @@ avalanche blockchain elastic [blockchainName] [flags]
--transform-validators If true, transform validators to permissionless validators after elastic transform
```

### Add Permissionless Validator in an Elastic Avalanche L1
### Add Permissionless Validator in an Elastic L1

This command adds a node as a permissionless validator in an Elastic Avalanche L1.

Expand All @@ -512,7 +511,7 @@ avalanche blockchain join [blockchainName] --elastic [flags]
--testnet add permissionless validator in existing testnet deployment (alias for `fuji`)
```

### Add Permissionless Delegator in an Elastic Avalanche L1
### Add Permissionless Delegator in an Elastic L1

This command delegates stake to a permissionless validator in an Elastic Avalanche L1.

Expand All @@ -538,12 +537,12 @@ avalanche blockchain addPermissionlessDelegator [blockchainName] [flags]
--testnet add permissionless delegator in existing testnet deployment (alias for `fuji`)
```

Avalanche L1 Upgrade[​](#avalanche-l1-upgrade "Direct link to heading")
Avalanche Blockchain Upgrade[​](#avalanche-blockchain-upgrade "Direct link to heading")
-----------------------------------------------------------

The `blockchain upgrade` command suite provides a collection of tools for updating your developmental and deployed Avalanche L1s.

### Avalanche L1 Upgrade Apply
### Upgrade Apply

Apply generated upgrade bytes to running Avalanche L1 nodes to trigger a network upgrade.

Expand Down Expand Up @@ -571,7 +570,7 @@ avalanche blockchain upgrade apply [blockchainName] [flags]
--testnet testnet apply upgrade existing testnet deployment (alias for `fuji`)
```

### Avalanche L1 Upgrade Export
### Upgrade Export

Export the upgrade bytes file to a location of choice on disk.

Expand All @@ -589,7 +588,7 @@ avalanche blockchain upgrade export [blockchainName] [flags]
--upgrade-filepath string Export upgrade bytes file to location of choice on disk
```

### Avalanche L1 Upgrade Generate
### Upgrade Generate

The `blockchain upgrade generate` command builds a new upgrade.json file to customize your Avalanche L1. It guides the user through the process using an interactive wizard.

Expand All @@ -605,7 +604,7 @@ avalanche blockchain upgrade generate [blockchainName] [flags]
-h, --help help for generate
```

### Avalanche L1 Upgrade Import
### Upgrade Import

Import the upgrade bytes file into the local environment.

Expand All @@ -622,7 +621,7 @@ avalanche blockchain upgrade import [blockchainName] [flags]
--upgrade-filepath string Import upgrade bytes file into local environment
```

### Avalanche L1 Upgrade Print
### Upgrade Print

Print the upgrade.json file content.

Expand All @@ -634,7 +633,7 @@ avalanche blockchain upgrade print [blockchainName] [flags]

**Flags**:

### Avalanche L1 Upgrade VM
### Upgrade VM

The `blockchain upgrade vm` command enables the user to upgrade their Avalanche L1's VM binary. The command can upgrade both local Avalanche L1s and publicly deployed Avalanche L1s on Fuji and Mainnet.

Expand Down
17 changes: 2 additions & 15 deletions content/docs/tooling/cross-chain/teleporter-token-bridge.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,26 +31,13 @@ Network. We will name our Avalanche L1 `testblockchain`.
First, let's create an ERC-20 Token and deploy it to C-Chain. For our example, it will be called
TOK.

Sample script to deploy the ERC-20 Token can be found [here](https://github.com/ava-labs/avalanche-cli/tree/add-deploy-script/deploy_erc20).
Note that you will need to modify the script [here](https://github.com/ava-labs/avalanche-cli/blob/add-deploy-script/deploy_erc20/deploy_erc20.sh#L17)
based on where you place the deploy script directory in your environment.
Sample script to deploy the ERC-20 Token can be found [here](https://github.com/ava-labs/avalanche-cli/blob/main/cmd/contractcmd/deploy_erc20.go).

Prior to executing the script, you will first need to [install Foundry](https://book.getfoundry.sh/getting-started/installation)
in your environment.

To deploy the ERC-20 Token to C-Chain, we will call:

```bash
./deploy_erc20/deploy_erc20.sh c-chain

Deploying to http://127.0.0.1:9650/ext/bc/C/rpc
Compiling...
Compiling 5 files with Solc 0.8.18
Solc 0.8.18 finished in 750.65ms
Compiler run successful!
Deployer: 0x8db97C7cEcE249c2b98bDC0226Cc4C2A57BF52FC
Deployed to: 0x5DB9A7629912EBF95876228C24A848de0bfB43A9
Transaction hash: 0xfc5f58885634d42648cde4eed415b2bcb3e56e571d7412d4e98e03ed3e155b7c
avalanche contract deploy erc20
```

When the command is run, our EWOQ address `0x8db97C7cEcE249c2b98bDC0226Cc4C2A57BF52FC` would have
Expand Down
Loading