diff --git a/.github/linkChecker.ts b/.github/linkChecker.ts index a769338ad00..723c60ae16a 100644 --- a/.github/linkChecker.ts +++ b/.github/linkChecker.ts @@ -5,7 +5,7 @@ import { sync as globSync } from 'glob'; const baseUrl = 'http://localhost:3000'; // base url of the website -const whitelist = ["crates.io", "softwaretestinghelp.com", "coinbase.com", "assets.website-files.com"] // some websites return 404 for head requests, so we need to whitelist them, (fix: pass header -H 'Accept: text/html' and parse text/html) +const whitelist = ["crates.io", "softwaretestinghelp.com", "coinbase.com", "assets.website-files.com", "moralis.io"] // some websites return 404 for head requests, so we need to whitelist them, (fix: pass header -H 'Accept: text/html' and parse text/html) // see https://github.com/rust-lang/crates.io/issues/788 interface LinkCheckResult { diff --git a/content/docs/tooling/avalanche-cli.mdx b/content/docs/tooling/avalanche-cli.mdx index f11b3e4a145..de586499cb0 100644 --- a/content/docs/tooling/avalanche-cli.mdx +++ b/content/docs/tooling/avalanche-cli.mdx @@ -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") +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 +### Add Validator The `blockchain addValidator` command whitelists a primary network validator to validate the provided deployed Avalanche L1. @@ -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 +### Remove Validator This command removes a node as a validator in an Avalanche L1. @@ -113,7 +113,7 @@ avalanche blockchain removeValidator [blockchainName] [flags] --testnet remove validator in existing testnet deployment (alias for `fuji`) ``` -### Avalanche L1 Change Owner +### Change Owner The `blockchain changeOwner` changes the owner of the deployed Avalanche L1. @@ -146,7 +146,7 @@ avalanche blockchain changeOwner [blockchainName] [flags] --threshold uint32 required number of control key signatures to make subnet changes ``` -### Avalanche L1 Configure +### 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. @@ -165,8 +165,7 @@ avalanche blockchain configure [blockchainName] [flags] --subnet-config string path to the subnet configuration ``` -### Avalanche L1 Create - +### 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. 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. @@ -204,7 +203,7 @@ avalanche blockchain create [blockchainName] [flags] --warp generate a vm with warp support (needed for teleporter) ``` -### Avalanche L1 Delete +### Delete The `blockchain delete` command deletes an existing Avalanche L1 configuration. @@ -220,7 +219,7 @@ avalanche blockchain delete [flags] -h, --help help for delete ``` -### Avalanche L1 Deploy +### Deploy The `blockchain deploy` command deploys your Avalanche L1 configuration locally, to Fuji Testnet, or to Mainnet. @@ -259,7 +258,7 @@ avalanche blockchain deploy [blockchainName] [flags] --threshold uint32 required number of control key signatures to make subnet changes ``` -### Avalanche L1 Describe +### 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. @@ -276,7 +275,7 @@ avalanche blockchain describe [blockchainName] [flags] -h, --help help for describe ``` -### Avalanche L1 Export +### Export The `blockchain export` command write the details of an existing Avalanche L1 deploy to a file. @@ -295,7 +294,7 @@ avalanche blockchain export [blockchainName] [flags] -o, --output string write the export data to the provided file path ``` -### Avalanche L1 Import +### Import The `blockchain import` command imports configurations into Avalanche-CLI. @@ -349,7 +348,7 @@ avalanche blockchain import public [blockchainPath] [flags] ``` -### Avalanche L1 Join +### Join The `blockchain join` command configures your validator node to begin validating a new Avalanche L1. @@ -382,7 +381,7 @@ avalanche blockchain join [blockchainName] [flags] --testnet testnet join on testnet (alias for `fuji`) ``` -### Avalanche L1 List +### 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. @@ -399,7 +398,7 @@ avalanche blockchain list [flags] -h, --help help for list ``` -### Avalanche L1 Publish +### Publish The `blockchain publish` command publishes the Avalanche L1's VM to a repository. @@ -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 +### Stats The `blockchain stats` command prints validator statistics for the given Avalanche L1. @@ -440,7 +439,7 @@ avalanche blockchain stats [blockchainName] [flags] --testnet testnet print stats on testnet (alias for `fuji`) ``` -### Avalanche L1 VMID +### VMID The `blockchain vmid` command prints the virtual machine ID (VMID) for the given Avalanche L1. @@ -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[​](#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). @@ -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. @@ -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. @@ -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") +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 +### Apply Apply generated upgrade bytes to running Avalanche L1 nodes to trigger a network upgrade. @@ -571,7 +570,7 @@ avalanche blockchain upgrade apply [blockchainName] [flags] --testnet testnet apply upgrade existing testnet deployment (alias for `fuji`) ``` -### Avalanche L1 Upgrade Export +### Export Export the upgrade bytes file to a location of choice on disk. @@ -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 +### 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. @@ -605,7 +604,7 @@ avalanche blockchain upgrade generate [blockchainName] [flags] -h, --help help for generate ``` -### Avalanche L1 Upgrade Import +### Import Import the upgrade bytes file into the local environment. @@ -622,7 +621,7 @@ avalanche blockchain upgrade import [blockchainName] [flags] --upgrade-filepath string Import upgrade bytes file into local environment ``` -### Avalanche L1 Upgrade Print +### Print Print the upgrade.json file content. @@ -634,7 +633,7 @@ avalanche blockchain upgrade print [blockchainName] [flags] **Flags**: -### Avalanche L1 Upgrade VM +### 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. @@ -660,7 +659,7 @@ The `node` command suite provides a collection of tools for creating and maintai To get started, use the node create command wizard to walk through the configuration to make your node a primary validator on Avalanche public network. You can use the rest of the commands to maintain your node and make your node an Avalanche L1 Validator. -### Node Create +### Create (ALPHA Warning) This command is currently in experimental mode. @@ -705,7 +704,7 @@ avalanche node create [clusterName] [flags] --use-static-ip attach static Public IP on cloud servers (default true) ``` -### Node Devnet +### Devnet (ALPHA Warning) This command is currently in experimental mode. @@ -713,7 +712,7 @@ avalanche node create [clusterName] [flags] The `node devnet` command suite provides a collection of commands related to devnets. You can check the updated status by calling avalanche node status `` -### Node Devnet Deploy +### Devnet Deploy The `node devnet deploy` command deploys an Avalanche L1 into a devnet cluster, creating Avalanche L1 and blockchain TXs for it. It saves the deploy info both locally and remotely. @@ -723,7 +722,7 @@ The `node devnet deploy` command deploys an Avalanche L1 into a devnet cluster, avalanche node devnet deploy [clusterName] [blockchainName] [flags] ``` -### Node Devnet Wiz +### Devnet Wiz The `node devnet wiz` command creates a devnet and deploys, sync and validate an Avalanche L1 into it. It creates the Avalanche L1 if so needed. @@ -777,7 +776,7 @@ avalanche node devnet wiz [clusterName] [blockchainName] [flags] --validators strings deploy subnet into given comma separated list of validators. defaults to all cluster nodes ``` -### Node List +### List (ALPHA Warning) This command is currently in experimental mode. @@ -791,7 +790,7 @@ The `node list` command lists all clusters together with their nodes. avalanche node list [flags] ``` -### Node Ssh +### Ssh (ALPHA Warning) This command is currently in experimental mode. @@ -811,7 +810,7 @@ avalanche node ssh [clusterName] [flags] -h, --help help for status ``` -### Node Status +### Status (ALPHA Warning) This command is currently in experimental mode. @@ -834,7 +833,7 @@ avalanche node status [clusterName] [flags] --subnet string specify the subnet the node is syncing with ``` -### Node Stop +### Stop (ALPHA Warning) This command is currently in experimental mode. @@ -858,7 +857,7 @@ avalanche node stop [clusterName] [flags] -h, --help help for stop ``` -### Node Sync +### Sync (ALPHA Warning) This command is currently in experimental mode. @@ -872,7 +871,7 @@ The `node sync` command enables all nodes in a cluster to be bootstrapped to an avalanche node sync [clusterName] [blockchainName] [flags] ``` -### Node Update +### Update (ALPHA Warning) This command is currently in experimental mode. @@ -880,7 +879,7 @@ avalanche node sync [clusterName] [blockchainName] [flags] The `node update` command suite provides a collection of commands for nodes to update their AvalancheGo version or VM version/config. You can check the status after update by running `avalanche node status` -### Node Update Avalanche L1 +### Update Subnet (ALPHA Warning) This command is currently in experimental mode. @@ -900,7 +899,7 @@ avalanche node update subnet [clusterName] [blockchainName] [flags] -h, --help help for subnet ``` -### Node Validate +### Validate (ALPHA Warning) This command is currently in experimental mode. @@ -910,7 +909,7 @@ The `node validate` command suite provides a collection of commands for nodes to You can check the bootstrap status by running `avalanche node status `. -### Node Validate Primary +### Validate Primary (ALPHA Warning) This command is currently in experimental mode. @@ -938,7 +937,7 @@ avalanche node validate primary [clusterName] [flags] -t, --testnet fuji set up validator in testnet (alias to fuji) ``` -### Node Validate Avalanche L1 +### Validate Subnet (ALPHA Warning) This command is currently in experimental mode. @@ -971,7 +970,7 @@ avalanche node validate subnet [clusterName] [blockchainName] [flags] -t, --testnet fuji set up validator in testnet (alias to fuji) ``` -### Node Whitelist +### Whitelist (ALPHA Warning) This command is currently in experimental mode. @@ -997,7 +996,7 @@ avalanche node whitelist [--ip ] [--ssh ""] [flags] --ssh string ssh public key to whitelist ``` -### Node Export +### Export (ALPHA Warning) This command is currently in experimental mode. @@ -1022,7 +1021,7 @@ avalanche node export [clusterName] [flags] --include-secrets include keys in the export ``` -### Node Import +### Import (ALPHA Warning) This command is currently in experimental mode. @@ -1045,7 +1044,7 @@ avalanche node import [clusterName] [flags] -h, --help help for import ``` -### Node Resize +### Resize (ALPHA Warning) This command is currently in experimental mode. @@ -1079,7 +1078,7 @@ When you deploy an Avalanche L1 locally, it runs on a local, multi-node Avalanch This network currently supports multiple, concurrently deployed Avalanche L1s. -### Network Clean +### Clean The `network clean` command shuts down your local, multi-node network. All deployed Avalanche L1s shutdown and delete their state. You can restart the network by deploying a new Avalanche L1 configuration. @@ -1096,7 +1095,7 @@ avalanche network clean [flags] -h, --help help for clean ``` -### Network Start +### Start The `network start` command starts a local, multi-node Avalanche network on your machine. @@ -1117,7 +1116,7 @@ avalanche network start [flags] --snapshot-name string name of snapshot to use to start the network from (default "default-1654102509") ``` -### Network Status +### Status The `network status` command prints whether or not a local Avalanche network is running and some basic stats about the network. @@ -1133,7 +1132,7 @@ avalanche network status [flags] -h, --help help for status ``` -### Network Stop +### Stop The `network stop` command shuts down your local, multi-node network. @@ -1157,7 +1156,7 @@ Transaction[​](#transaction "Direct link to heading") The `transaction` command suite provides all of the utilities required to sign multisig transactions. -### Transaction Commit +### Commit The `transaction commit` command commits a transaction by submitting it to the P-Chain. @@ -1174,7 +1173,7 @@ avalanche transaction commit [blockchainName] [flags] --input-tx-filepath string Path to the transaction signed by all signatories ``` -### Transaction Sign +### Sign The `transaction sign` command signs a multisig transaction. @@ -1201,7 +1200,7 @@ The `key` command suite provides a collection of tools for creating and managing To get started, use the `key create` command. -### Key Create +### Create The `key create` command generates a new private key to use for creating and controlling test Avalanche L1s. Keys generated by this command are NOT cryptographically secure enough to use in production environments. DO NOT use these keys on Mainnet. @@ -1223,7 +1222,7 @@ avalanche key create [keyName] [flags] -h, --help help for create ``` -### Key Delete +### Delete The `key delete` command deletes an existing signing key. @@ -1242,7 +1241,7 @@ avalanche key delete [keyName] [flags] -h, --help help for delete ``` -### Key Export +### Export The `key export` command exports a created signing key. You can use an exported key in other applications or import it into another instance of Avalanche-CLI. @@ -1259,7 +1258,7 @@ By default, the tool writes the hex encoded key to stdout. If you provide the `- -o, --output string write the key to the provided file path ``` -### Key List +### List The `key list` command prints information for all stored signing keys or for the ledger addresses associated to certain indices. @@ -1286,7 +1285,7 @@ avalanche key list [flags] --xchain list X-Chain addresses (default true) ``` -### Key Transfer +### Transfer The `key transfer` command allows to transfer funds between stored keys or ledger addresses. @@ -1315,3 +1314,4 @@ avalanche key transfer [options] [flags] -a, --target-addr string receiver address -t, --testnet transfer between testnet (fuji) addresses ``` + diff --git a/content/docs/tooling/cross-chain/teleporter-token-bridge.mdx b/content/docs/tooling/cross-chain/teleporter-token-bridge.mdx index cfb873e08b7..70e1d41a7ec 100644 --- a/content/docs/tooling/cross-chain/teleporter-token-bridge.mdx +++ b/content/docs/tooling/cross-chain/teleporter-token-bridge.mdx @@ -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