teleporter

Documentation

Overview

Copyright (C) 2022, Ava Labs, Inc. All rights reserved See the file LICENSE for licensing terms.

Copyright (C) 2022, Ava Labs, Inc. All rights reserved. See the file LICENSE for licensing terms.

Index

• Variables
• func DeployAndFundRelayer(app *application.Avalanche, teleporterVersion string, network models.Network, ...) (bool, string, string, error)
• func DeployRelayer(binDir string, configPath string, logFilePath string, runFilePath string, ...) error
• func DeployTeleporterRegistry(txOpts *bind.TransactOpts, client ethclient.Client, ...) (common.Address, *types.Transaction, *teleporterRegistry.TeleporterRegistry, ...)
• func FundRelayer(rpcURL string, prefundedPrivateKey string, teleporterRelayerAddress string) error
• func GetRelayerKeyInfo(keyPath string) (string, string, error)
• func InstallRelayer(binDir string) (string, error)
• func RelayerCleanup(runFilePath string, storageDir string) error
• func RelayerIsUp(runFilePath string) (bool, int, *os.Process, error)
• func SetProposerVM(app *application.Avalanche, network models.Network, blockchainID string, ...) error
• func UpdateRelayerConfig(relayerConfigPath string, relayerStorageDir string, relayerAddress string, ...) error
• type Deployer
  • func (t *Deployer) Deploy(teleporterInstallDir string, version string, subnetName string, rpcURL string, ...) (bool, string, string, error)
  • func (t *Deployer) DeployMessenger(teleporterInstallDir string, version string, subnetName string, rpcURL string, ...) (bool, string, error)
  • func (t *Deployer) DeployRegistry(teleporterInstallDir string, version string, subnetName string, rpcURL string, ...) (string, error)
  • func (t *Deployer) DownloadAssets(teleporterInstallDir string, version string) error
  • func (t *Deployer) GetAssets(teleporterInstallDir string, version string) (string, string, string, error)
• type Info
  • func GetInfo(app *application.Avalanche) (*Info, error)

Variables

var (

	// 10 AVAX
	TeleporterPrefundedAddressBalance = big.NewInt(0).
		Mul(big.NewInt(1e18), big.NewInt(600))
)

Functions

func DeployAndFundRelayer

func DeployAndFundRelayer(
	app *application.Avalanche,
	teleporterVersion string,
	network models.Network,
	subnetName string,
	blockchainID string,
	fundedKeyName string,
) (bool, string, string, error)

func DeployRelayer

func DeployRelayer(
	binDir string,
	configPath string,
	logFilePath string,
	runFilePath string,
	storageDir string,
) error

func DeployTeleporterRegistry

func DeployTeleporterRegistry(
	txOpts *bind.TransactOpts,
	client ethclient.Client,
	teleporterRegistryConstructorInput []teleporterRegistry.ProtocolRegistryEntry,
) (common.Address, *types.Transaction, *teleporterRegistry.TeleporterRegistry, error)

func FundRelayer

func FundRelayer(
	rpcURL string,
	prefundedPrivateKey string,
	teleporterRelayerAddress string,
) error

func GetRelayerKeyInfo

func GetRelayerKeyInfo(keyPath string) (string, string, error)

func InstallRelayer

func InstallRelayer(binDir string) (string, error)

func RelayerCleanup

func RelayerCleanup(runFilePath string, storageDir string) error

func RelayerIsUp

func RelayerIsUp(runFilePath string) (bool, int, *os.Process, error)

func SetProposerVM

func SetProposerVM(
	app *application.Avalanche,
	network models.Network,
	blockchainID string,
	fundedKeyName string,
) error

func UpdateRelayerConfig

func UpdateRelayerConfig(
	relayerConfigPath string,
	relayerStorageDir string,
	relayerAddress string,
	relayerPrivateKey string,
	network models.Network,
	subnetID string,
	blockchainID string,
	teleporterContractAddress string,
	teleporterRegistryAddress string,
) error

Types

type Deployer

type Deployer struct {
	// contains filtered or unexported fields
}

func (*Deployer) Deploy

func (t *Deployer) Deploy(
	teleporterInstallDir string,
	version string,
	subnetName string,
	rpcURL string,
	prefundedPrivateKey string,
	deployMessenger bool,
	deployRegistry bool,
) (bool, string, string, error)

func (*Deployer) DeployMessenger

func (t *Deployer) DeployMessenger(
	teleporterInstallDir string,
	version string,
	subnetName string,
	rpcURL string,
	prefundedPrivateKey string,
) (bool, string, error)

func (*Deployer) DeployRegistry

func (t *Deployer) DeployRegistry(
	teleporterInstallDir string,
	version string,
	subnetName string,
	rpcURL string,
	prefundedPrivateKey string,
) (string, error)

func (*Deployer) DownloadAssets

func (t *Deployer) DownloadAssets(
	teleporterInstallDir string,
	version string,
) error

func (*Deployer) GetAssets

func (t *Deployer) GetAssets(
	teleporterInstallDir string,
	version string,
) (string, string, string, error)

type Info

type Info struct {
	Version                  string
	FundedAddress            string
	FundedBalance            *big.Int
	MessengerDeployerAddress string
	RelayerAddress           string
}

func GetInfo

func GetInfo(
	app *application.Avalanche,
) (*Info, error)