helper

Documentation

Index

• Constants
• Variables
• func CreateApproveERC20Txn(amount *big.Int, spender, erc20TokenAddr types.Address, rootchainTx bool) (*ethgo.Transaction, error)
• func CreateMintTxn(receiver, erc20TokenAddr types.Address, amount *big.Int, rootchainTx bool) (*ethgo.Transaction, error)
• func CreateTransaction(sender ethgo.Address, receiver *ethgo.Address, input []byte, value *big.Int, ...) *ethgo.Transaction
• func DecodePrivateKey(rawKey string) (ethgo.Key, error)
• func DeployProxyContract(txRelayer txrelayer.TxRelayer, deployerKey ethgo.Key, proxyContractName string, ...) (*ethgo.Receipt, error)
• func GetECDSAKey(privateKey, accountDir, accountConfig string) (ethgo.Key, error)
• func GetRootchainID() (string, error)
• func GetValidatorInfo(validatorAddr ethgo.Address, ...) (*polybft.ValidatorInfo, error)
• func ReadRootchainIP() (string, error)
• func SendTransaction(txRelayer txrelayer.TxRelayer, addr ethgo.Address, input []byte, ...) (*ethgo.Receipt, error)
• type MessageResult
  • func (r MessageResult) GetOutput() string

Constants

const (
	TestAccountPrivKey      = "aa75e9a7d427efc732f8e4f1a5b7646adcc61fd5bae40f80d13c8419c9f43d6d"
	TestModeFlag            = "test"
	SupernetManagerFlag     = "supernet-manager"
	SupernetManagerFlagDesc = "address of supernet manager contract"
	StakeManagerFlag        = "stake-manager"
	StakeManagerFlagDesc    = "address of stake manager contract"
	NativeRootTokenFlag     = "native-root-token"
	NativeRootTokenFlagDesc = "address of native root token"
	GenesisPathFlag         = "genesis"
	GenesisPathFlagDesc     = "genesis file path, which contains chain configuration"
	DefaultGenesisPath      = "./genesis.json"
	StakeTokenFlag          = "stake-token"
	StakeTokenFlagDesc      = "address of ERC20 token used for staking on rootchain"
	ProxyContractsAdminFlag = "proxy-contracts-admin"
	ProxyContractsAdminDesc = "admin for proxy contracts"
	AddressesFlag           = "addresses"
	AmountsFlag             = "amounts"
	Erc20TokenFlag          = "erc20-token" //nolint:gosec
)

Variables

var (
	ErrRootchainNotFound   = errors.New("rootchain not found")
	ErrRootchainPortBind   = errors.New("port 8545 is not bind with localhost")
	ErrMandatoryStakeToken = errors.New("stake token address is mandatory")

	ErrNoAddressesProvided = errors.New("no addresses provided")
	ErrInconsistentLength  = errors.New("addresses and amounts must be equal length")

	ErrMandatoryERC20Token = errors.New("erc20 token address is mandatory")
)

Functions

func CreateApproveERC20Txn

func CreateApproveERC20Txn(amount *big.Int,
	spender, erc20TokenAddr types.Address, rootchainTx bool) (*ethgo.Transaction, error)

CreateApproveERC20Txn sends approve transaction to ERC20 token for spender so that it is able to spend given tokens

func CreateMintTxn

func CreateMintTxn(receiver, erc20TokenAddr types.Address,
	amount *big.Int, rootchainTx bool) (*ethgo.Transaction, error)

CreateMintTxn encodes parameters for mint function on rootchain token contract

func CreateTransaction

func CreateTransaction(sender ethgo.Address, receiver *ethgo.Address,
	input []byte, value *big.Int, isDynamicFee bool) *ethgo.Transaction

CreateTransaction is a helper function that creates either dynamic fee or legacy transaction based on provided flag

func DecodePrivateKey

func DecodePrivateKey(rawKey string) (ethgo.Key, error)

DecodePrivateKey decodes a private key from provided raw private key

func DeployProxyContract

func DeployProxyContract(txRelayer txrelayer.TxRelayer, deployerKey ethgo.Key, proxyContractName string,
	proxyAdmin, logicAddress types.Address) (*ethgo.Receipt, error)

func GetECDSAKey

func GetECDSAKey(privateKey, accountDir, accountConfig string) (ethgo.Key, error)

GetECDSAKey returns the key based on provided parameters If private key is provided, it will return that key if not, it will return the key from the secrets manager

func GetRootchainID

func GetRootchainID() (string, error)

func GetValidatorInfo

func GetValidatorInfo(validatorAddr ethgo.Address, supernetManagerAddr, stakeManagerAddr types.Address,
	chainID int64, txRelayer txrelayer.TxRelayer) (*polybft.ValidatorInfo, error)

GetValidatorInfo queries SupernetManager smart contract on root and retrieves validator info for given address

func ReadRootchainIP

func ReadRootchainIP() (string, error)

func SendTransaction

func SendTransaction(txRelayer txrelayer.TxRelayer, addr ethgo.Address, input []byte, contractName string,
	deployerKey ethgo.Key) (*ethgo.Receipt, error)

SendTransaction sends provided transaction

Types

type MessageResult

type MessageResult struct {
	Message string `json:"message"`
}

func (MessageResult) GetOutput

func (r MessageResult) GetOutput() string