react/README.md

@oceanprotocol/react

React hooks & components on top of squid.js

Installation

npm install @oceanprotocol/react

Usage

First, wrap your App with the OceanProvider:

import React from 'react'
import { OceanProvider } from '@oceanprotocol/react'

export default function MyApp({ children }: { children: any }) {
    return (
        <OceanProvider>
            <h1>My App</h1>
            {children}
        </OceanProvider>
        
    )
}

Then within your component use the provided hooks to interact with Ocean's functionality:

import React from 'react'
import { useOcean, OceanConfig, useConsume } from '@oceanprotocol/react'

const oceanConfig: OceanConfig = {
    nodeUri: '',
    ...
}

export default function MyComponent() {
  // TODO: setup web3 first
  
  // Initialize, get existing, or reinitalize Ocean
  const { ocean, account } = useOcean(web3, oceanConfig)

  // consume asset
  const { consumeAsset, isLoading, step } = useConsume(ocean, account)

  async function handleClick() {
      const ddo = 'did:op:0x000000000'
      await consumeAsset(ddo)
  }

  return (
    <div>
        Your account: {account}

        <button onClick={handleClick}>
            {isLoading ? step : 'Download Asset' }
        </button>
    </div>
  )
}