def activate_package(args: Namespace, config: Config) -> None:
# support: etherscan / ipfs / github / erc1319
url = parse.urlparse(args.package_or_uri)
if url.scheme:
if url.scheme not in SUPPORTED_SCHEMES:
raise UriNotSupportedError(
f"URIs with a scheme of {url.scheme} are not supported. "
f"Currently supported schemes include: {SUPPORTED_SCHEMES}")
try:
args.package_name = "etherscan" # for etherscan URIs
args.package_version = "1.0.0" # for etherscan URIs
args.uri = args.package_or_uri
cli_pkg = Package(args, config.ipfs_backend)
manifest = cli_pkg.manifest
except UriNotSupportedError:
raise UriNotSupportedError(
f"{args.package_or_uri} is not a supported URI. The only URIs currently supported "
"are Registry, Github Blob, Etherscan and IPFS")
else:
if not is_package_installed(args.package_or_uri, config):
raise InstallError(
f"Package: {args.package_or_uri} not installed in ethPM dir: {config.ethpm_dir}."
)
manifest = json.loads((config.ethpm_dir / args.package_or_uri /
"manifest.json").read_text())
pkg = ethpmPackage(manifest, config.w3)
activation_banner = (
f"{(LIGHTNING_EMOJI + PACKAGE_EMOJI) * 4}{LIGHTNING_EMOJI}\n"
f"{bold_white('Activating package')}: {bold_blue(pkg.name)}@{bold_green(pkg.version)}\n"
f"{(LIGHTNING_EMOJI + PACKAGE_EMOJI) * 4}{LIGHTNING_EMOJI}\n")
cli_logger.info(activation_banner)
if "contractTypes" in pkg.manifest:
num_contract_types = len(pkg.manifest["contractTypes"])
else:
num_contract_types = 0
if "deployments" in pkg.manifest:
num_deployments = sum(
len(deps) for _, deps in pkg.manifest["deployments"].items())
else:
num_deployments = 0
if num_contract_types > 0:
available_factories = generate_contract_factories(pkg)
if len(available_factories) > 0:
formatted_factories = list_keys_for_display(available_factories)
factories_banner = (
f"Successfully generated {len(available_factories)} contract "
f"{pluralize(len(available_factories), 'factory')} on mainnet from "
f"{num_contract_types} detected contract {pluralize(num_contract_types, 'type')}.\n"
f"{''.join(formatted_factories)}\n"
"To get a contract factory on a different chain, call "
f"`{bold_white('get_factory(target_factory, target_w3)')}`\n"
"using the available contract fatories and Web3 instances.\n\n"
)
else:
factories_banner = "\n"
else:
available_factories = {}
factories_banner = "No detected contract types.\n"
if num_deployments > 0:
available_instances = generate_deployments(pkg, config)
formatted_instances = list_keys_for_display(available_instances)
deployments_banner = (
f"Successfully generated {len(available_instances)} contract "
f"{pluralize(len(available_instances), 'instance')} from {num_deployments} detected "
f"{pluralize(num_deployments, 'deployment')}.\n"
f"{''.join(formatted_instances)}\n")
else:
available_instances = {}
deployments_banner = "No detected deployments.\n"
if config.private_key:
auth_banner = (
f"Deployments configured to sign for: {config.w3.eth.defaultAccount}\n"
)
else:
auth_banner = (
"Contract instances and web3 instances have not been configured with an account.\n"
"Use the --keyfile-password flag to enable automatic signing.\n")
available_w3s = get_w3s(config)
formatted_w3s = list_keys_for_display(available_w3s)
web3_banner = "Available Web3 Instances\n" f"{''.join(formatted_w3s)}\n"
banner = (
f"{factories_banner}{deployments_banner}{web3_banner}{auth_banner}\n"
"The API for web3.py contract factories and instances can be found here:\n"
f"{bold_white('https://web3py.readthedocs.io/en/stable/contracts.html')}\n\n"
"Starting IPython console... ")
helper_fns = {"get_factory": get_factory}
embed(
user_ns={
**available_factories,
**available_instances,
# ignore b/c conflicting types w/in dict values
**available_w3s, # type: ignore
**helper_fns, # type: ignore
},
banner1=banner,
colors="neutral",
)
def registry_remove_cmd(args: argparse.Namespace) -> None:
config = Config(args)
remove_registry(args.uri_or_alias, config)
cli_logger.info(
f"Registry: {args.uri_or_alias} removed from registry store.")
def uninstall_action(args: argparse.Namespace) -> None:
validate_uninstall_cli_args(args)
config = Config(args)
uninstall_package(args.package, config)
cli_logger.info("%s uninstalled from %s", args.package, config.ethpm_dir)
def registry_activate_cmd(args: argparse.Namespace) -> None:
config = Config(args)
activate_registry(args.uri_or_alias, config)
cli_logger.info(f"Registry @ {args.uri_or_alias} activated.")
def registry_explore_cmd(args: argparse.Namespace) -> None:
config = Config(args)
cli_logger.info(f"Looking for packages @ {args.uri_or_alias}: \n")
explore_registry(args.uri_or_alias, config)
def update_package(args: Namespace, config: Config) -> None:
if not is_package_installed(args.package, config):
check_for_aliased_package(args.package, config)
return
installed_package = resolve_installed_package_by_id(args.package, config)
active_registry = get_active_registry(config.xdg_ethpmcli_root /
REGISTRY_STORE)
if is_valid_registry_uri(installed_package.install_uri):
validate_same_registry(installed_package.install_uri,
active_registry.uri)
connected_chain_id = config.w3.eth.chainId
active_registry_uri = parse_registry_uri(active_registry.uri)
if not to_int(text=active_registry_uri.chain_id) == connected_chain_id:
raise InstallError(
f"Registry URI chain: {active_registry_uri.chain_id} doesn't match "
f"connected web3: {connected_chain_id}.")
config.w3.pm.set_registry(active_registry_uri.address)
all_package_names = config.w3.pm.get_all_package_names()
if installed_package.resolved_package_name not in all_package_names:
raise InstallError(
f"{installed_package.resolved_package_name} is not available on the active registry "
f"{active_registry.uri}. Available packages include: {all_package_names}."
)
all_release_data = config.w3.pm.get_all_package_releases(
installed_package.resolved_package_name)
all_versions = [version for version, _ in all_release_data]
if installed_package.resolved_version not in all_versions:
raise InstallError(
f"{installed_package.resolved_package_name}@{installed_package.resolved_version} not "
f"found on the active registry {active_registry.uri}.")
on_chain_install_uri = pluck_release_data(
all_release_data, installed_package.resolved_version)
if on_chain_install_uri != installed_package.resolved_uri:
raise InstallError(
f"Install URI found on active registry for {installed_package.resolved_package_name}@"
f"{installed_package.resolved_version}: {on_chain_install_uri} does not match the "
f"install URI found in local lockfile: {installed_package.resolved_uri}."
)
cli_logger.info(
f"{len(all_versions)} versions of {installed_package.resolved_package_name} "
f"found: {all_versions} \n"
f"On the active registry: {active_registry.uri}")
count = 0
while True:
count += 1
target_version = input(
"Please enter the version you want to install. ")
if count > 5:
raise InstallError("Max attempts (5) reached. ")
elif target_version == installed_package.resolved_version:
cli_logger.info(f"Version already installed: {target_version}. ")
elif target_version not in all_versions:
cli_logger.info(f"Version unavailable: {target_version}. ")
else:
break
# Create an updated args/Package for new install
updated_args = copy.deepcopy(args)
if installed_package.resolved_package_name != args.package:
updated_args.alias = args.package
updated_args.uri = pluck_release_data(all_release_data, target_version)
updated_args.package_version = target_version
updated_package = Package(updated_args, config.ipfs_backend)
# atomic replace
with tempfile.TemporaryDirectory() as tmpdir:
tmp_ethpm_dir = Path(tmpdir) / ETHPM_PACKAGES_DIR
shutil.copytree(config.ethpm_dir, tmp_ethpm_dir)
tmp_config = copy.copy(config)
tmp_config.ethpm_dir = tmp_ethpm_dir
uninstall_package(args.package, tmp_config)
install_package(updated_package, tmp_config)
shutil.rmtree(config.ethpm_dir)
tmp_ethpm_dir.replace(config.ethpm_dir)
cli_logger.info(f"{updated_args.package} successfully updated to version "
f"{updated_args.package_version}.")
def pretty_print_raw_manifest(raw_manifest) -> None:
manifest = ManifestDisplay(raw_manifest)
cli_logger.info(f"Package Name: {manifest.package_name}")
cli_logger.info(f"Package Version: {manifest.package_version}")
cli_logger.info(f"Manifest Version: {manifest.manifest_version}\n")
cli_logger.info(f"Metadata: \n{''.join(manifest.meta())}")
cli_logger.info(f"Sources: \n{''.join(manifest.sources())}")
cli_logger.info(f"Contract Types: \n{''.join(manifest.contract_types())}")
cli_logger.info(f"Deployments: \n{''.join(manifest.deployments())}")
cli_logger.info(
f"Build Dependencies: \n{''.join(manifest.build_dependencies())}")
def generate_custom_manifest(project_dir: Path) -> None:
cli_logger.info("Manifest Wizard")
cli_logger.info("---------------")
cli_logger.info("Create ethPM manifests for local projects.")
cli_logger.info("Project directory must include solc output.")
cli_logger.info("Follow the steps in the docs to generate solc output.")
contracts_dir = project_dir / "contracts"
validate_solc_output(project_dir)
solc_output_path = project_dir / SOLC_OUTPUT
solc_output = json.loads(solc_output_path.read_text())["contracts"]
builder_fns = (
gen_package_name(),
gen_version(),
gen_manifest_version(),
gen_description(),
gen_license(),
gen_authors(),
gen_keywords(),
gen_links(),
*gen_contract_types_and_sources(solc_output, contracts_dir),
*gen_deployments(solc_output),
# todo: *gen_build_dependencies(),
# todo: ipfs pinning support
# todo: workflow for adding a single field to existing manifest
# -- aka. extend existing manifest with a single deployment
gen_validate_manifest(),
b.write_to_disk(project_dir),
)
final_fns = (fn for fn in builder_fns if fn is not None)
cli_logger.info(
"Building your manifest. This could take a minute if you're pinning assets to IPFS."
)
manifest = b.build({}, *final_fns)
cli_logger.info(
f"Manifest successfully created and written to {project_dir}/{manifest['version']}.json."
)
