zeth.helper.eth_gen_network_config Namespace Reference

Functions
None	eth_gen_network_config (str eth_network, Optional[str] eth_rpc_endpoint, Optional[str] eth_rpc_certificate, bool eth_rpc_insecure, str output_file)

Variables
	default
	help
	is_flag

Function Documentation

eth_gen_network_config()

None zeth.helper.eth_gen_network_config.eth_gen_network_config	(	str	eth_network,
		Optional[str]	eth_rpc_endpoint,
		Optional[str]	eth_rpc_certificate,
		bool	eth_rpc_insecure,
		str	output_file
	)

Generate a network config file. ETH_NETWORK is a network name or
pre-existing network config file.

Examples:

\b
    # Write default config for "ganache" to the default file
    $ zeth-helper eth-gen-network-config ganache

\b
    # Write "geth" config with a custom endpoint to default file
    $ zeth-helper eth-gen-network-config geth \\
        --eth-rpc-endpoint http://localhost:8080

\b
    # Write a custom https endpoint to file, specifying the certificate
    $ zeth-helper eth-gen-network-config \\
        my-network \\
        --eth-rpc-endpoint https://rpc.my-network.io:8545 \\
        --eth-rpc-certificate rpc.my-network.io.crt

\b
    # Write default network and endpoint to file "default-network"
    $ zeth-helper eth-gen-network-config --output-file default-network

Definition at line 27 of file eth_gen_network_config.py.

def eth_gen_network_config(
        eth_network: str,
        eth_rpc_endpoint: Optional[str],
        eth_rpc_certificate: Optional[str],
        eth_rpc_insecure: bool,
        output_file: str) -> None:
    """
    Generate a network config file. ETH_NETWORK is a network name or
    pre-existing network config file.
 
    Examples:
 
    \b
        # Write default config for "ganache" to the default file
        $ zeth-helper eth-gen-network-config ganache
 
    \b
        # Write "geth" config with a custom endpoint to default file
        $ zeth-helper eth-gen-network-config geth \\
            --eth-rpc-endpoint http://localhost:8080
 
    \b
        # Write a custom https endpoint to file, specifying the certificate
        $ zeth-helper eth-gen-network-config \\
            my-network \\
            --eth-rpc-endpoint https://rpc.my-network.io:8545 \\
            --eth-rpc-certificate rpc.my-network.io.crt
 
    \b
        # Write default network and endpoint to file "default-network"
        $ zeth-helper eth-gen-network-config --output-file default-network
    """
 
    if eth_rpc_endpoint is not None:
        network = NetworkConfig(
            name=eth_network,
            endpoint=eth_rpc_endpoint,
            certificate=eth_rpc_certificate,
            insecure=eth_rpc_insecure)
    else:
        network = get_eth_network(eth_network)
 
    network_json = network.to_json()
    print(f"network: {network_json}")
 
    with open(output_file, "w") as eth_network_f:
        eth_network_f.write(network_json)
    print(f"written to \"{output_file}\"")

Here is the call graph for this function:

Variable Documentation

default

zeth.helper.eth_gen_network_config.default

Definition at line 14 of file eth_gen_network_config.py.

help

zeth.helper.eth_gen_network_config.help

Definition at line 15 of file eth_gen_network_config.py.

is_flag

zeth.helper.eth_gen_network_config.is_flag

Definition at line 21 of file eth_gen_network_config.py.