Moving provider content around

developers/apis/README.md

@@ -1,2 +0,0 @@
-# APIs
-

developers/aquarius/README.md

@@ -1,7 +1,5 @@
 # Aquarius
 
-
-
 ### Postman documentation
 
 Click [here](https://documenter.getpostman.com/view/2151723/UVkmQc7r) to explore the documentation and more examples in postman.

developers/provider/get-requests.md

@@ -1,2 +1,172 @@
 # Get Requests
 
+
+### nonce endpoint
+
+#### GET /api/services/nonce
+
+Parameters
+
+```
+    userAddress: String object containing a user's ethereum address
+```
+
+Returns: Json object containing the last-used nonce value. The nonce endpoint is just informative, use the current UTC timestamp as a nonce, where required in other endpoints.
+
+Example:
+
+```
+GET /api/services/nonce?userAddress=0x990922334
+```
+
+Response:
+
+```json
+{
+  "nonce": 23
+}
+```
+
+#### Javascript Example
+
+```runkit  nodeVersion="18.x.x"
+const axios = require('axios')
+
+const response = await axios( `https://v4.provider.oceanprotocol.com/api/services/nonce?userAddress=0x0db823218e337a6817e6d7740eb17635deadafaf`)
+ 
+console.log(response.status)
+console.log(response.data)
+
+```
+
+### Encrypt endpoint
+
+#### GET /api/services/encrypt
+
+Body: binary application/octet-stream
+
+Returns: Bytes string containing the encrypted document.
+
+Example:
+
+```
+POST /api/services/encrypt
+body: b'\xfd7zXZ\x00\x00\x04\xe6\xd6\xb4F\ ... \x00\x04YZ'
+```
+
+Response:
+
+```
+b'0x04b2bfab1f4e...7ed0573'
+```
+
+#### Javascript Example
+
+```runkit  nodeVersion="18.x.x"
+const fetch = require('cross-fetch')
+
+const data = "test"
+const response = await fetch('https://v4.provider.oceanprotocol.com/api/services/encrypt?chainId=1', {
+        method: 'POST',
+        body: JSON.stringify(data),
+        headers: { 'Content-Type': 'application/octet-stream' }
+      })
+console.log(response)      
+
+```
+#### GET /api/services/initialize
+
+Parameters
+
+```
+    documentId: String object containing document id (e.g. a DID)
+    serviceId: String, ID of the service the datatoken is attached to
+    consumerAddress: String object containing consumer's address
+    environment: String representing a compute environment offered by the provider
+    validUntil: Integer, date of validity of the service (optional)
+    fileIndex: Integer, the index of the file from the files list in the dataset. If set, provider will validate the file access. (optional)
+```
+
+Returns: Json document with a quote for amount of tokens to transfer to the provider account.
+
+Example:
+
+```
+GET /api/services/initialize
+payload:
+{
+    "documentId":"0x1111",
+    "serviceId": 0,
+    "consumerAddress":"0x990922334",
+}
+payload (with optional parameters):
+{
+    "documentId":"0x1111",
+    "serviceId": 0,
+    "consumerAddress":"0x990922334",
+    "validUntil": 1578004800,
+    "fileIndex": 1
+}
+```
+
+Response:
+
+```json
+{
+    "datatoken": "0x21fa3ea32892091...",
+    "nonce": 23,
+    "providerFee": {
+        "providerFeeAddress": "0xabc123...",
+        "providerFeeToken": "0xabc123...",
+        "providerFeeAmount": "200",
+        "providerData": "0xabc123...",
+        "v": 27,
+        "r": "0xabc123...",
+        "s": "0xabc123...",
+        "validUntil": 123456,
+    },
+    "computeAddress": "0x8123jdf8sdsa..."
+}
+```
+
+### Download endpoint
+
+#### GET /api/services/download
+
+Parameters
+
+```
+    documentId: String object containing document id (e.g. a DID)
+    serviceId: String, representing the list of `file` objects that describe each file in the dataset
+    transferTxId: Hex string -- the id of on-chain transaction for approval of datatokens transfer
+    given to the provider's account
+    fileIndex: integer, the index of the file from the files list in the dataset
+    nonce: Nonce
+    consumerAddress: String object containing consumer's address
+    signature: String object containg user signature (signed message)
+```
+
+Returns: File stream. Retrieves the attached asset files.
+
+Example:
+
+```
+GET /api/services/download
+payload:
+{
+    "documentId":"0x1111",
+    "serviceId": 0,
+    "fileIndex": 0,
+    "datatoken": "",
+    "consumerAddress":"0x990922334",
+    "signature":"0x00110011",
+    "transferTxId": "0xa09fc23421345532e34829"
+```
+
+Response:
+
+```json
+{
+  "": ""
+}
+```

developers/provider/post-requests.md

@@ -1,2 +1,90 @@
 # Post Requests
 
+### Decrypt endpoint
+
+#### POST /api/services/decrypt
+
+Parameters
+
+```
+    decrypterAddress: String object containing the address of the decrypter (required)
+    chainId: the chain id of the network the document is on (required)
+    transactionId: the transaction id of the encrypted document (optional)
+    dataNftAddress: the address of the data nft (optional)
+    encryptedDocument: the encrypted document (optional)
+    flags: the flags of the encrypted document (optional)
+    documentHash: the hash of the encrypted document (optional)
+    nonce: the nonce of the encrypted document (required)
+    signature: the signature of the encrypted document (required)
+```
+
+Returns: Bytes string containing the decrypted document.
+
+Example:
+
+```
+POST /api/services/decrypt
+payload: {
+    'decrypterAddress':'0xA78deb2Fa79463945C247991075E2a0e98Ba7A09'
+    'chainId':8996
+    'dataNftAddress':'0xBD558814eE914800EbfeF4a1cbE196F5161823d9'
+    'encryptedDocument':'0xfd377a585a0...f07afef7dc214'
+    'flags': 1
+    'documentHash':'0x0cb38a7bba49758a86f8556642aff655d00e41da28240d5ea0f596b74094d91f'
+    'nonce':'1644315615.24195'
+    'signature':'0xd6f27047853203824ab9e5acef87d0a501a64aee93f33a83b6f91cbe8fb4489824defceaccde91273f41290cb2a0c15572368e8bea0b456c7a653659cad7de311b'
+}
+```
+
+Response:
+
+```
+b'{"@context": ["https://w3id.org/did/v1"], "id": "did:op:0c184915b07b44c888d468be85a9b28253e80070e5294b1aaed81c ...'
+```
+
+### File info endpoint
+
+#### POST /api/services/fileinfo
+
+Retrieves Content-Type and Content-Length from the given URL or asset.
+
+Parameters
+
+For published assets:
+
+```
+{
+    did: String, DID of the dataset
+    serviceId: String, ID of the service
+}
+```
+
+For file objects,see https://docs.oceanprotocol.com/core-concepts/did-ddo#files
+
+If checksum is requests, file size should be lower < MAX\_CHECKSUM\_LENGTH (see Provider ENVs) If file is larger, checksum WILL NOT be computed.
+
+Returns: Json document file info object
+
+Example:
+
+```
+POST /api/services/fileinfo
+payload:
+{
+    "did":"0x1111",
+    "serviceId": "0",
+}
+```
+
+Response:
+
+```json
+[
+    {
+        "contentLength":"1161",
+        "contentType":"application/json",
+        "index":0,
+        "valid": true
+    },...
+]
+```