Plugins: Add StorageAPI

[fubuloubu]

Overview

Add support for lookups to various file storage locations, such as over http/https (via requests as 1st class plugin), ipfs/ipns/ipld (via py-ipfs-http-client or Infura, etc.), and any other relevant URI types which share data (Swarm is... still a thing bzz://...).

Use cases may include: downloading projects and manifest files, uploading/pinning manifest files, fetching source code, querying ethereum data (cached via IPLD), storing contract ABIs and bytecode, etc.

Specification

class StorageAPI:
    @property
    def uri_types(self) -> Set[Uri]:
        """Set of URI Types that this plugin handles"""

    def fetch(self, uri: Uri) -> Deserializable:
        """Obtain content at URI and store it on disk, returning file handle to content"""
        # NOTE: URI Type must be in `self.uri_types`
        # NOTE: Content can be cached in plugin data folder, or via other means (IPFS client data folder)
        # NOTE: Path returned can be a file or folder, handle appropriately

    def push(self, content: Serializable) -> Uri:
        ...

Dependencies

No dependencies

[antazoey]

Question: Is there a default StorageAPI implementation we will want to ship with core Ape?

[fubuloubu]

Question: Is there a default StorageAPI implementation we will want to ship with core Ape?

I think this concept got muddied up over the years, the current iteration of this idea is formalizing package and source querying capability via the query system, so it is possible to find packages (and publish) using multiple sources instead of just etherscan or disk cache. The "default implementation" we'd want to ship with Ape is whatever we want to use for publishing sources officially out of the box