1
0
mirror of https://github.com/oceanprotocol/docs.git synced 2024-11-02 08:20:22 +01:00
docs/content/tutorials/react-get-use-data-set.md

225 lines
6.5 KiB
Markdown
Raw Normal View History

2018-12-05 12:08:47 +01:00
---
title: Get & Use a Data Set
description: Tutorial to get and use a data set in a basic React app.
2018-12-05 12:08:47 +01:00
---
2018-12-17 14:02:35 +01:00
## Requirements
2019-04-02 13:18:59 +02:00
This is a continuation of the React App Tutorial. Make sure you already did the [React App Setup](/tutorials/react-setup/) and the [Publish a Data Set](/tutorials/react-publish-data-set/) steps.
2018-12-17 14:02:35 +01:00
2019-04-02 13:18:59 +02:00
Open `src/App.js` in your marketplace app.
2018-12-17 14:02:35 +01:00
## Retrieve Assets
In the previous tutorial we added asset publishing. We can now search for published assets for consumption. Just after the `submitAsset()` function we can add a new function that will handle search:
2018-12-17 14:02:35 +01:00
```js
2019-01-30 11:45:59 +01:00
async retrieveAssets() {
2019-04-01 12:27:52 +02:00
this.dbAssets = await this.ocean.assets.search("10 Monkey Species Small")
2018-12-17 14:02:35 +01:00
console.log(this.dbAssets)
}
```
The last thing we need is a button to start our search inside the render function just after `<button onClick={() => this.submitAsset()}>Register asset</button>`:
```jsx
2019-01-30 11:45:59 +01:00
<button onClick={() => this.retrieveAssets()}>Retrieve assets</button>
2018-12-17 14:02:35 +01:00
```
## Consume Assets
2018-12-17 14:02:35 +01:00
2019-04-02 13:18:59 +02:00
The retrieved assets can now be consumed so in this tutorial we consume the first one. The following code goes after the `async retrieveAssets()` function.
2018-12-17 14:02:35 +01:00
```js
2019-01-30 11:45:59 +01:00
async consumeAsset() {
2018-12-17 14:02:35 +01:00
// get all accounts
2019-04-01 12:27:52 +02:00
const accounts = await this.ocean.accounts.list()
2018-12-17 14:02:35 +01:00
// get first asset
const consumeAsset = this.dbAssets[0]
// get service we want to execute
const service = consumeAsset.findServiceByType('Access')
2019-04-01 12:27:52 +02:00
// order service agreement
const agreement = await this.ocean.assets.order(
2018-12-17 14:02:35 +01:00
consumeAsset.id,
service.serviceDefinitionId,
2019-04-01 12:27:52 +02:00
accounts[0]
)
// consume it
await this.ocean.assets.consume(
agreement,
2018-12-17 14:02:35 +01:00
consumeAsset.id,
service.serviceDefinitionId,
2019-04-01 12:27:52 +02:00
accounts[0],
''
)
2018-12-17 14:02:35 +01:00
}
```
2019-04-02 13:18:59 +02:00
We still need a button to start consumption. In the render function, just after the `<button onClick={()=>this.retrieveAssets()}>Retrieve assets</button>` line, add:
2018-12-17 14:02:35 +01:00
```jsx
2019-01-30 11:45:59 +01:00
<button onClick={() => this.consumeAsset()}>Consume asset</button>
2018-12-17 14:02:35 +01:00
```
2019-01-30 11:45:59 +01:00
With all these buttons in place, you should see this:
![React App 05](images/react-app-05.png)
Tip: Before clicking the `Retrieve assets` button, it might help to reload the page.
2019-04-03 14:40:15 +02:00
Go ahead and click the `Retrieve assets` button, and then the `Consume asset` button. Approve all the MetaMask dialog boxes.
2018-12-17 14:02:35 +01:00
If you have no errors in your `console.log` and can see your asset files listed, you have a working marketplace.
## Final Result
2018-12-17 14:02:35 +01:00
Here is the full source of `src/App.js` that you should have if you followed this tutorial:
```jsx
import React, { Component } from 'react'
import './App.css'
import { Ocean } from '@oceanprotocol/squid'
import * as Web3 from 'web3'
const web3 = new Web3(window.web3.currentProvider)
window.ethereum.enable()
const asset = {
base: {
2019-04-04 11:56:56 +02:00
name: '10 Monkey Species Small',
dateCreated: '2012-02-01T10:55:11Z',
author: 'Mario',
license: 'CC0: Public Domain',
contentType: 'jpg/txt',
2019-04-01 12:27:52 +02:00
price: 10,
files: [
{
2019-04-16 16:31:56 +02:00
index: 0,
contentType: 'application/zip',
2019-04-04 11:56:56 +02:00
checksum: '2bf9d229d110d1976cdf85e9f3256c7f',
checksumType: 'MD5',
2019-04-01 12:27:52 +02:00
contentLength: 12057507,
2019-04-16 16:31:56 +02:00
compression: 'zip',
encoding: 'UTF-8',
2019-04-16 18:14:00 +02:00
url:
'https://s3.amazonaws.com/datacommons-seeding-us-east/10_Monkey_Species_Small/assets/training.zip'
2019-04-01 12:27:52 +02:00
},
{
2019-04-16 16:31:56 +02:00
index: 1,
contentType: 'text/txt',
2019-04-04 11:56:56 +02:00
checksum: '354d19c0733c47ef3a6cce5b633116b0',
checksumType: 'MD5',
2019-04-01 12:27:52 +02:00
contentLength: 928,
2019-04-16 18:14:00 +02:00
url:
'https://s3.amazonaws.com/datacommons-seeding-us-east/10_Monkey_Species_Small/assets/monkey_labels.txt',
2019-04-16 16:31:56 +02:00
resourceId: 'test'
2019-04-01 12:27:52 +02:00
},
{
2019-04-16 16:31:56 +02:00
index: 2
2019-04-16 18:14:00 +02:00
}
2019-04-01 12:27:52 +02:00
],
2019-04-04 11:56:56 +02:00
checksum: '',
categories: ['image'],
tags: ['image data', 'classification', 'animals'],
type: 'dataset',
description: 'EXAMPLE ONLY ',
copyrightHolder: 'Unknown',
workExample: 'image path, id, label',
2018-12-17 14:02:35 +01:00
links: [
{
2019-04-04 11:56:56 +02:00
name: 'example model',
url:
'https://drive.google.com/open?id=1uuz50RGiAW8YxRcWeQVgQglZpyAebgSM'
2019-04-01 12:27:52 +02:00
},
{
2019-04-04 11:56:56 +02:00
name: 'example code',
type: 'example code',
url: 'https://github.com/slothkong/CNN_classification_10_monkey_species'
2019-04-01 12:27:52 +02:00
},
{
2019-04-04 11:56:56 +02:00
url:
'https://s3.amazonaws.com/datacommons-seeding-us-east/10_Monkey_Species_Small/links/discovery/n5151.jpg',
name: 'n5151.jpg',
type: 'discovery'
2019-04-01 12:27:52 +02:00
},
{
2019-04-04 11:56:56 +02:00
url:
'https://s3.amazonaws.com/datacommons-seeding-us-east/10_Monkey_Species_Small/links/sample/sample.zip',
name: 'sample.zip',
type: 'sample'
2018-12-17 14:02:35 +01:00
}
],
2019-04-04 11:56:56 +02:00
inLanguage: 'en'
2018-12-17 14:02:35 +01:00
}
}
class App extends Component {
async componentDidMount() {
this.ocean = await new Ocean.getInstance({
web3Provider: web3,
nodeUri: 'http://localhost:8545',
aquariusUri: 'http://localhost:5000',
brizoUri: 'http://localhost:8030',
2019-04-03 14:40:15 +02:00
brizoAddress: '0x00bd138abd70e2f00903268f3db08f2d25677c9e',
2018-12-17 14:02:35 +01:00
parityUri: 'http://localhost:8545',
2019-04-03 14:40:15 +02:00
secretStoreUri: 'http://localhost:12001'
2018-12-17 14:02:35 +01:00
})
2019-04-16 18:14:00 +02:00
console.log('Finished loading contracts.')
2018-12-17 14:02:35 +01:00
}
async submitAsset() {
2019-04-01 12:27:52 +02:00
const accounts = await this.ocean.accounts.list()
const ddo = await this.ocean.assets.create(asset, accounts[0])
2019-04-16 18:14:00 +02:00
console.log('Asset successfully submitted.')
console.log(ddo)
alert(
'Asset successfully submitted. Look into your console to see the response DDO object.'
)
2018-12-17 14:02:35 +01:00
}
2019-01-30 11:45:59 +01:00
async retrieveAssets() {
2019-04-04 11:56:56 +02:00
this.dbAssets = await this.ocean.assets.search('10 Monkey Species Small')
2018-12-17 14:02:35 +01:00
console.log(this.dbAssets)
2019-04-16 18:14:00 +02:00
alert(
'Asset successfully retrieved. Look into your console to see the search response.'
)
2018-12-17 14:02:35 +01:00
}
2019-01-30 11:45:59 +01:00
async consumeAsset() {
2018-12-17 14:02:35 +01:00
// get all accounts
2019-04-01 12:27:52 +02:00
const accounts = await this.ocean.accounts.list()
2018-12-17 14:02:35 +01:00
// get first asset
const consumeAsset = this.dbAssets[0]
// get service we want to execute
const service = consumeAsset.findServiceByType('Access')
2019-04-01 12:27:52 +02:00
// order service agreement
2019-04-02 13:18:59 +02:00
const agreement = await this.ocean.assets.order(
2019-01-30 11:45:59 +01:00
consumeAsset.id,
service.serviceDefinitionId,
accounts[0]
)
2019-04-01 12:27:52 +02:00
// consume it
2019-04-02 13:18:59 +02:00
await this.ocean.assets.consume(
2019-04-01 12:27:52 +02:00
agreement,
2019-01-30 11:45:59 +01:00
consumeAsset.id,
service.serviceDefinitionId,
2019-04-01 12:27:52 +02:00
accounts[0],
''
2019-01-30 11:45:59 +01:00
)
2018-12-17 14:02:35 +01:00
}
render() {
return (
<div className="App App-header">
<h1>Marketplace app</h1>
<button onClick={() => this.submitAsset()}>Register asset</button>
<button onClick={() => this.retrieveAssets()}>Retrieve assets</button>
<button onClick={() => this.consumeAsset()}>Consume asset</button>
</div>
)
}
}
export default App
2019-01-30 11:45:59 +01:00
```