Skip to content

Commit

Permalink
Merge branch 'main' into gstuart/test-fix-2
Browse files Browse the repository at this point in the history
  • Loading branch information
geoff-vball authored Jul 31, 2024
2 parents e2ea3f5 + 592798c commit c16b4dd
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 11 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ To get started with using Teleporter, see [How to Deploy Teleporter Enabled Subn
- [E2E tests](#e2e-tests)
- [Run specific E2E tests](#run-specific-e2e-tests)
- [Run the E2E tests on another network](#run-the-e2e-tests-on-another-network)
- [Upgradeability](#upgradeability)
- [Upgradability](#upgradability)
- [Deploy Teleporter to a Subnet](#deploy-teleporter-to-a-subnet)
- [Deploy TeleporterRegistry to a Subnet](#deploy-teleporterregistry-to-a-subnet)
- [ABI Bindings](#abi-bindings)
Expand Down Expand Up @@ -121,13 +121,13 @@ cp .env.example .env # Set proper values after copying.
The user wallet set in `.env` must have native tokens for each of the Subnets used in order for the test flows to be able to send transactions on those networks. The [Avalanche Testnet Faucet](https://core.app/tools/testnet-faucet) can be used to obtain native tokens for certain public testnet Subnets.
## Upgradeability
## Upgradability
The Teleporter contract is non-upgradeable and can not be changed once it is deployed. This provides immutability to the contracts, and ensures that the contract's behavior at each address is unchanging. However, to allow for new features and potential bug fixes, new versions of the Teleporter contract can be deployed to different addresses. The [TeleporterRegistry](./contracts/src/teleporter/TeleporterRegistry.sol) is used to keep track of the deployed versions of Teleporter, and to provide a standard interface for dApps to interact with the different Teleporter versions.
`TeleporterRegistry` **is not mandatory** for dApps built on top of Teleporter, but dApp's are recommended to leverage the registry to ensure they use the latest Teleporter version available. Another recommendation standard is to have a single canonical `TeleporterRegistry` for each Subnet chain, and unlike the Teleporter contract, the registry does not need to be deployed to the same address on every chain. This means the registry does not need a Nick's method deployment, and can be at different contract addresses on different chains.
For more information on the registry and how to integrate with Teleporter dApps, see the [Upgradeability doc](./contracts/src/teleporter/upgrades/README.md).
For more information on the registry and how to integrate with Teleporter dApps, see the [Upgradability doc](./contracts/src/teleporter/upgrades/README.md).
## Deploy Teleporter to a Subnet
Expand Down Expand Up @@ -181,7 +181,7 @@ The auto-generated bindings should be written under the `abi-bindings/` director
- [Teleporter Protocol Overview](./contracts/src/teleporter/README.md)
- [Cross Chain Applications](./contracts/src/CrossChainApplications/README.md)
- [Getting Started](./contracts/src/CrossChainApplications/GETTING_STARTED.md)
- [Teleporter Upgradeability](./contracts/src/teleporter/upgrades/README.md)
- [Teleporter Upgradability](./contracts/src/teleporter/upgrades/README.md)
- [Contract Deployment](./utils/contract-deployment/README.md)
- [Teleporter CLI](./cmd/teleporter-cli/README.md)
Expand Down
2 changes: 1 addition & 1 deletion contracts/src/teleporter/registry/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Teleporter Contracts Upgradeability
# Teleporter Contracts Upgradability

## Overview

Expand Down
8 changes: 4 additions & 4 deletions tests/local/e2e_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ const (
warpGenesisTemplateFile = "./tests/utils/warp-genesis-template.json"

teleporterMessengerLabel = "TeleporterMessenger"
upgradeabilityLabel = "upgradeability"
upgradabilityLabel = "upgradability"
utilsLabel = "utils"
validatorSetSigLabel = "ValidatorSetSig"
)
Expand Down Expand Up @@ -144,12 +144,12 @@ var _ = ginkgo.Describe("[Teleporter integration tests]", func() {
flows.ResubmitAlteredMessage(LocalNetworkInstance)
})
ginkgo.It("Check upgrade access",
ginkgo.Label(upgradeabilityLabel),
ginkgo.Label(upgradabilityLabel),
func() {
flows.CheckUpgradeAccess(LocalNetworkInstance)
})
ginkgo.It("Pause and Unpause Teleporter",
ginkgo.Label(upgradeabilityLabel),
ginkgo.Label(upgradabilityLabel),
func() {
flows.PauseTeleporter(LocalNetworkInstance)
})
Expand All @@ -166,7 +166,7 @@ var _ = ginkgo.Describe("[Teleporter integration tests]", func() {
flows.RelayerModifiesMessage(LocalNetworkInstance)
})
ginkgo.It("Teleporter registry",
ginkgo.Label(upgradeabilityLabel),
ginkgo.Label(upgradabilityLabel),
func() {
flows.TeleporterRegistry(LocalNetworkInstance)
})
Expand Down
4 changes: 2 additions & 2 deletions tests/testnet/main/run_testnet_flows.go
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ func main() {
runFlow("SendSpecificReceipts", flows.SendSpecificReceipts, network)
log.Info("Finished Teleporter test flows")

// Run the upgradeability test flows
// Run the upgradability test flows
runFlow("CheckUpgradeAccess", flows.CheckUpgradeAccess, network)
runFlow("PauseTeleporter", flows.PauseTeleporter, network)
log.Info("Finished upgradeability test flows")
log.Info("Finished upgradability test flows")
}

0 comments on commit c16b4dd

Please sign in to comment.