mirror of
https://github.com/oceanprotocol/react.git
synced 2025-02-14 21:10:38 +01:00
update docs & examples
This commit is contained in:
parent
a3b307d929
commit
d03d001e68
@ -1,12 +1,6 @@
|
|||||||
# `useCompute`
|
# `useCompute`
|
||||||
|
|
||||||
The `OceanProvider` maintains a connection to the Ocean Protocol network in multiple steps:
|
Start a compute job on a data asset and retrieve its status.
|
||||||
|
|
||||||
1. On mount, connect to Aquarius instance right away so any asset metadata can be retrieved before, and independent of any Web3 connections.
|
|
||||||
2. Once Web3 becomes available, a connection to all Ocean Protocol network components is established.
|
|
||||||
3. Once Ocean becomes available, spits out some info about it.
|
|
||||||
|
|
||||||
Also provides a `useOcean` helper hook to access its context values from any component.
|
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
@ -14,7 +8,6 @@ Also provides a `useOcean` helper hook to access its context values from any com
|
|||||||
import React from 'react'
|
import React from 'react'
|
||||||
import {
|
import {
|
||||||
useWeb3,
|
useWeb3,
|
||||||
useOcean,
|
|
||||||
useMetadata,
|
useMetadata,
|
||||||
useCompute,
|
useCompute,
|
||||||
computeOptions,
|
computeOptions,
|
||||||
@ -25,18 +18,15 @@ import {
|
|||||||
const did = 'did:op:0x000000000'
|
const did = 'did:op:0x000000000'
|
||||||
|
|
||||||
export default function MyComponent() {
|
export default function MyComponent() {
|
||||||
// Get web3 from built-in Web3Provider context
|
// Get web3 from Web3Provider context
|
||||||
const { web3 } = useWeb3()
|
const { web3, account } = useWeb3()
|
||||||
|
|
||||||
// Get Ocean instance from built-in OceanProvider context
|
|
||||||
const { ocean, account } = useOcean()
|
|
||||||
|
|
||||||
// Get metadata for this asset
|
// Get metadata for this asset
|
||||||
const { title, metadata } = useMetadata(did)
|
const { title, metadata } = useMetadata(did)
|
||||||
|
|
||||||
|
|
||||||
// compute asset
|
// compute asset
|
||||||
const { compute, computeStep } = useCompute()
|
const { compute, computeStep } = useCompute()
|
||||||
|
|
||||||
// raw code text
|
// raw code text
|
||||||
const [algorithmRawCode, setAlgorithmRawCode] = useState('')
|
const [algorithmRawCode, setAlgorithmRawCode] = useState('')
|
||||||
const [computeContainer, setComputeContainer] = useState<ComputeValue>()
|
const [computeContainer, setComputeContainer] = useState<ComputeValue>()
|
||||||
@ -48,6 +38,7 @@ export default function MyComponent() {
|
|||||||
const fileText = await readFileContent(files[0])
|
const fileText = await readFileContent(files[0])
|
||||||
setAlgorithmRawCode(fileText)
|
setAlgorithmRawCode(fileText)
|
||||||
}
|
}
|
||||||
|
|
||||||
async function handleSelectChange(event: any) {
|
async function handleSelectChange(event: any) {
|
||||||
const comType = event.target.value
|
const comType = event.target.value
|
||||||
setComputeContainer(comType)
|
setComputeContainer(comType)
|
||||||
|
@ -0,0 +1,39 @@
|
|||||||
|
# `useConsume`
|
||||||
|
|
||||||
|
Get access to, and download a data asset.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
```tsx
|
||||||
|
import React from 'react'
|
||||||
|
import { useWeb3, useMetadata, useConsume } from '@oceanprotocol/react'
|
||||||
|
|
||||||
|
const did = 'did:op:0x000000000'
|
||||||
|
|
||||||
|
export default function MyComponent() {
|
||||||
|
// Get web3 from Web3Provider context
|
||||||
|
const { web3, account } = useWeb3()
|
||||||
|
|
||||||
|
// Get metadata for this asset
|
||||||
|
const { title, metadata } = useMetadata(did)
|
||||||
|
|
||||||
|
// consume asset
|
||||||
|
const { consume, consumeStep } = useConsume()
|
||||||
|
|
||||||
|
async function handleDownload() {
|
||||||
|
await consume(did)
|
||||||
|
}
|
||||||
|
|
||||||
|
return (
|
||||||
|
<div>
|
||||||
|
<h1>{title}</h1>
|
||||||
|
<p>Price: {web3.utils.fromWei(metadata.main.price)}</p>
|
||||||
|
|
||||||
|
<p>Your account: {account}</p>
|
||||||
|
<button onClick={handleDownload}>
|
||||||
|
{consumeStep || 'Download Asset'}
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
|
)
|
||||||
|
}
|
||||||
|
```
|
@ -0,0 +1,26 @@
|
|||||||
|
# `useMetadata`
|
||||||
|
|
||||||
|
Get metadata for a specific data asset.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
```tsx
|
||||||
|
import React from 'react'
|
||||||
|
import { useMetadata } from '@oceanprotocol/react'
|
||||||
|
|
||||||
|
const did = 'did:op:0x000000000'
|
||||||
|
|
||||||
|
export default function MyComponent() {
|
||||||
|
// Get metadata for this asset
|
||||||
|
const { title, metadata } = useMetadata(did)
|
||||||
|
|
||||||
|
const { main, additionalInformation } = metadata
|
||||||
|
|
||||||
|
return (
|
||||||
|
<div>
|
||||||
|
<h1>{title}</h1>
|
||||||
|
<p>Price: {main.price}</p>
|
||||||
|
</div>
|
||||||
|
)
|
||||||
|
}
|
||||||
|
```
|
Loading…
x
Reference in New Issue
Block a user