Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Decentralized storage (IPFS/IPNS or similar) as DDO metadata storage #11

Merged
merged 24 commits into from
May 21, 2024

Conversation

georgevlada
Copy link

@georgevlada georgevlada commented Feb 6, 2024

Storage Specifications - Updates
https://docs.oceanprotocol.com/developers/storage

Additions for Encrypted Content
Two new keys have been introduced to specify encryption details for stored content. These keys are optional and indicate whether the content is encrypted:

encryptedBy: The public node address that encrypted the file.
encryptMethod: Specifies the encryption method used by the entity referenced in encryptedBy. Acceptable values are "ecies" or "aes".

Example for Encrypted URL Type:

{
  "remote": {
    "type": "url",
    "url": "https://file.com/ddo.json",
    "method": "get",
    "encryptedBy": "[node_id]",
    "encryptedMethod": "AES/ECIES"
  }
}

Metadata - Updates
https://docs.oceanprotocol.com/developers/metadata

Creating or Updating Metadata
Metadata can be created or updated using the setMetadata function at the contract level. The Decentralized Data Object (DDO) can be directly sent to this function, adhering to the specifications outlined at DDO Specification (https://docs.oceanprotocol.com/developers/ddo-specification). Alternatively, a structured format can be used for the DDO to be downloaded from the specified storage type and subsequently stored in the Indexer (Aquarius).

Example - URL Type Unencrypted:

{
  "remote": {
    "type": "url",
    "url": "https://file.com/ddo.json",
    "method": "get"
  }
}

Example - URL Type Encrypted:

{
  "remote": {
    "type": "url",
    "url": "https://file.com/ddo.json",
    "method": "get",
    "encryptedBy": "[node_address]",
    "encryptedMethod": "AES/ECIES"
  }
}

@georgevlada georgevlada self-assigned this Feb 6, 2024
@georgevlada georgevlada changed the title Feature/index remote ddo Decentralized storage (IPFS/IPNS or similar) as DDO metadata storage Feb 15, 2024
@georgevlada georgevlada marked this pull request as ready for review February 15, 2024 14:25
@alexcos20 alexcos20 merged commit d349cff into develop May 21, 2024
8 checks passed
@alexcos20 alexcos20 deleted the feature/index-remote-ddo branch May 21, 2024 09:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Decentralized storage (IPFS/IPNS or similar) as DDO metadata storage (including media files)
3 participants