Package Manager API
web3.pm object exposes methods to interact with Packages as defined by ERC 1123.
- To learn more about the EthPM spec, visit the documentation.
- To learn more about the Py-EthPM library used in this module, visit the documentation.
web3.pm API is still under development and likely to change quickly.
Now is a great time to get familiar with the API, and test out writing code that uses some of the great upcoming features.
By default, access to this module has been turned off in the stable version of Web3.py:
>>> from web3.auto import w3 >>> w3.pm ... AttributeError: The Package Management feature is disabled by default ...
In order to access these features, you can turn it on with...
>>> web3.enable_unstable_package_management_api() >>> w3.pm <web3.pm.PM at 0x....>
The following methods are available on the
.. autoclass:: web3.pm.PM :members:
.. autoclass:: web3.pm.ERCRegistry :members: __init__, _release, _get_package_name, _get_all_package_ids, _get_release_id, _get_all_release_ids, _get_release_data, _generate_release_id, _num_package_ids, _num_release_ids
.. autoclass:: web3.pm.VyperReferenceRegistry :members: deploy_new_instance, owner, transfer_owner
.. autoclass:: web3.pm.SolidityReferenceRegistry :members:
Creating your own Registry class
If you want to implement your own registry and use it with
web3.pm, you must create a subclass that inherits from
ERCRegistry, and implements all the ERC 1319 standard methods prefixed with an underscore in
ERCRegistry. Then, you have to manually set it as the
registry attribute on
custom_registry = CustomRegistryClass(address, w3) w3.pm.registry = custom_registry
One reason a user might want to create their own Registry class is if they build a custom Package Registry smart contract that has features beyond those specified in ERC 1319. For example, the ability to delete a release or some micropayment feature. Rather than accessing those functions directly on the contract instance, they can create a custom
ERCRegistry subclass to easily call both the standard & custom methods.
VyperReferenceRegistry class is an example of this, as it contains all of the
ERC 1319 defined functions (prefixed with an underscore, eg
_get_package_name) but also contains functions that are unique to the Vyper Registry reference implementation (eg