mirror of
https://github.com/oceanprotocol/docs.git
synced 2024-11-26 19:49:26 +01:00
f24d95a5a7
* Creating new page structure in developers section * Updating navigation * Splitting up DDO page and putting examples within details sections * Updated navigation * Updating table * GITBOOK-1: change request with no subject merged in GitBook * GITBOOK-2: change request with no subject merged in GitBook * Updating tables * Fixing services table * Updating tables * Updating algorithm page * Updating compute to data page * Updating API section * Adding the fine-grained permissions page * Adding Market-Level Permissions page * updating navigation * Updating fine grained permissions * adding information on DIDs * Updating navigation * Updating did and ddo page * GITBOOK-5: Adding video
178 lines
4.0 KiB
Markdown
178 lines
4.0 KiB
Markdown
|
|
---
|
|
title: Storage Specifications
|
|
section: developers
|
|
description: >-
|
|
Specification of storage options for assets in Ocean Protocol.
|
|
---
|
|
|
|
# Storage Specifications
|
|
|
|
Ocean does not handle the actual storage of files directly. The files are stored via other services which are then specified within the DDO.
|
|
|
|
During the publish process, file URLs must be encrypted with a respective _Provider_ API call before storing the DDO on-chain. For this, you need to send the following object to Provider (where "files" contains one or more storage objects):
|
|
|
|
```json
|
|
{
|
|
"datatokenAddress":"0x1",
|
|
"nftAddress": "0x2",
|
|
"files": [
|
|
...
|
|
]
|
|
}
|
|
```
|
|
|
|
The remainder of this document specifies the different types of storage objects that are supported:
|
|
|
|
## Static URLs.
|
|
|
|
Parameters:
|
|
|
|
* `url` - File url, required
|
|
* `method` - The HTTP method, required
|
|
* `headers` - Additional HTTP headers, optional
|
|
|
|
```
|
|
{
|
|
"type": "url",
|
|
"url": "https://url.com/file1.csv",
|
|
"method": "GET",
|
|
"headers":
|
|
{
|
|
"Authorization": "Bearer 123",
|
|
"APIKEY": "124",
|
|
}
|
|
}
|
|
```
|
|
|
|
## Interplanetary File System
|
|
|
|
**`IPFS`**
|
|
|
|
The [Interplanetary File System](https://ipfs.tech/) (IPFS) is a distributed file storage protocol that allows computers all over the globe to store and serve files as part of a giant peer-to-peer network. Any computer, anywhere in the world, can download the IPFS software and start hosting and serving files.
|
|
|
|
Parameters:
|
|
|
|
* `hash` - The file hash
|
|
|
|
```
|
|
{
|
|
"type": "ipfs",
|
|
"hash": "XXX"
|
|
}
|
|
```
|
|
|
|
## GraphQL
|
|
|
|
**`GraphQL`**
|
|
|
|
[GraphQL](https://graphql.org/) is a query language for APIs and a runtime for fulfilling those queries with your existing data.
|
|
|
|
Parameters:
|
|
|
|
* `url` - Server endpoint url, required
|
|
* `query` - The query to be executed, required
|
|
* `headers` - Additional HTTP headers, optional
|
|
|
|
```
|
|
{
|
|
"type": "graphql",
|
|
"url": "http://172.15.0.15:8000/subgraphs/name/oceanprotocol/ocean-subgraph",
|
|
"headers":{
|
|
"Authorization": "Bearer 123",
|
|
"APIKEY": "124",
|
|
},
|
|
"query": """query{
|
|
nfts(orderBy: createdTimestamp,orderDirection:desc){
|
|
id
|
|
symbol
|
|
createdTimestamp
|
|
}
|
|
}"""
|
|
}
|
|
```
|
|
|
|
## Smart Contract Data
|
|
|
|
Use a smart contract as data source.
|
|
|
|
Parameters:
|
|
|
|
* `chainId` - The chainId used to query the contract, required
|
|
* `address` - The smartcontract address, required
|
|
* `abi` - The function abi (NOT the entire contract abi), required
|
|
|
|
```
|
|
{
|
|
"type": "smartcontract",
|
|
"chainId": 1,
|
|
"address": "0x8149276f275EEFAc110D74AFE8AFECEaeC7d1593",
|
|
"abi": {
|
|
"inputs": [],
|
|
"name": "swapOceanFee",
|
|
"outputs": [{"internalType": "uint256", "name": "", "type": "uint256"}],
|
|
"stateMutability": "view",
|
|
"type": "function",
|
|
}
|
|
}
|
|
```
|
|
|
|
## Arweave
|
|
|
|
[Arweave](https://www.arweave.org/) is a decentralized data storage that allows to permanently store files over a distributed network of computers.
|
|
|
|
Parameters:
|
|
|
|
* `transactionId` - The transaction identifier
|
|
|
|
```
|
|
{
|
|
{
|
|
"type": "arweave",
|
|
"transactionId": "a4qJoQZa1poIv5guEzkfgZYSAD0uYm7Vw4zm_tCswVQ",
|
|
}
|
|
}
|
|
```
|
|
|
|
First class integrations supported in the future : **`Filecoin`** **`Storj`** **`SQL`**
|
|
|
|
A service can contain multiple files, using multiple storage types.
|
|
|
|
Example:
|
|
|
|
```json
|
|
{
|
|
"datatokenAddress": "0x1",
|
|
"nftAddress": "0x2",
|
|
"files": [
|
|
{
|
|
"type": "url",
|
|
"url": "https://url.com/file1.csv",
|
|
"method": "GET"
|
|
},
|
|
{
|
|
"type": "ipfs",
|
|
"hash": "XXXX"
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
To get information about the files after encryption, the `/fileinfo` endpoint of _Provider_ returns based on a passed DID an array of file metadata (based on the file type):
|
|
|
|
```json
|
|
[
|
|
{
|
|
"type": "url",
|
|
"contentLength": 100,
|
|
"contentType": "application/json"
|
|
},
|
|
{
|
|
"type": "ipfs",
|
|
"contentLength": 130,
|
|
"contentType": "application/text"
|
|
}
|
|
]
|
|
```
|
|
|
|
This only concerns metadata about a file, but never the file URLs. The only way to decrypt them is to exchange at least 1 datatoken based on the respective service pricing scheme. |